Skip to content

Commit 48dfcaf

Browse files
defguard-communitygitbook-bot
authored andcommitted
GITBOOK-392: URL clarification
1 parent efcc524 commit 48dfcaf

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

features/setting-up-your-instance/configuration.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@ icon: memo-circle-info
44

55
# Configuration
66

7-
Here you can find a list of all configurable things through environmental variables, options or configuration files for all defguard components (each section for every component).
7+
Here you can find a list of all configurable things through environmental variables, options or configuration files for all defguard components (each top-level section for a specific component):
8+
9+
* [Core config](configuration.md#core)
10+
* [Proxy config](configuration.md#proxy-service)
11+
* [Gateway config](configuration.md#gateway-configuration)
12+
* [YubiBridge config](configuration.md#yubibridge-configuration)
813

914
{% hint style="info" %}
1015
If you are using [one-line installation](one-line-install.md), everything is generated and configured automatically.
@@ -26,11 +31,11 @@ You can generate random strings for secrets with e.g.:
2631
* `DEFGUARD_SECRET_KEY`: JWT secret key for encrypting private cookies; must be at least 64 characters long
2732
* `DEFGUARD_GATEWAY_SECRET`: JWT secret key for encrypting Gateway tokens, default: `DEFGUARD_GATEWAY_SECRET`
2833
* `DEFGUARD_YUBIBRIDGE_SECRET`: JWT secret key for encrypting YubiBridge tokens, default: `DEFGUARD_YUBIBRIDGE_SECRET`
29-
* `DEFGUARD_OPENID_KEY`: this is optional if you want to use [HMAC](https://en.wikipedia.org/wiki/HMAC) algorithm for OIDC token validation, if you want to use [RSA](https://en.wikipedia.org/wiki/RSA\_\(cryptosystem\)) please provide a path to a private key file used for OAuth2/OpenID, [more here](https://defguard.gitbook.io/defguard/features/setting-up-your-instance/docker-compose#openid-rsa-setup).
34+
* `DEFGUARD_OPENID_KEY`: this is optional if you want to use [HMAC](https://en.wikipedia.org/wiki/HMAC) algorithm for OIDC token validation, if you want to use [RSA](https://en.wikipedia.org/wiki/RSA_\(cryptosystem\)) please provide a path to a private key file used for OAuth2/OpenID, [more here](https://defguard.gitbook.io/defguard/features/setting-up-your-instance/docker-compose#openid-rsa-setup).
3035

3136
### General configuration
3237

33-
* `DEFGUARD_URL`: URL of your server instance, default `http://localhost:8000.`This url is needed to be exact since it's needed for OpenID discovery endpoint to work correctly, so if you have a reverse-proxy, custom domain, please provide an actual URL for defguard core.
38+
* `DEFGUARD_URL`: URL of your server instance, default `http://localhost:8000. This is the address at which the Web UI you use to administer your instance and the REST API endpoints are available (both of those are served by defguard core on port 8000 by default; port can be configured with DEFGUARD_HTTP_PORT env variable).`This URL is needed to be exact since it's needed for OpenID discovery endpoint to work correctly, so if you have a reverse-proxy, custom domain, please provide an actual URL for defguard core.
3439
* `DEFGUARD_GATEWAY_DISCONNECTION_NOTIFICATION_TIMEOUT`: If gateway is disconnected for this long, send email notification, default: `10m` ([Humantime documentation](https://docs.rs/humantime/latest/humantime/struct.Duration.html))
3540
* `DEFGUARD_WEBAUTHN_RP_ID` (optional): Relying party ID and relying party origin for WebAuthn used for MFA. By default, it's generated by using a base domain of `DEFGUARD_URL` (for example https://defguard.example.com is converted to defguard.example.com).
3641

@@ -78,7 +83,7 @@ This is of course not recommended in production but can be useful when testing w
7883

7984
### Enrollment configuration
8085

81-
* `DEFGUARD_ENROLLMENT_URL`: external URL of the enrollment proxy server, default `http://localhost:8080` - this URL is send in enrollment emails as well as displayed when configuring the desktop client - thus must be to the actual URL you have configured the proxy to be visible at, otherwise the enrollment or desktop client configuration will not work.
86+
* `DEFGUARD_ENROLLMENT_URL`: external URL of the enrollment proxy server, default `http://localhost:8080` - this URL is sent in enrollment emails as well as displayed when configuring the desktop client - thus must be to the actual URL you have configured the proxy Web UI to be accessible at, otherwise the enrollment or desktop client configuration will not work.
8287
* `DEFGUARD_ENROLLMENT_TOKEN_TIMEOUT`: how long is the enrollment token valid for use, default: `24h` ([Humantime documentation](https://docs.rs/humantime/latest/humantime/struct.Duration.html))
8388
* `DEFGUARD_ENROLLMENT_SESSION_TIMEOUT`: how long in the enrollment session valid after a user uses the token to start the enrollment process, default: `10m` ([Humantime documentation](https://docs.rs/humantime/latest/humantime/struct.Duration.html))
8489

@@ -105,11 +110,11 @@ This is of course not recommended in production but can be useful when testing w
105110

106111
Here are proxy ENV variables. gRPC configuration is described more [on this help page.](../../admin-and-features/setting-up-your-instance/grpc-ssl-communication.md)
107112

108-
* `DEFGUARD_PROXY_HTTP_PORT`: port the API server will listen on, default `8080`
113+
* `DEFGUARD_PROXY_HTTP_PORT`: port the proxy API server and Web UI will listen on, default `8080`
109114
* `DEFGUARD_PROXY_GRPC_PORT`: port the gRPCS server will listen on, default `50051`
110115
* `DEFGUARD_PROXY_GRPC_CERT` (optional): path to TLS certificate file
111116
* `DEFGUARD_PROXY_GRPC_KEY`(optional): path to TLS key file. [More on that in this help page.](../../admin-and-features/setting-up-your-instance/grpc-ssl-communication.md)
112-
* `DEFGUARD_PROXY_URL` - if you wish to use External OIDC enrollment/desktop client configuration, please set this value to the same as `DEFGUARD_ENROLLMENT_URL` in core.
117+
* `DEFGUARD_PROXY_URL` - if you wish to use External OIDC enrollment/desktop client configuration, please set this value to the same as `DEFGUARD_ENROLLMENT_URL` in core. This is the address at which the proxy Web UI is available.
113118
* `DEFGUARD_PROXY_LOG_LEVEL` : [Logger](https://crates.io/crates/log) log level, default: `info`, supported: `debug`, `warn`, `error`
114119

115120
## Gateway Configuration

0 commit comments

Comments
 (0)