You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by ja...@apache.org on 2013/10/03 17:47:32 UTC
[34/50] git commit: updated
refs/heads/1894-feature-experimental-nodejs-couchjs to 532100c
add docs
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/eebe8aee
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/eebe8aee
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/eebe8aee
Branch: refs/heads/1894-feature-experimental-nodejs-couchjs
Commit: eebe8aeee9bbf8b6d0dec745aa8552b68e477f82
Parents: 1c61f30
Author: Jan Lehnardt <ja...@apache.org>
Authored: Sat Sep 21 16:14:39 2013 +0200
Committer: Jan Lehnardt <ja...@apache.org>
Committed: Thu Oct 3 17:21:29 2013 +0200
----------------------------------------------------------------------
share/doc/build/Makefile.am | 2 +
share/doc/src/contents.rst | 1 +
share/doc/src/experimental.rst | 73 +++++++++++++++++++++++++++++++++++++
3 files changed, 76 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb/blob/eebe8aee/share/doc/build/Makefile.am
----------------------------------------------------------------------
diff --git a/share/doc/build/Makefile.am b/share/doc/build/Makefile.am
index 66819fa..1b69ef6 100644
--- a/share/doc/build/Makefile.am
+++ b/share/doc/build/Makefile.am
@@ -143,6 +143,7 @@ html_files = \
html/_sources/about.txt \
html/_sources/contents.txt \
html/_sources/contributing.txt \
+ html/_sources/experimental.txt \
html/_sources/externals.txt \
html/_sources/json-structure.txt \
html/_static/ajax-loader.gif \
@@ -403,6 +404,7 @@ src_files = \
../src/whatsnew/index.rst \
../src/about.rst \
../src/contents.rst \
+ ../src/experimental.rst \
../src/contributing.rst \
../src/externals.rst \
../src/json-structure.rst \
http://git-wip-us.apache.org/repos/asf/couchdb/blob/eebe8aee/share/doc/src/contents.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/contents.rst b/share/doc/src/contents.rst
index 0b38b73..4395f92 100644
--- a/share/doc/src/contents.rst
+++ b/share/doc/src/contents.rst
@@ -29,6 +29,7 @@
fauxton/index
api/index
json-structure
+ experimental
contributing
whatsnew/index
cve/index
http://git-wip-us.apache.org/repos/asf/couchdb/blob/eebe8aee/share/doc/src/experimental.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/experimental.rst b/share/doc/src/experimental.rst
new file mode 100644
index 0000000..1e883bf
--- /dev/null
+++ b/share/doc/src/experimental.rst
@@ -0,0 +1,73 @@
+.. Licensed 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.
+
+.. _experimental:
+
+=====================
+Experimental Features
+=====================
+
+This is a list of experimental features in CouchDB. They are included in
+a release because the development team is requesting feedback from the
+larger developer community. As such, please play around with these features
+and send us feedback, thanks!
+
+Use at your own risk! Do not rely on these features for critical
+applications.
+
+NodeJS Query Server
+===================
+
+The NodeJS Query Server is an alternative runtime environment for
+the default JavaScript Query Server that runs on top of Node.JS and
+not SpiderMonkey like the default Query Server.
+
+
+Setup
+-----
+
+You will need to install Node.JS version 0.10.0 or later. See `Node.JS
+Downloads <http://nodejs.org/download/>`_ for options.
+
+1. Install the `couchjs-node` binary. Either via NPM:
+
+.. code-block:: shell
+
+ npm install -g couchjs
+
+Or from the CouchDB sources:
+
+.. code-block:: shell
+
+ cd src/couchjs-node
+ npm link
+
+.. note:: **NPM in non-standard locations**
+
+ If your Node.JS installation doesn’t store binaries in `/usr/local/bin`
+ you will need to adjust CouchDB’s configuration. Add this to your `local.ini`
+ file:
+
+ .. code-block:: ini
+
+ [query_servers]
+ nodejs = /path/to/couchjs-node /path/to/couchdb/share/server/main.js
+
+ And then restart your CouchDB instance.
+
+2. Done. Now you can create design documents with the `language` parameter
+set to `nodejs` and all JavaScript functions in this design document will
+be processed by the Node.JS query server.
+
+Enjoy!
+
+