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

Commit 1c8c497

Browse files
author
Vincent (Wen Yu) Ge
authored
Merge pull request #425 from appwrite/github-app-permissions
Add more missing variables for GitHub integration
2 parents 6e783a1 + f1e7d28 commit 1c8c497

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

app/views/docs/configuration.phtml

+32-2
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,18 @@
4444
</thead>
4545
<tbody>
4646
<tr>
47-
<td><code>http://[HOSTNAME_OR_IP]/v1/vcs/github/callback</code></td>
47+
<td><code>https://[HOSTNAME_OR_IP]/v1/vcs/github/callback</code></td>
4848
</tr>
4949
<tr>
50-
<td><code>http://[HOSTNAME_OR_IP]/v1/account/sessions/oauth2/callback/github/console</code></td>
50+
<td><code>https://[HOSTNAME_OR_IP]/v1/account/sessions/oauth2/callback/github/console</code></td>
5151
</tr>
5252
</tbody>
5353
</table>
5454

55+
<p>
56+
Also, check the <b>Request user authentication (OAuth) during installation</b> box.
57+
</p>
58+
5559
<h3><a href="#post-install" id="post-install">Post Installation</a></h3>
5660
<p>
5761
Check the <b>Redirect on update</b> box under the <b>Post installation</b> section.
@@ -168,6 +172,32 @@
168172
</tr>
169173
</thead>
170174
<tbody>
175+
<tr>
176+
<td>_APP_DOMAIN</td>
177+
<td>
178+
Your main Appwrite domain used to access the Appwrite Console.
179+
When setting a public suffix domain, Appwrite will attempt to issue a valid SSL certificate automatically.
180+
When used with a dev domain, Appwrite will assign a self-signed SSL certificate.
181+
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.
182+
</td>
183+
</tr>
184+
<tr>
185+
<td>_APP_DOMAIN_TARGET</td>
186+
<td>
187+
A hostname to serve as a CNAME target for your Appwrite custom domains.
188+
You can use the same value as used for the Appwrite <code>_APP_DOMAIN</code> variable.
189+
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>.
190+
</td>
191+
</tr>
192+
<tr>
193+
<td>_APP_DOMAIN_FUNCTIONS</td>
194+
<td>
195+
This will be used for system generated <a href="/docs/functions-deploy#domains">Function Domains</a>.
196+
When a function domain is generated, it will be <code>[UNIQUE_ID].[_APP_DOMAIN_FUNCTIONS]</code>.
197+
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>.
198+
You can use the same value as used for the Appwrite <code>_APP_DOMAIN</code> variable.
199+
</td>
200+
</tr>
171201
<tr>
172202
<td>_APP_VCS_GITHUB_APP_NAME</td>
173203
<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>

0 commit comments

Comments
 (0)