import quincy beta 17.1.0

[ceph.git] / ceph / doc / radosgw / frontends.rst

diff --git a/ceph/doc/radosgw/frontends.rst b/ceph/doc/radosgw/frontends.rst
index e4a013590851c06fbe815352bd7e551c42d94791..5c6900f54489df1a3f3db8f368f9101eba0c61d9 100644 (file)
--- a/ceph/doc/radosgw/frontends.rst
+++ b/ceph/doc/radosgw/frontends.rst
@@ -64,6 +64,38 @@ Options
 :Type: String
 :Default: None
 
+``ssl_options``
+
+:Description: Optional colon separated list of ssl context options:
+
+              ``default_workarounds`` Implement various bug workarounds.
+
+              ``no_compression`` Disable compression.
+
+              ``no_sslv2`` Disable SSL v2.
+
+              ``no_sslv3`` Disable SSL v3.
+
+              ``no_tlsv1`` Disable TLS v1.
+
+              ``no_tlsv1_1`` Disable TLS v1.1.
+
+              ``no_tlsv1_2`` Disable TLS v1.2.
+
+              ``single_dh_use`` Always create a new key when using tmp_dh parameters.
+
+:Type: String
+:Default: ``no_sslv2:no_sslv3:no_tlsv1:no_tlsv1_1``
+
+``ssl_ciphers``
+
+:Description: Optional list of one or more cipher strings separated by colons.
+              The format of the string is described in openssl's ciphers(1)
+              manual.
+
+:Type: String
+:Default: None
+
 ``tcp_nodelay``
 
 :Description: If set the socket option will disable Nagle's algorithm on 
@@ -95,83 +127,13 @@ Options
 :Type: Integer
 :Default: ``65000``
 
+``max_header_size``
 
-Civetweb
-========
-
-.. versionadded:: Firefly
-
-The ``civetweb`` frontend uses the Civetweb HTTP library, which is a
-fork of Mongoose.
-
-
-Options
--------
-
-``port``
-
-:Description: Sets the listening port number. For SSL-enabled ports, add an
-              ``s`` suffix like ``443s``. To bind a specific IPv4 or IPv6
-              address, use the form ``address:port``. Multiple endpoints
-              can either be separated by ``+`` as in ``127.0.0.1:8000+443s``,
-              or by providing multiple options as in ``port=8000 port=443s``.
-
-:Type: String
-:Default: ``7480``
-
-
-``num_threads``
-
-:Description: Sets the number of threads spawned by Civetweb to handle
-              incoming HTTP connections. This effectively limits the number
-              of concurrent connections that the frontend can service.
-
-:Type: Integer
-:Default: ``rgw_thread_pool_size``
-
-
-``request_timeout_ms``
-
-:Description: The amount of time in milliseconds that Civetweb will wait
-              for more incoming data before giving up.
+:Description: The maximum number of header bytes available for a single request.
 
 :Type: Integer
-:Default: ``30000``
-
-
-``ssl_certificate``
-
-:Description: Path to the SSL certificate file used for SSL-enabled ports.
-
-:Type: String
-:Default: None
-
-``access_log_file``
-
-:Description: Path to a file for access logs. Either full path, or relative
-                         to the current working directory. If absent (default), then
-                         accesses are not logged.
-
-:Type: String
-:Default: ``EMPTY``
-
-
-``error_log_file``
-
-:Description: Path to a file for error logs. Either full path, or relative
-                         to the current working directory. If absent (default), then
-                         errors are not logged.
-
-:Type: String
-:Default: ``EMPTY``
-
-
-The following is an example of the ``/etc/ceph/ceph.conf`` file with some of these options set: ::
- 
- [client.rgw.gateway-node1]
- rgw_frontends = civetweb request_timeout_ms=30000 error_log_file=/var/log/radosgw/civetweb.error.log access_log_file=/var/log/radosgw/civetweb.access.log
-
-A complete list of supported options can be found in the `Civetweb User Manual`_.
+:Default: ``16384``
+:Maximum: ``65536``
 
 
 Generic Options
@@ -189,5 +151,4 @@ Some frontend options are generic and supported by all frontends:
 :Default: None
 
 
-.. _Civetweb User Manual: https://civetweb.github.io/civetweb/UserManual.html
 .. _Config Reference: ../config-ref