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

Add more missing variables for GitHub integration #425

Merged
merged 6 commits into from
Sep 3, 2023
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
34 changes: 32 additions & 2 deletions app/views/docs/configuration.phtml
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,18 @@
</thead>
<tbody>
<tr>
<td><code>http://[HOSTNAME_OR_IP]/v1/vcs/github/callback</code></td>
<td><code>https://[HOSTNAME_OR_IP]/v1/vcs/github/callback</code></td>
</tr>
<tr>
<td><code>http://[HOSTNAME_OR_IP]/v1/account/sessions/oauth2/callback/github/console</code></td>
<td><code>https://[HOSTNAME_OR_IP]/v1/account/sessions/oauth2/callback/github/console</code></td>
</tr>
</tbody>
</table>

<p>
Also, check the <b>Request user authentication (OAuth) during installation</b> box.
</p>

<h3><a href="#post-install" id="post-install">Post Installation</a></h3>
<p>
Check the <b>Redirect on update</b> box under the <b>Post installation</b> section.
Expand Down Expand Up @@ -168,6 +172,32 @@
</tr>
</thead>
<tbody>
<tr>
<td>_APP_DOMAIN</td>
<td>
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.
gewenyu99 marked this conversation as resolved.
Show resolved Hide resolved
When used with a dev domain, Appwrite will assign a self-signed SSL certificate.
If you're using a proxy for <b>localhost development</b>, such as <a href="https://ngrok.com/" target="_blank" rel="noopener">ngrok</a>, this will be the domain of your localhost proxy.
</td>
</tr>
<tr>
<td>_APP_DOMAIN_TARGET</td>
<td>
A hostname to serve as a CNAME target for your Appwrite custom domains.
You can use the same value as used for the Appwrite <code>_APP_DOMAIN</code> variable.
If you're using a proxy for <b>localhost development</b>, such as <a href="https://ngrok.com/" target="_blank" rel="noopener">ngrok</a>, this will be the domain of your localhost proxy, such as <code>dd65-2405-201-4013-d8d7-b4c5-fb73-39f9-285c.ngrok.io</code>.
</td>
</tr>
<tr>
<td>_APP_DOMAIN_FUNCTIONS</td>
<td>
This will be used for system generated <a href="/docs/functions-deploy#domains">Function Domains</a>.
When a function domain is generated, it will be <code>[UNIQUE_ID].[_APP_DOMAIN_FUNCTIONS]</code>.
If <code>_APP_DOMAIN_FUNCTIONS</code> is set to <code>example.com</code> for example, the generated domain for functions will be something like <code>64d4d22db370ae41a32e.example.com</code>.
You can use the same value as used for the Appwrite <code>_APP_DOMAIN</code> variable.
</td>
</tr>
<tr>
<td>_APP_VCS_GITHUB_APP_NAME</td>
<td>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.</td>
Expand Down