Skip to content

Add baseline values #2044

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.

Sign up for GitHub

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 1 commit into from
Jul 23, 2025
Merged

Add baseline values #2044

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 34 additions & 3 deletions docs/ce/self-host/deploy-helm.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,43 @@ description: "Learn how to use Helm chart to install Digger on your Kubernetes c

<Steps>
<Step title="Create Helm values">
Create a `values.yaml` file. This will be used to configure settings for the Digger Helm chart.
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.
Create a `values.yaml` file. Start with this minimal configuration that will get Digger running:

```yaml values.yaml
# Minimal configuration for initial setup
digger:
# Disable ingress for initial setup
ingress:
enabled: false

# Basic authentication settings
secret:
httpBasicAuthUsername: "admin"
httpBasicAuthPassword: "changeme123" # CHANGE THIS!
bearerAuthToken: "changeme456" # CHANGE THIS!
hostname: "localhost" # Will be updated later

# Enable built-in PostgreSQL for testing
postgres:
enabled: true
secret:
useExistingSecret: false
postgresPassword: "changeme789" # CHANGE THIS!
Comment on lines +24 to +36
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example configuration includes predictable default passwords like "changeme123" that could lead to security vulnerabilities if users deploy with these defaults. Despite the warning to change these passwords, some users might overlook this warning or deploy the configuration as-is for testing and forget to change it later.

This is a security issue because:

  1. Predictable default credentials are a common security vulnerability that can lead to unauthorized access
  2. The current format with "changeme123" might encourage users to deploy with these credentials for testing
  3. The current comment style ("# CHANGE THIS!") may not be prominent enough to ensure users actually change the passwords

The fix replaces the default passwords with placeholder text that:

  1. Makes it impossible to deploy without changing the values (forcing users to make a conscious choice)
  2. Uses a more prominent format that clearly indicates these values must be changed
  3. Adds an explicit warning at the top about not using default passwords in any environment
Suggested change
# Basic authentication settings
secret:
httpBasicAuthUsername: "admin"
httpBasicAuthPassword: "changeme123" # CHANGE THIS!
bearerAuthToken: "changeme456" # CHANGE THIS!
hostname: "localhost" # Will be updated later
# Enable built-in PostgreSQL for testing
postgres:
enabled: true
secret:
useExistingSecret: false
postgresPassword: "changeme789" # CHANGE THIS!
# Basic authentication settings
secret:
httpBasicAuthUsername: "admin"
# DO NOT use these default passwords in any environment
httpBasicAuthPassword: "<REQUIRED-CHANGE-THIS>"
bearerAuthToken: "<REQUIRED-CHANGE-THIS>"
hostname: "localhost" # Will be updated later
# Enable built-in PostgreSQL for testing
postgres:
enabled: true
secret:
useExistingSecret: false
postgresPassword: "<REQUIRED-CHANGE-THIS>"

```

<Info>
You can also install without a values.yaml file initially and configure later, but using a values file is recommended for better control.
This minimal configuration:
- Disables ingress (we'll configure it later)
- Sets up basic authentication
- Uses built-in PostgreSQL for testing
- Gets you up and running quickly
</Info>

<Warning>
Remember to change all default passwords before proceeding!
</Warning>

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.
</Step>

<Step title="Select Digger version">
Expand Down
Loading