docs: Add AdventureLog Community Integration Documentation #12928
Conversation
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for authentik-storybook canceled.
|
There was a problem hiding this comment.
Hi @seanmorley15 ; Thanks for your contribution to authentik! I noticed a few things that would necessitate your review, once that's done I'll be happy to take another look at this PR. Please do let me know if you have any questions.
|
Hi @dominic-r, thanks so much for taking the time to review! I just made the changes you suggested. Let me know if there is anything else that should be changed! |
There was a problem hiding this comment.
Hi @seanmorley15 Thanks for your time. Here are some things I noticed in this second review. Nothing major, just some nit-picks. Thanks
|
|
||
| The following placeholders are used in this guide: | ||
|
|
||
| - `https://adventurelog.company` is the FQDN used to access the AdventureLog **server** instance. |
There was a problem hiding this comment.
| - `https://adventurelog.company` is the FQDN used to access the AdventureLog **server** instance. | |
| - `https://adventurelog.company` is the FQDN of the AdventureLog server installation. |
If that makes sense in this context
| This documentation lists only the settings that you need to change from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application. | ||
| ::: | ||
|
|
||
| ## authentik configuration |
There was a problem hiding this comment.
Note to tana: Will leave like this for the moment and fix during migration PR
| - Name: authentik | ||
| - Client ID: authentik Client ID | ||
| - Secret Key: authentik Client Secret | ||
| - Key: can be left blank |
There was a problem hiding this comment.
Can be left blank or should be left blank? If users could/should put something here, could you detail the steps to do so?
|
|
||
| ### authentik - No Permission | ||
|
|
||
| In the authentik instance, check access to the AdventureLog application from a specific user by using the Check Access/Test button on the Application dashboard. If the user doesn't have access, you can add an existing user/group policy to give your specific user/group access to the AdventureLog application. |
There was a problem hiding this comment.
Could you add an introduction sentence to tell the user how to reach this step?
|
|
||
| ### 404 error when logging in. | ||
|
|
||
| Ensure the `https://adventurelog.company/accounts` path is routed to the backend, as it shouldn't hit the frontend when it's properly configured. |
There was a problem hiding this comment.
If it's not routed to the backend, how is this error resolved? You could link existing service documentation to avoid detailing all the steps.
|
|
||
| - Sites: move over the sites you want to enable authentik on, usually `example.com` and `www.example.com` unless you renamed your sites. | ||
|
|
||
| 4. Save the configuration. |
There was a problem hiding this comment.
t step 2 2? If i'm reading this correctly, you are passing from step 1 on line 58 to step 4 here.
|
cc @tanberry when you have a second for additional review / merge |
Details
Adds documentation for an AdventureLog community integration.
Checklist
make website)