From 44944fdf526cbcf8bd1dba05f9224a19108bcace Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Fri, 1 Sep 2023 17:45:27 +0000 Subject: [PATCH 1/6] added more variables taht were missing from function GitHub integration --- app/views/docs/configuration.phtml | 31 ++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index d9c1817d..b32cc24d 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -44,14 +44,18 @@ - http://[HOSTNAME_OR_IP]/v1/vcs/github/callback + https://[HOSTNAME_OR_IP]/v1/vcs/github/callback - http://[HOSTNAME_OR_IP]/v1/account/sessions/oauth2/callback/github/console + https://[HOSTNAME_OR_IP]/v1/account/sessions/oauth2/callback/github/console +

+ Also select the Request user authentication (OAuth) during installation box. +

+

Post Installation

Check the Redirect on update box under the Post installation section. @@ -168,6 +172,29 @@ + + _APP_DOMAIN + + Your Appwrite domain address. + When setting a public suffix domain, Appwrite will attempt to issue a valid SSL certificate automatically. + When used with a dev domain, Appwrite will assign a self-signed SSL certificate. + If you're using a proxy for localhost development, such as ngrok, this will be the domain of your localhost proxy. + + + + _APP_DOMAIN_TARGET + + A DNS A-record hostname to serve as a CNAME target for your Appwrite custom domains. + You can use the same value as used for the Appwrite _APP_DOMAIN variable. + If you're using a proxy for localhost development, such as ngrok, this will be the domain of your localhost proxy, such as dd65-2405-201-4013-d8d7-b4c5-fb73-39f9-285c.ngrok.io. + + + + _APP_DOMAIN_FUNCTIONS + + [@steven @khushboo help] + + _APP_VCS_GITHUB_APP_NAME 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. From 216a057ad108024c1eb2b87e114ece9c7d9e8aba Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Fri, 1 Sep 2023 15:18:39 -0400 Subject: [PATCH 2/6] Update app/views/docs/configuration.phtml Co-authored-by: Steven Nguyen <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/configuration.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index b32cc24d..3b1c0674 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -53,7 +53,7 @@

- Also select the Request user authentication (OAuth) during installation box. + Also, check the Request user authentication (OAuth) during installation box.

Post Installation

From b70c1754cd6327289ac9b05032fe52b90d4716dd Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Fri, 1 Sep 2023 15:18:51 -0400 Subject: [PATCH 3/6] Update app/views/docs/configuration.phtml Co-authored-by: Steven Nguyen <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/configuration.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 3b1c0674..1aeea8ca 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -184,7 +184,7 @@ _APP_DOMAIN_TARGET - A DNS A-record hostname to serve as a CNAME target for your Appwrite custom domains. + A hostname to serve as a CNAME target for your Appwrite custom domains. You can use the same value as used for the Appwrite _APP_DOMAIN variable. If you're using a proxy for localhost development, such as ngrok, this will be the domain of your localhost proxy, such as dd65-2405-201-4013-d8d7-b4c5-fb73-39f9-285c.ngrok.io. From a8a67886cd18241ff327ef21a52e81ba41dd4f8f Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Fri, 1 Sep 2023 15:19:02 -0400 Subject: [PATCH 4/6] Update app/views/docs/configuration.phtml Co-authored-by: Steven Nguyen <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/configuration.phtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 1aeea8ca..20a1a010 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -175,7 +175,7 @@ _APP_DOMAIN - Your Appwrite domain address. + Your main Appwrite domain used to access the Appwrite Console. When setting a public suffix domain, Appwrite will attempt to issue a valid SSL certificate automatically. When used with a dev domain, Appwrite will assign a self-signed SSL certificate. If you're using a proxy for localhost development, such as ngrok, this will be the domain of your localhost proxy. From 79a0842a6d83ebf7994d2c5bb879bae59f11707b Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Fri, 1 Sep 2023 15:19:32 -0400 Subject: [PATCH 5/6] Update app/views/docs/configuration.phtml Co-authored-by: Steven Nguyen <1477010+stnguyen90@users.noreply.github.com> --- app/views/docs/configuration.phtml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index 20a1a010..e94adc5f 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -192,7 +192,8 @@ _APP_DOMAIN_FUNCTIONS - [@steven @khushboo help] + This will be used for Function Domains. When a function domain is generated, it will be [UNIQUE_ID].[_APP_DOMAIN_FUNCTIONS]. + You can use the same value as used for the Appwrite _APP_DOMAIN variable. From f1e7d28bcfdf43b1e9db1bae6feb8a1d2927fc1d Mon Sep 17 00:00:00 2001 From: "Vincent (Wen Yu) Ge" Date: Fri, 1 Sep 2023 19:39:33 +0000 Subject: [PATCH 6/6] add example for _APP_DOMAIN_TARGET --- app/views/docs/configuration.phtml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/app/views/docs/configuration.phtml b/app/views/docs/configuration.phtml index e94adc5f..786a035f 100644 --- a/app/views/docs/configuration.phtml +++ b/app/views/docs/configuration.phtml @@ -192,7 +192,9 @@ _APP_DOMAIN_FUNCTIONS - This will be used for Function Domains. When a function domain is generated, it will be [UNIQUE_ID].[_APP_DOMAIN_FUNCTIONS]. + This will be used for system generated Function Domains. + When a function domain is generated, it will be [UNIQUE_ID].[_APP_DOMAIN_FUNCTIONS]. + If _APP_DOMAIN_FUNCTIONS is set to example.com for example, the generated domain for functions will be something like 64d4d22db370ae41a32e.example.com. You can use the same value as used for the Appwrite _APP_DOMAIN variable.