trustchain-oc1-orchestral/authentik
Archived
10
0
Fork 0
Code Issues Pull requests 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
Show stats Download patch file Download diff file Expand all files Collapse all files

2
web/src/pages/providers/saml/SAMLProviderViewPage.ts
View file

@ -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>

30
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 - 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