Skip to content

Commit 7712482

Browse files
committed
docs(user verification): Update documentation to include new email/phone 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.
1 parent 94eef32 commit 7712482

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,16 @@ APPWRITE = {
4141
'PROJECT_ENDPOINT': 'https://example.com/v1',
4242
'PROJECT_ID': 'PROJECT_ID',
4343
'PROJECT_API_KEY': 'PROJECT_API_KEY',
44-
'USER_ID_HEADER': 'USER_ID',
4544
}
4645
```
47-
| Setting | Default | Description |
48-
|--------------------|-----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|
49-
| `PROJECT_ENDPOINT` | | The endpoint of your Appwrite project. You can find this in the Appwrite console under Settings > General. |
50-
| `PROJECT_ID` | | The ID of your Appwrite project. You can find this in the Appwrite console under Settings > General. |
51-
| `PROJECT_API_KEY` | | The API key of your Appwrite project. You can find this in the Appwrite console under Settings > API Keys. |
52-
| `USER_ID_HEADER` | HTTP_USER_ID | The header name that will be used to store the user ID. |
46+
| Setting | Default | Description |
47+
|--------------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
48+
| `PROJECT_ENDPOINT` | | The endpoint of your Appwrite project. You can find this in the Appwrite console under Settings > General. |
49+
| `PROJECT_ID` | | The ID of your Appwrite project. You can find this in the Appwrite console under Settings > General. |
50+
| `PROJECT_API_KEY` | | The API key of your Appwrite project. You can find this in the Appwrite console under Settings > API Keys. |
51+
| `USER_ID_HEADER` | HTTP_USER_ID | The header name that will be used to store the user ID. |
52+
| `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. |
53+
| `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. |
5354

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

0 commit comments

Comments
 (0)