Skip to content

Commit

Permalink
docs(user verification): Update documentation to include new email/ph…
Browse files Browse the repository at this point in the history 
…one verification settings

This commit updates the documentation to include information about the new email/phone verification settings added in a previous commit. The updated documentation ensures that developers and users are aware of the new feature and how to use it in their applications.
  • Loading branch information
@khashashin
khashashin committed Feb 10, 2023
1 parent 94eef32 commit 7712482
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,16 @@ APPWRITE = {
'PROJECT_ENDPOINT': 'https://example.com/v1',
'PROJECT_ID': 'PROJECT_ID',
'PROJECT_API_KEY': 'PROJECT_API_KEY',
'USER_ID_HEADER': 'USER_ID',
}
```
| Setting | Default | Description |
|--------------------|-----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
| `PROJECT_ENDPOINT` | | The endpoint of your Appwrite project. You can find this in the Appwrite console under Settings > General. |
| `PROJECT_ID` | | The ID of your Appwrite project. You can find this in the Appwrite console under Settings > General. |
| `PROJECT_API_KEY` | | The API key of your Appwrite project. You can find this in the Appwrite console under Settings > API Keys. |
| `USER_ID_HEADER` | HTTP_USER_ID | The header name that will be used to store the user ID. |
| Setting | Default | Description |
|--------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `PROJECT_ENDPOINT` | | The endpoint of your Appwrite project. You can find this in the Appwrite console under Settings > General. |
| `PROJECT_ID` | | The ID of your Appwrite project. You can find this in the Appwrite console under Settings > General. |
| `PROJECT_API_KEY` | | The API key of your Appwrite project. You can find this in the Appwrite console under Settings > API Keys. |
| `USER_ID_HEADER` | HTTP_USER_ID | The header name that will be used to store the user ID. |
| `VERIFY_EMAIL` | False | If set to `True`, the middleware will check if the user's email address has been verified in Appwrite before authenticating the user. If the email address has not been verified, the user will not be authenticated. |
| `VERIFY_PHONE` | False | If set to `True`, the middleware will check if the user's phone number has been verified in Appwrite before authenticating the user. If the phone number has not been verified, the user will not be authenticated. |

## How it works
This middleware class will get the user ID from the header specified in the `USER_ID_HEADER` setting.
Expand Down

0 comments on commit 7712482

Please sign in to comment.