Return-Path: X-Original-To: apmail-incubator-callback-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-callback-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id BB1AE956B for ; Fri, 18 May 2012 17:40:04 +0000 (UTC) Received: (qmail 97965 invoked by uid 500); 18 May 2012 17:40:04 -0000 Delivered-To: apmail-incubator-callback-commits-archive@incubator.apache.org Received: (qmail 97916 invoked by uid 500); 18 May 2012 17:40:04 -0000 Mailing-List: contact callback-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: callback-dev@incubator.apache.org Delivered-To: mailing list callback-commits@incubator.apache.org Received: (qmail 97893 invoked by uid 99); 18 May 2012 17:40:04 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 18 May 2012 17:40:04 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 95EF316AEF; Fri, 18 May 2012 17:40:03 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: mwbrooks@apache.org To: callback-commits@incubator.apache.org X-Mailer: ASF-Git Admin Mailer Subject: [2/2] docs commit: Added the whitelist guide Message-Id: <20120518174003.95EF316AEF@tyr.zones.apache.org> Date: Fri, 18 May 2012 17:40:03 +0000 (UTC) Added the whitelist guide Project: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/commit/1b440d9c Tree: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/tree/1b440d9c Diff: http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/diff/1b440d9c Branch: refs/heads/master Commit: 1b440d9c93d6e7fa2de3246da8ffa697433861f8 Parents: df73ed0 Author: Nathan Campos Authored: Fri May 4 16:59:35 2012 -0300 Committer: Nathan Campos Committed: Fri May 4 16:59:35 2012 -0300 ---------------------------------------------------------------------- docs/en/edge/guide/whitelist/index.md | 66 ++++++++++++++++++++++++++++ 1 files changed, 66 insertions(+), 0 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cordova-docs/blob/1b440d9c/docs/en/edge/guide/whitelist/index.md ---------------------------------------------------------------------- diff --git a/docs/en/edge/guide/whitelist/index.md b/docs/en/edge/guide/whitelist/index.md new file mode 100644 index 0000000..e552944 --- /dev/null +++ b/docs/en/edge/guide/whitelist/index.md @@ -0,0 +1,66 @@ +--- +license: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--- + +Whitelisting +============ + +This guide will introduce you to Cordova's newest addition: Whitelists. It's intention is to be simple and easy to understand so new and senior Cordova developers can avoid errors while upgrading a project or creating a new one. + +Why was this introduced? +------------------------ + +A question I asked myself as soon as I got a error while debugging a project after upgrading to 1.6.1. + +This feature was introduced, for developers that weren't sanitizing their links, as to prevent an app state where there is no way back. + +Its current status +------------------ + + * **iOS**: Full whitelist support + * **Android**: Unknown + * **Windows Phone**: Unknown + * **BlackBerry**: Unknown + * **WebOS, Symbian, Bada**: Unknown + +How to edit the whitelist? +-------------------------- + +**iOS** + +The easiest way of doing this is by going to your project's *cordova.plist* file and adding a new *String* to the *ExternalHosts* key. That's all! + +How should a whitelist key look like? +------------------------------------- + +For example, if you want to add [google.com][1] to your whitelist all you have to do is add a new key, as described above, with the following value: `google.com` + +**Wildcards** + +You can also use wildcards on whitelist keys. If you want to enable all domains possible it's easy, just add a key with the value `*`. If you want to add all the sub-domains to the whitelist, just add a key with a value like this: `*.domain.com`. + +Be warned that you should not include a full URL, with the `http://` part, just the sub-domain/domain, like on the examples. + +The End +------- + +This guide is a contribution of [Nathan Campos][2] to the Cordova project. + + +[1]: http://google.com +[2]: http://about.me/nathanpc \ No newline at end of file