Skip to content

docs: clarify DATABASE_URL vs DB_PATH precedence (#206)#234

Open
haidrrrry wants to merge 2 commits into
HKUDS:mainfrom
haidrrrry:contribute/hkuds-env-clarity
Open

docs: clarify DATABASE_URL vs DB_PATH precedence (#206)#234
haidrrrry wants to merge 2 commits into
HKUDS:mainfrom
haidrrrry:contribute/hkuds-env-clarity

Conversation

@haidrrrry
Copy link
Copy Markdown

Summary

Clarifies .env.example database configuration so PostgreSQL (DATABASE_URL) and SQLite (DB_PATH) are not read as conflicting defaults.

Fixes #206

Changes

  • Document that DATABASE_URL takes precedence when set
  • Document SQLite-only local quick start path
  • Note ALLOW_SQLITE=true for unit tests

Test plan

  • pytest service/server/tests/test_env_example.py

Explain PostgreSQL vs SQLite precedence so local SQLite defaults do not
look conflicting with PostgreSQL deployment examples. Fixes HKUDS#206.

Co-authored-by: Cursor <cursoragent@cursor.com>
@haidrrrry
Copy link
Copy Markdown
Author

Docs-only PR — no runtime behavior change.

pytest service/server/tests/test_env_example.py -q

Let me know if you want the same note copied into README self-hosting section.

Mirror .env.example guidance so self-hosters see PostgreSQL vs SQLite
precedence without opening env files first.

Co-authored-by: Cursor <cursoragent@cursor.com>
@haidrrrry
Copy link
Copy Markdown
Author

@TianyuFan0504 updated with README database note + .env.example clarification for #206. Docs-only, should be quick review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docker setup seems inconsistent with local SQLite default configuration

1 participant