rooty/fab-manager
1
0
Fork 0
mirror of https://github.com/LaCasemate/fab-manager.git synced 2025-02-06 01:08:21 +01:00
Code Issues Releases Activity

Updated SSO documentation

Browse Source
This commit is contained in:
Sylvain 2021-10-13 09:09:58 +02:00
parent 6cd91d0291
commit 4e4849e7bc
2 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -1,6 +1,7 @@
# Changelog Fab-manager # Changelog Fab-manager
- Updated production documentation - Updated production documentation
- Updated SSO documentation
- Improved stripe subscription process with better error handling - Improved stripe subscription process with better error handling
- The upgrade script will check and report the ability to access the hub API - The upgrade script will check and report the ability to access the hub API
- Fix a bug: missing translations - Fix a bug: missing translations

4
doc/sso_with_github.md
View File

@ -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 identifier**: Your Client ID, collected just before.
- **Client secret**: Your Client Secret, 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. - 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`. 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. 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 - As the command just prompted you, you have to re-compile the assets
- In development, `rails tmp:clear` will do the job. - 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. - 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: - Finally, to notify all existing users about the change (and send them their migration code/link), run:
```bash ```bash