Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

website/docs: update and rearchitect the oauth2 provider docs #11916

Merged
merged 27 commits into from
Dec 10, 2024
Merged

Conversation

tanberry
Copy link
Contributor

@tanberry tanberry commented Nov 5, 2024

This PR adds more conceptual info to the index page (thanks Jens), and creates a new page for procedurals (to be written). It also moves all content about GitHub compatibility to a separate child-page.

If applicable

  • The documentation has been updated
  • The documentation has been formatted (make website)

@tanberry tanberry requested a review from a team as a code owner November 5, 2024 04:20
@tanberry tanberry requested a review from BeryJu November 5, 2024 04:20
@tanberry tanberry marked this pull request as draft November 5, 2024 04:21
Copy link

netlify bot commented Nov 5, 2024

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 598e6c8
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/674f68f022c5ed0008932e93
😎 Deploy Preview https://deploy-preview-11916--authentik-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Nov 5, 2024

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 598e6c8
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/674f68f0ce865d0008a83b70

@authentik-automation
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 40.8%, saving 31.25 KB.

Filename Before After Improvement Visual comparison
website/docs/add-secure-apps/providers/oauth2/OAuth2-diagram.png 76.51 KB 45.26 KB -40.8% View diff

161 images did not require optimisation.

Copy link

codecov bot commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.64%. Comparing base (1623885) to head (598e6c8).
Report is 41 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #11916      +/-   ##
==========================================
- Coverage   92.68%   92.64%   -0.05%     
==========================================
  Files         762      762              
  Lines       38151    38151              
==========================================
- Hits        35362    35344      -18     
- Misses       2789     2807      +18     
Flag Coverage Δ
e2e 49.05% <ø> (-0.05%) ⬇️
integration 24.76% <ø> (ø)
unit 90.22% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

github-actions bot commented Nov 5, 2024

authentik PR Installation instructions

Instructions for docker-compose

Add the following block to your .env file:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-598e6c8850d2fd1d12f38a54bd93b28c55b491f1
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

For arm64, use these values:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-598e6c8850d2fd1d12f38a54bd93b28c55b491f1-arm64
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

Afterwards, run the upgrade commands from the latest release notes.

Instructions for Kubernetes

Add the following block to your values.yml file:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-598e6c8850d2fd1d12f38a54bd93b28c55b491f1

For arm64, use these values:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-598e6c8850d2fd1d12f38a54bd93b28c55b491f1-arm64

Afterwards, run the upgrade commands from the latest release notes.

BeryJu and others added 8 commits November 5, 2024 19:52
@tanberry tanberry marked this pull request as ready for review November 8, 2024 14:02
@tanberry tanberry merged commit 29f53fd into main Dec 10, 2024
71 checks passed
@tanberry tanberry deleted the docs-oauth2 branch December 10, 2024 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants