- Labels are a good way to flag a user to grant them access to resources.
+ Labels are a good way to categorize a user to grant them access to resources.
For example, a subscriber label can be added to a user once they've purchased a subscription.
- For example, in a todo app, a user can create a team for one of their todo lists and invite another user to the team to grant the other user access. + For example, in a todo app, a user can create a team for one of their todo lists and invite another user to the team to grant the other user access. The invited user can accept the invitation to gain access. If the user's ever removed from the team, they'll lose access again.
diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 9a0fc31f..d9c1817d 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -22,10 +22,143 @@Appwrite supports automatic deployments through Git integration. - In order for Appwrite to access your repos, you must configure a GitHub app to enable this integration. + In order for Appwrite to access your repos, you must create a GitHub app to enable this integration. + The GitHub app requires the following configurations.
-You'll have to configure the following environment variables.
+
+ For automatic Git deployment to work, Appwrite needs to receive communication from GitHub, this means your Appwrite project must be accessible on the internet.
+ If you're running on localhost, you need to run a proxy like ngrok.
+
+ GitHub will use callback URLs to redirect users back to Appwrite. + Set these callback URLs under Identifying and authorizing users. +
+| URLs | +
http://[HOSTNAME_OR_IP]/v1/vcs/github/callback |
+
http://[HOSTNAME_OR_IP]/v1/account/sessions/oauth2/callback/github/console |
+
+ Check the Redirect on update box under the Post installation section. +
+ + +
+ GitHub will notify Appwrite about events like new commits using webhooks.
+ Under Webhook, you need to check the Active checkbox.
+ You also need to set the Webhook URL as https://[HOSTNAME_OR_IP]/v1/vcs/github/events.
+
+ If you're running Appwrite on localhost, GitHub can't send requests to Appwrite through webhooks and automatic deployments won't work.
+ You'll need host Appwrite on a server or use a proxy like ngrok to make Appwrite accessible to GitHub.
+
+ Configure these permissions under the Repository permission dropdown. +
+| Permission | +Access | +
| Administration | +Read and write | +
| Checks | +Read and write. | +
| Commit Statuses | +Read and write | +
| Contents | +Read and write | +
| Issues | +Read and write | +
| Metadata | +Read-only | +
| Pull requests | +Read and write | +
| Webhooks | +Read and write | +
+ Configure these permissions under the Account Permission dropdown. +
+| Permission | +Access | +
| Email address | +Read-only | +
+ Select these under the Subscribe to events dropdown. +
+| Event | ++ | + |
| Pull request | +Push | ++ |
After creating your app, you'll have to configure the following environment variables.
| _APP_VCS_GITHUB_APP_NAME | -Name of your GitHub app. This value should be set to your GitHub application's URL. | +Name of your GitHub app. This is the display name you'll see on GitHub and it will be visible in your GitHub app's URL. |
| _APP_VCS_GITHUB_PRIVATE_KEY | @@ -64,6 +197,14 @@
Self-hosting Appwrite gives you more configurable options. You can customize Appwrite with your choice of S3 compatible storage adaptors, email and SMS providers, functions runtimes, and more.
+Self-hosting Appwrite gives you more configurable options. You can customize Appwrite with your choice of S3 compatible storage adapters, email and SMS providers, functions runtimes, and more.