Skip to content

website/integrations: improves netbird documentation#14191

Merged
dewi-tik merged 6 commits intomainfrom
website/integrations/improve-netbird-doc
Apr 24, 2025
Merged

website/integrations: improves netbird documentation#14191
dewi-tik merged 6 commits intomainfrom
website/integrations/improve-netbird-doc

Conversation

@dewi-tik
Copy link
Contributor

Details

Closes #14156

Improves the NetBird documentation and brings it more in line with the official NetBird documentation


Checklist

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

@netlify
Copy link

netlify bot commented Apr 23, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 2e867db
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/6809e9f35c7fa80008a2cb4f
😎 Deploy Preview https://deploy-preview-14191--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.

@netlify
Copy link

netlify bot commented Apr 23, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 2e867db
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/6809e9f378d445000814f99d

@codecov
Copy link

codecov bot commented Apr 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.75%. Comparing base (2cc5f4b) to head (2e867db).
Report is 16 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14191      +/-   ##
==========================================
- Coverage   92.80%   92.75%   -0.05%     
==========================================
  Files         808      809       +1     
  Lines       41419    41533     +114     
==========================================
+ Hits        38440    38526      +86     
- Misses       2979     3007      +28     
Flag Coverage Δ
e2e 47.85% <ø> (+0.04%) ⬆️
integration 24.39% <ø> (+0.14%) ⬆️
unit 90.57% <ø> (-0.08%) ⬇️

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.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 23, 2025

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-2e867db32c2e55a3e0f56d6aa60330a0b1d0ac8f
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-2e867db32c2e55a3e0f56d6aa60330a0b1d0ac8f

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

@dewi-tik dewi-tik marked this pull request as ready for review April 23, 2025 10:44
@dewi-tik dewi-tik requested a review from a team as a code owner April 23, 2025 10:44
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.

Looks good, thanks so much @dewi-tik !

Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>
Copy link
Member

@dominic-r dominic-r left a comment

Choose a reason for hiding this comment

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

Thanks. A few more nits, then LGTM

tanberry and others added 2 commits April 23, 2025 17:06
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com>
@dewi-tik dewi-tik enabled auto-merge (squash) April 24, 2025 07:37
@dewi-tik dewi-tik merged commit 5aedc8a into main Apr 24, 2025
88 checks passed
@dewi-tik dewi-tik deleted the website/integrations/improve-netbird-doc branch April 24, 2025 08:26
NETBIRD_AUTH_OIDC_CONFIGURATION_ENDPOINT="https://authentik.company/application/o/<application slug>/.well-known/openid-configuration"
NETBIRD_USE_AUTH0=false
NETBIRD_AUTH_CLIENT_ID="<Your Client ID>"
NETBIRD_AUTH_SUPPORTED_SCOPES="openid profile email offline_access api"

Choose a reason for hiding this comment

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

I think this variable can be removed. NETBIRD_AUTH_AUDIENCE
This is a public client and there is not Client Secret to set

kensternberg-authentik added a commit that referenced this pull request Apr 25, 2025
* main:
  web: Safari fixes merge branch (#14181)
  website: bump the build group in /website with 9 updates (#14204)
  website: bump typescript from 5.8.2 to 5.8.3 in /website (#13786)
  lifecycle/migrate: fix migration failing if killed during first startup (#14207)
  core, web: update translations (#14203)
  lifecycle/aws: bump aws-cdk from 2.1010.0 to 2.1012.0 in /lifecycle/aws (#14205)
  website/integrations: improves netbird documentation (#14191)
  website/docs: updated user count info (#14186)
  website/docs: rearranged brands docs (#14116)
  website: integrations: apache guacamole: remove redirect URI comments (#14113)
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.

Improving Netbird documentation

4 participants