Skip to content

feat: documentation for IPv6/more flexible interface binding support #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chase-roohms merged 1 commit into from
May 15, 2026
+8 −1
Merged

feat: documentation for IPv6/more flexible interface binding support #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/content/docs/environment-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,18 @@ For OIDC configuration variables, please see [OIDC / SSO Integration](/docs/oidc

| Variable | Default | Description |
|----------|---------|-------------|
| `HOST` | `0.0.0.0` | Network interface the server binds to. The default binds to all interfaces, which is required inside Docker. |
| `HOST` | `0.0.0.0` | Network interface the server binds to. The default binds to all IPv4 interfaces, which is required inside Docker. |
| `HOSTS` | `""` | A list of network interfaces the server binds to, either comma-separated or in JSON array format. If it is not set, the `HOST` value is used instead. |
| `PORT` | `3313` | Port the server listens on inside the container. If you change this, update the `ports` mapping and health check URL in your Compose file to match. |
| `APP_URL` | `""` | Used for constructing URLs in OIDC API response, and also used for setting the displayed URL in the API docs. |
| `CONVERSION_WORKER_CONCURRENCY` | `5` | Number of concurrent conversion workers. Each one runs on its own thread. |

> **What is the distinction between `HOSTS` and `HOST`?**
>
> Simple configuration that require the server to bind to only one interface can be done using `HOST`. However, more complex configurations may require binding to more than one interface, which `HOSTS` enables; one example of this is if you wish to make the server available over both IPv6 and IPv4, which requires binding to an address of each family. For example, binding to all IPv6 interfaces and all IPv4 interfaces requires binding to both `::` and `0.0.0.0`, which can be done by setting `HOSTS` to `::,0.0.0.0` or `["::", "0.0.0.0"]`.
>
> If both `HOST` and `HOSTS` are used at the same time, the value set in `HOSTS` will be used, and a warning to this effect will be logged.

### Storage

| Variable | Default | Description |
Expand Down