website/integrations: Add documentation for Drupal #12925
Conversation
✅ Deploy Preview for authentik-storybook canceled.
|
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
BeryJu
changed the title
There was a problem hiding this comment.
Hi, thanks for your contribution. Before reviewing this PR, would it be possible to make sure your contribution follows the template outlined in the documentation? Thanks.
|
@dominic-r I've made this change (however the authentik configuration needs to happen before the Drupal configuration) |
There was a problem hiding this comment.
Hi @justafish . Thanks for your contribution. Here are a few comments. Please do let me know if you have any questions.
| ::: | ||
|
|
||
|
|
||
| ## authentik configuration |
There was a problem hiding this comment.
Note to tana: reminder: will update format in a later PR
|
Hi @justafish. Just checking in to see if there are any developments related to this PR. thanks |
|
@dominic-r I've addressed your feedback 👍 |
| ## Drupal configuration | ||
|
|
||
| - From the Admin Toolbar or admin page at https://drupal.company/admin go to | ||
| Configuration -> OpenID Connect or directly at https://drupal.company/admin/config/services/openid-connect |
There was a problem hiding this comment.
| Configuration -> OpenID Connect or directly at https://drupal.company/admin/config/services/openid-connect | |
| **Configuration -> OpenID Connect** or directly at https://drupal.company/admin/config/services/openid-connect. |
|
|
||
| - From the Admin Toolbar or admin page at https://drupal.company/admin go to | ||
| Configuration -> OpenID Connect or directly at https://drupal.company/admin/config/services/openid-connect | ||
| - Input the Client ID and Secret you noted above |
There was a problem hiding this comment.
| - Input the Client ID and Secret you noted above | |
| - Input the Client ID and Secret you noted above. |
| Configuration -> OpenID Connect or directly at https://drupal.company/admin/config/services/openid-connect | ||
| - Input the Client ID and Secret you noted above | ||
| - Fill out the following endpoints: | ||
| - Authorization endpoint: <kbd>https://<em>authentik.company</em>/application/o/authorize/</kbd> |
There was a problem hiding this comment.
| - Authorization endpoint: <kbd>https://<em>authentik.company</em>/application/o/authorize/</kbd> | |
| - **Authorization endpoint**: <kbd>https://<em>authentik.company</em>/application/o/authorize/</kbd> |
| - Input the Client ID and Secret you noted above | ||
| - Fill out the following endpoints: | ||
| - Authorization endpoint: <kbd>https://<em>authentik.company</em>/application/o/authorize/</kbd> | ||
| - Token endpoint: <kbd>https://<em>authentik.company</em>/application/o/token/</kbd> |
There was a problem hiding this comment.
| - Token endpoint: <kbd>https://<em>authentik.company</em>/application/o/token/</kbd> | |
| - **Token endpoint**: <kbd>https://<em>authentik.company</em>/application/o/token/</kbd> |
| - Fill out the following endpoints: | ||
| - Authorization endpoint: <kbd>https://<em>authentik.company</em>/application/o/authorize/</kbd> | ||
| - Token endpoint: <kbd>https://<em>authentik.company</em>/application/o/token/</kbd> | ||
| - UserInfo endpoint: <kbd>https://<em>authentik.company</em>/application/o/userinfo/</kbd> |
There was a problem hiding this comment.
| - UserInfo endpoint: <kbd>https://<em>authentik.company</em>/application/o/userinfo/</kbd> | |
| - **UserInfo endpoint**: <kbd>https://<em>authentik.company</em>/application/o/userinfo/</kbd> |
| If you are developing Drupal locally with DDEV and authentik is also running | ||
| locally, use `host.docker.internal:9000` as the hostname for the Token and UserInfo endpoints. | ||
| ::: | ||
| - Select the "Override registration settings" checkbox |
There was a problem hiding this comment.
| - Select the "Override registration settings" checkbox | |
| - Select the "Override registration settings" checkbox. |
| locally, use `host.docker.internal:9000` as the hostname for the Token and UserInfo endpoints. | ||
| ::: | ||
| - Select the "Override registration settings" checkbox | ||
| - Enable the OpenID button on user login form |
There was a problem hiding this comment.
| - Enable the OpenID button on user login form | |
| - Enable the OpenID button on user login form. |
| - Create an application e.g. "Drupal" and set the Provider field to the provider | ||
| created above | ||
|
|
||
| ## Drupal configuration |
There was a problem hiding this comment.
@justafish ideally these steps would be numbered, not bullets.
There was a problem hiding this comment.
Thanks so much @justafish for this contribution. I was shocked that we didn't already have an integration guide for Drupal; now we do, thanks to you!
I made a few more minor edits, once those are in let's get this merged!
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #12925 +/- ##
==========================================
- Coverage 92.75% 90.64% -2.11%
==========================================
Files 769 792 +23
Lines 38929 40232 +1303
==========================================
+ Hits 36109 36469 +360
- Misses 2820 3763 +943
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Details
Adds documentation for authentication with Drupal
Checklist
ak test authentik/)make lint-fix)If an API change has been made
make gen-build)If changes to the frontend have been made
make web)If applicable
make website)