Skip to content

Commit c60fbe3

Browse files
sriramveeraghantasriramveeraghanta
committed
fix: formatting
1 parent d23584e commit c60fbe3

File tree

1 file changed

+70
-70
lines changed
  • docs/self-hosting/govern/integrations

1 file changed

+70
-70
lines changed

‎docs/self-hosting/govern/integrations/github.md‎

Lines changed: 70 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -36,130 +36,130 @@ To configure GitHub integration, you'll need to create a GitHub App within your
3636

3737
== GitHub Cloud {#github-cloud}
3838

39-
Follow these steps to create a GitHub App, set callback URLs, and configure webhooks so Plane can sync PRs and commits from GitHub Cloud.
39+
Follow these steps to create a GitHub App, set callback URLs, and configure webhooks so Plane can sync PRs and commits from GitHub Cloud.
4040

41-
#### GitHub Cloud
41+
#### 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**.
45+
2. Click **New GitHub App**.
4646

47-
![Create GitHub App](/images/integrations/github/create-github-app.webp#hero)
47+
![Create GitHub App](/images/integrations/github/create-github-app.webp#hero)
4848

49-
3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**.
49+
3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**.
5050

51-
![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero)
51+
![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero)
5252

53-
4. In the **Identifying and authorizing users** section, add the following **Callback URLS**.
53+
4. In the **Identifying and authorizing users** section, add the following **Callback URLS**.
5454

55-
```bash
56-
https://<your-domain>/silo/api/github/auth/callback
57-
https://<your-domain>/silo/api/github/auth/user/callback
58-
```
55+
```bash
56+
https://<your-domain>/silo/api/github/auth/callback
57+
https://<your-domain>/silo/api/github/auth/user/callback
58+
```
5959

60-
These URLs allow Plane to verify and enable workspace connection with the Github App.
60+
These URLs allow Plane to verify and enable workspace connection with the Github App.
6161

62-
![Add Callback URL](/images/integrations/github/add-callback-url.webp#hero)
62+
![Add Callback URL](/images/integrations/github/add-callback-url.webp#hero)
6363

6464
:::warning
6565
Make sure to opt out of **Expire user authorization tokens** feature.
6666
:::
6767

68-
5. In the **Post installation** section, add the below **Setup URL**.
68+
5. In the **Post installation** section, add the below **Setup URL**.
6969

70-
```bash
71-
https://<your-domain>/silo/api/github/auth/callback
72-
```
70+
```bash
71+
https://<your-domain>/silo/api/github/auth/callback
72+
```
7373

74-
Redirects users to this URL after GitHub app installation.
74+
Redirects users to this URL after GitHub app installation.
7575

76-
![Add setup URL](/images/integrations/github/add-setup-url.webp#hero)
76+
![Add setup URL](/images/integrations/github/add-setup-url.webp#hero)
7777

78-
6. Turn on **Redirect on update**.
78+
6. Turn on **Redirect on update**.
7979

80-
7. In the **Webhook** section, add the below **Webhook URL**.
80+
7. In the **Webhook** section, add the below **Webhook URL**.
8181

82-
```bash
83-
https://<your-domain>/silo/api/github/github-webhook
84-
```
82+
```bash
83+
https://<your-domain>/silo/api/github/github-webhook
84+
```
8585

86-
This allows Plane to receive updates from GitHub repositories.
86+
This allows Plane to receive updates from GitHub repositories.
8787

88-
![Add Webhook URL](/images/integrations/github/add-webhook-url.webp#hero)
88+
![Add Webhook URL](/images/integrations/github/add-webhook-url.webp#hero)
8989

9090
== GitHub Enterprise Server {#github-enterprise-server}
91-
These steps cover hostname, callback URLs, and private key differences for on‑prem GitHub deployments.
91+
These steps cover hostname, callback URLs, and private key differences for on‑prem GitHub deployments.
9292

93-
#### GitHub Enterprise Server
93+
#### GitHub Enterprise Server
9494

95-
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.
9696

97-
2. Click **New GitHub App**.
97+
2. Click **New GitHub App**.
9898

99-
![Create GitHub App](/images/integrations/github/create-github-app.webp#hero)
99+
![Create GitHub App](/images/integrations/github/create-github-app.webp#hero)
100100

101-
3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**.
101+
3. In the **Register new GitHub App** page, provide a **GitHub App name** and **Homepage URL**.
102102

103-
![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero)
103+
![App name and homepage URL](/images/integrations/github/app-name-homepage-url.webp#hero)
104104

105-
4. In the **Identifying and authorizing users** section, add the following **Callback URLS**.
105+
4. In the **Identifying and authorizing users** section, add the following **Callback URLS**.
106106

107-
**For Plane cloud instance**
107+
**For Plane cloud instance**
108108

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-
```
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+
```
113113

114-
**For Plane self-hosted instance**
114+
**For Plane self-hosted instance**
115115

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-
```
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+
```
120120

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)
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)
123123
:::warning
124124
Make sure to opt out of **Expire user authorization tokens** feature.
125125
:::
126126

127-
5. In the **Post installation** section, add the below **Setup URL**.
127+
5. In the **Post installation** section, add the below **Setup URL**.
128128

129-
**For Plane cloud instance**
129+
**For Plane cloud instance**
130130

131-
```bash
132-
https://silo.plane.so/api/oauth/github-enterprise/auth/callback
133-
```
131+
```bash
132+
https://silo.plane.so/api/oauth/github-enterprise/auth/callback
133+
```
134134

135-
**For Plane self-hosted instance**
135+
**For Plane self-hosted instance**
136136

137-
```bash
138-
https://<your-plane-domain>/silo/api/oauth/github-enterprise/auth/callback
139-
```
137+
```bash
138+
https://<your-plane-domain>/silo/api/oauth/github-enterprise/auth/callback
139+
```
140140

141-
Redirects users to this URL after GitHub app installation.
142-
![Add setup URL](/images/integrations/github/add-setup-url.webp#hero)
141+
Redirects users to this URL after GitHub app installation.
142+
![Add setup URL](/images/integrations/github/add-setup-url.webp#hero)
143143

144-
6. Turn on **Redirect on update**.
144+
6. Turn on **Redirect on update**.
145145

146-
7. In the **Webhook** section, add the below **Webhook URL**.
146+
7. In the **Webhook** section, add the below **Webhook URL**.
147147

148-
**For Plane cloud instance**
148+
**For Plane cloud instance**
149149

150-
```bash
151-
https://silo.plane.so/api/github-enterprise/github-webhook
152-
```
150+
```bash
151+
https://silo.plane.so/api/github-enterprise/github-webhook
152+
```
153153

154-
**For Plane self-hosted instance**
154+
**For Plane self-hosted instance**
155155

156-
```bash
157-
https://<your-plane-domain>/silo/api/github-enterprise/github-webhook
158-
```
156+
```bash
157+
https://<your-plane-domain>/silo/api/github-enterprise/github-webhook
158+
```
159159

160-
This allows Plane to receive updates from GitHub repositories.
160+
This allows Plane to receive updates from GitHub repositories.
161161

162-
![Add Webhook URL](/images/integrations/github/add-webhook-url.webp#hero)
162+
![Add Webhook URL](/images/integrations/github/add-webhook-url.webp#hero)
163163

164164
:::
165165

0 commit comments

Comments
 (0)