Skip to content

Commit

Permalink
docs: also update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eliasmueller committed Dec 3, 2024
1 parent f0971a7 commit 66d8d3a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 11 deletions.
14 changes: 5 additions & 9 deletions docs/content/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,16 +182,13 @@ All options with a default value are optional.
??? config-option-multi "**_export.exporters.gropius.graphql-backend-authentication_**"
??? config-option "**_export.exporters.gropius.graphql-backend-authentication.authentication-url_**"
- Type: String (a valid URL)
- Description: The URL where CLARA can obtain an authentication token from the Gropius-backend via username and password.
??? config-option "**_export.exporters.gropius.graphql-backend-authentication.username_**"
- Type: String
- Description: The username for obtaining an authentication token.
??? config-option "**_export.exporters.gropius.graphql-backend-authentication.password_**"
- Type: String
- Description: The password for obtaining an authentication token.
- Description: The URL where CLARA can obtain an authentication token from the Gropius-backend via client credentials.
??? config-option "**_export.exporters.gropius.graphql-backend-authentication.client-id_**"
- Type: String
- Description: The OAuth client ID for obtaining an authentication token.
??? config-option "**_export.exporters.gropius.graphql-backend-authentication.client-secret_**"
- Type: String
- Description: The OAuth client ID's secret for obtaining an authentication token.

??? config-option "**_export.exporters.gropius.component-handling_**"
- Type: String (one of `Delete` or `Modify`)
Expand Down Expand Up @@ -255,7 +252,6 @@ export:
graphql-backend-url: http://my.backend.com:8080/graphql
graphql-backend-authentication:
authentication-url: http://my.backend.com:3000/authenticate/oauth/xxxxxxxx-1111-yyyy-2222-zzzzzzzzzzzz/token
username: ${CLARA_GROPIUS_GRAPHQL_USERNAME}
password: ${CLARA_GROPIUS_GRAPHQL_PASSWORD}
client-id: ${CLARA_GROPIUS_GRAPHQL_CLIENT_ID}
client-secret: ${CLARA_GROPIUS_GRAPHQL_CLIENT_SECRET}
```
3 changes: 1 addition & 2 deletions docs/content/setup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,7 @@ macOS:
- If you want to use the Gropius exporter, set the Gropius environment variables:
```sh
export CLARA_GROPIUS_GRAPHQL_CLIENT_ID=<your-id>
export CLARA_GROPIUS_GRAPHQL_PASSWORD=<your-password>
export CLARA_GROPIUS_GRAPHQL_USERNAME=<your-username>
export CLARA_GROPIUS_GRAPHQL_CLIENT_SECRET=<your-secret>
```
- Start CLARA by executing the application:
```sh
Expand Down

0 comments on commit 66d8d3a

Please sign in to comment.