-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added logo and more info on authentication
- Loading branch information
1 parent
ff55a65
commit f53f117
Showing
6 changed files
with
106 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,19 @@ | ||
# Authentication | ||
|
||
Authentication providers are defined in `application.json` under `auth.providers`. The default provider is `polkadot`. You can also turn on `google` auth provider and specify roles according to your domain. | ||
|
||
## Polkadot authentication | ||
|
||
Users are registered with their polkadot addresses. | ||
|
||
Users have to have valid NFTs in their wallet in order to access the physical space and certain parts of the app. | ||
|
||
### Wallet Connect | ||
|
||
Wallet Connect allows your users to log in using their mobile devices. It is advisable to turn this feature on. In order to activate Wallet Connect integration you have to provide `WALLET_CONNECT_PROJECT_ID` in your `.env` file. | ||
|
||
Feel free to modify `AUTH_MESSAGE_TO_SIGN` to be any string you prefer instead of a random default string. | ||
|
||
## Google authentication | ||
|
||
Users can register using Google SSO. An automatic role can be configured and given based on the email domains users are registering with. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# Users module | ||
|
||
### Configuring profile fields | ||
|
||
Contact fields are displayed when users are onboarding. Users can modify contact fields in their profile after the onboarding as well. | ||
|
||
You can configure which contact fields are required for your instance by setting `required` to true or false. | ||
|
||
You can change the displayed field names for them by modifying `fieldName` values. | ||
|
||
If you do not want to use a certain field, you can remove its configuration entirely and it wont be shown. | ||
|
||
e.g | ||
|
||
```json | ||
"metadata": { | ||
"profileFields": { | ||
"birthday": { | ||
"label": "Birthday", | ||
"required": false | ||
}, | ||
"team": { | ||
"label": "Team", | ||
"placeholder": "Team name", | ||
"required": false | ||
}, | ||
"jobTitle": { | ||
"label": "What do you do?", | ||
"placeholder": "Rust Engineer", | ||
"required": false | ||
}, | ||
"bio": { | ||
"label": "Notes about you", | ||
"placeholder": "Leave here any notes that may be helpful to others: how to work with you, scope of responsibility, extra contact information, or literally anything you want to share with people visiting your profile.", | ||
"required": false | ||
}, | ||
"contacts": { | ||
"matrix": { | ||
"label": "Matrix Handle", | ||
"placeholder": "@username:example.com", | ||
"required": true, | ||
"prefix": "https://matrix.to/#/@" | ||
}, | ||
"github": { | ||
"label": "GitHub", | ||
"placeholder": "username", | ||
"required": false, | ||
"prefix": "https://github.com/" | ||
}, | ||
"telegram": { | ||
"label": "Telegram", | ||
"placeholder": "username", | ||
"required": false, | ||
"prefix": "https://t.me/" | ||
}, | ||
"signal": { | ||
"label": "Signal", | ||
"placeholder": "username", | ||
"required": false, | ||
"prefix": "https://signal.me/#p/" | ||
}, | ||
"twitter": { | ||
"label": "Twitter", | ||
"placeholder": "username", | ||
"required": false, | ||
"prefix": "https://twitter.com/" | ||
} | ||
} | ||
} | ||
} | ||
|
||
``` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters