Description:
There is an inconsistency in the DATABASE_URL configuration between the Docker setup instructions and the .env.example files in the repository, which may cause issues when booting up the application.
Steps to Reproduce:
-
Follow the Docker setup instructions in the README.md:
docker run -d \
--name muzer-db \
-e POSTGRES_USER=myuser \
-e POSTGRES_PASSWORD=mypassword \
-e POSTGRES_DB=mydatabase \
-p 5432:5432 \
postgres
In this setup, the POSTGRES_USER is set to myuser and POSTGRES_PASSWORD is set to mypassword.
-
Compare the DATABASE_URL in the .env.example files for both next-app and ws folders:
DATABASE_URL=postgresql://postgres:postgres@postgres:5432/postgres
Problems:
-
Inconsistent Credentials:
The Docker setup uses myuser and mypassword, whereas the .env.example file uses postgres for both the username and password. This inconsistency can lead to authentication errors when starting the application, as the DATABASE_URL won't match the credentials defined in the Docker container.
-
Hostname Mismatch:
The .env.example files use postgres as the host (@postgres:5432), assuming the application is being run inside a Docker network. However, when not using Docker, the hostname should be localhost:
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/postgres
This causes a problem for users who are not using Docker, as the application tries to connect to postgres instead of localhost.
Proposed Solutions:
-
Update the Docker instructions in the README.md to match the .env.example file, using:
docker run -d \
--name muzer-db \
-e POSTGRES_USER=postgres \
-e POSTGRES_PASSWORD=postgres \
-e POSTGRES_DB=postgres \
-p 5432:5432 \
postgres
-
Modify the .env.example file to include a note or conditional configuration for users who are not using Docker, ensuring they switch the host to localhost:
# When using Docker, use the 'postgres' hostname
# DATABASE_URL=postgresql://postgres:postgres@postgres:5432/postgres
# For non-Docker setups, use 'localhost'
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/postgres
Additional Information:
- The mismatch between
localhost and postgres creates boot-up errors for users who are not running the database in a Docker network.
- Providing clear instructions for both Docker and non-Docker setups would improve the developer experience and reduce confusion.
Please let me know if any further clarification is needed!
Description:
There is an inconsistency in the
DATABASE_URLconfiguration between the Docker setup instructions and the.env.examplefiles in the repository, which may cause issues when booting up the application.Steps to Reproduce:
Follow the Docker setup instructions in the
README.md:In this setup, the
POSTGRES_USERis set tomyuserandPOSTGRES_PASSWORDis set tomypassword.Compare the
DATABASE_URLin the.env.examplefiles for bothnext-appandwsfolders:Problems:
Inconsistent Credentials:
The Docker setup uses
myuserandmypassword, whereas the.env.examplefile usespostgresfor both the username and password. This inconsistency can lead to authentication errors when starting the application, as theDATABASE_URLwon't match the credentials defined in the Docker container.Hostname Mismatch:
The
.env.examplefiles usepostgresas the host (@postgres:5432), assuming the application is being run inside a Docker network. However, when not using Docker, the hostname should belocalhost:This causes a problem for users who are not using Docker, as the application tries to connect to
postgresinstead oflocalhost.Proposed Solutions:
Update the Docker instructions in the
README.mdto match the.env.examplefile, using:Modify the
.env.examplefile to include a note or conditional configuration for users who are not using Docker, ensuring they switch the host tolocalhost:Additional Information:
localhostandpostgrescreates boot-up errors for users who are not running the database in a Docker network.Please let me know if any further clarification is needed!