Skip to content

Commit 17d1109

Browse files
authored
Merge pull request #41 from lightdash/gh-integration
chore: add github integration on sidebar
2 parents 3c5f6f4 + b267acc commit 17d1109

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

docs.json

+1
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,7 @@
220220
"group": "Customize deployment",
221221
"pages": [
222222
"self-host/customize-deployment/configure-a-slack-app-for-lightdash",
223+
"self-host/customize-deployment/configure-github-for-lightdash",
223224
"self-host/customize-deployment/configure-lightdash-to-use-an-external-database",
224225
"self-host/customize-deployment/configure-lightdash-to-use-external-object-storage",
225226
"self-host/customize-deployment/configure-logging-for-lightdash",

self-host/customize-deployment/configure-github-for-lightdash.mdx

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
---
2-
title: "Configure Github integration for self-hosted Lightdash"
3-
description: "Description of your new file."
2+
title: "Configure a Github integration for self-hosted Lightdash"
3+
sidebarTitle: "Github Integration"
44
---
55

66
In this guide we will show you how you can enable the Github integration on your on self-hosted Lightdash server.
77

88
### Create a new Github app
99

10-
Go to app settings in Github, either organization or account developer settings and click `New Github App`
10+
Go to app settings in Github, either organization or account developer settings and click `New Github App`
1111

1212
![Github Create App Pn](/images/github-create-app.png)
1313

1414
**Settings:**
1515

1616
1. Set the app name: must be unique across Github
1717
2. Add a description
18-
3. Homepage URL: e.g. `https://lightdash.com`
19-
4. Callback URL: `https://<your-domain>/api/v1/github/oauth/callback`
20-
5. Enable `Expire user authorization tokens`
18+
3. Homepage URL: e.g. `https://lightdash.com`
19+
4. Callback URL: `https://<your-domain>/api/v1/github/oauth/callback`
20+
5. Enable `Expire user authorization tokens`
2121
6. Enable `Request user authorization (OAuth) during installation`
2222

2323
![Github Oauth Refresh Token Pn](/images/github-oauth-refresh-token.png)
@@ -27,14 +27,14 @@ Go to app settings in Github, either organization or account developer settings
2727

2828
**Repository Permissions:**
2929

30-
- Checks: `Read and write`
30+
- Checks: `Read and write`
3131
- Contents: `Read and write`
32-
- Pull requests: `Read and write`
33-
- Workflows (optional): `Read and write`
32+
- Pull requests: `Read and write`
33+
- Workflows (optional): `Read and write`
3434

35-
**Account Permissions: **None
35+
**Account Permissions:** None
3636

37-
**Where can this GitHub App be installed? **Any account
37+
**Where can this GitHub App be installed?** Any account
3838

3939
### **Generate Certificate and Secret**
4040

0 commit comments

Comments
 (0)