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 docker outpost integration documentation for docker socket proxies #12644

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

itskagee
Copy link

  • Changed the docker socket proxy link to point to a better and more maintained solution.
  • Changed permissions to include System/Info.
  • Added a section on how to connect to a docker socket proxy.
  1. The existing solution is sparsely maintained. This new docker socket proxy solution is an enhanced and hardened fork of the current one and is actively maintained by a reputed team.
  2. System/Info permission is required, otherwise the outpost integration doesn't work.
  3. Most documentation on docker socket proxies list examples which connect over TCP, but that doesn't work with authentik. This can be confusing to the average user. Hence, added a section to reflect that connections must be made over HTTP.

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)

If applicable

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

- Changed the docker socket proxy link to point to a better and more maintained solution.
- Changed permissions to include System/Info.
- Added a section on how to connect to a docker socket proxy.

Signed-off-by: itskagee <[email protected]>
@itskagee itskagee requested a review from a team as a code owner January 11, 2025 16:00
Copy link

netlify bot commented Jan 11, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit c37eea6
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/678295b878b1a7000889d583
😎 Deploy Preview https://deploy-preview-12644--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 Jan 11, 2025

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit c37eea6
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/678295b86cda9300080a4025
😎 Deploy Preview https://deploy-preview-12644--authentik-storybook.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.

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.

1 participant