From 35679f5abbdff358f1a778aefe3468e298372495 Mon Sep 17 00:00:00 2001 From: Darrin <54423468+obsidiangroup@users.noreply.github.com> Date: Tue, 25 Oct 2022 06:12:57 -0400 Subject: [PATCH] website/integrations: Add TrueCommand integration (#3819) * Create index.md Initial checkin of truecommand integration Signed-off-by: Darrin <54423468+obsidiangroup@users.noreply.github.com> * Update index.md First draft Signed-off-by: Darrin <54423468+obsidiangroup@users.noreply.github.com> * Add TrueCommand Integration Signed-off-by: Darrin <54423468+obsidiangroup@users.noreply.github.com> * website: run prettier on truecommand integration. * Update website/integrations/services/truecommand/index.md Co-authored-by: Jens L. Signed-off-by: Darrin <54423468+obsidiangroup@users.noreply.github.com> * Update website/integrations/services/truecommand/index.md Co-authored-by: Jens L. Signed-off-by: Darrin <54423468+obsidiangroup@users.noreply.github.com> * Update website/integrations/services/truecommand/index.md Co-authored-by: Jens L. Signed-off-by: Darrin <54423468+obsidiangroup@users.noreply.github.com> * Change name to TrueNAS TrueCommand, update SAML Attribute. Signed-off-by: Darrin <54423468+obsidiangroup@users.noreply.github.com> Signed-off-by: Darrin <54423468+obsidiangroup@users.noreply.github.com> Co-authored-by: Darrin Walton Co-authored-by: Jens L. --- .../services/truecommand/index.md | 117 ++++++++++++++++++ website/sidebarsIntegrations.js | 1 + 2 files changed, 118 insertions(+) create mode 100644 website/integrations/services/truecommand/index.md diff --git a/website/integrations/services/truecommand/index.md b/website/integrations/services/truecommand/index.md new file mode 100644 index 000000000..d30d02a46 --- /dev/null +++ b/website/integrations/services/truecommand/index.md @@ -0,0 +1,117 @@ +--- +title: TrueNAS TrueCommand +--- + +Support level: Community + +## What is TrueNAS TrueCommand + +From https://www.truenas.com/truecommand/ +:::note +What is TrueCommand? +TrueCommand is a ZFS-aware solution allowing you to set custom alerts on statistics like ARC usage or pool capacity and ensuring storag +e uptime and future planning. TrueCommand also identifies and pinpoints errors on drives or vdevs (RAID groups), saving you valuable ti +me when resolving issues. +::: + +:::warning +This setup assumes you will be using HTTPS as TrueCommand generates ACS and Redirect URLs based on the complete URL. +::: + +## Preparation + +The following placeholders will be used: + +- `truecommand.company` is the FQDN of the snipe-it install. +- `authentik.company` is the FQDN of the authentik install. + +Create an application in authentik and use the slug for later as `truenas-truecommand`. + +Create a SAML provider with the following parameters: + +- ACS URL: `https://truecommand.company/saml/acs` +- Issuer: `truecommand-saml` +- Binding: `Post` + +Under _Advanced protocol settings_, set a certificate for _Signing Certificate_. +Under _Advanced protocol settings_, set NameID Property to _authentik default SAML Mapping: Email_. + +## SAML Property Mappings + +The following custom property mappings are required. + +Under _Customisation_, select _Property Mappings_, then _Create_. Select _SAML Property Mapping_. + +### Username + +- Name: `Truecommand - Username` +- SAML Attribute Name: `unique_name` +- Expression + +```python +return request.user.username +``` + +### Email + +- Name: `Truecommand - Email` +- SAML Attribute Name: `email` +- Expression + +```python +return request.user.email +``` + +### Fullname + +- Name: `Truecommand - Fullname` +- SAML Attribute Name: `given_name` OR `display_name` +- Expression + +```python +return request.user.name +``` + +### Other Attributes + +If you have custom attributes, or attributes imported from Active Directory, TrueCommand supports the following additional mappings: + +#### Role + +- Name: `Truecommand - Role` +- SAML Attribute Name: `title` +- Expression + +```python +return [custom_attribute] +``` + +#### Phone Number + +- Name: `Truecommand - Phone Number` +- SAML Attribute Name: `telephone_number` +- Expression + +```python +return [custom_attribute] +``` + +Return to _Providers_ under _Applications_, and edit the Provider created above. + +Under _Advanced protocol settings_, select the additional property mappings created above. + +### SAML Metadata + +Click the _Copy download URL_ to save the Metadata URL into your clipboard. + +## TrueCommand Config + +- Click on the gear icon in the upper right corner. +- Select Administration +- Click on CONFIGURE +- SAML Identity Provider URL: `Paste the Metadata URL from your clipboard.` +- Click _Save_, then click _Configure_ again then select _Start the SAML service_, then click _Save_ to start the service. + +## Additional Resources + +- https://www.truenas.com/docs/truecommand/administration/settings/samlad/ diff --git a/website/sidebarsIntegrations.js b/website/sidebarsIntegrations.js index fe1bbc402..89b929591 100644 --- a/website/sidebarsIntegrations.js +++ b/website/sidebarsIntegrations.js @@ -75,6 +75,7 @@ module.exports = { "services/pgadmin/index", "services/powerdns-admin/index", "services/snipe-it/index", + "services/truecommand/index", "services/veeam-enterprise-manager/index", ], },