A full-featured CRM built with React, shadcn/ui, and Supabase.
[Doc] Add SSO documentation
Gildasb69a472dafa2
diff --git a/doc/src/content/docs/developers/sso.mdx b/doc/src/content/docs/developers/sso.mdxnew file mode 100644index 00000000..70acea35--- /dev/null+++ b/doc/src/content/docs/developers/sso.mdx@@ -0,0 +1,88 @@+---+title: Configuring SSO+description: This document explains how to configure SSO for Atomic CRM.+---++## Enable SSO in Supabase++In _Authentication > Sign in / Providers_, enable _SAML 2.0_+++## Setup Google Workplace++1. **Open your [Google Workplace Console](https://admin.google.com/) and go to _Apps > Web and mobile apps_**+ ++2. **Choose to add custom SAML app**+ ++3. **Fill out app details**++ The information you enter here is for visibility into your Google Workspace. You can choose any values you like. _Atomic CRM_ as a name works well for most use cases. Optionally enter a description and a logo.+ ++4. **Download IdP metadata**++ This is a very important step. Click on _DOWNLOAD METADATA_ and save the file that was downloaded. You will need to upload this file later.+ +++5. **Add service provider details**++ Fill out these service provider details on the next screen. Replace `<project>` with your Supabase project identifier in the URLs below.++ | Detail | Value |+ |--------|-------|+ | ACS URL | https://<project>.supabase.co/auth/v1/sso/saml/acs |+ | Entity ID | https://<project>.supabase.co/auth/v1/sso/saml/metadata |+ | Start URL | Your application URL (optional) |+ | Name ID format | EMAIL |+ | Name ID | Basic Information > Primary email |++ ++6. **Configure attribute mapping**++ To properly map the identity details to the sales fields in Atomic CRM, add the following mappings:++ | Google Directory attributes | App attributes |+ |-----------------------------|----------------|+ | Primary email | `email` |+ | First name | `first_name` |+ | Last name | `last_name` |++ ++7. **Configure user access**++ You can configure which Google Workspace user accounts will get access to Atomic CRM. This is important if you wish to limit access to your software engineering teams.++ You can configure this access by clicking on the _User access_ card (or down-arrow). Follow the instructions on screen.+ ++8. **Save the following JSON in a mapping.json file**+ ```json+ {+ "keys": {+ "email": {+ "name": "email"+ },+ "first_name": {+ "name": "first_name"+ },+ "last_name": {+ "name": "last_name"+ }+ }+ }+ ```++9. **Register the SSO Provider**++ Run the following command:+ ```sh+ npx supabase sso add --type saml --project-ref <your-project> \+ --metadata-file /path/to/saml/metadata.xml \+ --attribute-mapping-file /path/to/mapping.json \+ --domains company.com+ ```diff --git a/doc/src/content/images/sso-google-1.png b/doc/src/content/images/sso-google-1.pngnew file mode 100644index 00000000..eb003bc9Binary files /dev/null and b/doc/src/content/images/sso-google-1.png differdiff --git a/doc/src/content/images/sso-google-2.png b/doc/src/content/images/sso-google-2.pngnew file mode 100644index 00000000..17e852a5Binary files /dev/null and b/doc/src/content/images/sso-google-2.png differdiff --git a/doc/src/content/images/sso-google-3.png b/doc/src/content/images/sso-google-3.pngnew file mode 100644index 00000000..260076beBinary files /dev/null and b/doc/src/content/images/sso-google-3.png differdiff --git a/doc/src/content/images/sso-google-4.png b/doc/src/content/images/sso-google-4.pngnew file mode 100644index 00000000..3b02de5eBinary files /dev/null and b/doc/src/content/images/sso-google-4.png differdiff --git a/doc/src/content/images/sso-google-5.png b/doc/src/content/images/sso-google-5.pngnew file mode 100644index 00000000..f7cc4326Binary files /dev/null and b/doc/src/content/images/sso-google-5.png differdiff --git a/doc/src/content/images/sso-google-6.png b/doc/src/content/images/sso-google-6.pngnew file mode 100644index 00000000..00ff977bBinary files /dev/null and b/doc/src/content/images/sso-google-6.png differdiff --git a/doc/src/content/images/sso-google-7.png b/doc/src/content/images/sso-google-7.pngnew file mode 100644index 00000000..0edeceddBinary files /dev/null and b/doc/src/content/images/sso-google-7.png differdiff --git a/doc/src/content/images/sso-google-8.png b/doc/src/content/images/sso-google-8.pngnew file mode 100644index 00000000..a8a847cfBinary files /dev/null and b/doc/src/content/images/sso-google-8.png differ