Skip to content

Commit 2678e75

Browse files
authored
Merge pull request #2054 from diggerhq/docs/improve-helm-setup-flow
docs: improve helm setup flow and clarify steps
2 parents e8a86a2 + f3a6243 commit 2678e75

File tree

1 file changed

+13
-29
lines changed

1 file changed

+13
-29
lines changed

docs/ce/self-host/deploy-helm.mdx

Lines changed: 13 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -140,20 +140,18 @@ description: "Learn how to use Helm chart to install Digger on your Kubernetes c
140140
```
141141
</Step>
142142

143-
<Step title="GitHub App setup">
144-
Navigate to your Digger hostname to create and configure the GitHub App:
143+
<Step title="Create GitHub App">
144+
Navigate to your Digger hostname to create the GitHub App:
145145

146146
1. Go to `https://your-digger-hostname/github/setup`
147147
2. Follow the web interface to create your GitHub App
148-
3. Install the app in your GitHub organization
149-
4. Collect the generated credentials:
150-
- GitHub App ID
151-
- Client ID
152-
- Client Secret
153-
- Private Key (base64 encoded)
154-
- Webhook Secret
148+
3. The page will display your app credentials
155149

156150
![Digger GitHub App Setup Success](/images/digger-github-app-wizard.png)
151+
152+
<Note>
153+
**Don't close this tab yet!** You'll need these credentials in the next steps.
154+
</Note>
157155
</Step>
158156

159157
<Step title="Update configuration with GitHub App credentials">
@@ -180,30 +178,16 @@ description: "Learn how to use Helm chart to install Digger on your Kubernetes c
180178
```
181179
</Step>
182180

183-
<Step title="Access Digger">
184-
After deployment, wait for 2-5 minutes for all pods to reach a running state.
185-
You can find the IP address/hostname by executing:
181+
<Step title="Install GitHub App">
182+
Click the installation link shown in the GitHub App creation wizard:
186183

187-
```bash
188-
kubectl get ingress -n digger
189-
```
184+
- The link will look like: `https://github.com/apps/your-digger-app-name/installations/new`
185+
- Install the app in your GitHub organization
186+
- Select which repositories the app can access
190187

191-
Access Digger at your configured hostname and verify the GitHub App is properly connected.
188+
After installation, you can verify everything is working by creating a pull request with Terraform/OpenTofu files and commenting `digger plan`.
192189
</Step>
193190

194-
<Step title="Upgrade your instance">
195-
To upgrade your instance of Digger, update the docker image tag in your Helm values and rerun:
196-
197-
```bash
198-
helm upgrade digger-backend oci://ghcr.io/diggerhq/helm-charts/digger-backend \
199-
--namespace digger \
200-
--values values.yaml
201-
```
202-
203-
<Tip>
204-
Always back up your database before each upgrade, especially in a production environment.
205-
</Tip>
206-
</Step>
207191
</Steps>
208192

209193
## Advanced Configuration

0 commit comments

Comments
 (0)