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/scripts: updated readme, added docsmg.env file #10710

Merged
merged 16 commits into from
Aug 5, 2024
Merged

Conversation

tanberry
Copy link
Contributor

@tanberry tanberry commented Jul 31, 2024

This PR updates the readme for the migration script to mention the docsmg.env file.

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

@tanberry tanberry requested a review from a team as a code owner July 31, 2024 20:12
Copy link

netlify bot commented Jul 31, 2024

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 0834860
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/66b0d3a6c3d9980008819c36
😎 Deploy Preview https://deploy-preview-10710--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 Jul 31, 2024

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 0834860
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/66b0d3a604a36a0008b6814a

Copy link

codecov bot commented Aug 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.54%. Comparing base (2a2f1c3) to head (0834860).
Report is 17 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #10710   +/-   ##
=======================================
  Coverage   92.53%   92.54%           
=======================================
  Files         721      721           
  Lines       35359    35354    -5     
=======================================
- Hits        32721    32717    -4     
+ Misses       2638     2637    -1     
Flag Coverage Δ
e2e 49.60% <ø> (-0.02%) ⬇️
integration 25.35% <ø> (-0.02%) ⬇️
unit 90.05% <ø> (+<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 Aug 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-083486040b1888afc289208baec1b16f424b8bf9
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-083486040b1888afc289208baec1b16f424b8bf9-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-083486040b1888afc289208baec1b16f424b8bf9

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-083486040b1888afc289208baec1b16f424b8bf9-arm64

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

@tanberry tanberry merged commit 76b1d4d into main Aug 5, 2024
71 checks passed
@tanberry tanberry deleted the migrate-test branch August 5, 2024 14:49
kensternberg-authentik added a commit that referenced this pull request Aug 5, 2024
* refs/remotes/origin/main: (37 commits)
  release: 2024.6.3
  website/docs: prepare 2024.6.3 release notes (#10775)
  website/scripts: updated readme, added docsmg.env file  (#10710)
  web: bump API Client version (#10777)
  root: fix opencontainers ref (#10776)
  core: applications api: properly select provider (#10373)
  root: remove warnings (#10774)
  enterprise/rac: fix error when listing connection tokens as non-superuser (#10771)
  core: bump golang.org/x/oauth2 from 0.21.0 to 0.22.0 (#10754)
  core: bump goauthentik.io/api/v3 from 3.2024062.1 to 3.2024062.2 (#10753)
  core: bump golang.org/x/sync from 0.7.0 to 0.8.0 (#10755)
  web: bump the rollup group across 1 directory with 3 updates (#10756)
  web: bump core-js from 3.37.1 to 3.38.0 in /web (#10757)
  web: bump @swc/core from 1.7.4 to 1.7.6 in /web/sfe (#10758)
  web: bump rollup from 4.19.2 to 4.20.0 in /web/sfe (#10759)
  core: bump black from 24.4.2 to 24.8.0 (#10760)
  core: bump msgraph-sdk from 1.5.3 to 1.5.4 (#10761)
  core: bump coverage from 7.6.0 to 7.6.1 (#10762)
  core: bump ruff from 0.5.5 to 0.5.6 (#10763)
  core: bump django-filter from 24.2 to 24.3 (#10764)
  ...
kensternberg-authentik added a commit that referenced this pull request Aug 5, 2024
* main: (37 commits)
  release: 2024.6.3
  website/docs: prepare 2024.6.3 release notes (#10775)
  website/scripts: updated readme, added docsmg.env file  (#10710)
  web: bump API Client version (#10777)
  root: fix opencontainers ref (#10776)
  core: applications api: properly select provider (#10373)
  root: remove warnings (#10774)
  enterprise/rac: fix error when listing connection tokens as non-superuser (#10771)
  core: bump golang.org/x/oauth2 from 0.21.0 to 0.22.0 (#10754)
  core: bump goauthentik.io/api/v3 from 3.2024062.1 to 3.2024062.2 (#10753)
  core: bump golang.org/x/sync from 0.7.0 to 0.8.0 (#10755)
  web: bump the rollup group across 1 directory with 3 updates (#10756)
  web: bump core-js from 3.37.1 to 3.38.0 in /web (#10757)
  web: bump @swc/core from 1.7.4 to 1.7.6 in /web/sfe (#10758)
  web: bump rollup from 4.19.2 to 4.20.0 in /web/sfe (#10759)
  core: bump black from 24.4.2 to 24.8.0 (#10760)
  core: bump msgraph-sdk from 1.5.3 to 1.5.4 (#10761)
  core: bump coverage from 7.6.0 to 7.6.1 (#10762)
  core: bump ruff from 0.5.5 to 0.5.6 (#10763)
  core: bump django-filter from 24.2 to 24.3 (#10764)
  ...
kensternberg-authentik added a commit that referenced this pull request Aug 6, 2024
* main: (473 commits)
  blueprints: handle model referencing non-existent app/model (#10796)
  website/docs: add more content about flows (#10527)
  brands: add OIDC webfinger support (#10400)
  web/admin: fix selectable card colour in dark theme (#10794)
  web: bump API Client version (#10793)
  policies: add GeoIP policy (#10454)
  core: bump debugpy from 1.8.3 to 1.8.5 (#10781)
  web: bump @sentry/browser from 8.22.0 to 8.23.0 in /web in the sentry group across 1 directory (#10782)
  website: bump postcss from 8.4.40 to 8.4.41 in /website (#10783)
  web: bump the wdio group across 2 directories with 4 updates (#10785)
  web: bump @lit/localize from 0.12.1 to 0.12.2 in /web (#10786)
  web: bump @floating-ui/dom from 1.6.8 to 1.6.9 in /web (#10787)
  web: bump @lit/localize-tools from 0.7.2 to 0.8.0 in /web (#10788)
  web: bump lit from 3.1.4 to 3.2.0 in /web (#10789)
  core: bump goauthentik.io/api/v3 from 3.2024062.2 to 3.2024063.1 (#10790)
  web: bump API Client version (#10779)
  release: 2024.6.3
  website/docs: prepare 2024.6.3 release notes (#10775)
  website/scripts: updated readme, added docsmg.env file  (#10710)
  web: bump API Client version (#10777)
  ...
kensternberg-authentik added a commit that referenced this pull request Aug 6, 2024
* main: (702 commits)
  blueprints: handle model referencing non-existent app/model (#10796)
  website/docs: add more content about flows (#10527)
  brands: add OIDC webfinger support (#10400)
  web/admin: fix selectable card colour in dark theme (#10794)
  web: bump API Client version (#10793)
  policies: add GeoIP policy (#10454)
  core: bump debugpy from 1.8.3 to 1.8.5 (#10781)
  web: bump @sentry/browser from 8.22.0 to 8.23.0 in /web in the sentry group across 1 directory (#10782)
  website: bump postcss from 8.4.40 to 8.4.41 in /website (#10783)
  web: bump the wdio group across 2 directories with 4 updates (#10785)
  web: bump @lit/localize from 0.12.1 to 0.12.2 in /web (#10786)
  web: bump @floating-ui/dom from 1.6.8 to 1.6.9 in /web (#10787)
  web: bump @lit/localize-tools from 0.7.2 to 0.8.0 in /web (#10788)
  web: bump lit from 3.1.4 to 3.2.0 in /web (#10789)
  core: bump goauthentik.io/api/v3 from 3.2024062.2 to 3.2024063.1 (#10790)
  web: bump API Client version (#10779)
  release: 2024.6.3
  website/docs: prepare 2024.6.3 release notes (#10775)
  website/scripts: updated readme, added docsmg.env file  (#10710)
  web: bump API Client version (#10777)
  ...
kensternberg-authentik added a commit that referenced this pull request Aug 6, 2024
* main: (690 commits)
  blueprints: handle model referencing non-existent app/model (#10796)
  website/docs: add more content about flows (#10527)
  brands: add OIDC webfinger support (#10400)
  web/admin: fix selectable card colour in dark theme (#10794)
  web: bump API Client version (#10793)
  policies: add GeoIP policy (#10454)
  core: bump debugpy from 1.8.3 to 1.8.5 (#10781)
  web: bump @sentry/browser from 8.22.0 to 8.23.0 in /web in the sentry group across 1 directory (#10782)
  website: bump postcss from 8.4.40 to 8.4.41 in /website (#10783)
  web: bump the wdio group across 2 directories with 4 updates (#10785)
  web: bump @lit/localize from 0.12.1 to 0.12.2 in /web (#10786)
  web: bump @floating-ui/dom from 1.6.8 to 1.6.9 in /web (#10787)
  web: bump @lit/localize-tools from 0.7.2 to 0.8.0 in /web (#10788)
  web: bump lit from 3.1.4 to 3.2.0 in /web (#10789)
  core: bump goauthentik.io/api/v3 from 3.2024062.2 to 3.2024063.1 (#10790)
  web: bump API Client version (#10779)
  release: 2024.6.3
  website/docs: prepare 2024.6.3 release notes (#10775)
  website/scripts: updated readme, added docsmg.env file  (#10710)
  web: bump API Client version (#10777)
  ...
kensternberg-authentik added a commit that referenced this pull request Aug 6, 2024
* main: (229 commits)
  blueprints: handle model referencing non-existent app/model (#10796)
  website/docs: add more content about flows (#10527)
  brands: add OIDC webfinger support (#10400)
  web/admin: fix selectable card colour in dark theme (#10794)
  web: bump API Client version (#10793)
  policies: add GeoIP policy (#10454)
  core: bump debugpy from 1.8.3 to 1.8.5 (#10781)
  web: bump @sentry/browser from 8.22.0 to 8.23.0 in /web in the sentry group across 1 directory (#10782)
  website: bump postcss from 8.4.40 to 8.4.41 in /website (#10783)
  web: bump the wdio group across 2 directories with 4 updates (#10785)
  web: bump @lit/localize from 0.12.1 to 0.12.2 in /web (#10786)
  web: bump @floating-ui/dom from 1.6.8 to 1.6.9 in /web (#10787)
  web: bump @lit/localize-tools from 0.7.2 to 0.8.0 in /web (#10788)
  web: bump lit from 3.1.4 to 3.2.0 in /web (#10789)
  core: bump goauthentik.io/api/v3 from 3.2024062.2 to 3.2024063.1 (#10790)
  web: bump API Client version (#10779)
  release: 2024.6.3
  website/docs: prepare 2024.6.3 release notes (#10775)
  website/scripts: updated readme, added docsmg.env file  (#10710)
  web: bump API Client version (#10777)
  ...
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