Skip to content
This repository has been archived by the owner on Sep 29, 2023. It is now read-only.

Add github app config information #424

Merged
merged 17 commits into from
Aug 31, 2023
Merged

Add github app config information #424

merged 17 commits into from
Aug 31, 2023

Conversation

gewenyu99
Copy link
Contributor

What does this PR do?

(Provide a description of what this PR does.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)

@gewenyu99 gewenyu99 marked this pull request as ready for review August 31, 2023 00:11
Copy link
Member

@vermakhushboo vermakhushboo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's also add how to configure webhook url.
https://<ngrok url>/v1/vcs/github/events

@vermakhushboo
Copy link
Member

Maybe this detail as well: Everytime user updates their GitHub app's setting, they need to go to their app installation page and approve the prompt - GitHub app is asking for updated permissions

Copy link
Contributor

@stnguyen90 stnguyen90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor formatting suggestions.

I didn't read the content, though.

@@ -80,18 +198,18 @@

<p>You can find a full list of supported runtimes on the <a href="/docs/environment-variables#functions">environment variables</a> page.</p>

<p>You can also configure the maximum timeout that can be set on individual Appwrite functions. The maximum configurable timeout can be increased by changing the <code>_APP_FUNCTIONS_TIMEOUT</code> environment variable. This environment variable changes the configurable maximum but does not alter existing individual configurations.</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The _APP_FUNCTIONS_RUNTIMES above shouldn't have spaces

@gewenyu99
Copy link
Contributor Author

gewenyu99 commented Aug 31, 2023

localhost_2080_docs_configuration (4)

<p>You'll have to configure the following environment variables.</p>
<p>
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 <code>localhost</code>, you need to run a proxy like <b>ngrok</b>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we add a hyperlink to the ngrok website

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linked

Vincent (Wen Yu) Ge and others added 2 commits August 31, 2023 16:24
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants