diff --git a/docs.json b/docs.json index 1f6ef63..7204efb 100644 --- a/docs.json +++ b/docs.json @@ -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", diff --git a/self-host/customize-deployment/configure-github-for-lightdash.mdx b/self-host/customize-deployment/configure-github-for-lightdash.mdx index dcf316c..8b6f5d9 100644 --- a/self-host/customize-deployment/configure-github-for-lightdash.mdx +++ b/self-host/customize-deployment/configure-github-for-lightdash.mdx @@ -1,13 +1,13 @@ --- -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) @@ -15,9 +15,9 @@ Go to app settings in Github, either organization or account developer 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:///api/v1/github/oauth/callback` -5. Enable `Expire user authorization tokens` +3. Homepage URL: e.g. `https://lightdash.com` +4. Callback URL: `https:///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) @@ -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**