starred/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2026-01-13 04:40:29 +01:00
Code Issues 98 Packages Projects Releases 10 Wiki Activity

[Feature] Ability to Read Postgres-Pass from File #785

New Issue
Closed
opened 2025-12-29 02:23:59 +01:00 by adam · 3 comments
adam commented 2025-12-29 02:23:59 +01:00
Owner
Copy Link

Originally created by @felixw7k on GitHub (Sep 7, 2024).

Use case

As a system administrator i want to check my headscale-config into a git repository. Having secrets in git is considered bad practice, so any headscale-configuration with postgres.pass set, should not be pushed into a git-repo.

Description

If you want to have your configuration versioned, at the moment you are left with the options "using postgres via socket" or "using sqlite" since the password to your database-server would also be checked in.

Being able to read the postgres-password from a file in the headscale-config let's us treat the configuration as "non-secret".

In Docker this file could be bind-mounted by the admin , in a kubernetes-enviromnent it could be set as a secret; which both would no longer be headscale's concern.

Contribution

  • I can write the design doc for this feature
  • I can contribute this feature

How can it be implemented?

In my opinion, treating the postgres-password the same as the oidc-client-secret would be perfect:
Equivalent to oidc.client_secret_path i could imagine an option like postgres.pass_path to read the password from a file.

Originally created by @felixw7k on GitHub (Sep 7, 2024). ### Use case As a system administrator i want to check my headscale-config into a git repository. Having secrets in git is considered bad practice, so any headscale-configuration with `postgres.pass` set, should not be pushed into a git-repo. ### Description If you want to have your configuration versioned, at the moment you are left with the options "using postgres via socket" or "using sqlite" since the password to your database-server would also be checked in. Being able to read the postgres-password from a file in the headscale-config let's us treat the configuration as "non-secret". In Docker this file could be bind-mounted by the admin , in a kubernetes-enviromnent it could be set as a secret; which both would no longer be headscale's concern. ### Contribution - [ ] I can write the design doc for this feature - [ ] I can contribute this feature ### How can it be implemented? In my opinion, treating the postgres-password the same as the oidc-client-secret would be perfect: Equivalent to `oidc.client_secret_path` i could imagine an option like `postgres.pass_path` to read the password from a file.
adam added the enhancementstale labels 2025-12-29 02:23:59 +01:00
adam closed this issue 2025-12-29 02:23:59 +01:00
adam commented 2025-12-29 02:23:59 +01:00
Author
Owner
Copy Link

@kradalby commented on GitHub (Sep 9, 2024):

All the configuration options are also settable via environment variables, e.g. HEADSCALE_DATABASE_POSTGRES_PASS.

I dont disagree that it can also be read by file, but I think that solves the majority of problems.

Please also note that we do not actively support or improve postgres and strongly recommend the use of SQLite.

@kradalby commented on GitHub (Sep 9, 2024): All the configuration options are also settable via environment variables, e.g. HEADSCALE_DATABASE_POSTGRES_PASS. I dont disagree that it can also be read by file, but I think that solves the majority of problems. Please also note that we do not actively support or improve postgres and _strongly_ recommend the use of SQLite.
adam commented 2025-12-29 02:23:59 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Dec 25, 2024):

This issue is stale because it has been open for 90 days with no activity.

@github-actions[bot] commented on GitHub (Dec 25, 2024): This issue is stale because it has been open for 90 days with no activity.
adam commented 2025-12-29 02:23:59 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Jan 1, 2025):

This issue was closed because it has been inactive for 14 days since being marked as stale.

@github-actions[bot] commented on GitHub (Jan 1, 2025): This issue was closed because it has been inactive for 14 days since being marked as stale.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
CLI
DERP
DNS
Nix
OIDC
SSH
bug
database
documentation
duplicate
enhancement
faq
good first issue
grants
help wanted
might-come
needs design doc
needs investigation
no-stale-bot
out of scope
performance
policy 📝
pull-request
Mirrored from GitHub Pull Request
 question
regression
routes
stale
tags
tailscale-feature-gap
well described ❤️
wontfix
No Label enhancement stale
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#785
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?