netbox-community / netbox-docker

🐳 Docker Image of NetBox
https://github.com/netbox-community/netbox-docker/wiki
Apache License 2.0
1.73k stars 800 forks source link

Add docker compose daemon flag #1256

Closed joshmcorreia closed 1 month ago

joshmcorreia commented 1 month ago

New Behavior

Add the -d daemon flag so that the container continues to run in the background.

Contrast to Current Behavior

Currently if the user runs docker compose up their shell is blocked and the container will exit as soon as the user closes their shell.

Discussion: Benefits and Drawbacks

Benefits are that the container continues to run when the user exits their shell. No known drawbacks.

Changes to the Wiki

These changes should be reflected in the wiki as well for step 5.

Proposed Release Note Entry

Add docker compose daemon flag

Double Check

cimnine commented 1 month ago

Thanks for this suggestion.

The main goal of our project is to provide the container, and the compose file is mostly scaffolding for the development of the container. But my main concern is, that this makes it harder for beginners to find the log output and thereby know if something is off or not. It may also wrongly suggest that the containers may survive a reboot this way (they don't — such behavior would have to be defined in the docker-compose.override.yml by specifying the reboot property).

joshmcorreia commented 1 month ago

Ah I see, well in that case I would suggest pointing out in the wiki that the commands listed need to be run in a separate terminal because the docker compose up command will block further commands, specifically:

docker compose exec netbox /opt/netbox/netbox/manage.py createsuperuser
docker compose stop
docker compose down -v
cimnine commented 1 month ago

Anyone is free to improve the wiki as they believe it's best.