Skip to content

chore: add github integration on sidebar #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,7 @@
"group": "Customize deployment",
"pages": [
"self-host/customize-deployment/configure-a-slack-app-for-lightdash",
"self-host/customize-deployment/configure-github-for-lightdash",
"self-host/customize-deployment/configure-lightdash-to-use-an-external-database",
"self-host/customize-deployment/configure-lightdash-to-use-external-object-storage",
"self-host/customize-deployment/configure-logging-for-lightdash",
Expand Down
22 changes: 11 additions & 11 deletions self-host/customize-deployment/configure-github-for-lightdash.mdx
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
---
title: "Configure Github integration for self-hosted Lightdash"
description: "Description of your new file."
title: "Configure a Github integration for self-hosted Lightdash"
sidebarTitle: "Github Integration"
---

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

### Create a new Github app

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

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

**Settings:**

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

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

**Repository Permissions:**

- Checks: `Read and write`
- Checks: `Read and write`
- Contents: `Read and write`
- Pull requests: `Read and write`
- Workflows (optional): `Read and write`
- Pull requests: `Read and write`
- Workflows (optional): `Read and write`

**Account Permissions: **None
**Account Permissions:** None

**Where can this GitHub App be installed? **Any account
**Where can this GitHub App be installed?** Any account

### **Generate Certificate and Secret**

Expand Down