Skip to content

Add SSO technical documentation page #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Feb 18, 2021
Merged

Add SSO technical documentation page #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
866d31e
Add SSO technical documentation page
Convly Jan 18, 2021
f9dfafd
Add SSO to the sidebar
Convly Jan 18, 2021
e079385
Update the pr with the review & new features
Convly Jan 29, 2021
30b14a1
Add gold badge for sso
Convly Feb 4, 2021
aa8ad24
Add npm/yarn tabs for strategies installation
Convly Feb 15, 2021
b0e41f9
Use better wording for admin.url option
Convly Feb 15, 2021
1b44f9c
Add comments & filenames for code examples help the user understand w…
Convly Feb 15, 2021
b798a2c
Add information about the callback URL + add comments for the custom …
Convly Feb 15, 2021
ffcd142
Merge branch 'main' into dev/concept-sso
pwizla Feb 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions developer-docs/.vuepress/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@ module.exports = {
'/latest/concepts/requests-responses',
'/latest/concepts/routing',
'/latest/concepts/services',
'/latest/concepts/sso',
'/latest/concepts/templates',
'/latest/concepts/webhooks',
],
Expand Down
13 changes: 12 additions & 1 deletion developer-docs/latest/concepts/configurations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ This is an example of a full configuration, typically certain keys do not need t

**Path —** `./config/server.js`.

```js
```javascript
module.exports = ({ env }) => ({
host: env('HOST', '0.0.0.0'),
port: env.int('PORT', 1337),
Expand All @@ -226,6 +226,14 @@ module.exports = ({ env }) => ({
},
admin: {
auth: {
events: {
onConnectionSuccess(e) {
console.log(e.user, e.provider);
},
onConnectionError(e) {
console.error(e.error, e.provider);
},
},
secret: env('ADMIN_JWT_SECRET', 'someSecretKey'),
},
url: env('PUBLIC_ADMIN_URL', '/dashboard'),
Expand Down Expand Up @@ -264,6 +272,9 @@ module.exports = ({ env }) => ({
| `admin` | Admin panel configuration | Object | |
| `admin.auth` | Authentication configuration | Object | |
| `admin.auth.secret`| Secret used to encode JWT tokens | string| `undefined` |
| `admin.auth.events`| Record of all the events subscribers registered for the authentication | object| `{}` |
| `admin.auth.events.onConnectionSuccess`| Function called when an admin user log in successfully to the administration panel | function | `undefined` |
| `admin.auth.events.onConnectionError`| Function called when an admin user fails to log in to the administration panel | function| `undefined` |
| `admin.url` | Url of your admin panel. Default value: `/admin`. Note: If the url is relative, it will be concatenated with `url`. | string | `/admin` |
| `admin.autoOpen` | Enable or disabled administration opening on start. | boolean | `true` |
| `admin.watchIgnoreFiles` | Add custom files that should not be watched during development. See more [here](https://github.com/paulmillr/chokidar#path-filtering) (property `ignored`). | Array(string) | `[]` |
Expand Down
Loading