You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by kx...@apache.org on 2015/02/20 01:26:49 UTC
[16/26] documentation commit: updated refs/heads/master to 5a81ace
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/25273e7a/src/api/server/configuration.rst
----------------------------------------------------------------------
diff --git a/src/api/server/configuration.rst b/src/api/server/configuration.rst
index 5f53002..ffa9cf7 100644
--- a/src/api/server/configuration.rst
+++ b/src/api/server/configuration.rst
@@ -23,136 +23,135 @@ the various configuration values within a running CouchDB instance.
============
.. http:get:: /_config
- :synopsis: Obtains a list of the entire server configuration
-
- Returns the entire CouchDB server configuration as a JSON structure. The
- structure is organized by different configuration sections, with
- individual values.
-
- :<header Accept: - :mimetype:`application/json`
- - :mimetype:`text/plain`
- :>header Content-Type: - :mimetype:`application/json`
- - :mimetype:`text/plain; charset=utf-8`
- :code 200: Request completed successfully
- :code 401: CouchDB Server Administrator privileges required
-
- **Request**
-
- .. code-block:: http
-
- GET /_config HTTP/1.1
- Accept: application/json
- Host: localhost:5984
-
- **Response**:
-
- .. code-block:: http
-
- HTTP/1.1 200 OK
- Cache-Control: must-revalidate
- Content-Length: 4148
- Content-Type: application/json
- Date: Sat, 10 Aug 2013 12:01:42 GMT
- Server: CouchDB (Erlang/OTP)
-
- {
- "attachments": {
- "compressible_types": "text/*, application/javascript, application/json, application/xml",
- "compression_level": "8"
- },
- "couch_httpd_auth": {
- "auth_cache_size": "50",
- "authentication_db": "_users",
- "authentication_redirect": "/_utils/session.html",
- "require_valid_user": "false",
- "timeout": "600"
- },
- "couchdb": {
- "database_dir": "/var/lib/couchdb",
- "delayed_commits": "true",
- "max_attachment_chunk_size": "4294967296",
- "max_dbs_open": "100",
- "max_document_size": "4294967296",
- "os_process_timeout": "5000",
- "uri_file": "/var/lib/couchdb/couch.uri",
- "util_driver_dir": "/usr/lib64/couchdb/erlang/lib/couch-1.5.0/priv/lib",
- "view_index_dir": "/var/lib/couchdb"
- },
- "daemons": {
- "auth_cache": "{couch_auth_cache, start_link, []}",
- "db_update_notifier": "{couch_db_update_notifier_sup, start_link, []}",
- "external_manager": "{couch_external_manager, start_link, []}",
- "httpd": "{couch_httpd, start_link, []}",
- "query_servers": "{couch_query_servers, start_link, []}",
- "stats_aggregator": "{couch_stats_aggregator, start, []}",
- "stats_collector": "{couch_stats_collector, start, []}",
- "uuids": "{couch_uuids, start, []}",
- "view_manager": "{couch_view, start_link, []}"
- },
- "httpd": {
- "allow_jsonp": "false",
- "authentication_handlers": "{couch_httpd_oauth, oauth_authentication_handler}, {couch_httpd_auth, cookie_authentication_handler}, {couch_httpd_auth, default_authentication_handler}",
- "bind_address": "192.168.0.2",
- "default_handler": "{couch_httpd_db, handle_request}",
- "max_connections": "2048",
- "port": "5984",
- "secure_rewrites": "true",
- "vhost_global_handlers": "_utils, _uuids, _session, _oauth, _users"
- },
- "httpd_db_handlers": {
- "_changes": "{couch_httpd_db, handle_changes_req}",
- "_compact": "{couch_httpd_db, handle_compact_req}",
- "_design": "{couch_httpd_db, handle_design_req}",
- "_temp_view": "{couch_httpd_view, handle_temp_view_req}",
- "_view_cleanup": "{couch_httpd_db, handle_view_cleanup_req}"
- },
- "httpd_design_handlers": {
- "_info": "{couch_httpd_db, handle_design_info_req}",
- "_list": "{couch_httpd_show, handle_view_list_req}",
- "_rewrite": "{couch_httpd_rewrite, handle_rewrite_req}",
- "_show": "{couch_httpd_show, handle_doc_show_req}",
- "_update": "{couch_httpd_show, handle_doc_update_req}",
- "_view": "{couch_httpd_view, handle_view_req}"
- },
- "httpd_global_handlers": {
- "/": "{couch_httpd_misc_handlers, handle_welcome_req, <<\"Welcome\">>}",
- "_active_tasks": "{couch_httpd_misc_handlers, handle_task_status_req}",
- "_all_dbs": "{couch_httpd_misc_handlers, handle_all_dbs_req}",
- "_config": "{couch_httpd_misc_handlers, handle_config_req}",
- "_log": "{couch_httpd_misc_handlers, handle_log_req}",
- "_oauth": "{couch_httpd_oauth, handle_oauth_req}",
- "_replicate": "{couch_httpd_misc_handlers, handle_replicate_req}",
- "_restart": "{couch_httpd_misc_handlers, handle_restart_req}",
- "_session": "{couch_httpd_auth, handle_session_req}",
- "_stats": "{couch_httpd_stats_handlers, handle_stats_req}",
- "_utils": "{couch_httpd_misc_handlers, handle_utils_dir_req, \"/usr/share/couchdb/www\"}",
- "_uuids": "{couch_httpd_misc_handlers, handle_uuids_req}",
- "favicon.ico": "{couch_httpd_misc_handlers, handle_favicon_req, \"/usr/share/couchdb/www\"}"
- },
- "log": {
- "file": "/var/log/couchdb/couch.log",
- "include_sasl": "true",
- "level": "info"
- },
- "query_server_config": {
- "reduce_limit": "true"
- },
- "query_servers": {
- "javascript": "/usr/bin/couchjs /usr/share/couchdb/server/main.js"
- },
- "replicator": {
- "max_http_pipeline_size": "10",
- "max_http_sessions": "10"
- },
- "stats": {
- "rate": "1000",
- "samples": "[0, 60, 300, 900]"
- },
- "uuids": {
- "algorithm": "utc_random"
- }
- }
-
+ :synopsis: Obtains a list of the entire server configuration
+
+ Returns the entire CouchDB server configuration as a JSON structure. The
+ structure is organized by different configuration sections, with
+ individual values.
+
+ :<header Accept: - :mimetype:`application/json`
+ - :mimetype:`text/plain`
+ :>header Content-Type: - :mimetype:`application/json`
+ - :mimetype:`text/plain; charset=utf-8`
+ :code 200: Request completed successfully
+ :code 401: CouchDB Server Administrator privileges required
+
+ **Request**
+
+ .. code-block:: http
+
+ GET /_config HTTP/1.1
+ Accept: application/json
+ Host: localhost:5984
+
+ **Response**:
+
+ .. code-block:: http
+
+ HTTP/1.1 200 OK
+ Cache-Control: must-revalidate
+ Content-Length: 4148
+ Content-Type: application/json
+ Date: Sat, 10 Aug 2013 12:01:42 GMT
+ Server: CouchDB (Erlang/OTP)
+
+ {
+ "attachments": {
+ "compressible_types": "text/*, application/javascript, application/json, application/xml",
+ "compression_level": "8"
+ },
+ "couch_httpd_auth": {
+ "auth_cache_size": "50",
+ "authentication_db": "_users",
+ "authentication_redirect": "/_utils/session.html",
+ "require_valid_user": "false",
+ "timeout": "600"
+ },
+ "couchdb": {
+ "database_dir": "/var/lib/couchdb",
+ "delayed_commits": "true",
+ "max_attachment_chunk_size": "4294967296",
+ "max_dbs_open": "100",
+ "max_document_size": "4294967296",
+ "os_process_timeout": "5000",
+ "uri_file": "/var/lib/couchdb/couch.uri",
+ "util_driver_dir": "/usr/lib64/couchdb/erlang/lib/couch-1.5.0/priv/lib",
+ "view_index_dir": "/var/lib/couchdb"
+ },
+ "daemons": {
+ "auth_cache": "{couch_auth_cache, start_link, []}",
+ "db_update_notifier": "{couch_db_update_notifier_sup, start_link, []}",
+ "external_manager": "{couch_external_manager, start_link, []}",
+ "httpd": "{couch_httpd, start_link, []}",
+ "query_servers": "{couch_query_servers, start_link, []}",
+ "stats_aggregator": "{couch_stats_aggregator, start, []}",
+ "stats_collector": "{couch_stats_collector, start, []}",
+ "uuids": "{couch_uuids, start, []}",
+ "view_manager": "{couch_view, start_link, []}"
+ },
+ "httpd": {
+ "allow_jsonp": "false",
+ "authentication_handlers": "{couch_httpd_oauth, oauth_authentication_handler}, {couch_httpd_auth, cookie_authentication_handler}, {couch_httpd_auth, default_authentication_handler}",
+ "bind_address": "192.168.0.2",
+ "default_handler": "{couch_httpd_db, handle_request}",
+ "max_connections": "2048",
+ "port": "5984",
+ "secure_rewrites": "true",
+ "vhost_global_handlers": "_utils, _uuids, _session, _oauth, _users"
+ },
+ "httpd_db_handlers": {
+ "_changes": "{couch_httpd_db, handle_changes_req}",
+ "_compact": "{couch_httpd_db, handle_compact_req}",
+ "_design": "{couch_httpd_db, handle_design_req}",
+ "_temp_view": "{couch_httpd_view, handle_temp_view_req}",
+ "_view_cleanup": "{couch_httpd_db, handle_view_cleanup_req}"
+ },
+ "httpd_design_handlers": {
+ "_info": "{couch_httpd_db, handle_design_info_req}",
+ "_list": "{couch_httpd_show, handle_view_list_req}",
+ "_rewrite": "{couch_httpd_rewrite, handle_rewrite_req}",
+ "_show": "{couch_httpd_show, handle_doc_show_req}",
+ "_update": "{couch_httpd_show, handle_doc_update_req}",
+ "_view": "{couch_httpd_view, handle_view_req}"
+ },
+ "httpd_global_handlers": {
+ "/": "{couch_httpd_misc_handlers, handle_welcome_req, <<\"Welcome\">>}",
+ "_active_tasks": "{couch_httpd_misc_handlers, handle_task_status_req}",
+ "_all_dbs": "{couch_httpd_misc_handlers, handle_all_dbs_req}",
+ "_config": "{couch_httpd_misc_handlers, handle_config_req}",
+ "_log": "{couch_httpd_misc_handlers, handle_log_req}",
+ "_oauth": "{couch_httpd_oauth, handle_oauth_req}",
+ "_replicate": "{couch_httpd_misc_handlers, handle_replicate_req}",
+ "_restart": "{couch_httpd_misc_handlers, handle_restart_req}",
+ "_session": "{couch_httpd_auth, handle_session_req}",
+ "_stats": "{couch_httpd_stats_handlers, handle_stats_req}",
+ "_utils": "{couch_httpd_misc_handlers, handle_utils_dir_req, \"/usr/share/couchdb/www\"}",
+ "_uuids": "{couch_httpd_misc_handlers, handle_uuids_req}",
+ "favicon.ico": "{couch_httpd_misc_handlers, handle_favicon_req, \"/usr/share/couchdb/www\"}"
+ },
+ "log": {
+ "file": "/var/log/couchdb/couch.log",
+ "include_sasl": "true",
+ "level": "info"
+ },
+ "query_server_config": {
+ "reduce_limit": "true"
+ },
+ "query_servers": {
+ "javascript": "/usr/bin/couchjs /usr/share/couchdb/server/main.js"
+ },
+ "replicator": {
+ "max_http_pipeline_size": "10",
+ "max_http_sessions": "10"
+ },
+ "stats": {
+ "rate": "1000",
+ "samples": "[0, 60, 300, 900]"
+ },
+ "uuids": {
+ "algorithm": "utc_random"
+ }
+ }
.. _api/config/section:
@@ -160,49 +159,48 @@ the various configuration values within a running CouchDB instance.
====================
.. http:get:: /_config/{section}
- :synopsis: Returns all the configuration values for the specified section
-
- Gets the configuration structure for a single section.
+ :synopsis: Returns all the configuration values for the specified section
- :param section: Configuration section name
- :<header Accept: - :mimetype:`application/json`
- - :mimetype:`text/plain`
- :>header Content-Type: - :mimetype:`application/json`
- - :mimetype:`text/plain; charset=utf-8`
- :code 200: Request completed successfully
- :code 401: CouchDB Server Administrator privileges required
+ Gets the configuration structure for a single section.
- **Request**:
+ :param section: Configuration section name
+ :<header Accept: - :mimetype:`application/json`
+ - :mimetype:`text/plain`
+ :>header Content-Type: - :mimetype:`application/json`
+ - :mimetype:`text/plain; charset=utf-8`
+ :code 200: Request completed successfully
+ :code 401: CouchDB Server Administrator privileges required
- .. code-block:: http
+ **Request**:
- GET /_config/httpd HTTP/1.1
- Accept: application/json
- Host: localhost:5984
+ .. code-block:: http
- **Response**:
+ GET /_config/httpd HTTP/1.1
+ Accept: application/json
+ Host: localhost:5984
- .. code-block:: http
+ **Response**:
- HTTP/1.1 200 OK
- Cache-Control: must-revalidate
- Content-Length: 444
- Content-Type: application/json
- Date: Sat, 10 Aug 2013 12:10:40 GMT
- Server: CouchDB (Erlang/OTP)
+ .. code-block:: http
- {
- "allow_jsonp": "false",
- "authentication_handlers": "{couch_httpd_oauth, oauth_authentication_handler}, {couch_httpd_auth, cookie_authentication_handler}, {couch_httpd_auth, default_authentication_handler}",
- "bind_address": "127.0.0.1",
- "default_handler": "{couch_httpd_db, handle_request}",
- "enable_cors": "false",
- "log_max_chunk_size": "1000000",
- "port": "5984",
- "secure_rewrites": "true",
- "vhost_global_handlers": "_utils, _uuids, _session, _oauth, _users"
- }
+ HTTP/1.1 200 OK
+ Cache-Control: must-revalidate
+ Content-Length: 444
+ Content-Type: application/json
+ Date: Sat, 10 Aug 2013 12:10:40 GMT
+ Server: CouchDB (Erlang/OTP)
+ {
+ "allow_jsonp": "false",
+ "authentication_handlers": "{couch_httpd_oauth, oauth_authentication_handler}, {couch_httpd_auth, cookie_authentication_handler}, {couch_httpd_auth, default_authentication_handler}",
+ "bind_address": "127.0.0.1",
+ "default_handler": "{couch_httpd_db, handle_request}",
+ "enable_cors": "false",
+ "log_max_chunk_size": "1000000",
+ "port": "5984",
+ "secure_rewrites": "true",
+ "vhost_global_handlers": "_utils, _uuids, _session, _oauth, _users"
+ }
.. _api/config/section/key:
@@ -210,127 +208,124 @@ the various configuration values within a running CouchDB instance.
========================
.. http:get:: /_config/{section}/{key}
- :synopsis: Returns a specific section/configuration value
-
- Gets a single configuration value from within a specific configuration
- section.
+ :synopsis: Returns a specific section/configuration value
- :param section: Configuration section name
- :param key: Configuration option name
- :<header Accept: - :mimetype:`application/json`
- - :mimetype:`text/plain`
- :>header Content-Type: - :mimetype:`application/json`
- - :mimetype:`text/plain; charset=utf-8`
- :code 200: Request completed successfully
- :code 401: CouchDB Server Administrator privileges required
+ Gets a single configuration value from within a specific configuration
+ section.
- **Request**:
+ :param section: Configuration section name
+ :param key: Configuration option name
+ :<header Accept: - :mimetype:`application/json`
+ - :mimetype:`text/plain`
+ :>header Content-Type: - :mimetype:`application/json`
+ - :mimetype:`text/plain; charset=utf-8`
+ :code 200: Request completed successfully
+ :code 401: CouchDB Server Administrator privileges required
- .. code-block:: http
+ **Request**:
- GET /_config/log/level HTTP/1.1
- Accept: application/json
- Host: localhost:5984
+ .. code-block:: http
- **Response**:
+ GET /_config/log/level HTTP/1.1
+ Accept: application/json
+ Host: localhost:5984
- .. code-block:: http
+ **Response**:
- HTTP/1.1 200 OK
- Cache-Control: must-revalidate
- Content-Length: 8
- Content-Type: application/json
- Date: Sat, 10 Aug 2013 12:12:59 GMT
- Server: CouchDB (Erlang/OTP)
+ .. code-block:: http
- "debug"
+ HTTP/1.1 200 OK
+ Cache-Control: must-revalidate
+ Content-Length: 8
+ Content-Type: application/json
+ Date: Sat, 10 Aug 2013 12:12:59 GMT
+ Server: CouchDB (Erlang/OTP)
+ "debug"
- .. note::
- The returned value will be the JSON of the value, which may be a
- string or numeric value, or an array or object. Some client
- environments may not parse simple strings or numeric values as valid JSON.
-
+ .. note::
+ The returned value will be the JSON of the value, which may be a string
+ or numeric value, or an array or object. Some client environments may
+ not parse simple strings or numeric values as valid JSON.
.. http:put:: /_config/{section}/{key}
- :synopsis: Sets the specified configuration value
-
- Updates a configuration value. The new value should be supplied in the
- request body in the corresponding JSON format. If you are setting a string
- value, you must supply a valid JSON string. In response CouchDB sends old
- value for target section key.
+ :synopsis: Sets the specified configuration value
- :param section: Configuration section name
- :param key: Configuration option name
- :<header Accept: - :mimetype:`application/json`
- - :mimetype:`text/plain`
- :<header Content-Type: :mimetype:`application/json`
- :>header Content-Type: - :mimetype:`application/json`
- - :mimetype:`text/plain; charset=utf-8`
- :code 200: Request completed successfully
- :code 400: Invalid JSON request body
- :code 401: CouchDB Server Administrator privileges required
- :code 500: Error setting configuration
+ Updates a configuration value. The new value should be supplied in the
+ request body in the corresponding JSON format. If you are setting a string
+ value, you must supply a valid JSON string. In response CouchDB sends old
+ value for target section key.
- **Request**:
+ :param section: Configuration section name
+ :param key: Configuration option name
+ :<header Accept: - :mimetype:`application/json`
+ - :mimetype:`text/plain`
+ :<header Content-Type: :mimetype:`application/json`
+ :>header Content-Type: - :mimetype:`application/json`
+ - :mimetype:`text/plain; charset=utf-8`
+ :code 200: Request completed successfully
+ :code 400: Invalid JSON request body
+ :code 401: CouchDB Server Administrator privileges required
+ :code 500: Error setting configuration
- .. code-block:: http
+ **Request**:
- PUT /_config/log/level HTTP/1.1
- Accept: application/json
- Content-Length: 7
- Content-Type: application/json
- Host: localhost:5984
+ .. code-block:: http
- "info"
+ PUT /_config/log/level HTTP/1.1
+ Accept: application/json
+ Content-Length: 7
+ Content-Type: application/json
+ Host: localhost:5984
- **Response**:
+ "info"
- .. code-block:: http
+ **Response**:
- HTTP/1.1 200 OK
- Cache-Control: must-revalidate
- Content-Length: 8
- Content-Type: application/json
- Date: Sat, 10 Aug 2013 12:12:59 GMT
- Server: CouchDB (Erlang/OTP)
+ .. code-block:: http
- "debug"
+ HTTP/1.1 200 OK
+ Cache-Control: must-revalidate
+ Content-Length: 8
+ Content-Type: application/json
+ Date: Sat, 10 Aug 2013 12:12:59 GMT
+ Server: CouchDB (Erlang/OTP)
+ "debug"
.. http:delete:: /_config/{section}/{key}
- :synopsis: Removes the current setting
+ :synopsis: Removes the current setting
- Deletes a configuration value. The returned JSON will be the value of
- the configuration parameter before it was deleted.
+ Deletes a configuration value. The returned JSON will be the value of the
+ configuration parameter before it was deleted.
- :param section: Configuration section name
- :param key: Configuration option name
- :<header Accept: - :mimetype:`application/json`
- - :mimetype:`text/plain`
- :>header Content-Type: - :mimetype:`application/json`
- - :mimetype:`text/plain; charset=utf-8`
- :code 200: Request completed successfully
- :code 401: CouchDB Server Administrator privileges required
- :code 404: Specified configuration option not found
+ :param section: Configuration section name
+ :param key: Configuration option name
+ :<header Accept: - :mimetype:`application/json`
+ - :mimetype:`text/plain`
+ :>header Content-Type: - :mimetype:`application/json`
+ - :mimetype:`text/plain; charset=utf-8`
+ :code 200: Request completed successfully
+ :code 401: CouchDB Server Administrator privileges required
+ :code 404: Specified configuration option not found
- **Request**:
+ **Request**:
- .. code-block:: http
+ .. code-block:: http
- DELETE /_config/log/level HTTP/1.1
- Accept: application/json
- Host: localhost:5984
+ DELETE /_config/log/level HTTP/1.1
+ Accept: application/json
+ Host: localhost:5984
- **Response**:
+ **Response**:
- .. code-block:: http
+ .. code-block:: http
- HTTP/1.1 200 OK
- Cache-Control: must-revalidate
- Content-Length: 7
- Content-Type: application/json
- Date: Sat, 10 Aug 2013 12:29:03 GMT
- Server: CouchDB (Erlang/OTP)
+ HTTP/1.1 200 OK
+ Cache-Control: must-revalidate
+ Content-Length: 7
+ Content-Type: application/json
+ Date: Sat, 10 Aug 2013 12:29:03 GMT
+ Server: CouchDB (Erlang/OTP)
- "info"
+ "info"
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/25273e7a/src/api/server/index.rst
----------------------------------------------------------------------
diff --git a/src/api/server/index.rst b/src/api/server/index.rst
index c2e8d9a..f3098e8 100644
--- a/src/api/server/index.rst
+++ b/src/api/server/index.rst
@@ -10,7 +10,6 @@
.. License for the specific language governing permissions and limitations under
.. the License.
-
.. _api/server:
======
@@ -22,7 +21,6 @@ CouchDB server for obtaining CouchDB information and getting and setting
configuration information.
.. toctree::
-
- common
- authn
- configuration
+ common
+ authn
+ configuration