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

Add additional details for Configuring GitHub app #429

Merged
merged 7 commits into from
Sep 11, 2023
Merged

Add additional details for Configuring GitHub app #429

Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3c24924
Update _APP_VCS_GITHUB_PRIVATE_KEY docs to give a clear example
stnguyen90 Sep 8, 2023
5fd8704
Add GitHub App name to Configuring GitHub App
stnguyen90 Sep 8, 2023
1050650
Add homepage URL to Configuring GitHub app for completness
stnguyen90 Sep 8, 2023
d7131dc
Update Callback URL for Configuring GitHub app
stnguyen90 Sep 8, 2023
2607019
Add Where can this GitHub App be installed? to Configuring GitHub app
stnguyen90 Sep 8, 2023
09fbb4d
Change Subscribe to events table header to be Events
stnguyen90 Sep 11, 2023
0dfda83
Add an example section for github env vars
stnguyen90 Sep 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions app/views/docs/configuration.phtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,22 @@
If you're running on <code>localhost</code>, you need to run a proxy like <a href="https://ngrok.com/" target="_blank" rel="noopener">ngrok</a>.
</p>

<h3><a href="#github-app-name" id="github-app-name">GitHub App name</a></h3>

<p>
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 <code>_APP_VCS_GITHUB_APP_NAME</code> environment variable in Appwrite.
</p>

<h3><a href="#github-homepage-url" id="github-homepage-url">Homepage URL</a></h3>

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

<h3><a href="#callback" id="callback">Callback URL</a></h3>
<p>
GitHub will use <b>callback URLs</b> to redirect users back to Appwrite.
Set these callback URLs under <b>Identifying and authorizing users</b>.
Set these callback URLs under <b>Identifying and authorizing users</b> in the same order as listed below.
</p>
<table class="full">
<thead>
Expand Down Expand Up @@ -147,7 +159,7 @@
<table class="full">
<thead>
<tr>
<td>Event</td>
<td>Events</td>
<td></td>
<td></td>
</tr>
Expand All @@ -161,6 +173,12 @@
</tbody>
</table>

<h3><a href="#github-where-installed" id="github-where-installed">Where can this GitHub App be installed?</a></h3>

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

<h3><a href="#github-variables" id="github-variables">Environment Variables</a></h3>
<p>After creating your app, you'll have to configure the following environment variables.</p>

Expand Down Expand Up @@ -204,7 +222,7 @@
</tr>
<tr>
<td>_APP_VCS_GITHUB_PRIVATE_KEY</td>
<td>GitHub app RSA private key. You can generate private keys from GitHub application settings.</td>
<td>RSA private key from GitHub wrapped with double quotes and newlines replaced with <code>\n</code> like <code>"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEAuT8f3lo/X83hfvb0ZN/KD2pl86o/jl3ywKrkj/PQZBmtEv/z\nIugE//sfFoHWc4cizkcji+n3FNU+GEdvMioKuJlPBqPTY8hAbVn7R0geZLpDV/rs\n[...]\n-----END RSA PRIVATE KEY-----"</code>. You can generate private keys from GitHub application settings.</td>
</tr>
<tr>
<td>_APP_VCS_GITHUB_APP_ID</td>
Expand Down