Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

createdb instruction in README unclear #313

Open
schildbach opened this issue Sep 23, 2023 · 2 comments
Open

createdb instruction in README unclear #313

schildbach opened this issue Sep 23, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@schildbach
Copy link

The createdb command is mentioned in the README in order to create the correct Postgres DB. However, the command is neither in the repository, nor is it in the created docker image. I assume the documentation is out of date.

@DMRobertson
Copy link
Contributor

DMRobertson commented Sep 25, 2023

createdb is part of postgres.

The specific database name (syncv3 in the example) isn't important because you can tell the proxy exactly how to connect to postgres via the SYNCV3_DB environment variable.

If you have suggestions for how to improve the readme, we would gladly review a PR.

@DMRobertson DMRobertson changed the title documented createdb command missing createdb instruction in README unclear Sep 25, 2023
@DMRobertson DMRobertson added the documentation Improvements or additions to documentation label Sep 25, 2023
@jimmybrancaccio
Copy link

I actually got tripped up on this too - I'm not very familiar with PostgreSQL. I wonder if it would be worth just adding a little note in that section with exactly what you said:

createdb is part of postgres.

Or just show CREATE DATABASE syncv3;.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants