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

Docker container documentation #1479

Open
Tracked by #1470
Braqzen opened this issue Nov 22, 2023 · 0 comments
Open
Tracked by #1470

Docker container documentation #1479

Braqzen opened this issue Nov 22, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Braqzen
Copy link
Contributor

Braqzen commented Nov 22, 2023

We provide a docker-compose.yml but do not inform the user of what to do with it, how to alter it etc.

It would be useful to show the user the command to build / start a container, when to update via pull, how to update the compose file with additional flags and which sections to leave as they are.

Ex. in order to redeploy an indexer that has been updated I needed to update the container with a flag for the service and also deploy with an additional flag. This was undocumented at the time and I have raised an issue which may have been specifically addressed since then.

The idea is to get the user up and running quickly instead of assume that they know how to user docker.

@Braqzen Braqzen added the documentation Improvements or additions to documentation label Nov 22, 2023
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

1 participant