Skip to content

Fix: gracefully handle missing optional env vars for Helm/Kubernetes (#186) #196

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

Open
AnthonyGeorgeAZ wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix: gracefully handle missing optional env vars for Helm/Kubernetes (#186) #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
84f4923
Improve getRuntimeValue for better value handlingfix: handle missing …
AnthonyGeorgeAZ May 3, 2026
22a3cd3
docs: add Helm/Kubernetes note for optional env vars (#186)
AnthonyGeorgeAZ May 3, 2026
4430f60
fix: resolve TypeScript type errors from getRuntimeValue returning un…
AnthonyGeorgeAZ May 3, 2026
43132f7
fix: add default values for optional env vars in application.yml (#186)
AnthonyGeorgeAZ May 4, 2026
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
4 changes: 4 additions & 0 deletions README.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,10 @@ Need customization or production setup? Continue reading below ↓
| BRAND_CONFIG | No | Brand config for white labeling. Requires license. In format `{ "name": "Quantum Labs", "shortName": "QL", "website": "https://example.io", mail: "contact@example.io" }` | (empty) |
| LDAP_ENABLED | No | Enables or disables LDAP. More variables are needed. You can get the full list [here](./dev-docs/LDAP_SETUP.md) | false |

#### Helm / Kubernetes deployments

When deploying with Helm, setting an optional variable to an empty string in `values.yaml` causes Kubernetes to strip it from the container entirely. Simply omit optional variables you don't need — the application will treat them as disabled. Avoid using placeholder sentinels like `"-"` as they will be passed as real values to services like Google Analytics or reCAPTCHA and may cause unexpected behaviour.

For production deployments, it’s strongly recommended to use unique credentials and not rely on defaults.

#### For remote servers
Expand Down
6 changes: 3 additions & 3 deletions api/src/main/resources/application.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ security:
token:
secret-key: ${JWT_SECRET_KEY}
expire-length: 1209600000 # 1000*60*60*24*14
invitation-via-email: ${INVITATION_VIA_EMAIL}
invitation-via-email: ${INVITATION_VIA_EMAIL:false}
recaptcha-secret-key: ${RECAPTCHA_SECRET_KEY:}
cors:
enabled: ${ENABLE_CORS:true}
Expand All @@ -96,7 +96,7 @@ frontend:
home-url: ${PUBLIC_HOME_URL:}
mail:
recipients: ${MAIL_RECIPIENTS}
enable: ${ENABLE_EMAIL_NOTIFICATIONS}
enable: ${ENABLE_EMAIL_NOTIFICATIONS:false}
type: ${MAIL_TYPE:SMTP}
superAdmin:
role:
Expand Down Expand Up @@ -129,7 +129,7 @@ enable-sso: ${ENABLE_SSO:false}
oauth2:
success-redirect-url: ${PUBLIC_FRONT_URL}/oauth2/success
failure-redirect-url: ${PUBLIC_FRONT_URL}/oauth2/failure
provider: ${OAUTH2_PROVIDER}
provider: ${OAUTH2_PROVIDER:}
license-key: ${LICENSE_KEY:}
license-fingerprint-required: ${LICENSE_FINGERPRINT_REQUIRED:true}
license-file-path: ${LICENSE_FILE_PATH:}
Expand Down
14 changes: 8 additions & 6 deletions frontend/src/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,13 @@ const getRuntimeValue = (
key: string,
defaultValue = ''
): string | undefined => {
const envValue = process.env[`REACT_APP_${key}`];
const envValue = process.env[`REACT_APP_${key}`]?.trim();
const runtimeValue = window.__RUNTIME_CONFIG__?.[key]?.trim();
return envValue || runtimeValue || defaultValue;
const value = envValue || runtimeValue || defaultValue;
if (!value || value.trim() === '' || value.trim() === '-' || value.trim() === 'disabled') {
return undefined;
}
return value.trim();
};

export const firebaseConfig = {
Expand Down Expand Up @@ -87,15 +91,13 @@ export const brandRawConfig: BrandRawConfig = getRuntimeValue('BRAND_CONFIG')
? JSON.parse(getRuntimeValue('BRAND_CONFIG'))
: null;

export const demoLink: string = getRuntimeValue('DEMO_LINK');
export const demoLink: string = getRuntimeValue('DEMO_LINK') ?? '';

export const isWhiteLabeled: boolean = !!(customLogoPaths || brandRawConfig);

export const IS_ORIGINAL_CLOUD = !isWhiteLabeled && isCloudVersion;

export const PADDLE_SECRET_TOKEN: string = getRuntimeValue(
'PADDLE_SECRET_TOKEN'
);
export const PADDLE_SECRET_TOKEN: string = getRuntimeValue('PADDLE_SECRET_TOKEN') ?? '';

export const paddleEnvironment = getRuntimeValue('PADDLE_ENVIRONMENT') as
| 'sandbox'
Expand Down