https://markbeep.github.io/AudioBookRequest/docs/concepts/ Recent content in Concepts on AudioBookRequest Docs Hugo en https://markbeep.github.io/AudioBookRequest/docs/concepts/environment-variables/ Mon, 09 Jun 2025 13:46:33 +0200 https://markbeep.github.io/AudioBookRequest/docs/concepts/environment-variables/ <table> <thead> <tr> <th>ENV</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>ABR_APP__PORT</code></td> <td>The port to run the server on.</td> <td>8000</td> </tr> <tr> <td><code>ABR_APP__DEBUG</code></td> <td>If to enable debug mode. Not recommended for production.</td> <td>false</td> </tr> <tr> <td><code>ABR_APP__OPENAPI_ENABLED</code></td> <td>If set to <code>true</code>, enables an OpenAPI specs page on <code>/docs</code>.</td> <td>false</td> </tr> <tr> <td><code>ABR_APP__CONFIG_DIR</code></td> <td>The directory path where persistant data and configuration is stored. If ran using Docker or Kubernetes, this is the location a volume should be mounted to.</td> <td>/config</td> </tr> <tr> <td><code>ABR_APP__LOG_LEVEL</code></td> <td>One of <code>DEBUG</code>, <code>INFO</code>, <code>WARN</code>, <code>ERROR</code>.</td> <td>INFO</td> </tr> <tr> <td><code>ABR_APP__BASE_URL</code></td> <td>Defines the base url the website is hosted at. If the website is accessed at <code>example.org/abr/</code>, set the base URL to <code>/abr/</code></td> <td></td> </tr> <tr> <td><code>ABR_DB__SQLITE_PATH</code></td> <td>If relative, path and name of the sqlite database in relation to <code>ABR_APP__CONFIG_DIR</code>. If absolute (path starts with <code>/</code>), the config dir is ignored and only the absolute path is used.</td> <td>db.sqlite</td> </tr> <tr> <td><code>ABR_APP__DEFAULT_REGION</code></td> <td>Default audible region to use for the search. Has to be one of <code>us, ca, uk, au, fr, de, jp, it, in, es, br</code>.</td> <td>us</td> </tr> <tr> <td><code>ABR_APP__FORCE_LOGIN_TYPE</code></td> <td>Forces the login type and prevents it from being modified. Can be one of <code>basic</code>, <code>forms</code>, <code>oidc</code>, or <code>none</code> to disable the login. <code>oidc</code> requires both the <code>ABR_APP__INIT_ROOT_USERNAME</code> and <code>ABR_APP__INIT_ROOT_PASSWORD</code> environment variables to be set.</td> <td></td> </tr> <tr> <td><code>ABR_APP__INIT_ROOT_USERNAME</code></td> <td>Sets the initial username of the root user when first launching ABR. Has no effect if a root admin already exists.</td> <td></td> </tr> <tr> <td><code>ABR_APP__INIT_ROOT_PASSWORD</code></td> <td>Sets the initial password of the root user when first launching ABR. Has no effect if a root admin already exists.</td> <td></td> </tr> </tbody> </table> <div class="alert alert-primary" role="alert"> <h4 class="alert-heading">Note</h4> There are two underscores (<code>__</code>) between the first and second part of each environment variable like between <code>ABR_APP</code> and <code>PORT</code>. </div>