-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
website/integrations: Semaphore #12515
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
Merged
Merged
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
c093f46
Initial start of Semaphore UI docs
nicedevil007 4230021
Added Semaphore UI docs link
nicedevil007 0d6183f
Changed to mdx format
nicedevil007 6ba7900
Ran make lint-fix, make web and make website
nicedevil007 332f41f
Merge branch 'semaphore' of https://github.com/nicedevil007/authentik…
nicedevil007 18d288d
Added sidebar entry
nicedevil007 69a1673
added sidebar integration
nicedevil007 bceb904
now fixed sidebar integration
nicedevil007 07de32a
Update website/integrations/services/semaphore/index.mdx
nicedevil007 e76f1e3
Update website/integrations/services/semaphore/index.mdx
nicedevil007 edc8eb7
Update website/integrations/services/semaphore/index.mdx
nicedevil007 81ad6ed
Update website/integrations/services/semaphore/index.mdx
nicedevil007 e0ed36e
Update website/integrations/services/semaphore/index.mdx
nicedevil007 012217e
Update website/integrations/services/semaphore/index.mdx
nicedevil007 3eeeb0d
Update website/integrations/services/semaphore/index.mdx
nicedevil007 b81d791
Update website/integrations/services/semaphore/index.mdx
nicedevil007 97776e8
Update website/integrations/services/semaphore/index.mdx
nicedevil007 2b84156
Update website/integrations/services/semaphore/index.mdx
nicedevil007 3b27f55
Update to Feedback on PR ;)
nicedevil007 af84df3
Title…
nicedevil007 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| --- | ||
| title: Integrate with Semaphore UI | ||
| sidebar_label: Semaphore | ||
| --- | ||
|
|
||
| # Semaphore UI | ||
|
|
||
| <span class="badge badge--secondary">Support level: Community</span> | ||
|
|
||
| ## What is Semaphore UI | ||
|
|
||
| > Semaphore UI is a modern web interface for managing popular DevOps tools. | ||
| > -- https://semaphoreui.com/ | ||
| > | ||
| > This guide explains how to configure Semaphore UI to use authentik as the OAuth provider for logging in to the Web GUI. | ||
|
|
||
| ## Preparation | ||
|
|
||
| The following placeholders are used in this guide: | ||
|
|
||
| - `semaphore.company` is the FQDN of the Semaphore install. | ||
| - `authentik.company` is the FQDN of the authentik install. | ||
|
|
||
| ## authentik configuration | ||
|
|
||
| [Create](https://docs.goauthentik.io/docs/add-secure-apps/applications/manage_apps#add-new-applications) an OAuth2/OpenID provider and an application in authentik. Use the following parameters for the OAuth2/OpenID provider: | ||
|
|
||
|
nicedevil007 marked this conversation as resolved.
|
||
| **Provider:** | ||
|
|
||
| - Name: `SP-semaphore` | ||
| - Client type: `Confidential` | ||
| - Redirect URIs/Origins (RegEx): `https://semaphore.company/api/auth/oidc/authentik/redirect/` | ||
| - Signing Key: `authentik Self-signed Certificate` | ||
|
|
||
| Take note of the Client ID and Client Secret, you'll need to give them to Semaphore UI in Step 3. | ||
|
|
||
| Leave the rest as default values. The durations can be changed as needed. | ||
|
|
||
| **Application:** | ||
|
|
||
| - Name: `Semaphore UI` | ||
| - Slug: `semaphore` | ||
| - Launch URL: `https://semaphore.company/` | ||
|
|
||
| ## Semaphore UI configuration | ||
|
|
||
| Log in to your Semaphore UI host via SSH. Edit the `config.json` file (should be located under `/etc/semaphore`) file with the text editor of your choice. | ||
|
|
||
| Before the last curly brace, add the following content: | ||
|
|
||
| ``` | ||
| "oidc_providers": { | ||
| "authentik": { | ||
| "display_name": "SSO-Login", | ||
| "provider_url": "https://authentik.company/application/o/semaphore/", | ||
| "client_id": "<client-id>", | ||
| "client_secret": "<<< Client Secret >>>", | ||
| "redirect_url": "https://semaphore.company/api/auth/oidc/authentik/redirect/", | ||
| "username_claim": "username", | ||
| "name_claim": "name", | ||
| "email_claim": "email", | ||
| "scopes": ["openid", "profile", "email"] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| :::info | ||
| It is mandatory to include 'authentik' in lowercase letters. There should also be another curly brace above these lines. Make sure to add a `,` after it to maintain proper formatting. | ||
| ::: | ||
|
|
||
| More information on this can be found in the Semaphore documentation https://docs.semaphoreui.com/administration-guide/openid/authentik/. | ||
|
|
||
| Leave the rest as default. | ||
|
|
||
| ## Test the login | ||
|
nicedevil007 marked this conversation as resolved.
|
||
|
|
||
| - Open a browser of your choice and open the URL `https://semaphore.company`. | ||
| - Click on the SSO-Login button. | ||
| - You should be redirected to authentik (with the login flows you created) and then authentik should redirect you back to `https://semaphore.company` URL. | ||
| - If you are redirected back to the `https://semaphore.company` URL you did everything correct. | ||
|
|
||
| :::note Users are created upon logging in with authentik. They will not have the rights to create anything initially. These permissions must be assigned later by the local admin created during the first login to the Semaphore UI. ::: | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.