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

Changes to Docker and Podman documentation #50

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

herzenschein
Copy link

@herzenschein herzenschein commented Oct 6, 2023

This updates the container documentation to follow my findings under https://github.com/herzenschein/herz-podman/tree/main/writefreely.

There are a few noteworthy things here:

  • The bash script wasn't needed and it was outdated
  • The docs mention an example config file that doesn't exist yet (config/sample-config.ini), which should be added later
  • This also adds instructions for Podman
  • It has a troubleshooting section

I plan to add Podman Quadlets in the future, following the scheme I devised under https://github.com/herzenschein/herz-quadlet/tree/main/writefreely.

Companion pull request: writefreely/writefreely#784

Counter pull request: #39

This method should be guaranteed to be functional for Docker and Podman

The `docker-setup.sh` script will present you with a few questions to set up your dev instance. You can hit enter for most of them, except for "Admin username" and "Admin password." You'll probably have to wait a few seconds after running `docker-compose up -d` for the Docker services to come up before running the bash script.
```bash
cp config/sample-config.ini config.ini
Copy link

@safaci2000 safaci2000 Sep 3, 2024

Choose a reason for hiding this comment

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

why not simply make this part of the docker build? That way you won't have to do a manual step, and then you can simply run: docker-compose run writefreely-web config start which will update the config.ini without the weird directory behaviors. Even running a touch config.ini would be just as good.

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

Successfully merging this pull request may close these issues.

2 participants