beads/docs
Sam 7e4da9ab20
Add credentials file support for Dolt server passwords (#2854)
* feat: add credentials file support for Dolt server passwords

Add INI-style credentials file (~/.config/beads/credentials) as a
fallback for Dolt server passwords, keyed by [host:port] section.
This lets users working with multiple servers avoid juggling env vars
per project.

Lookup order: BEADS_DOLT_PASSWORD env var > credentials file > empty.
Path overridable via BEADS_CREDENTIALS_FILE env var.
Warns on overly permissive file permissions (unix only, mirrors ssh).

* docs: document credentials file in DOLT.md

Add credentials file section to the Dolt backend docs covering file
format, default location, permission warnings, and password resolution
order. Update the config reference and env var table to reference the
new feature.

* fix: use resolved runtime port for credentials file lookup

The credential file lookup in GetDoltServerPassword() used the port
from metadata.json, but the actual connection port comes from
doltserver.DefaultConfig() which has its own priority chain (port file >
config.yaml > metadata.json). When these diverge — e.g., IAP tunnel on
3308 vs local Dolt on 3307 — the credentials file lookup used the wrong
[host:port] section.

Add GetDoltServerPasswordForPort() that accepts an explicit port, and
use it in main.go where the resolved runtime port is already known.
Existing GetDoltServerPassword() delegates to the new method for
backward compatibility.

* fix: use mysql.Config.FormatDSN for proper password escaping

Passwords with special characters (& < > / % etc.) were inserted raw
into the DSN string, breaking go-sql-driver/mysql parsing. Passwords
like "zId&z,L9P4X,%k4n4rylGV<Ibos9<)/p" would cause "Access denied"
errors even though the password was correct.

Switch from manual fmt.Sprintf DSN construction to mysql.Config's
FormatDSN(), which handles escaping correctly. This also consolidates
timeout and TLS configuration into the typed Config struct instead of
string concatenation.

* test: add DSN special character password roundtrip tests

Covers passwords with &, <, >, /, ?, %, @, :, and () — all of which
broke the old fmt.Sprintf DSN construction. Verifies that FormatDSN
produces a parseable DSN and the password survives the roundtrip.
2026-04-02 20:35:56 -07:00
..
design cleanup: remove remaining Gas Town terminology from help text, docs, and comments 2026-03-22 13:27:43 -07:00
dev-notes docs: remove stale daemon refs and bd sync --status/--merge references 2026-02-28 19:54:49 -07:00
ADAPTIVE_IDS.md feat: support issue_id_mode=counter for sequential IDs (#2013) 2026-02-22 23:49:46 -08:00
ADVANCED.md refactor: remove gastown/Gas Town string references from beads code and docs (bd-1ue8) 2026-03-20 18:39:50 -07:00
AIDER_INTEGRATION.md docs: replace stale bd sync references with bd dolt push/pull (GH#2442, GH#2435) 2026-03-08 10:12:08 -07:00
ANTIVIRUS.md harden installers and docs for transparent trust model (GH#1857) 2026-03-15 12:02:56 -07:00
ARCHITECTURE.md /{README,cmd}: go back to init 2026-03-28 13:47:20 -07:00
ATTRIBUTION.md fix: remove dead 3-way merge config remnants (GH#2353) 2026-03-05 15:57:33 -08:00
audit-sync-mode-complexity.md fix: complete UUID primary keys cleanup across codebase 2026-03-14 10:12:04 -07:00
CLAUDE.md refactor: remove gastown/Gas Town string references from beads code and docs (bd-1ue8) 2026-03-20 18:39:50 -07:00
CLAUDE_INTEGRATION.md docs: document bd setup command 2025-12-16 01:08:42 -08:00
CLI_REFERENCE.md /{README,cmd}: go back to init 2026-03-28 13:47:20 -07:00
COLLISION_MATH.md docs: fix broken relative links across documentation 2025-12-16 00:46:08 -08:00
COMMUNITY_TOOLS.md Add claude-workspace-snapshot to Claude Code Orchestration 2026-03-28 21:04:19 -07:00
CONFIG.md /{README,cmd}: go back to init 2026-03-28 13:47:20 -07:00
CONTRIBUTOR_NAMESPACE_ISOLATION.md cleanup: remove remaining Gas Town terminology from help text, docs, and comments 2026-03-22 13:27:43 -07:00
COPILOT_INTEGRATION.md fix: replace stale 'bd sync' references with bd dolt push/commit (GH#2435) 2026-03-07 17:00:19 +01:00
DEPENDENCIES.md docs(deps): add DEPENDENCIES.md covering dependency system and gates 2026-02-27 10:09:05 -08:00
DOLT-BACKEND.md /{cmd,docs,internal}: more cleanup 2026-03-31 12:33:52 -07:00
DOLT.md Add credentials file support for Dolt server passwords (#2854) 2026-04-02 20:35:56 -07:00
ERROR_HANDLING.md docs: remove stale daemon refs and bd sync --status/--merge references 2026-02-28 19:54:49 -07:00
EXCLUSIVE_LOCK.md docs(claim): standardize start-work semantics to --claim (#2070) 2026-02-24 22:11:39 -08:00
FAQ.md /{README,cmd}: go back to init 2026-03-28 13:47:20 -07:00
GIT_INTEGRATION.md /{cmd,docs,internal}: more cleanup 2026-03-31 12:33:52 -07:00
graph-links.md refactor: remove Gas Town references from codebase 2025-12-30 14:13:32 -08:00
INSTALLING.md harden installers and docs for transparent trust model (GH#1857) 2026-03-15 12:02:56 -07:00
INTEGRATION_CHARTER.md Add Integration Charter: define scope boundary for tracker integrations 2026-03-30 09:12:28 -07:00
INTERNALS.md refactor: remove gastown/Gas Town string references from beads code and docs (bd-1ue8) 2026-03-20 18:39:50 -07:00
LABELS.md cleanup: remove remaining Gas Town terminology from help text, docs, and comments 2026-03-22 13:27:43 -07:00
LINTING.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08:00
messaging.md refactor: remove gastown/Gas Town string references from beads code and docs (bd-1ue8) 2026-03-20 18:39:50 -07:00
METADATA.md docs: document issue.metadata field and reserved key prefixes 2026-02-06 02:14:10 -05:00
MOLECULES.md cleanup: remove remaining Gas Town terminology from help text, docs, and comments 2026-03-22 13:27:43 -07:00
MULTI_REPO_AGENTS.md fix: add shared Dolt server mode for multi-repo/agent setups (GH#2416) 2026-03-10 17:38:00 -07:00
MULTI_REPO_MIGRATION.md docs: replace stale bd sync references with bd dolt push/pull (GH#2442, GH#2435) 2026-03-08 10:12:08 -07:00
OBSERVABILITY.md /{cmd,docs,internal}: more cleanup 2026-03-31 12:33:52 -07:00
PERFORMANCE_TESTING.md docs: update stale SQLite references to Dolt across 10 documentation files 2026-02-16 01:22:58 -08:00
PLUGIN.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08:00
pr-752-chaos-testing-review.md docs: remove stale daemon references from all documentation (GH#1982) 2026-02-22 17:57:53 -08:00
PROTECTED_BRANCHES.md fix(docs): purge stale bd sync/import/--branch refs + add CI doc validation (GH#2522) 2026-03-11 13:25:40 -07:00
QUICKSTART.md Improve quickstart docs with Why Beads section and --explain examples 2026-03-30 09:13:16 -07:00
README_TESTING.md DOCTOR IMPROVEMENTS: visual improvements/grouping + add comprehensive tests + fix gosec warnings (#656) 2025-12-20 03:10:06 -08:00
RELEASE-STABILITY-GATE.md Add release stability gate for upgrade safety (GH#2951) (#2963) 2026-04-01 17:00:25 -07:00
RELEASING.md docs: remove stale daemon references from all documentation (GH#1982) 2026-02-22 17:57:53 -08:00
REPO_CONTEXT.md docs: replace stale bd sync references with bd dolt push/pull (GH#2442, GH#2435) 2026-03-08 10:12:08 -07:00
ROUTING.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08:00
RULES_AUDIT_DESIGN.md Add bd rules audit and bd rules compact commands (#2810) 2026-04-02 20:29:34 -07:00
SETUP.md feat(setup): target CLAUDE.md and GEMINI.md for hooks integrations 2026-03-15 15:02:52 -07:00
SYNC_SETUP.md /{cmd,docs,internal}: remove file removal that can cause data corruption 2026-03-31 12:04:55 -07:00
TESTING.md refactor(testutil): expand Dolt readiness to 5-state enum (#2304) 2026-03-03 03:55:54 -08:00
TESTING_PHILOSOPHY.md fix: remove dead 3-way merge config remnants (GH#2353) 2026-03-05 15:57:33 -08:00
TODO.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08:00
TROUBLESHOOTING.md /{cmd,docs,internal}: remove file removal that can cause data corruption 2026-03-31 12:04:55 -07:00
UI_PHILOSOPHY.md docs: consolidate duplicate UI_PHILOSOPHY files (GH#745) 2025-12-27 18:01:59 -08:00
UNINSTALLING.md docs: remove stale JSONL references from ~73 markdown files (bd-9ni.4) 2026-02-22 22:18:02 -08:00
WORKTREES.md fix(docs): purge stale bd sync/import/--branch refs + add CI doc validation (GH#2522) 2026-03-11 13:25:40 -07:00