Skip to content

Commit

Permalink
Add documentation about the TELEMETRY key.
Browse files Browse the repository at this point in the history
  • Loading branch information
Rémy HUBSCHER committed Sep 25, 2017
1 parent e3026e3 commit 0fd58b8
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,15 @@ database services to configure.

However you can configure the following parameters using environment variables:

+-------------------+--------------------------------------------------+
| **VARIABLE** | **Description** |
+-------------------+--------------------------------------------------+
| ``PORT`` | The service PORT, by default runs on 9876 |
+-------------------+--------------------------------------------------+
| ``VERSION_FILE`` | The JSON version file, default PWD/version.json |
+-------------------+--------------------------------------------------+
| ``CACHE_MAX_AGE`` | The Cache-Control max-age value, default to 30 |
| | seconds. Set it to 0 to set it to no-cache |
+-------------------+--------------------------------------------------+
+-----------------------+---------------------------------------------------+
| **VARIABLE** | **Description** |
+-----------------------+---------------------------------------------------+
| ``PORT`` | The service PORT, by default runs on 9876 |
+-----------------------+---------------------------------------------------+
| ``VERSION_FILE`` | The JSON version file, default PWD/version.json |
+-----------------------+---------------------------------------------------+
| ``CACHE_MAX_AGE`` | The Cache-Control max-age value, default to 30 |
| | seconds. Set it to 0 to set it to no-cache |
+-----------------------+---------------------------------------------------+
| ``TELEMETRY_API_KEY`` | API KEY to be able to query the Telemetry Service |
+-----------------------+---------------------------------------------------+

0 comments on commit 0fd58b8

Please sign in to comment.