From 4e4849e7bcabfcd9645e0fd63e5845fe2ed15b27 Mon Sep 17 00:00:00 2001 From: Sylvain Date: Wed, 13 Oct 2021 09:09:58 +0200 Subject: [PATCH] Updated SSO documentation --- CHANGELOG.md | 1 + doc/sso_with_github.md | 4 +++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 061dcbcea..deb5966ee 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ # Changelog Fab-manager - Updated production documentation +- Updated SSO documentation - Improved stripe subscription process with better error handling - The upgrade script will check and report the ability to access the hub API - Fix a bug: missing translations diff --git a/doc/sso_with_github.md b/doc/sso_with_github.md index ee61dcf76..26b92fee2 100644 --- a/doc/sso_with_github.md +++ b/doc/sso_with_github.md @@ -33,6 +33,8 @@ For this guide, we will use [GitHub](https://developer.github.com/v3/oauth/) as - **Client identifier**: Your Client ID, collected just before. - **Client secret**: Your Client Secret, collected just before. +Please note that in some cases we'll encounter an issue unless the **common URL** must only contain the root domain (e.g. `http://github.com`), and the other parts of the URL must go to **Authorization endpoint** (e.g. `/login/oauth/authorize`) and **Token Acquisition Endpoint** (e.g. `/login/oauth/access_token`). + - Then you will need to define the matching of the fields between the Fab-manager and what the external SSO can provide. Please note that the only mandatory field is `User.uid`. To continue with our GitHub example, you will need to look at [this documentation page](https://developer.github.com/v3/users/#get-the-authenticated-user) to know witch field can be mapped and how, and [this one](https://developer.github.com/v3/) to know the root URL of the API. @@ -59,7 +61,7 @@ rails fablab:auth:switch_provider[GitHub] - As the command just prompted you, you have to re-compile the assets - In development, `rails tmp:clear` will do the job. - - In production with Docker, `rm -rf public/assets`, followed by `docker-compose run --rm fabmanager bundle exec rails assets:precompile` + - In production with Docker, `rm -rf public/packs`, followed by `docker-compose run --rm fabmanager bundle exec rails assets:precompile` - Then restart the web-server or the container. - Finally, to notify all existing users about the change (and send them their migration code/link), run: ```bash