website/integrations: improve Vikunja docs (#3370)

* website/docs: improve Vikunja docs

- Added placeholder for name set in config.yml with example using uppercase letters and spaces, to show how the callback URL will be handled with said name
- Added note that local login can be disabled
- Reword restart note at bottom to sound more fluent

Signed-off-by: JJGadgets <git@jjgadgets.tech>

* website/docs: update Vikunja provider screenshot

* minor fixes

Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>

Signed-off-by: JJGadgets <git@jjgadgets.tech>
Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
Co-authored-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
JJGadgets 2022-10-01 04:50:56 +08:00 committed by GitHub
parent 9996e02f6d
commit b73c70cbc2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 5 deletions

View File

@ -22,6 +22,7 @@ The following placeholders will be used:
- `vik.company` is the FQDN of Vikunja.
- `authentik.company` is the FQDN of authentik.
- `authentik Login` is the name shown on Vikunja set in config.yml, and used for the Redirect URI. If the name set in config.yml has capitalization or spaces like in this example, they will be set to lowercase and no spaces in the callback URL, like `authentiklogin`.
### Step 1
@ -39,16 +40,16 @@ Only settings that have been modified from default have been listed.
- Redirect URIs/Origins:
```
https://vik.company/auth/openid/authentik
https://vik.company/auth/openid/authentiklogin
```
![](./vikunja1.png)
### Step 2
Edit/Create you `config.yml` file for Vikunja
Edit/Create your `config.yml` file for Vikunja. Local authentication can be safely disabled in the Local block if all users must login through authentik, in this example it is left enabled.
Incorporate the following example Auth block into your `config.yml`
Incorporate the following example Auth block into your `config.yml`:
```bash
auth:
@ -71,7 +72,7 @@ auth:
# A list of enabled providers
providers:
# The name of the provider as it will appear in the frontend.
- name: authentik
- name: "authentik Login"
# The auth url to send users to if they want to authenticate using OpenID Connect.
authurl: https://authentik.company/application/o/vikunja/
# The client ID used to authenticate Vikunja at the OpenID Connect provider.
@ -96,5 +97,5 @@ In authentik, create an application which uses this provider. Optionally apply a
## Notes
:::note
Recommend you restart the Vikunja stack after making the config file changes.
It is recommended to restart all Vikunja components (API and frontend) after applying the OpenID configuration to Vikunja.
:::

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 83 KiB