Skip to content

website/docs: Add OIDC auth integration with Nextcloud#7406

Merged
BeryJu merged 10 commits intogoauthentik:mainfrom
astro-stan:add-nextcloud-oidc-docs
Nov 22, 2023
Merged

website/docs: Add OIDC auth integration with Nextcloud#7406
BeryJu merged 10 commits intogoauthentik:mainfrom
astro-stan:add-nextcloud-oidc-docs

Conversation

@astro-stan
Copy link
Contributor

@astro-stan astro-stan commented Nov 1, 2023

Details

Adds detailed docs on setting up OIDC authentication with Nextcloud. Includes tips and warnings against common pitfalls when setting up different configurations

Checklist

  • Local tests pass (ak test authentik/)
  • The code has been formatted (make lint-fix)

If an API change has been made

  • The API schema has been updated (make gen-build)

If changes to the frontend have been made

  • The code has been formatted (make web)
  • The translation files have been updated (make i18n-extract)

If applicable

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

@astro-stan astro-stan requested a review from a team as a code owner November 1, 2023 20:09
@netlify
Copy link

netlify bot commented Nov 1, 2023 •
edited
Loading

✅ Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit ff0cf52
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/655e198675b1680008564e0d

@netlify
Copy link

netlify bot commented Nov 1, 2023 •
edited
Loading

✅ Deploy Preview for authentik ready!

Name Link
🔨 Latest commit ff0cf52
🔍 Latest deploy log https://app.netlify.com/sites/authentik/deploys/655e1986c009fa0008d2ba77
😎 Deploy Preview https://deploy-preview-7406--authentik.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 94 (🔴 down 3 from production)
Accessibility: 90 (no change from production)
Best Practices: 100 (no change from production)
SEO: 80 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

@codecov
Copy link

codecov bot commented Nov 1, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (345022f) 92.17% compared to head (ff0cf52) 92.64%.
Report is 205 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #7406      +/-   ##
==========================================
+ Coverage   92.17%   92.64%   +0.47%     
==========================================
  Files         587      588       +1     
  Lines       28895    29140     +245     
==========================================
+ Hits        26634    26997     +363     
+ Misses       2261     2143     -118
Flag Coverage Δ
e2e 50.71% <ø> (+1.39%) ⬆️
integration 25.93% <ø> (-0.09%) ⬇️
unit 89.71% <ø> (+0.11%) ⬆️

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.

astro-stan and others added 4 commits November 1, 2023 20:17
@astro-stan
fix note
aec67bc
@astro-stan
lint
f01ff64
@astro-stan
typo
b74fb40
@astro-stan
Update index.md
af66dde 
Signed-off-by: sdimovv <36302090+sdimovv@users.noreply.github.com>
@astro-stan
Copy link
Contributor Author

astro-stan commented Nov 14, 2023

@BeryJu can I get a merge please :D

@rissson
Copy link
Member

rissson commented Nov 16, 2023

Do you mind moving the OIDC section below the SAML one as it requires an additional nextcloud app to be installed? Also, let's add a quick sentence stating there are two different protocols that can be configured and linking to the specific section for each of them.

@astro-stan
Copy link
Contributor Author

astro-stan commented Nov 16, 2023 •
edited
Loading

Do you mind moving the OIDC section below the SAML one as it requires an additional nextcloud app to be installed? Also, let's add a quick sentence stating there are two different protocols that can be configured and linking to the specific section for each of them.

I can add the section about the different protocols, no problem. However, I think you misunderstood what is required for SAML. Both auth methods require the installation of an additional app in Nextcloud. Both apps are "official", that is provided by the Nexcloud devs. However, neither of them comes installed with vanilla Nextcloud install. So the "extra" requirements for both are the same.

That being said I can still move it below SAML if you insist. I put it first since I believe most people will want to set up OIDC, as it is generally more popular than SAML.

@rissson
Copy link
Member

rissson commented Nov 17, 2023 •
edited
Loading

Ah I misremembered then, it's fine as it is then!

@astro-stan
Copy link
Contributor Author

astro-stan commented Nov 20, 2023

@rissson
Does this need anything else to get merged?

tanberry
tanberry requested changes Nov 20, 2023
View reviewed changes
Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's what I think is a typo that needs to be fixed... autorization --> authorization

@rissson
Copy link
Member

rissson commented Nov 20, 2023

Apart from the typo raised by Tana, all good for me

@astro-stan
Update index.md
72e29bd 
Signed-off-by: sdimovv <36302090+sdimovv@users.noreply.github.com>
@astro-stan
Copy link
Contributor Author

astro-stan commented Nov 21, 2023

Typo fixed. Let me know if there are more. Otherwise this can be merged.

@rissson
Copy link
Member

rissson commented Nov 22, 2023

@BeryJu could you force-merge this?

@BeryJu
fix typos
ff0cf52 
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
@BeryJu BeryJu merged commit 30f9d6b into goauthentik:main Nov 22, 2023
kensternberg-authentik added a commit that referenced this pull request Nov 27, 2023
@kensternberg-authentik
Merge branch 'main' into web/sidebar-with-live-content-3
5b898be 
* main: (47 commits)
  web: bump the wdio group in /tests/wdio with 2 updates (#7702)
  events: fix lint (#7700)
  events: add better fallback for sanitize_item to ensure everything can be saved as JSON (#7694)
  web: bump the wdio group in /tests/wdio with 4 updates (#7696)
  events: include user agent in events (#7693)
  web: fix labels on group view page (#7677)
  website/docs: Add OIDC auth integration with Nextcloud (#7406)
  web: fix locale (#7689)
  core: bump python from 3.11.5-bookworm to 3.12.0-bookworm (#7048)
  translate: Updates for file web/xliff/en.xlf in zh_TW (#7688)
  web: bump pyright from 1.1.336 to 1.1.337 in /web (#7681)
  core: bump sentry-sdk from 1.35.0 to 1.36.0 (#7683)
  website: bump prism-react-renderer from 2.2.0 to 2.3.0 in /website (#7685)
  web: bump the sentry group in /web with 2 updates (#7679)
  web: bump rollup from 4.5.0 to 4.5.1 in /web (#7680)
  web: bump @types/codemirror from 5.60.14 to 5.60.15 in /web (#7682)
  web: bump the wdio group in /tests/wdio with 2 updates (#7684)
  website: bump react-tooltip from 5.23.0 to 5.24.0 in /website (#7686)
  core: bump goauthentik.io/api/v3 from 3.2023103.4 to 3.2023104.1 (#7687)
  website/blog: Blog on security (#7671)
  ...
@astro-stan astro-stan deleted the add-nextcloud-oidc-docs branch November 30, 2023 14:23
kensternberg-authentik added a commit that referenced this pull request Dec 8, 2023
@kensternberg-authentik
Merge branch 'main' into web/standalone-description-lists
4795488 
* main: (219 commits)
  web: bump the wdio group in /tests/wdio with 2 updates (#7702)
  events: fix lint (#7700)
  events: add better fallback for sanitize_item to ensure everything can be saved as JSON (#7694)
  web: bump the wdio group in /tests/wdio with 4 updates (#7696)
  events: include user agent in events (#7693)
  web: fix labels on group view page (#7677)
  website/docs: Add OIDC auth integration with Nextcloud (#7406)
  web: fix locale (#7689)
  core: bump python from 3.11.5-bookworm to 3.12.0-bookworm (#7048)
  translate: Updates for file web/xliff/en.xlf in zh_TW (#7688)
  web: bump pyright from 1.1.336 to 1.1.337 in /web (#7681)
  core: bump sentry-sdk from 1.35.0 to 1.36.0 (#7683)
  website: bump prism-react-renderer from 2.2.0 to 2.3.0 in /website (#7685)
  web: bump the sentry group in /web with 2 updates (#7679)
  web: bump rollup from 4.5.0 to 4.5.1 in /web (#7680)
  web: bump @types/codemirror from 5.60.14 to 5.60.15 in /web (#7682)
  web: bump the wdio group in /tests/wdio with 2 updates (#7684)
  website: bump react-tooltip from 5.23.0 to 5.24.0 in /website (#7686)
  core: bump goauthentik.io/api/v3 from 3.2023103.4 to 3.2023104.1 (#7687)
  website/blog: Blog on security (#7671)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tanberry tanberry tanberry requested changes

@rissson rissson rissson approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@astro-stan @rissson @tanberry @BeryJu