From 53eec3bc40c99a7995a6e8ac910fe7d9f3ba7331 Mon Sep 17 00:00:00 2001 From: Sebastian Serth Date: Wed, 7 Jul 2021 20:04:33 +0200 Subject: [PATCH] Add overview of environment variables --- docs/environment_variables.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 docs/environment_variables.md diff --git a/docs/environment_variables.md b/docs/environment_variables.md new file mode 100644 index 00000000..3a1166fe --- /dev/null +++ b/docs/environment_variables.md @@ -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`
`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) |