ceph/doc/radosgw/frontends.rst

   1 ==============
   2 HTTP Frontends
   3 ==============
   4
   5 .. contents::
   6
   7 The Ceph Object Gateway supports two embedded HTTP frontend libraries
   8 that can be configured with ``rgw_frontends``.
   9
  10 Beast
  11 =====
  12
  13 .. versionadded:: Luminous
  14
  15 The ``beast`` frontend uses the Boost.Beast library for HTTP parsing
  16 and the Boost.Asio library for asynchronous network i/o.
  17
  18 Options
  19 -------
  20
  21 ``port``
  22
  23 :Description: Sets the listening port number.
  24
  25 :Type: Integer
  26 :Default: ``80``
  27
  28
  29 Civetweb
  30 ========
  31
  32 .. versionadded:: Firefly
  33
  34 The ``civetweb`` frontend uses the Civetweb HTTP library, which is a
  35 fork of Mongoose.
  36
  37
  38 Options
  39 -------
  40
  41 ``port``
  42
  43 :Description: Sets the listening port number. For SSL-enabled ports, add an
  44               ``s`` suffix like ``443s``. To bind a specific IPv4 or IPv6
  45               address, use the form ``address:port``. Multiple endpoints
  46               can be separated by ``+`` as in ``127.0.0.1:8000+443s``.
  47
  48 :Type: String
  49 :Default: ``7480``
  50
  51
  52 ``num_threads``
  53
  54 :Description: Sets the number of threads spawned by Civetweb to handle
  55               incoming HTTP connections. This effectively limits the number
  56               of concurrent connections that the frontend can service.
  57
  58 :Type: Integer
  59 :Default: ``rgw_thread_pool_size``
  60
  61
  62 ``request_timeout_ms``
  63
  64 :Description: The amount of time in milliseconds that Civetweb will wait
  65               for more incoming data before giving up.
  66
  67 :Type: Integer
  68 :Default: ``30000``
  69
  70
  71 ``ssl_certificate``
  72
  73 :Description: Path to the SSL certificate file used for SSL-enabled ports.
  74
  75 :Type: String
  76 :Default: None
  77
  78
  79 A complete list of supported options can be found in the `Civetweb User Manual`_.
  80
  81
  82 Generic Options
  83 ===============
  84
  85 Some frontend options are generic and supported by all frontends:
  86
  87 ``prefix``
  88
  89 :Description: A prefix string that is inserted into the URI of all
  90               requests. For example, a swift-only frontend could supply
  91               a uri prefix of ``/swift``.
  92
  93 :Type: String
  94 :Default: None
  95
  96
  97 .. _Civetweb User Manual: https://civetweb.github.io/civetweb/UserManual.html