habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

website/docs: fix order of steps on bookstack integration

Browse Source 
Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
Jens Langhammer
2021-10-03 18:46:47 +02:00
parent 1c52836060
commit 62cfb76b39
2 changed files with 18 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
website/docs/integrations/services/bookstack/index.md
View File

@ -34,20 +34,31 @@ In authentik, under _Providers_, create a _SAML Provider_ with these settings:
- Audience: https://book.company/saml2/metadata
**Advanced protocol settings**
- Signing Certificate: Choose your certificate or the default authentik Self-signed Certificate
- Signing Certificate: Choose your certificate or the default authentik Self-signed Certificate
All other options as default.
![](./authentik_saml_bookstack.png)
Save your settings, and obtain your Metadata URL from Authentik.
### Step 2
In authentik, create an application which uses this provider. Optionally apply access restrictions to the application using policy bindings.
- Name: Bookstack
- Slug: bookstack
- Provider: Bookstack
- Launch URL: https://book.company
### Step 3
Obtain your Metadata URL from Authentik.
1. Click on the BookStack Provider
2. Click the Metadata Tab
3. Click Copy download URL (This URL is the `METADATAURL` required in Step 2)
3. Click Copy download URL (This URL is the `METADATAURL` required in Step 4)
![](./metadataurl.png)
### Step 2
### Step 4
Edit the `.env` file inside of the `www` folder of Bookstack.
@ -64,7 +75,7 @@ SAML2_EMAIL_ATTRIBUTE=email
# Name of the attribute to use as an ID for the SAML user.
SAML2_EXTERNAL_ID_ATTRIBUTE=uid
# Name of the attribute(s) to use for the user's display name
# Can have mulitple attributes listed, separated with a '|' in which
# Can have multiple attributes listed, separated with a '|' in which
# case those values will be joined with a space.
# Example: SAML2_DISPLAY_NAME_ATTRIBUTES=firstName|lastName
# Defaults to the ID value if not found.
@ -81,15 +92,6 @@ SAML2_AUTOLOAD_METADATA=true
Bookstack Reference link: https://www.bookstackapp.com/docs/admin/saml2-auth/
:::
### Step 3
In authentik, create an application which uses this provider. Optionally apply access restrictions to the application using policy bindings.
- Name: Bookstack
- Slug: bookstack
- Provider: Bookstack
- Launch URL: https://book.company
## Notes
:::note
@ -98,4 +100,4 @@ BookStack will attempt to match the SAML user to an existing BookStack user base
:::note
SAML Group Sync is supported by Bookstack. Review the BookStack documention on the required Environment variables. https://www.bookstackapp.com/docs/admin/saml2-auth/
:::
:::