@@ -40,126 +40,133 @@ Follow these steps to create a GitHub App, set callback URLs, and configure webh
4040
4141#### GitHub Cloud
4242
43- 1 . Go to ** Settings \> Developer Settings \> GitHub Apps** in your GitHub organization.
43+ 1 . Go to ** Settings \> Developer Settings \> GitHub Apps** in your GitHub organization.
4444
45- 2 . Click ** New GitHub App** .
46- ![ Create GitHub App] ( /images/integrations/github/create-github-app.webp#hero )
45+ 2 . Click ** New GitHub App** .
4746
48- 3 . In the ** Register new GitHub App** page, provide a ** GitHub App name** and ** Homepage URL** .
49- ![ App name and homepage URL] ( /images/integrations/github/app-name-homepage-url.webp#hero )
47+ ![ Create GitHub App] ( /images/integrations/github/create-github-app.webp#hero )
5048
51- 4 . In the ** Identifying and authorizing users ** section, add the following ** Callback URLS ** .
49+ 3 . In the ** Register new GitHub App ** page, provide a ** GitHub App name ** and ** Homepage URL ** .
5250
53- ``` bash
54- https://< your-domain> /silo/api/github/auth/callback
55- https://< your-domain> /silo/api/github/auth/user/callback
56- ```
51+ ![ App name and homepage URL] ( /images/integrations/github/app-name-homepage-url.webp#hero )
5752
58- These URLs allow Plane to verify and enable workspace connection with the Github App.
59- ![ Add Callback URL] ( /images/integrations/github/add-callback-url.webp#hero )
53+ 4 . In the ** Identifying and authorizing users** section, add the following ** Callback URLS** .
6054
61- ::: warning
62- Make sure to opt out of ** Expire user authorization tokens** feature.
63- :::
55+ ``` bash
56+ https://< your-domain> /silo/api/github/auth/callback
57+ https://< your-domain> /silo/api/github/auth/user/callback
58+ ```
6459
65- 5 . In the ** Post installation ** section, add the below ** Setup URL ** .
60+ These URLs allow Plane to verify and enable workspace connection with the Github App .
6661
67- ``` bash
68- https://< your-domain> /silo/api/github/auth/callback
69- ```
62+ ! [Add Callback URL](/images/integrations/github/add-callback-url.webp#hero)
7063
71- Redirects users to this URL after GitHub app installation.
72- ![ Add setup URL] ( /images/integrations/github/add-setup-url.webp#hero )
64+ :::warning
65+ Make sure to opt out of ** Expire user authorization tokens** feature.
66+ :::
7367
74- 6 . Turn on ** Redirect on update ** .
68+ 5. In the ** Post installation ** section, add the below ** Setup URL ** .
7569
76- 7 . In the ** Webhook** section, add the below ** Webhook URL** .
70+ ` ` ` bash
71+ https://< your-domain> /silo/api/github/auth/callback
72+ ` ` `
7773
78- ``` bash
79- https:// < your-domain > /silo/api/github/github-webhook
80- ```
74+ Redirects users to this URL after GitHub app installation.
75+
76+ ! [Add setup URL](/images/integrations/github/add-setup-url.webp#hero)
8177
82- This allows Plane to receive updates from GitHub repositories .
78+ 6. Turn on ** Redirect on update ** .
8379
84- ![ Add Webhook URL] ( /images/integrations/github/add-webhook-url.webp#hero )
80+ 7. In the ** Webhook** section, add the below ** Webhook URL** .
81+
82+ ` ` ` bash
83+ https://< your-domain> /silo/api/github/github-webhook
84+ ` ` `
85+
86+ This allows Plane to receive updates from GitHub repositories.
87+
88+ ! [Add Webhook URL](/images/integrations/github/add-webhook-url.webp#hero)
8589
8690== GitHub Enterprise Server {# github-enterprise-server}
8791These steps cover hostname, callback URLs, and private key differences for on‑prem GitHub deployments.
8892
8993# ### GitHub Enterprise Server
9094
91- 1 . Go to ** Settings \> Developer Settings \> GitHub Apps** in your GitHub organization.
95+ 1. Go to ** Settings \> Developer Settings \> GitHub Apps** in your GitHub organization.
9296
93- 2 . Click ** New GitHub App** .
94- ![ Create GitHub App] ( /images/integrations/github/create-github-app.webp#hero )
97+ 2. Click ** New GitHub App** .
9598
96- 3 . In the ** Register new GitHub App** page, provide a ** GitHub App name** and ** Homepage URL** .
97- ![ App name and homepage URL] ( /images/integrations/github/app-name-homepage-url.webp#hero )
99+ ! [Create GitHub App](/images/integrations/github/create-github-app.webp#hero)
98100
99- 4 . In the ** Identifying and authorizing users ** section, add the following ** Callback URLS ** .
101+ 3. In the ** Register new GitHub App ** page, provide a ** GitHub App name ** and ** Homepage URL ** .
100102
101- ** For Plane cloud instance **
103+ ! [App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero)
102104
103- ``` bash
104- https://silo.plane.so/api/oauth/github-enterprise/auth/callback
105- https://silo.plane.so/api/oauth/github-enterprise/auth/user/callback
106- ```
105+ 4. In the ** Identifying and authorizing users** section, add the following ** Callback URLS** .
107106
108- ** For Plane self-hosted instance**
107+ ** For Plane cloud instance**
109108
110- ``` bash
111- https://< your-domain > / silo/api/oauth/github-enterprise/auth/callback
112- https://< your-domain > / silo/api/oauth/github-enterprise/auth/user/callback
113- ```
109+ ` ` ` bash
110+ https://silo.plane.so /api/oauth/github-enterprise/auth/callback
111+ https://silo.plane.so /api/oauth/github-enterprise/auth/user/callback
112+ ` ` `
114113
115- These URLs allow Plane to verify and enable workspace connection with the Github App.
116- ![ Add Callback URL] ( /images/integrations/github/add-callback-url.webp#hero )
117- ::: warning
118- Make sure to opt out of ** Expire user authorization tokens** feature.
119- :::
114+ ** For Plane self-hosted instance**
120115
121- 5 . In the ** Post installation** section, add the below ** Setup URL** .
116+ ` ` ` bash
117+ https://< your-domain> /silo/api/oauth/github-enterprise/auth/callback
118+ https://< your-domain> /silo/api/oauth/github-enterprise/auth/user/callback
119+ ` ` `
122120
123- ** For Plane cloud instance**
121+ These URLs allow Plane to verify and enable workspace connection with the Github App.
122+ ! [Add Callback URL](/images/integrations/github/add-callback-url.webp#hero)
123+ :::warning
124+ Make sure to opt out of ** Expire user authorization tokens** feature.
125+ :::
124126
125- ``` bash
126- https://silo.plane.so/api/oauth/github-enterprise/auth/callback
127- ```
127+ 5. In the ** Post installation** section, add the below ** Setup URL** .
128128
129- ** For Plane self-hosted instance**
129+ ** For Plane cloud instance**
130130
131- ``` bash
132- https://< your-plane-domain > / silo/api/oauth/github-enterprise/auth/callback
133- ```
131+ ` ` ` bash
132+ https://silo.plane.so /api/oauth/github-enterprise/auth/callback
133+ ` ` `
134134
135- Redirects users to this URL after GitHub app installation.
136- ![ Add setup URL] ( /images/integrations/github/add-setup-url.webp#hero )
135+ ** For Plane self-hosted instance**
137136
138- 6 . Turn on ** Redirect on update** .
137+ ` ` ` bash
138+ https://< your-plane-domain> /silo/api/oauth/github-enterprise/auth/callback
139+ ` ` `
139140
140- 7 . In the ** Webhook** section, add the below ** Webhook URL** .
141+ Redirects users to this URL after GitHub app installation.
142+ ! [Add setup URL](/images/integrations/github/add-setup-url.webp#hero)
141143
142- ** For Plane cloud instance **
144+ 6. Turn on ** Redirect on update ** .
143145
144- ``` bash
145- https://silo.plane.so/api/github-enterprise/github-webhook
146- ```
146+ 7. In the ** Webhook** section, add the below ** Webhook URL** .
147147
148- ** For Plane self-hosted instance**
148+ ** For Plane cloud instance**
149149
150- ``` bash
151- https://< your-plane-domain > / silo/api/github-enterprise/github-webhook
152- ```
150+ ` ` ` bash
151+ https://silo.plane.so /api/github-enterprise/github-webhook
152+ ` ` `
153153
154- This allows Plane to receive updates from GitHub repositories.
154+ ** For Plane self-hosted instance **
155155
156- ![ Add Webhook URL] ( /images/integrations/github/add-webhook-url.webp#hero )
156+ ` ` ` bash
157+ https://< your-plane-domain> /silo/api/github-enterprise/github-webhook
158+ ` ` `
159+
160+ This allows Plane to receive updates from GitHub repositories.
161+
162+ ! [Add Webhook URL](/images/integrations/github/add-webhook-url.webp#hero)
157163
158164:::
159165
160166# ## Set up permissions and events
161167
1621681. Add repository and account permissions by setting the ** Access** dropdown next to each permission, as shown in the tables below.
169+
163170 ! [Setup permissions](/images/integrations/github/setup-permissions.webp#hero)
164171
165172 ** Repository permissions**
0 commit comments