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. Can be specified multiple
  24               times as in ``port=80 port=8000``.
  25
  26 :Type: Integer
  27 :Default: ``80``
  28
  29
  30 ``endpoint``
  31
  32 :Description: Sets the listening address in the form ``address[:port]``,
  33               where the address is an IPv4 address string in dotted decimal
  34               form, or an IPv6 address in hexadecimal notation. The
  35               optional port defaults to 80. Can be specified multiple times
  36               as in ``endpoint=::1 endpoint=192.168.0.100:8000``.
  37
  38 :Type: Integer
  39 :Default: None
  40
  41
  42 Civetweb
  43 ========
  44
  45 .. versionadded:: Firefly
  46
  47 The ``civetweb`` frontend uses the Civetweb HTTP library, which is a
  48 fork of Mongoose.
  49
  50
  51 Options
  52 -------
  53
  54 ``port``
  55
  56 :Description: Sets the listening port number. For SSL-enabled ports, add an
  57               ``s`` suffix like ``443s``. To bind a specific IPv4 or IPv6
  58               address, use the form ``address:port``. Multiple endpoints
  59               can either be separated by ``+`` as in ``127.0.0.1:8000+443s``,
  60               or by providing multiple options as in ``port=8000 port=443s``.
  61
  62 :Type: String
  63 :Default: ``7480``
  64
  65
  66 ``num_threads``
  67
  68 :Description: Sets the number of threads spawned by Civetweb to handle
  69               incoming HTTP connections. This effectively limits the number
  70               of concurrent connections that the frontend can service.
  71
  72 :Type: Integer
  73 :Default: ``rgw_thread_pool_size``
  74
  75
  76 ``request_timeout_ms``
  77
  78 :Description: The amount of time in milliseconds that Civetweb will wait
  79               for more incoming data before giving up.
  80
  81 :Type: Integer
  82 :Default: ``30000``
  83
  84
  85 ``ssl_certificate``
  86
  87 :Description: Path to the SSL certificate file used for SSL-enabled ports.
  88
  89 :Type: String
  90 :Default: None
  91
  92
  93 A complete list of supported options can be found in the `Civetweb User Manual`_.
  94
  95
  96 Generic Options
  97 ===============
  98
  99 Some frontend options are generic and supported by all frontends:
 100
 101 ``prefix``
 102
 103 :Description: A prefix string that is inserted into the URI of all
 104               requests. For example, a swift-only frontend could supply
 105               a uri prefix of ``/swift``.
 106
 107 :Type: String
 108 :Default: None
 109
 110
 111 .. _Civetweb User Manual: https://civetweb.github.io/civetweb/UserManual.html