From a0c40ee18454804a90100d02689654ea07368352 Mon Sep 17 00:00:00 2001 From: Travis Reeder Date: Tue, 21 Mar 2017 16:45:53 -0700 Subject: [PATCH] More doc fixes. --- docs/operating/options.md | 67 ++++++++------------------------------- 1 file changed, 13 insertions(+), 54 deletions(-) diff --git a/docs/operating/options.md b/docs/operating/options.md index cff480caa..a9e7f672e 100644 --- a/docs/operating/options.md +++ b/docs/operating/options.md @@ -5,62 +5,21 @@ When starting IronFunctions, you can pass in the following configuration variables as environment variables. Use `-e VAR_NAME=VALUE` in docker run. For example: -``` +```sh docker run -e VAR_NAME=VALUE ... ``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Env VariablesDescriptionDefault values
DB_URLThe database URL to use in URL format. See [Databases](operating/databases/README.md) for more information.$(pwd)/bolt.db
MQ_URLThe message queue to use in URL format. See [Message Queues](mqs/README.md) for more information.$(pwd)/queue.db
API_URLThe primary IronFunctions API URL to that this instance will talk to. In a production environment, this would be your load balancer URL.N/A
PORTSets the port to run on8080
LOG_LEVELSet to DEBUG to enable debuggingINFO
DOCKER_HOSTDocker remote API URL/var/run/docker.sock:/var/run/docker.sock
DOCKER_API_VERSIONDocker remote API version1.24
DOCKER_TLS_VERIFYSet this option to enable/disable Docker remote API over TLS/SSL. Default: 00
DOCKER_CERT_PATHSet this option to specify where CA cert placeholder~/.docker/cert.pem
+| Env Variables | Description | Default values | +| --------------|-------------|----------------| +| DB_URL | The database URL to use in URL format. See [Databases](databases/README.md) for more information. | bolt:///app/data/bolt.db | +| MQ_URL | The message queue to use in URL format. See [Message Queues](mqs/README.md) for more information. | bolt:///app/data/worker_mq.db | +| API_URL | The primary IronFunctions API URL to that this instance will talk to. In a production environment, this would be your load balancer URL. | N/A | +| PORT | Sets the port to run on | 8080 | +| LOG_LEVEL | Set to DEBUG to enable debugging | INFO | +| DOCKER_HOST | Docker remote API URL | /var/run/docker.sock:/var/run/docker.sock | +| DOCKER_API_VERSION | Docker remote API version | 1.24 | +| DOCKER_TLS_VERIFY | Set this option to enable/disable Docker remote API over TLS/SSL. | 0 | +| DOCKER_CERT_PATH | Set this option to specify where CA cert placeholder | ~/.docker/cert.pem | ## Starting without Docker in Docker @@ -72,7 +31,7 @@ a couple reasons why we did it this way: the docker run command to set the max memory for the IronFunctions instance AND all of the functions it's running. There are some reasons you may not want to use dind, such as using the image cache during testing or you're running -[Windows](operating/windows.md). +[Windows](windows.md). ### Mount the Host Docker