-
-
Notifications
You must be signed in to change notification settings - Fork 151
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
Add docker compose #429
base: develop
Are you sure you want to change the base?
Add docker compose #429
Conversation
IMHO we should not repeat the same information in multiple places, either keep it here (probably better) or in the wiki, not both. Otherwise we have to maintain it in two places, in which case both will be out of sync/outdated very easily. I'd suggest adding the files to a |
I love this, @jaywon ! |
As per feedback, for now isolating Docker related files into a dedicated directory. * Move .env, .env.example, docker-compose.yml to docker/ * Update documentation for running ZAP/HUD in Docker
@thc202 I incorporated your feedback for moving the In regards to the documentation, I totally agree that info should not be duplicated but I also don't think it's intuitive or standard to have multiple In general I think developers expect to get a few things out of a main
Outside of that, it's standard expectation I think to go to a single wiki or branded documentation site for more descriptive information/details. I did start this and @mellaniesori and @dscrobonia were going to jump on a call this week to really get some traction around documentation with a proposed workflow if that's ok. Ultimately, Github Wikis really break down for really "selling" a project and organizing information well as opposed to something like this. So....long story short, I'd like to propose documentation driving towards that. Right now it will exist in wiki and the main |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general I think developers expect to get a few things out of a main README at a minimum:
How do I install the project
How do I run the project
Basic configurations/usage details
Couldn't agree more! I think its easy to overload the README as well as the wiki. I am SO excited for the new docs and I love the work/ changes to docs you've made here! Great movement towards a more refined HUD product.
Added simple
docker-compose
file for easily running the project in a Docker container with minimal setup and command line interaction.Could add explicit
docker network
to run on, not sure if anyone has an opinion on that or use the default that will be created.Copied raw
Docker
run commands from the wiki toREADME
as well to have at least the base installation options on the mainREADME
and let user drive to wiki for more granular subject matter.Hoping this makes it simple/clear for folks to start using quickly w/ a variety of options and little blockers.