From b04b14033016177de5874275db481168d5ddfb4e Mon Sep 17 00:00:00 2001 From: Robin Klingsberg Date: Sat, 2 Mar 2019 10:41:19 -0500 Subject: [PATCH] Add configuration docs --- docs/configuration.rst | 16 ++++++++++++++++ docs/history.rst | 4 ++++ docs/index.rst | 1 + 3 files changed, 21 insertions(+) create mode 100644 docs/configuration.rst diff --git a/docs/configuration.rst b/docs/configuration.rst new file mode 100644 index 0000000..214524b --- /dev/null +++ b/docs/configuration.rst @@ -0,0 +1,16 @@ +Configuration +============= + +sprockets.mixins.metrics has the ability to be configured via environment variables. + +The following environment variables are recognized: + ++-----------------+---------------------------------------+----------+---------------+ +| Name | Description | Required | Default Value | ++-----------------+---------------------------------------+----------+---------------+ +| STATSD_HOST | The StatsD host to connect to | No | 127.0.0.1 | ++-----------------+---------------------------------------+----------+---------------+ +| STATSD_PORT | The port on which StatsD is listening | No | 8125 | ++-----------------+---------------------------------------+----------+---------------+ +| STATSD_PROTOCOL | The transport-layer protocol to use | No | 8125 | ++-----------------+---------------------------------------+----------+---------------+ diff --git a/docs/history.rst b/docs/history.rst index 7b70680..665c54a 100644 --- a/docs/history.rst +++ b/docs/history.rst @@ -3,6 +3,10 @@ Release History =============== +`Next Release`_ +--------------- +- Add configuration documentation + `4.0.0`_ (06-Feb-2019) ---------------------- - Add support for Tornado 5 diff --git a/docs/index.rst b/docs/index.rst index 67b2f9f..8c2dfc9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,6 +8,7 @@ License :hidden: api + configuration examples contributing history