Skip to content

Commit 737dc3b

Browse files
Steadyit Officegitbook-bot
Steadyit Office
authored and
gitbook-bot
committed
GITBOOK-129: change request with no subject merged in GitBook
1 parent e01f0aa commit 737dc3b

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

‎install-and-configure/install-on-prem-platform/advanced-configuration.md

+11-12
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ navTitle: Advanced Configuration
66
# Configuration Options
77

88
{% hint style="info" %}
9-
This part of the documentation is only intended in the context of a supported PoC (Proof of Concept) together with the Steadybit team.
10-
Please, [book an appointment](https://www.steadybit.com/book-demo) to scope your PoC before continuing to evaluate the on-prem solution.
9+
This part of the documentation is only intended in the context of a supported PoC (Proof of Concept) together with the Steadybit team. Please, [book an appointment](https://www.steadybit.com/book-demo) to scope your PoC before continuing to evaluate the on-prem solution.
1110

1211
If you just want to try out Steadybit, we recommend you [sign up for our SaaS platform](https://signup.steadybit.com).
1312
{% endhint %}
@@ -57,15 +56,15 @@ For running the platform with multiple instances, a Redis message broker is requ
5756
### Web Configuration
5857

5958
| Environment Variable | Required | Description |
60-
| -------------------------------------- | -------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
59+
| -------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
6160
| `STEADYBIT_WEB_PUBLIC_URL` | | URL to point to your Steadybit installation. Use this if your platform is running behind a reverse proxy doing path rewriting. Also it is used for the links in notifications. |
6261
| `STEADYBIT_WEB_PUBLIC_EXPERIMENT_PORT` | | By default the Websocket connections are advertised to the agents on port 7878. If the public port differs (e.g. because of a proxy) use this property to advertise a different port. |
6362
| `STEADYBIT_WEB_PUBLIC_EXPERIMENT_URL` | | By default the Websocket connections are advertised on the same url name as the agents registers to. If you run a separate loadbalancer for the websockets you can override the advertised url. |
6463

6564
### Log Configuration
6665

6766
| Environment Variable | Required | Description |
68-
| -------------------- | -------- |----------------------------------------------------------------------------------------------------|
67+
| -------------------- | -------- | -------------------------------------------------------------------------------------------------- |
6968
| `LOGGING_FORMAT` | | By default Steadybit uses `text` format. Set this this to `json` to switch the log format to JSON. |
7069

7170
### Static-Authentication
@@ -98,16 +97,16 @@ By default the ldap is accessed anonymously, unless `STEADYBIT_AUTH_LDAP_MANAGER
9897
| `STEADYBIT_AUTH_LDAP_SYNC_TEAM_SEARCH_FILTER` | | <p>The filter for the groupOfNames/groupOfUniqueNames for the teams<br><strong>Example:</strong> <code>ou=teams,ou=groups,dc=steadybit,dc=com</code></p> |
9998
| `STEADYBIT_AUTH_LDAP_SYNC_TEAM_KEY_ATTRIBUTE` | | <p>The attribute to use as Team key<br><strong>Example:</strong> <code>cn=steadybit_admin,ou=groups,dc=steadybit,dc=com</code></p> |
10099
| `STEADYBIT_AUTH_LDAP_SYNC_TEAM_NAME_ATTRIBUTE` | | <p>The attribute to use as Team name<br><strong>Example:</strong> <code>cn=steadybit_admin,ou=groups,dc=steadybit,dc=com</code></p> |
101-
| `STEADYBIT_AUTH_SYNC_CRON` | | <p>Cron Expression which defines the periods for the LDAP synchronization<br><strong>Default:</strong> <code>0 0 _/2 ? _ \* \*</code></p> |
100+
| `STEADYBIT_AUTH_SYNC_CRON` | | <p>Cron Expression which defines the periods for the LDAP synchronization<br><strong>Default:</strong> <code>0 0 _/2 ? _ * *</code></p> |
102101

103102
### OpenID-Connect Authentication
104103

105-
You can use an OpenID Connect compatible authentication provider for user authentication. Steadybit uses the `authorization_code` grant type.
104+
You can use an OpenID Connect compatible authentication provider for user authentication. Steadybit uses the `authorization_code` grant type. The callback URL is `https://<host>/oauth2/login/code/default`
106105

107106
> The first user to login will be assigned the `ADMIN` role, all other will be assigned the `USER` role. The roles can be changed by an admin user via the UI.
108107
109108
| Environment Variable | Required | Description |
110-
| ------------------------------------------------------- | -------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
109+
| ------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
111110
| `STEADYBIT_AUTH_PROVIDER` | yes | <p>Use <code>OAUTH2</code> for OIDC-Authentication<br><strong>Example:</strong> <code>OAUTH2</code></p> |
112111
| `STEADYBIT_AUTH_OAUTH2_ISSUER_URI` | yes | <p>URI for the OpenID Connect discovery endpoint.<br><strong>Example:</strong> <code>https://keycloak/auth/realms/demo</code></p> |
113112
| `STEADYBIT_AUTH_OAUTH2_CLIENT_ID` | yes | <p>The client ID to use for the OIDC registration<br><strong>Example:</strong> <code>steadybit</code></p> |
@@ -137,16 +136,16 @@ OpenID Connect can be used to [authenticate the agents to the platform](advanced
137136
| Environment Variable | Required | Description |
138137
| ---------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------ |
139138
| `STEADYBIT_AUTH_AGENT_PROVIDER` | | <p>Set to <code>OAUTH2</code> to use the OIDC.<br><strong>Default:</strong> <code>AGENT_KEY</code></p> |
140-
| `STEADYBIT_AUTH_AGENT_OAUTH2_ISSUER_URI` | yes | <p>The issuer URI of your identity provider</p> |
139+
| `STEADYBIT_AUTH_AGENT_OAUTH2_ISSUER_URI` | yes | The issuer URI of your identity provider |
141140

142141
### Proxy Settings
143142

144143
Steadybit will use these proxy settings if the platform needs to connect to other services (for example your OIDC identity provider).
145144

146145
| Environment Variable | Required | Description |
147146
| -------------------------- | -------- | ---------------------------------------------------------------------------- |
148-
| `STEADYBIT_PROXY_HOST` | | <p>Hostname of your proxy</p> |
149-
| `STEADYBIT_PROXY_PORT` | | <p>Port of your proxy</p> |
147+
| `STEADYBIT_PROXY_HOST` | | Hostname of your proxy |
148+
| `STEADYBIT_PROXY_PORT` | | Port of your proxy |
150149
| `STEADYBIT_PROXY_PROTOCOL` | | <p>Protocol of your proxy<br><strong>Default:</strong> <code>http</code></p> |
151-
| `STEADYBIT_PROXY_USER` | | <p>Username of your proxy</p> |
152-
| `STEADYBIT_PROXY_PASSWORD` | | <p>Password of your proxy</p> |
150+
| `STEADYBIT_PROXY_USER` | | Username of your proxy |
151+
| `STEADYBIT_PROXY_PASSWORD` | | Password of your proxy |

0 commit comments

Comments
 (0)