Skip to content
This repository was archived by the owner on Sep 29, 2023. It is now read-only.
Merged
Changes from all commits
Commits
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
40 changes: 37 additions & 3 deletions app/views/docs/configuration.phtml
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>. You can generate private keys from GitHub application settings.</td>
</tr>
<tr>
<td>_APP_VCS_GITHUB_APP_ID</td>
Expand All @@ -225,6 +243,22 @@
</tbody>
</table>

<p>
For example, see below.
</p>

<div class="ide margin-bottom" data-lang="bash" data-lang-label="Bash">
<pre class="line-numbers"><code class="prism language-bash" data-prism>_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</code></pre>
</div>

<p><a href="/docs/environment-variables"><i class="icon-angle-circled-right margin-start-negative-tiny margin-end-tiny"></i> Learn more about environment variables</a></p>

<h3><a href="#existing-apps" id="existing-apps">Update Existing GitHub Apps</a></h3>
Expand Down