docs: Correct Docker setup errors + remove irrelevant native PostgreSQL instructions - #759
Merged
Merged
Conversation
…QL instructions - Fix POSTGRES_PORT: 5434 → 5432 - Fix REDIS_PORT: 6378 → 6379 - Fix POSGRES_DB typo → POSTGRES_DB in docker run command - Bump postgres image: 12 → 18 (Django 5.2 requires PostgreSQL 14+) - Remove native PostgreSQL setup instructions (Quickstart, user/db creation, permission management) : Redundant when using the recommended Docker setup where the container bootstraps everything from env vars; kept operational commands (drop, backup, restore) which remain useful regardless of setup method
Member
|
thanks, I forgot to update the dockerfile since I'm using the native setup rather than docker |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Fixes several errors in the README that block contributors from getting
the app running with the recommended Docker setup.
Changes
POSTGRES_PORT:5434→5432REDIS_PORT:6378→6379POSGRES_DBtypo →POSTGRES_DBin thedocker runcommand (wassilently ignored by Docker, causing the container to use the wrong
database name)
postgres:12→postgres:18: Django 5.2 raisesNotSupportedErrorwith PostgreSQL 12 (PostgreSQL 14 or later is required)creation, owner/password management) : These only apply to a
host-installed PostgreSQL. With the recommended Docker setup the
container bootstraps everything from env vars, making these blocks
misleading for contributors following the Docker path. Operational
commands (drop schema, backup, restore) are kept as they remain
useful during development regardless of setup method.
How I found this
Hit all of these while setting up a fresh local environment following
the README as written.