documentation update

yaptide · Oct 17, 2023 · 596f667 · 596f667
1 parent 2eae46e
commit 596f667
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/authentication.md b/docs/authentication.md
@@ -0,0 +1,18 @@
+# Authentication
+
+Yaptide platform can authenticate users using two methods:
+
+  * using own database of users. In that case submission of simulation is limited only to a local pool of workers.
+  * using Keycloak server. Such server is provided for example in PLGrid infrastructure. This solution offers a possibility to submit simulations to an HPC cluster.
+
+
+Configuration of keycloak is based on following environmental variables:
+
+  * `KEYCLOAK_BASE_URL` - URL of the keycloak server, for example `'https://sso.pre.plgrid.pl'`
+  * `KEYCLOAK_REALM` - name of the realm, for example `PLGrid`
+  * `KEYCLOAK_CLIENT_ID` - name of the client, for example `yaptide`
+
+  These variables needs to be provided to the docker compose files via the `.env` file, both for backend and the frontend parts.
+  The backend propagates this variable to the `yaptide_flask` container, to be able to verify keycloak tokens.
+  The frontend needs to know the URL of the keycloak server, so it can redirect the user to the login page.
+  To properly setup these variables in case of ansible deployment, please use `plgrid_vars.yml` as an example.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -19,6 +19,7 @@ nav:
   - Overview: index.md
   - Maintenance: maintenance.md
   - Simulators: simulators.md
+  - Authentication: authentication.md
   - Cloud deploy: ansible.md
 
 plugins: