From d4e15f0f3957b0efa877a9ff94a3117759ac1a58 Mon Sep 17 00:00:00 2001 From: 4d62 Date: Thu, 2 Jan 2025 09:16:58 -0500 Subject: [PATCH] website/integrations: meshcentral: document (#12509) * website/integrations: meshcentral: apply patch from previous mr Applies patch taken from https://patch-diff.githubusercontent.com/raw/goauthentik/authentik/pull/10490.patch * website/integrations: meshcentral: lint Lints code with prettier * website/integrations: meshcentral: cleanup * Updates header to match the template * Update preparation text * Add docsowhateveritscalled :::info's * Remove image * Text says "add x to config", adding `(...)` isn't needed IMO * Update website/integrations/services/meshcentral/index.md Co-authored-by: Tana M Berry Signed-off-by: 4d62 --------- Signed-off-by: 4d62 Co-authored-by: Tana M Berry --- .../services/meshcentral/index.md | 58 +++++++++++++++++++ website/sidebarsIntegrations.js | 1 + 2 files changed, 59 insertions(+) create mode 100644 website/integrations/services/meshcentral/index.md diff --git a/website/integrations/services/meshcentral/index.md b/website/integrations/services/meshcentral/index.md new file mode 100644 index 0000000000..bb66fa21cb --- /dev/null +++ b/website/integrations/services/meshcentral/index.md @@ -0,0 +1,58 @@ +--- +title: Integrate with MeshCentral +sidebar_label: MeshCentral +--- + +Support level: Community + +## 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": "", + "clientsecret": "", + "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. diff --git a/website/sidebarsIntegrations.js b/website/sidebarsIntegrations.js index d1e67fb39c..19d9df6249 100644 --- a/website/sidebarsIntegrations.js +++ b/website/sidebarsIntegrations.js @@ -83,6 +83,7 @@ module.exports = { "services/harbor/index", "services/hashicorp-vault/index", "services/jenkins/index", + "services/meshcentral/index", "services/minio/index", "services/netbox/index", "services/pgadmin/index",