Skip to content

docs: re-write the docker setup #10

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

rihards-simanovics
Copy link
Member

@rihards-simanovics rihards-simanovics commented Mar 23, 2025

closes #6
closes #9

end result should look like this:

image

@rihards-simanovics rihards-simanovics linked an issue Mar 23, 2025 that may be closed by this pull request
Copy link

vercel bot commented Mar 23, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
invoice-shelf-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 23, 2025 2:48am

@rihards-simanovics rihards-simanovics added the documentation Improvements or additions to documentation label Mar 23, 2025
@rihards-simanovics
Copy link
Member Author

@mchev, if you have time, could you check the docs and see if I missed anything? Thank you.

...
environment:
## Set your database password
- XXX_PASSWORD=somepass # Where XXX is the Database Type of your choice.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be give examples SQLITE_PASSWORDetc. Idk well the docker part but why not DB_PASSWORD too ?

Copy link
Member Author

@rihards-simanovics rihards-simanovics Apr 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Different Docker images use different environment variables, just like our own IS image. The MySQL image specifically requires the password environment variable to be set to MYSQL_PASSWORD, while the PostgreSQL image requires POSTGRES_PASSWORD.

Does our SQLite database have a password? Since the DB is stored locally in the project root and not encrypted by a password, I thought we only provided a path; I can update the doc if that's not the case.

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

Successfully merging this pull request may close these issues.

docker setup has various mistakes and outdated procedures Documentation improvements
2 participants