chore(docs): add sso with azure documentation (#95)

Document the necessary steps to setup oauth with Microsoft Azure. Part of #53
ametnes · May 25, 2024 · e925c67 · e925c67
1 parent 05c0008
commit e925c67
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -45,6 +45,8 @@ nav:
       - 'installing/ametnes.md'
   - 'Access Control': 'rbac.md'
   - 'App Integration': 'apps/example.ipynb'
+  - 'Single Sign On':
+      - 'sso/azure.md'
   - 'Development Guide':
       - 'Local Development': 'dev-guide/local.md'
       - 'Architecture': 'dev-guide/architecture.md'

diff --git a/docs/src/sso/azure.md b/docs/src/sso/azure.md
@@ -0,0 +1,36 @@
+# Setup SSO with Azure
+
+## Register your application with Azure
+First register your application with Azure using the steps described <a href="https://learn.microsoft.com/en-us/azure/active-directory-b2c/client-credentials-grant-flow?pivots=b2c-user-flow" target="_blank">here</a>.
+
+Take note of these;
+
+2. Azure Client ID
+2. Azure Tenant ID
+
+## Configure Nesis
+To configure Nesis for Azure, set these environment variables for the respective microservices;
+
+### Frontend
+
+In the frontend, set
+
+```
+NESIS_OAUTH_AZURE_ENABLED: true
+NESIS_OAUTH_AZURE_CLIENT_ID: 00000000-0000-0000-0000-000000000
+NESIS_OAUTH_AZURE_REDIRECTURI: http[s]://your.nesis.host.name/
+NESIS_OAUTH_TOKEN_KEY: __some__random_secure_key___
+NESIS_OAUTH_TOKEN_VALUE: ___some___other___very__random___key
+```
+
+In the api service, set
+```
+NESIS_OAUTH_TOKEN_KEY: __some__random_secure_key___
+NESIS_OAUTH_TOKEN_VALUE: ___some___other___very__random___key
+```
+
+!!! warning "Important"
+
+    The key `NESIS_OAUTH_TOKEN_KEY` and value `NESIS_OAUTH_TOKEN_VALUE` must match in both services.
+
+You should now be able to authenticate with Microsoft Azure.