Restructure API docs so that they can be formatted with Docbox. (#3355)

Generate Docbox browseable HTML with `npm run build-api-docs`
2016-11-30 19:38:53 -08:00
parent 2544c3f20e
commit 560d8ffec0
13 changed files with 519 additions and 304 deletions
@@ -0,0 +1,14 @@
+## Environment Variables
+
+### SIGNAL_PARENT_WHEN_READY
+
+If the SIGNAL_PARENT_WHEN_READY environment variable is set osrm-routed will
+send the USR1 signal to its parent when it will be running and waiting for
+requests. This could be used to upgrade osrm-routed to a new binary on the fly
+without any service downtime - no incoming requests will be lost.
+
+### DISABLE_ACCESS_LOGGING
+
+If the DISABLE_ACCESS_LOGGING environment variable is set osrm-routed will
+**not** log any http requests to standard output. This can be useful in high
+traffic setup.