Releases: netbox-community/netbox-docker
Version 1.5.1
Noteworthy Changes
Fixed release action workflow #658
Release build fixed
Compatibility
This version of Netbox Docker is only compatible with Netbox v3.1.x.
For older versions, use a previous release of Netbox Docker.
Version 1.5.0
Noteworthy Changes
Add dir to configuration file #656
This fixed #653 and enables loading of the SOCIAL_AUTH_* settings
Startup scripts typos #632, #633
Thanks to @grawert for fixing some bugs in our startup initialisers
Added ENV variables for INSECURE_SKIP_TLS_VERIFY #630
INSECURE_SKIP_TLS_VERIFY for Redis connection settings is now loaded from ENV variable
Update postgres Docker tag to v14 #594
Our docker-compose file was updated to use PostgreSQL 14.
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 13, i.e. before the upgrade) and restore (with a clean PostgreSQL 14, i.e. after the upgrade) 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 14, you can stick to version 13 just fine. You could do this with a docker-compose.override.yml like so:
version: '3.4'
services:
postgres:
image: postgres:13-alpinePublish image to GitHub Container Registry #621
NetBox Docker is now also published to GitHub's Container Registry: docker pull ghcr.io/netbox-community/netbox
Install postgresql-client #620
Added psql to enable use of manage.py dbshell
jq check #607
Add check for jq command to build scripts and print error if it is not found
Compatibility
This version of Netbox Docker is only compatible with Netbox v3.1.x.
For older versions, use a previous release of Netbox Docker.
Contributors
Assets 2
Version 1.4.1
Noteworthy Changes
Project Version in Docker Tag #583
As of this release we will have Docker tags that relate to the version of the NetBox Docker project.
Some examples:
latest-ldapwill also be taggedlatest-ldap-1.4.1v3.0-ldapwill also be taggedv3.0-ldap-1.4.1v3.0.2-ldapwill also be taggedv3.0.2-ldap-1.4.1snapshot-ldapwill also be taggedsnapshot-ldap-1.4.1latestwill also be taggedlatest-1.4.1v3.0will also be taggedv3.0-1.4.1v3.0.2will also be taggedv3.0.2-1.4.1snapshotwill also be taggedsnapshot-1.4.1
Fix for user "101" not found #589
As a measure to prevent the getpwnam("101") failed, user "101" not found error, we changed the default user.
It is now the user called unit with the user-id 100 (instead of the previous user 101).
We don't expect this to cause troubles, as the group-id will still be 0 (i.e. root).
You can continue to run the container with any arbitrary user-id as long as the group-id is 0.
You should not run the container as user root (i.e. id 0)!
Updated dependencies #605 #608
- The
python-crc32cdependency was updated to version1.3.0.
It's release notes claim Python 3.10 compatibility. - The
django-storagedependency was updated to version1.12.1.
It's release notes state support for Django 3.2 among other changes.
Compatibility
This version of Netbox Docker is only compatible with Netbox v3.0.x.
For older versions, use a previous release of Netbox Docker.
Version 1.4.0
Noteworthy Changes
Drops privileges to user 101 and group 0 #546
This fixes some of the permission errors when the container is started as root.
Added container for Netbox housekeeping command #571
Netbox version 3.0.x has a new housekeeping command that should be run periodically. This adds an additional container in which this command is run every 24 hours. The interval can be changed with a new environment variable: HOUSEKEEPING_INTERVAL
Print last line of django db connection error while waiting for the database to start #565
Display an error message when the database fails to start and a hint on how to print the complete error
Check if remote branch exists before checkout #579
The build script checks if the Netbox branch / tags exists before starting the build process. With this change we can now print a useful error message if a branch / tag is missing instead of a Git error.
Use tini as entrypoint
All containers use tini as entrypint for correct handling of PID1 responsibilities.
Compatibility
This version of Netbox Docker is only compatible with Netbox v3.0.x. For older versions, use a previous release of Netbox Docker.
Known Issues
There are no confirmed issues at the time of writing this. See the issues labelled bug in our issues section.
Sponsoring
Consider buying the maintainers of this project a beer or drink:
Version 1.3.1
Noteworthy Changes
This release fixes a problem with the Python google-crc32c module when building the NetBox Docker image.
Bugfix/docker port issue #538
Fixed error with port on startup with latest Docker version (3.5.1 (66090)).
Compatibility
This version of Netbox Docker is only compatible with Netbox v3.0.x. For older versions, use a previous release of Netbox Docker.
Known Issues
There are no confirmed issues at the time of writing this. See the issues labelled bug in our issues section.
Sponsoring
Consider buying the maintainers of this project a beer or drink:
Version 1.3.0
This release adds support for for NetBox 3.0 and drops support for older releases.
Noteworthy Changes
Optimise migrations on startup #507
Migrations are only started when they are needed. Additionally some update tasks from Netbox are run when migrations where done.
Update postgres Docker tag to v13 #508
Our docker-compose file was updated to use PostgreSQL 13.
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 12, i.e. before the upgrade) and restore (with a clean PostgreSQL 13, i.e. after the upgrade) 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 13, you can stick to version 12 just fine. You could do this with a docker-compose.override.yml like so:
version: '3.4'
services:
postgres:
image: postgres:12-alpineAlpine update to 3.14 #534
Image is now based on Alpine 3.14
Compatibility
This version of NetBox Docker is only compatible with NetBox v3.0.x. For older versions, use a previous release of NetBox Docker.
Known Issues
There are no confirmed critical issues at the time of writing this. See the issues labelled bug in our issues section.
Sponsoring
Consider buying the maintainers of this project a beer or drink:
Version 1.2.0
This release adds support for for NetBox 2.11 and drops support for older releases. It also fixes some bugs in the initializers and in the handling of custom configuration files.
Noteworthy Changes
Initializers need updates! #485
As upstream NetBox evolves, our initializers have to follow suit. Therefore you need to adjust the following files if you make use of them. Also, rack_groups.yml was renamed to locations.yml.
# custom_links.yml
- name: link_to_repo
- text: 'Link to Netbox Docker'
- url: 'https://github.com/netbox-community/netbox-docker'
+ link_text: 'Link to Netbox Docker'
+ link_url: 'https://github.com/netbox-community/netbox-docker'# power_panels.yml
- rack_group: cage 101
+ location: cage 101# racks.yml
- group: cage 101
+ location: cage 101There are also some new features in devices.yml and vlan_groups.yml, see the respective files. We're very grateful for this work by @tobiasge.
Fixes for User, Groups and Permissions initializers #497
The underlying permission system changed in a recent NetBox version, which broke our initializer scripts.
@ryanmerolle has provided a fix for this.
Changes are required, if you use the initializers to set permissions!
Please see the PR and / or the current users.yml, groups.yml and object_permissions.yml files.
Removed the random port exposure #495
Previously, NetBox Docker's docker-compose.yml contained a line to expose NetBox Docker's internal port 8080 to a random port.
We have removed this now.
Because for a while now, we advise users to customize their setup using the docker-compose.override.yml file.
In it, you can bind NetBox Docker's port 8080 to a port of your choosing, often that would be 8080:8080.
Yet, because of the way Docker merges the two YAML files, it was only possible to add another port mapping.
But the old port mapping stayed around.
This was now changed.
This was initially suggested in #407 by @centum – thank you for starting the discussion – and @tobiasge provided the PR that was finally merged.
Extra configuration example for LDAP #448
Some things are better not configured through environment variables.
Until recently it was very hard to adjust such settings.
But we recently introduced the possibility for custom configuration files, that can be mounted into the container (or built-in by extending the container).
@ryanmerolle took the effort to propose an example configuration file, configuration/ldap/extra.py, which showcases some of the LDAP settings for which there is otherwise no obvious solution for their configuration.
RE: TLS
We previously recommended to use Hitch in order to set up TLS for NetBox Docker.
It turns out that this solution had some flaws.
We now suggest the same setup (from an architectural point of view), but with Caddy instead of Hitch.
Please find all the relevant information in the Wiki on our TLS page. (It even has an example showing how to configure that setup with automatic certificates from Let's Encrypt!)
Thanks to @ryanmerolle for the hard work of figuring out the nuts and bolts of this new setup.
This shall also be a short reminder that our wiki is a community wiki and that anyone is welcome to improve it or provide alternative solutions!
Fixed CMD passing #492
If you need to use a custom command with your NetBox Docker container, then may have experienced troubles before. @jhujhiti provided a fix for this. Thanks a lot!
Updated Dependencies #483 #486 #479 #477
The following pre-installed dependencies, that are not dependencies of NetBox itself, have been updated:
ruamel.yamlis now atv0.17.4django-auth-ldapis now atv2.4.0
These were provided by @renovate-bot – thanks for the awesome service!
Examples for plugin configuration and enhanced logging #496
There are now two additional configuration files, that are exemplarily for how to configure plugins and also for how to configure more fine-grained logging.
Note: If you turn on the logging, don't forget to add the LOGGING variable to your netbox.env or docker-compose.override.yml.
This improvement was proposed and implemented by @ryanmerolle.
Compatibility
This version of NetBox Docker is only compatible with NetBox v2.11.x. For older versions, use a previous release of NetBox Docker.
Known Issues
There are no confirmed critical issues at the time of writing this. See the issues labelled bug in our issues section.
Sponsoring
Consider buying the maintainers of this project a beer or drink:
Version 1.1.0
Noteworthy Changes
This releases fixes a bug with the discovery of custom configurations. It also updates some dependencies. See the correspoding milestone for all changed.
🚨 Upgrading from Earlier Versions than 1.0.0? Read this! ⚠️
We've made some major changes in version 1.0.0. Please read the corresponding release notes.
Fix Custom Configuration Discovery #450
There was a bug which prevented that certain custom configuration files were not loaded.
This was the case, when the custom configuration file's name was alphabetically before the main configuration file's name.
I.e. a_configuration.py is alphabetically before configuration.py. With this file, a_configuation.py, it was therefore not possible to overwrite values which are already declared in configuration.py. (The same holds true for ldap_config.py, but it's worse, because the letter L is relatively late in the alphabet.)
See #450 for more details.
Change of Slack server #455
As #netbox moved to a new Slack instance,
we're following suit.
Please join our new Slack channel #netbox-docker.
New Initializer #391
@MajesticFalcon kindly provided two new initializers. See these files for examples:
- initializers/custom_links.yml
- initializers/webhooks.yml
«Batteries Included» for Storage Backends #421
We now ship the dependencies to use the following django-storages-backends out of the box:
azure(for Azure Blob storage)boto3(for AWS S3 and compatible storage)dropboxgoogle(for Google Cloud Storage)libcloudsftp
See the django-storages documentation and the relevant part in the NetBox documentation.
Updated Dependencies #460 #438
The following dependencies were upgraded:
- ruamel.yaml to v0.16.13
- django-auth-ldap to v2.3.0
Compatibility
This version of NetBox Docker is only compatible with NetBox v2.10.x. For older versions, use a previous release of NetBox Docker.
Known Issues
There are no confirmed critical issues at the time of writing this. See the issues labelled bug in our issues section.
Sponsoring
Consider buying the maintainers of this project a beer or drink:
Version 1.0.2
Noteworthy Changes
This release fixes a problem with the Python cryptograhpy module when building the NetBox Docker image.
🚨 Upgrading from Earlier Versions than 1.0.0? Read this! ⚠️
We've made some major changes in version 1.0.0. Please read the corresponding release notes.
Compatibility
This version of Netbox Docker is only compatible with Netbox v2.10.x. For older versions, use a previous release of Netbox Docker.
Known Issues
There are no confirmed issues at the time of writing this. See the issues labelled bug in our issues section.
Sponsoring
Consider buying the maintainers of this project a beer or drink:
Version 1.0.1
Noteworthy Changes
This release fixes a typo in docker/launch-netbox.sh and updates the django-storages dependency.
🚨 Upgrading from Earlier Versions than 1.0.0? Read this! ⚠️
We've made some major changes in version 1.0.0. Please read the corresponding release notes.
Compatibility
This version of Netbox Docker is only compatible with Netbox v2.10.x. For older versions use a previous release of Netbox Docker.
Known Issues
There are no confirmed issues at the time of writing this. See the issues labelled bug in our issues section.
Sponsoring
Consider buying the maintainers of this project a beer or drink: