This release contains the following notable changes:
New Branching Model #184 #202
We have switched the branching model of this repository. What was the master branch will become the release branch. There is a new develop branch already.
This new branching model and the reasons for the change are documented in our wiki.
If you want to update your local docker-compose scripts, this means you have to checkout the new branch:
git fetch --prune
git checkout -b release --track origin/releaseNon-Root image #172 #186
The Netbox Docker image was enhanced to be compatible with setups that require the container to be run as non-root user. This was suggested originally by @Furragen in #172 and was implemented in #186.
The changes to the image are kept to a minimum. You can now run the netbox and netbox-worker containers by defining an uid, e.g. 101. The way Linux works is that this user does not have to exist, so we don't actually create it.
All files created with this new image will be created using umask 002.
Upgrade instructions
If you have read-write-enabled mounts (e.g. for the media folder of Netbox), make sure that they are group-writable for root. The same is valid for the static filed folder.
The simplest way to do this is by deleting the volume:
docker-compose stop netbox
docker volume rm netbox-docker_netbox-static-files
docker-compose up -d netbox(If your project folder is not called netbox-docker, use the following command to figure out the name of the volume to delete: docker volume ls | grep netbox-static-files).
PostgreSQL 11 #195
Our docker-compose file was updated to use PostgreSQL 11.
If you have experience with running Netbox with PostgreSQL 12, please open an issue.
We'd love to upgrade!
Also note that you will need to take manual action after you upgrade a live PostgreSQL database.
If your database is not too big, a full backup (with PostgreSQL 10) and restore (with a clean PostgreSQL 11) is probably the easiest to achieve. Our troubleshooting wiki page has instructions on how to backup and restore a Netbox database. Please test the procedure on a test system first!
Note that there is no requirement to update to PostgreSQL 11, you can stick to version 10 just fine. You could do this with a docker-compose.override.yml like so:
version: '3.4'
services:
postgres:
image: postgres:10-alpineRedis 5 #194
Our docker-compose file was updated to use Redis 5.
Massive Speedup in startup_scripts #207
It was possible to change the way the startup_scripts are executed. Initializers are startup_scripts as well, and they ship by default.
Before it used to take minutes to run through all the startup_scripts, now it's a matter of seconds.
There's almost no reason anymore to disable the execution of startup_scripts ;)
SSLMODE for PostgreSQL #177
A contribution by @sdktr enables the use of TLS when connection to a PostgreSQL database. TLS is often required if you use this image on cloud platforms. The default mode is set to prefer, which means that if TLS is available, Netbox will use it. Else it will fall-back to the unencrypted connection.
Documentation moved to the Wiki #189
Most of our documentation was removed from the README.md file, which has grown quite a bit.
That file now only contains the bare-minimum to get started with Netbox Docker.
Everything else, especially the troubleshooting section, are now in our wiki.
Maintenance
There have been a bunch of other maintenance tasks. See milestone 0.20.0 for a list of issues that are related to this release.
Compatibility
This version is compatible with Netbox 2.6.x, and probably earlier.
⚠️ This version does not work with Netbox 2.7.x! This is planned for the next version, 0.21.0.
Known Issues
It seems that are labels are not correctly applied when we build our image on Docker Hub. See #210 .