htwkmooc/codeocean
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add overview of environment variables

Browse Source
This commit is contained in:
Sebastian Serth
2021-07-07 20:04:33 +02:00
parent 9696fcb06f
commit 53eec3bc40
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/environment_variables.md Normal file
View File

@ -0,0 +1,15 @@
# Environment Variables
The following environment variables are specifically support in CodeOcean and are used to configure the application in addition to the setting files under `config/`.
| Environment Variable | Default | Description |
|- |- |- |
| `RAILS_ENV` | `development` | Specifies the Rails environment which can be configured using the files in `config/environments` |
| `RAILS_RELATIVE_URL_ROOT` | `/` | Specifies the subpath of the application, used for links and assets |
| `SENTRY_DSN` | `` | Specifies the Sentry error reporting endpoint for the Rails server |
| `RAILS_LOG_TO_STDOUT` | `false` in `production` | Enables the server to print log output to the command line |
| `RAILS_SERVE_STATIC_FILES` | `true` in `development` and `test`<br>`false` in `production` and `staging` | Specifies whether the Rails server should be able to handle requests for non-dynamic resources (e.g., assets) |
| `BACKTRACE` | `false` | Enables more verbose log output from framework code during debugging |
| `TRUSTED_IP` | ` ` in `development` | Enables `BetterErrors` for the given IP addresses during development |
| `LISTEN_ADDRESS` | `127.0.0.1` in `development` | Specifies the IP address the server should attach to during development |
| `HEADLESS_TEST` | `false` | Enables the test environment to work without a window manager for feature tests (e.g., using Vagrant) |