cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [2/2] docs commit: Added the whitelist guide
Date Fri, 18 May 2012 17:40:03 GMT
Added the whitelist guide


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/ |   66 ++++++++++++++++++++++++++++
 1 files changed, 66 insertions(+), 0 deletions(-)
diff --git a/docs/en/edge/guide/whitelist/ b/docs/en/edge/guide/whitelist/
new file mode 100644
index 0000000..e552944
--- /dev/null
+++ b/docs/en/edge/guide/whitelist/
@@ -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
+         Unless required by applicable law or agreed to in writing,
+         software distributed under the License is distributed on an
+         KIND, either express or implied.  See the License for the
+         specific language governing permissions and limitations
+         under the License.
+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?
+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 [][1] to your whitelist all you have to do is add
a new key, as described above, with the following value: ``
+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: `*`.
+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.
\ No newline at end of file

View raw message