Skip to content
Browse files

added section to documentation describing manual installation

Change-Id: I7c42cde66ccc7cfd1949cea7e4946b15a71c3a2b
Reviewed-on: http://review.couchbase.org/10671
Tested-by: Marty Schoch <marty.schoch@gmail.com>
Reviewed-by: Marty Schoch <marty.schoch@gmail.com>
  • Loading branch information...
1 parent aca0354 commit 6cbb2ef3d3dec66f3284baa7bb70051e5e91cb38 @mschoch mschoch committed
Showing with 44 additions and 0 deletions.
  1. +22 −0 README.markdown
  2. +22 −0 doc/README.txt
View
22 README.markdown
@@ -140,6 +140,28 @@ Replacing the value for sdk.dir with the path to the Android SDK on the build se
The current build of Android Couchbase embed the CouchDB binaries. There is information on how to build these binaries on the [SourceBuild](https://github.com/couchbase/Android-Couchbase-SourceBuild) project.
+## Manual Installation
+
+In some environments it may not be possible to use the couchbase.xml ant script installer. Couchbase can be installed manually using the following steps.
+
+1. Unzip the Couchbase.zip archive. This will produce another zip file named overlay.zip.
+2. Extract the contents of the overlay.zip file into your project. This will place all assets and libraries in the correct location within the structure of your project.
+
+ cd <project root>
+ unzip /<path to>/overlay.zip
+
+3. Update the project's AndroidManifest.xml to declare the Couchbase service and request the required permissions.
+
+ Within the "application" section add:
+
+ <service android:name="com.couchbase.android.CouchbaseService" android:enabled="true" android:exported="false"/>
+
+ Within the "manifest" section add:
+
+ <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
+ <uses-permission android:name="android.permission.INTERNET"/>
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
+
## License
Portions under Apache, Erlang, and other licenses.
View
22 doc/README.txt
@@ -90,6 +90,28 @@ For examples please look at:
* https://github.com/daleharvey/Android-MobileFuton
* https://github.com/couchbaselabs/AndroidGrocerySync
+## Manual Installation
+
+In some environments it may not be possible to use the couchbase.xml ant script installer. Couchbase can be installed manually using the following steps.
+
+1. Unzip the Couchbase.zip archive. This will produce another zip file named overlay.zip.
+2. Extract the contents of the overlay.zip file into your project. This will place all assets and libraries in the correct location within the structure of your project.
+
+ cd <project root>
+ unzip /<path to>/overlay.zip
+
+3. Update the project's AndroidManifest.xml to declare the Couchbase service and request the required permissions.
+
+ Within the "application" section add:
+
+ <service android:name="com.couchbase.android.CouchbaseService" android:enabled="true" android:exported="false"/>
+
+ Within the "manifest" section add:
+
+ <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
+ <uses-permission android:name="android.permission.INTERNET"/>
+ <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
+
## Join us
There is a Google Group here for Mobile Couchbase at https://groups.google.com/group/mobile-couchbase. Let's talk about how to optimize the Erlang build, what the best Java APIs are for CouchDB, how to take advantage of replication on mobile devices. It'll be fun.

0 comments on commit 6cbb2ef

Please sign in to comment.
Something went wrong with that request. Please try again.