-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
website/integrations: meshcentral: document #12509
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
tanberry
merged 5 commits into
goauthentik:main
from
dominic-r:sdko/feat/integration/pickup-10490
Jan 2, 2025
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
ba56eab
website/integrations: meshcentral: apply patch from previous mr
9f866fd
website/integrations: meshcentral: lint
f5868cb
website/integrations: meshcentral: cleanup
fe9682a
Update website/integrations/services/meshcentral/index.md
074a12b
Merge branch 'goauthentik:main' into sdko/feat/integration/pickup-10490
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,58 @@ | ||
| --- | ||
| title: Integrate with MeshCentral | ||
| sidebar_label: MeshCentral | ||
| --- | ||
|
|
||
| <span class="badge badge--secondary">Support level: Community</span> | ||
|
|
||
| ## What is MeshCentral | ||
|
|
||
| > MeshCentral is a free, open source, web-based platform for remote device management. | ||
| > | ||
| > -- https://meshcentral.com | ||
|
|
||
| ## Preparation | ||
|
|
||
| The following placeholders are used in this guide: | ||
|
|
||
| - `meshcentral.company` is the FQDN of the MeshCentral install. | ||
| - `authentik.company` is the FQDN of the authentik install. | ||
|
|
||
| ## authentik configuration | ||
|
|
||
| Create an OAuth2/OpenID provider with the following parameters: | ||
|
|
||
| - Client Type: `Confidential` | ||
| - Redirect URIs: `https://meshcentral.company/auth-oidc-callback` | ||
| - Scopes: OpenID, Email and Profile | ||
| - Signing Key: Select any available key | ||
|
|
||
| Note the Client ID and Client Secret values. | ||
|
|
||
| Next, create an application, using the provider you've created above. | ||
|
|
||
| ## MeshCentral configuration | ||
|
|
||
| Edit the `config.json` file for your MeshCentral deployment, and add the following code in the `domains:` subsection: | ||
|
|
||
| :::info | ||
| For Docker deployments, the `config.json` should be located in the directory on the host machine you mapped to `/opt/meshcentral/meshcentral-data`. | ||
| ::: | ||
|
|
||
| :::info | ||
| If you need to enable advanced OIDC configurations, please refer to the [Using the OpenID Connect Strategy](https://ylianst.github.io/MeshCentral/meshcentral/openidConnectStrategy/) section in the MeshCentral documentation for detailed instructions. | ||
| ::: | ||
|
|
||
| ```json | ||
| "domains": { | ||
| "authStrategies": { | ||
| "oidc": { | ||
| "issuer": "https://authentik.company/application/o/meshcentral/", | ||
| "clientid": "<Client ID>", | ||
| "clientsecret": "<Client Secret>", | ||
| "newAccounts": true | ||
| } | ||
| }, | ||
| ``` | ||
|
|
||
| To ensure everything is setup correctly, restart your MeshCentral instance and visit the main page. You should be greeted with a new button to allow signing in with OIDC. | ||
|
dominic-r marked this conversation as resolved.
|
||
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.