chore: add github app instructions (#40)

* Documentation edits made through Mintlify web editor
* chore: add checks
* chore: add github app instructions

---------

Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: almeidabbm <[email protected]>
Co-authored-by: Jake Peterson <[email protected]>

Author: 3 people

images/github-create-app.png

@@ -1,11 +1,11 @@
 ---
-title: "Configure a slack integration for self-hosted Lightdash"
+title: "Configure a Slack integration for self-hosted Lightdash"
 sidebarTitle: Slack Integration
 ---
 
 In this guide we will show you how you can enable [the Slack integration](/references/slack-integration) on your on self-hosted Lightdash server.
 
-### Create a new Slack APP on your organization
+### Create a new Slack app on your organization
 
 First we will have to create a Slack APP [https://api.slack.com/apps?new\_app=1](https://api.slack.com/apps?new%5Fapp=1)
 
@@ -23,7 +23,7 @@ Then select the workspace you want to enable this into. Later you can `enable di
 </Frame>
 
 
-Then copy this manifest to allow URL unfurls in your app. **Make sure you update `your Lightdash URL` in the manifest below** (for example, `app.lightdash.cloud` or `eu1.lightdash.cloud`).
+Then copy this manifest to allow URL unfurls in your app. **Make sure you update `your-lightdash-deployment-url.com` in the manifest below** (for example, `app.lightdash.cloud`).
 
 ```json
 display_information:
@@ -76,9 +76,10 @@ Now copy the following credentials from your new app.
 From `Basic Information`
 
 <Frame>
-  <img src="" alt=""/>
-</Frame>
 ![](/images/slack-basic-information-9a846bde79778d77d0c2616734fac8f1.png)
+</Frame>
+
+
 * Client ID
 * Client secret (show and copy)
 * Signing secret (show and copy)

images/github-deactivate-webhooks.png

@@ -0,0 +1,65 @@
+---
+title: "Configure Github integration for self-hosted Lightdash"
+description: "Description of your new file."
+---
+
+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` 
+
+![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` 
+6. Enable `Request user authorization (OAuth) during installation`
+
+   ![Github Oauth Refresh Token Pn](/images/github-oauth-refresh-token.png)
+7. Deactivate webhooks
+
+   ![Github Deactivate Webhooks Pn](/images/github-deactivate-webhooks.png)
+
+**Repository Permissions:**
+
+- Checks: `Read and write` 
+- Contents: `Read and write`
+- Pull requests: `Read and write` 
+- Workflows (optional): `Read and write` 
+
+**Account Permissions: **None
+
+**Where can this GitHub App be installed? **Any account 
+
+### **Generate Certificate and Secret**
+
+After creating your Github account you will need to generate a Client Secret.
+
+Copy it and keep it safe, this will get used for the `GITHUB_CLIENT_SECRET` environment variable.
+
+![Github Generate Client Secret Pn](/images/github-generate-client-secret.png)
+
+And a Private Key.
+
+Convert the contents of the private key file into `base64` , this will get used for the `GITHUB_PRIVATE_KEY` environment variable.
+
+![Github Generate Private Key Pn](/images/github-generate-private-key.png)
+
+<Info>
+  You should save both the Client Secret and the Private Key in a safe place as you might need them at a later time.
+</Info>
+
+### Adding credentials to your local environment
+
+Now you need to add the following environment variables to your Lightdash server.
+
+- `GITHUB_PRIVATE_KEY` : This is the `base64` string of the Private Key generated for your Github app
+- `GITHUB_CLIENT_SECRET` : This is the client secret generated for your Github app
+- `GITHUB_CLIENT_ID`: Copy this from your Github app settings \> General
+- `GITHUB_APP_ID`: Copy this from your Github app settings \> General
+- `GITHUB_APP_NAME`: This is the name you set for your app, you can find it in app settings.

images/github-generate-client-secret.png

@@ -162,7 +162,7 @@ These variables enable you to configure the [AI Analyst functionality](guides/ai
 
 ### Slack Integration
 
-These variables enable you to configure the [Slack integration](guides/using-slack-integration.mdx).
+These variables enable you to configure the [Slack integration](/guides/using-slack-integration).
 
 | Variable               | Description                    | Required? | Default |
 | :--------------------- | :----------------------------- | :-------: | :-----: |
@@ -173,16 +173,16 @@ These variables enable you to configure the [Slack integration](guides/using-sla
 
 ### GitHub Integration
 
-These variables enable you to configure Github integrations
+These variables enable you to configure [Github integrations](/self-host/customize-deployment/configure-github-for-lightdash)
 
-| Variable                 | Description                                      | Required? | Default |
-| :----------------------- | :----------------------------------------------- | :-------: | :-----: |
-| `GITHUB_PRIVATE_KEY`     | GitHub private key for GitHub App authentication |           |         |
-| `GITHUB_APP_ID`          | GitHub Application ID                            |           |         |
-| `GITHUB_CLIENT_ID`       | GitHub OAuth client ID                           |           |         |
-| `GITHUB_CLIENT_SECRET`   | GitHub OAuth client secret                       |           |         |
-| `GITHUB_APP_NAME`        | Name of the GitHub App                           |           |         |
-| `GITHUB_REDIRECT_DOMAIN` | Domain for GitHub OAuth redirection              |           |         |
+| Variable                 | Description                                      | Required?                                    | Default |
+| :----------------------- | :----------------------------------------------- | :------------------------------------------: | :-----: |
+| `GITHUB_PRIVATE_KEY`     | GitHub private key for GitHub App authentication | <Icon icon="square-check" iconType="solid" />|         |
+| `GITHUB_APP_ID`          | GitHub Application ID                            | <Icon icon="square-check" iconType="solid" />|         |
+| `GITHUB_CLIENT_ID`       | GitHub OAuth client ID                           | <Icon icon="square-check" iconType="solid" />|         |
+| `GITHUB_CLIENT_SECRET`   | GitHub OAuth client secret                       | <Icon icon="square-check" iconType="solid" />|         |
+| `GITHUB_APP_NAME`        | Name of the GitHub App                           | <Icon icon="square-check" iconType="solid" />|         |
+| `GITHUB_REDIRECT_DOMAIN` | Domain for GitHub OAuth redirection              |                                              |         |
 
 ### **Organization appearance**