diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 786a035f..af4cd7b8 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -31,10 +31,22 @@ If you're running on localhost, you need to run a proxy like ngrok.

+

GitHub App name

+ +

+ The GitHub App name will be displayed when connecting Appwrite to GitHub. In addition, this name will be transformed to a slug ("My GitHub App" will become "my-github-app") and appear in the URL when accessing your app in GitHub. This slug should be set as the _APP_VCS_GITHUB_APP_NAME environment variable in Appwrite. +

+ +

Homepage URL

+ +

+The homepage URL will appear when looking at the public page of your app. It can be any URL you'd like. +

+

Callback URL

GitHub will use callback URLs to redirect users back to Appwrite. - Set these callback URLs under Identifying and authorizing users. + Set these callback URLs under Identifying and authorizing users in the same order as listed below.

@@ -147,7 +159,7 @@
- + @@ -161,6 +173,12 @@
EventEvents
+

Where can this GitHub App be installed?

+ +

+ Check the Any account box under Where can this GitHub App be installed? section. This is important to allow you to install the GitHub app on multiple Appwrite projects. +

+

Environment Variables

After creating your app, you'll have to configure the following environment variables.

@@ -204,7 +222,7 @@ _APP_VCS_GITHUB_PRIVATE_KEY - GitHub app RSA private key. You can generate private keys from GitHub application settings. + RSA private key from GitHub wrapped with double quotes and newlines replaced with \n. You can generate private keys from GitHub application settings. _APP_VCS_GITHUB_APP_ID @@ -225,6 +243,22 @@ +

+ For example, see below. +

+ +
+
_APP_DOMAIN=appwrite.example.com
+_APP_DOMAIN_TARGET=appwrite.example.com
+_APP_DOMAIN_FUNCTIONS=functions.example.com
+_APP_VCS_GITHUB_APP_NAME=my-github-app
+_APP_VCS_GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEAuT8f3lo/X83hfvb0ZN/KD2pl86o/jl3ywKrkj/PQZBmtEv/z\nIugE//sfFoHWc4cizkcji+n3FNU+GEdvMioKuJlPBqPTY8hAbVn7R0geZLpDV/rs\n[...]\n-----END RSA PRIVATE KEY-----"
+_APP_VCS_GITHUB_APP_ID=12415
+_APP_VCS_GITHUB_CLIENT_ID=Iv1.35asdf43asd
+_APP_VCS_GITHUB_CLIENT_SECRET=35rsdse532q13
+_APP_VCS_GITHUB_WEBHOOK_SECRET=super-secret
+
+

Learn more about environment variables

Update Existing GitHub Apps