Add command options and documentation to Docker Compose #1645
Conversation
This commit introduces the command configuration for the bandersnatch service in Docker Compose setup. It includes the default 'mirror' command and adds commented options for 'verify' and 'once' to provide alternatives for running bandersnatch. The 'command' section is now clearly documented, making it easier for developers and sysadmins to understand and modify the behavior of the bandersnatch service. Changes: - Added 'command' directive to bandersnatch service with the default 'mirror' option. - Included comments explaining how to use the 'verify' and 'once' commands. - Explained the purpose of additional flags for the 'mirror' command. - Provided documentation for the build context of the bandersnatch_nginx image.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1645 +/- ##
=======================================
Coverage 83.55% 83.55%
=======================================
Files 31 31
Lines 4324 4324
Branches 780 780
=======================================
Hits 3613 3613
Misses 524 524
Partials 187 187 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Sounds good - Can you add some examples of how to use this into the Docker compose readme please?
https://github.com/pypa/bandersnatch/blob/main/src/bandersnatch_docker_compose/README.md
Might help someone like me who's never ran docker-compose before :)
- And add a changelog entry please.
Added multiple command options for the bandersnatch service in the docker-compose.yml file. These options include mirror, force, debug, verbose, verify, and once modes. Each mode is explained in the comments and can be uncommented to use. This provides flexibility in running the bandersnatch service based on the user's needs.
- Added the missing step for removing Bandersnatch configuration files. - Included a step for cleaning up Docker artifacts with `docker system prune`. - Improved clarity and completeness of the repository removal instructions.
Add docker compose link in the main README.md
|
Changes:
Users can now choose from several modes by uncommenting the corresponding command in the docker-compose.yml file. Please review and let me know if any changes are required. |
|
Can you just run |
using pre-commit run --all-files
|
This PR introduces the command configuration for the bandersnatch service in Docker Compose setup. It includes the default 'mirror' command and adds commented options for 'verify' and 'once' to provide alternatives for running bandersnatch.
The 'command' section is now clearly documented, making it easier for developers and sysadmins to understand and modify the behavior of the bandersnatch service.
Changes: