Skip to content

Commit 2992ca6

Browse files
committed
docs: improve helm installation documentation structure
1 parent 9f718b6 commit 2992ca6

File tree

1 file changed

+10
-65
lines changed

1 file changed

+10
-65
lines changed

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

Lines changed: 10 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -12,43 +12,8 @@ description: "Learn how to use Helm chart to install Digger on your Kubernetes c
1212

1313
<Steps>
1414
<Step title="Create Helm values">
15-
Create a `values.yaml` file. Start with this minimal configuration that will get Digger running:
16-
17-
```yaml values.yaml
18-
# Minimal configuration for initial setup
19-
digger:
20-
# Disable ingress for initial setup
21-
ingress:
22-
enabled: false
23-
24-
# Basic authentication settings
25-
secret:
26-
httpBasicAuthUsername: "admin"
27-
httpBasicAuthPassword: "changeme123" # CHANGE THIS!
28-
bearerAuthToken: "changeme456" # CHANGE THIS!
29-
hostname: "localhost" # Will be updated later
30-
31-
# Enable built-in PostgreSQL for testing
32-
postgres:
33-
enabled: true
34-
secret:
35-
useExistingSecret: false
36-
postgresPassword: "changeme789" # CHANGE THIS!
37-
```
38-
39-
<Info>
40-
This minimal configuration:
41-
- Disables ingress (we'll configure it later)
42-
- Sets up basic authentication
43-
- Uses built-in PostgreSQL for testing
44-
- Gets you up and running quickly
45-
</Info>
46-
47-
<Warning>
48-
Remember to change all default passwords before proceeding!
49-
</Warning>
50-
51-
To explore all configurable properties, check the [values.yaml](https://github.com/diggerhq/digger/blob/develop/helm-charts/digger-backend/values.yaml) file in the repository.
15+
Create a `values.yaml` file. This will be used to configure settings for the Digger Helm chart.
16+
To explore all configurable properties for your values file, visit the [values.yaml reference](https://github.com/diggerhq/digger/blob/develop/helm-charts/digger-backend/values.yaml).
5217
</Step>
5318

5419
<Step title="Select Digger version">
@@ -140,35 +105,15 @@ description: "Learn how to use Helm chart to install Digger on your Kubernetes c
140105
```
141106
</Step>
142107

143-
<Step title="Initial deployment">
144-
Deploy Digger with the initial configuration. Choose one of the following approaches:
108+
<Step title="Install the Helm chart">
109+
Once you are done configuring your `values.yaml` file, run the command below to install Digger:
145110

146-
<Tabs>
147-
<Tab title="With values.yaml (Recommended)">
148-
If you've created a `values.yaml` file with your configuration:
149-
150-
```bash
151-
helm install digger-backend oci://ghcr.io/diggerhq/helm-charts/digger-backend \
152-
--namespace digger \
153-
--create-namespace \
154-
--values values.yaml
155-
```
156-
</Tab>
157-
158-
<Tab title="Without values.yaml (Quick start)">
159-
If you want to install with default values first and configure later:
160-
161-
```bash
162-
helm install digger-backend oci://ghcr.io/diggerhq/helm-charts/digger-backend \
163-
--namespace digger \
164-
--create-namespace
165-
```
166-
167-
<Warning>
168-
This will use default values. You'll need to configure secrets and other settings before Digger will work properly.
169-
</Warning>
170-
</Tab>
171-
</Tabs>
111+
```bash
112+
helm install digger-backend oci://ghcr.io/diggerhq/helm-charts/digger-backend \
113+
--namespace digger \
114+
--create-namespace \
115+
--values values.yaml
116+
```
172117

173118
Wait for all pods to reach a running state:
174119

0 commit comments

Comments
 (0)