alihan/fn-serverless
1
0
Fork 0
mirror of https://github.com/fnproject/fn.git synced 2022-10-28 21:29:17 +03:00
Code Issues Packages Projects Releases Wiki Activity

More doc fixes.

Browse Source
This commit is contained in:
Travis Reeder
2017-03-21 16:45:53 -07:00
parent cfccf33c5d
commit a0c40ee184
1 changed files with 13 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
docs/operating/options.md
View File

@@ -5,62 +5,21 @@
When starting IronFunctions, you can pass in the following configuration variables as environment variables. Use `-e VAR_NAME=VALUE` in When starting IronFunctions, you can pass in the following configuration variables as environment variables. Use `-e VAR_NAME=VALUE` in
docker run. For example: docker run. For example:
``` ```sh
docker run -e VAR_NAME=VALUE ... docker run -e VAR_NAME=VALUE ...
``` ```
<table> | Env Variables | Description | Default values |
<tr> | --------------|-------------|----------------|
<th>Env Variables</th> | DB_URL | The database URL to use in URL format. See [Databases](databases/README.md) for more information. | bolt:///app/data/bolt.db |
<th>Description</th> | 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 |
<th>Default values</th> | 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 |
</tr> | PORT | Sets the port to run on | 8080 |
<tr> | LOG_LEVEL | Set to DEBUG to enable debugging | INFO |
<td>DB_URL</td> | DOCKER_HOST | Docker remote API URL | /var/run/docker.sock:/var/run/docker.sock |
<td>The database URL to use in URL format. See [Databases](operating/databases/README.md) for more information.</td> | DOCKER_API_VERSION | Docker remote API version | 1.24 |
<td>$(pwd)/bolt.db</td> | DOCKER_TLS_VERIFY | Set this option to enable/disable Docker remote API over TLS/SSL. | 0 |
</tr> | DOCKER_CERT_PATH | Set this option to specify where CA cert placeholder | ~/.docker/cert.pem |
<tr>
<td>MQ_URL</td>
<td>The message queue to use in URL format. See [Message Queues](mqs/README.md) for more information.</td>
<td>$(pwd)/queue.db</td>
</tr>
<tr>
<td>API_URL</td>
<td>The primary IronFunctions API URL to that this instance will talk to. In a production environment, this would be your load balancer URL.</td>
<td>N/A</td>
</tr>
<tr>
<td>PORT</td>
<td>Sets the port to run on</td>
<td>8080</td>
</tr>
<tr>
<td>LOG_LEVEL</td>
<td>Set to DEBUG to enable debugging</td>
<td>INFO</td>
</tr>
<tr>
<td>DOCKER_HOST</td>
<td>Docker remote API URL</td>
<td>/var/run/docker.sock:/var/run/docker.sock</td>
</tr>
<tr>
<td>DOCKER_API_VERSION</td>
<td>Docker remote API version</td>
<td>1.24</td>
</tr>
<tr>
<td>DOCKER_TLS_VERIFY</td>
<td>Set this option to enable/disable Docker remote API over TLS/SSL. Default: 0</td>
<td>0</td>
</tr>
<tr>
<td>DOCKER_CERT_PATH</td>
<td>Set this option to specify where CA cert placeholder</td>
<td>~/.docker/cert.pem</td>
</tr>
</table>
## Starting without Docker in Docker ## 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. 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 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 ### Mount the Host Docker