@@ -41,61 +41,72 @@ To configure GitHub integration, create a GitHub App within your organization.
41
41
42
42
<Tabs queryString = " edition" groupId = " editions" >
43
43
<TabItem value = " github-cloud" label = " GitHub Cloud" >
44
+ 1 . Go to ** Settings > Developer Settings > GitHub Apps** in your GitHub organization.
45
+
46
+ 2 . Click ** New GitHub App** .
47
+ ![ Create GitHub App] ( /images/integrations/github/create-github-app.webp#center )
44
48
45
- 1 . Go to ** Settings > Developer Settings > GitHub Apps ** in your GitHub organization .
46
- 2 . Click ** New GitHub App** .
47
- ![ Create GitHub App ] ( /images/integrations/github/create-github-app.webp#center )
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#center )
50
- 4 . In the ** Identifying and authorizing users ** section, add the following ** Callback URLs ** :
51
- ``` bash
52
- https:// < your-domain > /silo/api/github/auth/callback
53
- https:// < your-domain > /silo/api/github/auth/user/callback
54
- ```
55
- These URLs allow Plane to verify and enable workspace connection with the GitHub App.
56
- ![ Add Callback URL ] ( /images/integrations/github/ add-callback-url.webp#center )
57
- 5 . In the ** Post installation ** section, add this ** Setup URL** and check the box for ** Redirect on update ** .
58
- ![ Add setup URL ] ( /images/integrations/github/add-setup-url.webp#center )
59
- 6 . In the ** Webhook** section, add the following ** Webhook URL** to allow Plane to receive updates from GitHub repositories:
60
- ``` bash
61
- https://< your-domain> /silo/api/github/github-webhook
62
- ```
63
- ![ Add Webhook URL] ( /images/integrations/github/add-webhook-url.webp#center )
49
+ 3 . In the ** Register new GitHub App ** page, provide a ** GitHub App name ** and ** Homepage URL ** .
50
+ ![ App name and homepage URL ] ( /images/integrations/github/app-name-homepage-url.webp#center )
51
+
52
+ 4 . In the ** Identifying and authorizing users ** section, add the following ** Callback URLs ** :
53
+ ``` bash
54
+ https:// < your-domain > /silo/api/github/auth/callback
55
+ https:// < your-domain > /silo/api/github/auth/user/callback
56
+ ```
57
+ These URLs allow Plane to verify and enable workspace connection with the GitHub App.
58
+ ![ Add Callback URL ] ( /images/integrations/github/add-callback-url.webp#center )
59
+
60
+ 5 . In the ** Post installation ** section, add this ** Setup URL ** and check the box for ** Redirect on update ** .
61
+ ![ Add setup URL] ( /images/integrations/github/add-setup-url.webp#center )
62
+
63
+ 6 . In the ** Webhook** section, add the following ** Webhook URL** to allow Plane to receive updates from GitHub repositories:
64
+ ``` bash
65
+ https://< your-domain> /silo/api/github/github-webhook
66
+ ```
67
+ ![ Add Webhook URL] ( /images/integrations/github/add-webhook-url.webp#center )
64
68
</TabItem >
65
69
<TabItem value = " github-enterprise" label = " GitHub Enterprise Server" >
66
70
1 . Go to ** Settings > Developer Settings > GitHub Apps** in your GitHub organization.
71
+
67
72
2 . Click ** New GitHub App** .
68
- ![ Create GitHub App] ( /images/integrations/github/create-github-app.webp#center )
73
+ ![ Create GitHub App] ( /images/integrations/github/create-github-app.webp#center )
74
+
69
75
3 . In the ** Register new GitHub App** page, provide a ** GitHub App name** and ** Homepage URL** .
70
- ![ App name and homepage URL] ( /images/integrations/github/app-name-homepage-url.webp#center )
76
+ ![ App name and homepage URL] ( /images/integrations/github/app-name-homepage-url.webp#center )
77
+
71
78
4 . In the ** Identifying and authorizing users** section, add the following ** Callback URLs** :
72
- ** For Plane cloud**
73
- ``` bash
74
- https://silo.plane.so/api/github/auth/callback
75
- https://silo.plane.so/api/github/auth/user/callback
76
- ```
77
- ** For Plane self-hosted instance**
78
- ``` bash
79
- https://< your-domain> /silo/api/github/auth/callback
80
- https://< your-domain> /silo/api/github/auth/user/callback
81
- ```
82
- ![ Add Callback URL] ( /images/integrations/github/add-callback-url.webp#center )
79
+
80
+ ** For Plane cloud**
81
+ ``` bash
82
+ https://silo.plane.so/api/oauth/github-enterprise/auth/callback
83
+ https://silo.plane.so/api/oauth/github-enterprise/auth/user/callback
84
+ ```
85
+ ** For Plane self-hosted instance**
86
+ ``` bash
87
+ https://< your-domain> /silo/api/oauth/github-enterprise/auth/callback
88
+ https://< your-domain> /silo/api/oauth/github-enterprise/auth/user/callback
89
+ ```
90
+ ![ Add Callback URL] ( /images/integrations/github/add-callback-url.webp#center )
91
+
83
92
5 . In the ** Post installation** section:
84
- - Add the appropriate ** Setup URL** , based on your hosting type:
85
- - ** Plane cloud** : ` https://silo.plane.so/api/oauth/github-enterprise/auth/callback `
86
- - ** Self-hosted** : ` https://<your-plane-domain>/silo/api/oauth/github-enterprise/auth/callback `
87
- - Check the box for ** Redirect on update**
88
- ![ Add setup URL] ( /images/integrations/github/add-setup-url.webp#center )
93
+ - Add the appropriate ** Setup URL** , based on your hosting type:
94
+ - ** Plane cloud** : ` https://silo.plane.so/api/oauth/github-enterprise/auth/callback `
95
+ - ** Self-hosted** : ` https://<your-plane-domain>/silo/api/oauth/github-enterprise/auth/callback `
96
+ - Check the box for ** Redirect on update**
97
+ ![ Add setup URL] ( /images/integrations/github/add-setup-url.webp#center )
98
+
89
99
6 . In the ** Webhook** section, add the following ** Webhook URL** to allow Plane to receive updates from your GitHub repositories:
90
- ** For Plane cloud**
91
- ``` bash
92
- https://silo.plane.so/api/github/github-webhook
93
- ```
94
- ** For Plane self-hosted instance**
95
- ``` bash
96
- https://< your-domain> /silo/api/github/github-webhook
97
- ```
98
- ![ Add Webhook URL] ( /images/integrations/github/add-webhook-url.webp#center )
100
+
101
+ ** For Plane cloud**
102
+ ``` bash
103
+ https://silo.plane.so/api/github/github-webhook
104
+ ```
105
+ ** For Plane self-hosted instance**
106
+ ``` bash
107
+ https://< your-domain> /silo/api/github/github-webhook
108
+ ```
109
+ ![ Add Webhook URL] ( /images/integrations/github/add-webhook-url.webp#center )
99
110
</TabItem >
100
111
</Tabs >
101
112
0 commit comments