website/docs: fix order of steps on bookstack integration
Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
parent
1c52836060
commit
62cfb76b39
|
@ -134,7 +134,7 @@ export class SAMLProviderViewPage extends LitElement {
|
||||||
</dt>
|
</dt>
|
||||||
<dd class="pf-c-description-list__description">
|
<dd class="pf-c-description-list__description">
|
||||||
<div class="pf-c-description-list__text">
|
<div class="pf-c-description-list__text">
|
||||||
${this.provider.audience}
|
${this.provider.audience || "-"}
|
||||||
</div>
|
</div>
|
||||||
</dd>
|
</dd>
|
||||||
</div>
|
</div>
|
||||||
|
|
|
@ -34,20 +34,31 @@ In authentik, under _Providers_, create a _SAML Provider_ with these settings:
|
||||||
- Audience: https://book.company/saml2/metadata
|
- Audience: https://book.company/saml2/metadata
|
||||||
|
|
||||||
**Advanced protocol settings**
|
**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.
|
All other options as default.
|
||||||
|
|
||||||
![](./authentik_saml_bookstack.png)
|
![](./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
|
1. Click on the BookStack Provider
|
||||||
2. Click the Metadata Tab
|
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)
|
![](./metadataurl.png)
|
||||||
|
|
||||||
### Step 2
|
### Step 4
|
||||||
|
|
||||||
Edit the `.env` file inside of the `www` folder of Bookstack.
|
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.
|
# Name of the attribute to use as an ID for the SAML user.
|
||||||
SAML2_EXTERNAL_ID_ATTRIBUTE=uid
|
SAML2_EXTERNAL_ID_ATTRIBUTE=uid
|
||||||
# Name of the attribute(s) to use for the user's display name
|
# 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.
|
# case those values will be joined with a space.
|
||||||
# Example: SAML2_DISPLAY_NAME_ATTRIBUTES=firstName|lastName
|
# Example: SAML2_DISPLAY_NAME_ATTRIBUTES=firstName|lastName
|
||||||
# Defaults to the ID value if not found.
|
# 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/
|
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
|
## Notes
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
|
@ -98,4 +100,4 @@ BookStack will attempt to match the SAML user to an existing BookStack user base
|
||||||
|
|
||||||
:::note
|
:::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/
|
SAML Group Sync is supported by Bookstack. Review the BookStack documention on the required Environment variables. https://www.bookstackapp.com/docs/admin/saml2-auth/
|
||||||
:::
|
:::
|
||||||
|
|
Reference in a new issue