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/integrations: all general cleanup and updates #12716

Draft
wants to merge 22 commits into
base: main
Choose a base branch
from

Conversation

dominic-r
Copy link
Contributor

@dominic-r dominic-r commented Jan 17, 2025

sdko/integration-batch-updates/a

What?

This is part A of the series of PRs to update all integration documentation and remove outdated elements.

Updating all integrations to use the new format for the "authentik configuration" section is a giant part of this. Most integrations use the old application/provider format, this needs to be updated to prepare for the 2025.2 release. Furthermore, some integrations were updated to include the "short" app/provider config. The long config is preferred to retain more information/make docs clearer.

Then, there's general cleanup here and there and matching the style guide.

Notable changes

Addition of IntegrationsMultilineCodeblock

Adds a IntegrationsMultilineCodeblock React component to easily render codeblocks containing <em> tags for example. It is more reusable than using <pre>s and <code>s everywhere. One drawback: All affected files will need to be renamed from .md to .mdx for the component to load correctly. Since @GirlBossRush and I are modifying integration documentation, this is going to be fun for one of us (Probably me) as the majority of the files will need to be renamed.

Needs styling fixes... badly

Usage

import IntegrationsMultilineCodeblock from "@site/src/components/Integrations/IntegrationsCodeblock"

<IntegrationsMultilineCodeblock>
{`
What has to be said
`}
</IntegrationsMultilineCodeblock>

Addition to style guide

  • Usage for multiline codeblocks
  • If need to specify env variable ex: ${OIDC_CLIENT_SECRET}, add $\{OIDC_CLIENT_SECRET} to not add build error.

OIDC configuration for Bookstack

Added configuration to log into Bookstack w/ OIDC instead of just SAML.

Rewriting the AWS integration documentation

This PR introduces a complete rewrite of the AWS documentation including a long awaited and needed restructuring.

Move React component imports to top of file

Moves all imports to react components / tab stuff to the top of the file to make it clearer and follow best-practices

Adding references

At least one reference has been added to each integration documentation page. It would be fun/ideal to require this for future documentation...!

Actual budget configure with env variables/json

You can also configure actual budget w/ env vars or the json file instead of playing around in the ui... interesting

Internal links

Copy link

netlify bot commented Jan 17, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 2dd7a8e
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67a1081e6a6f400008e8475d

Copy link

netlify bot commented Jan 17, 2025

Deploy Preview for authentik-docs canceled.

Name Link
🔨 Latest commit 2dd7a8e
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67a1081eb94f7f0008535af3

Copy link

codecov bot commented Jan 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.67%. Comparing base (e4b6df3) to head (2dd7a8e).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12716      +/-   ##
==========================================
- Coverage   92.72%   92.67%   -0.06%     
==========================================
  Files         770      770              
  Lines       38945    38945              
==========================================
- Hits        36112    36091      -21     
- Misses       2833     2854      +21     
Flag Coverage Δ
e2e 48.46% <ø> (-0.09%) ⬇️
integration 24.59% <ø> (ø)
unit 90.37% <ø> (+<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.

@tanberry tanberry changed the title website/integrations: all: general cleanup and updates website/integrations: all general cleanup and updates Jan 17, 2025
7. For the **IdP Entity ID** field, enter: `https://authentik.company/application/saml/fortimanager/sso/binding/redirect/`
8. Set the **IdP Login URL** to: `https://authentik.company/application/saml/fortimanager/sso/binding/redirect/`
9. Set the **IdP Logout URL** to: `https://authentik.company/`
10. In the **IdP Certificate** field, import your authentik certificate (either self-signed or valid).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

TODO: Needs clarification of where it can be found and how it's configured

2. Under **Single Sign-On Mode**, choose **Service Provider (SP)** to enable SAML authentication.
3. Set the **SP Address** field to the FortiManager FQDN, <kbd>fortimanager.company</em>. This provides the URLs needed for configuration in authentik.
4. Choose the **Default Login Page** as either **Normal** or **Single Sign-On**. Selecting **Normal** allows both local and SAML authentication, while **Single Sign-On** restricts login to SAML only.
5. By default, FortiManager creates a new user if one does not exist. Set the **Default Admin Profile** to assign the desired permissions to new users. A `no_permissions` profile is created by default for this purpose.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

TODO: Where is that no_permissions profile, what is it, how? IDK

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.

Thank you @4d62 !

@dominic-r
Copy link
Contributor Author

@tanberry I don't think this is ready for merge yet. I'll finish, if you don't mind, all of the section outlined in notion before merging. Just to not make too many of these

@dominic-r dominic-r force-pushed the sdko/integration-batch-updates/a branch 2 times, most recently from 6e7b72e to ec33301 Compare January 31, 2025 19:53
Update integrations: Apache Guacamole, ArgoCD, Arube Orchestrator

website/integrations: wmigr + cleanup: work on batch a

website/integrations: all: add note about default values + fix build

try this

Signed-off-by: 4d62 <git@sdko.org>

Update website/integrations/services/apache-guacamole/index.mdx

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: 4d62 <git@sdko.org>

website/integrations: batch-a: fix some stuff and kbd try

website/integrations: freshrss + gatus: cleanup

website/integrations: frappe: cleanup

website/integrations: fortimanager: cleanup

website/integrations: fix build

website/integrations: fortimanager: set more <em>s and <kbd>s

website/integrations: fortimanager: fix build

website/integrations: aws: wow this is taking longer than I imagined

a few scim things i can add back but idk heh

included w/ goauthentik#12777 now
@dominic-r dominic-r force-pushed the sdko/integration-batch-updates/a branch from ec33301 to e4217aa Compare January 31, 2025 19:57
@dominic-r
Copy link
Contributor Author

dominic-r commented Feb 1, 2025

Hi @kensternberg-authentik , would it be possible to take a look at this react component I added + It's implementation when you have a second? Thanks in advance! The default codeblock in markdown ``` has some sort of copy button, I could mabye try piggy-backing on that?

nicedevil007 added a commit to nicedevil007/authentik that referenced this pull request Feb 2, 2025
goauthentik#12716

Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com>
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