Skip to content
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

Jump to bottom

docs: env var renamed in Caddyfile #888

Merged
merged 1 commit into from Apr 5, 2024
Merged

docs: env var renamed in Caddyfile #888

Show file tree
Hide file tree
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .vscode/launch.json
View file
Open in desktop
Expand Up @@ -13,7 +13,7 @@
"MERCURE_EXTRA_DIRECTIVES": "anonymous\nwrite_timeout 10s",
"GLOBAL_OPTIONS": "debug",
"SERVER_NAME": "localhost, host.docker.internal",
"EXTRA_DIRECTIVES": "tls internal"
"CADDY_SERVER_EXTRA_DIRECTIVES": "tls internal"
},
"args": ["run", "--config", "../../Caddyfile.dev"]
}
Expand Down
2 changes: 1 addition & 1 deletion charts/mercure/templates/deployment.yaml
View file
Open in desktop
Expand Up @@ -47,7 +47,7 @@ spec:
configMapKeyRef:
name: {{ include "mercure.fullname" . }}
key: global-options
- name: EXTRA_DIRECTIVES
- name: CADDY_SERVER_EXTRA_DIRECTIVES
valueFrom:
secretKeyRef:
name: {{ include "mercure.fullname" . }}
Expand Down
24 changes: 12 additions & 12 deletions docs/hub/config.md
View file
Open in desktop
Expand Up @@ -62,18 +62,18 @@ See also [the list of built-in Caddyfile directives](https://caddyserver.com/doc

The provided `Caddyfile` and the Docker image provide convenient environment variables:

| Environment variable | Description | Default value |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------- |
| `GLOBAL_OPTIONS` | the [global options block](https://caddyserver.com/docs/caddyfile/options#global-options) to inject in the `Caddyfile`, one per line | |
| `EXTRA_DIRECTIVES` | [`Caddyfile` statements](https://caddyserver.com/docs/caddyfile) | |
| `SERVER_NAME` | the server name or address | `localhost` |
| `MERCURE_TRANSPORT_URL` | the value passed to the `transport_url` directive | `bolt://mercure.db` |
| `MERCURE_PUBLISHER_JWT_KEY` | the JWT key to use for publishers | |
| `MERCURE_PUBLISHER_JWT_ALG` | the JWT algorithm to use for publishers | `HS256` |
| `MERCURE_SUBSCRIBER_JWT_KEY` | the JWT key to use for subscribers | |
| `MERCURE_SUBSCRIBER_JWT_ALG` | the JWT algorithm to use for subscribers | `HS256` |
| `MERCURE_EXTRA_DIRECTIVES` | a list of extra Mercure directives inject in the Caddy file, one per line | |
| `MERCURE_LICENSE` | the license to use ([only applicable for the HA version](cluster.md)) | |
| Environment variable | Description | Default value |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------- |
| `GLOBAL_OPTIONS` | the [global options block](https://caddyserver.com/docs/caddyfile/options#global-options) to inject in the `Caddyfile`, one per line | |
| `CADDY_SERVER_EXTRA_DIRECTIVES`| [`Caddyfile` statements](https://caddyserver.com/docs/caddyfile) | |
| `SERVER_NAME` | the server name or address | `localhost` |
| `MERCURE_TRANSPORT_URL` | the value passed to the `transport_url` directive | `bolt://mercure.db` |
| `MERCURE_PUBLISHER_JWT_KEY` | the JWT key to use for publishers | |
| `MERCURE_PUBLISHER_JWT_ALG` | the JWT algorithm to use for publishers | `HS256` |
| `MERCURE_SUBSCRIBER_JWT_KEY` | the JWT key to use for subscribers | |
| `MERCURE_SUBSCRIBER_JWT_ALG` | the JWT algorithm to use for subscribers | `HS256` |
| `MERCURE_EXTRA_DIRECTIVES` | a list of extra Mercure directives inject in the Caddy file, one per line | |
| `MERCURE_LICENSE` | the license to use ([only applicable for the HA version](cluster.md)) | |

## JWT Verification

Expand Down