Version 2.2.0

Noteworthy Changes

Initializers are now a plugin #831

All startup scripts, initializers and ruamel.yaml have been removed from the image. With this change we are now able to publish images faster after a release of a major NetBox version. The initializer functionality has been moved to a plugin. You can find this plugin here: https://github.com/tobiasge/netbox-initializers

Installed bzip2 #836

Some examples in our Wiki use bzip2 to compress backup data. Now we have bzip2 actually in the image.

Removed unnecessary logging from tests #835

To make the test logs clearer we removed some logging output

Update dependency django-storages to v1.13.1 #822

Changelog for django-storages

Compatibility

This version of NetBox Docker is only compatible with NetBox v3.3.x and above.
For older versions, use a previous release of NetBox Docker.

Version 2.1.0

Noteworthy Changes

Added our Python venv to the PATH variable #778

With our venv in the path manage.py commands can be started without absolute paths

Arm64 auto build #797

Images for ARM64 are build and pushed to the registries

Using Ubuntu 22.04 because Debian has old packages #805

Because of some security concerns (#800) we use Ubuntu and its newer packages

Add requirements for OIDC SSO #786

OIDC SSO was missing some Python packages to work correctly

LDAP TLS connection use the system trusted root store #808

Restores the same behaviour that we had in the old Alpine images: LDAP connections use the certificates from the system store (#799).

Compatibility

This version of Netbox Docker is only compatible with Netbox v3.2.x and above.
For older versions, use a previous release of Netbox Docker.

Version 2.0.0

Noteworthy Changes

This is a major release because the base image is now Debian 11. All users building their own images based on this one must check if they're using Alpine specific commands (like apk). These have to be changed to the Debian version (apt as example).
We are also not building images with the -ldap tag anymore because that is now integrated into the main image.

Fix setting custom field data if custom field object is missing #730

Fixed custom fields problem in initalizers.

feat: Make startup scripts idempotent #729

Running the startup scripts multiple times after changing values won't crash anymore

Added environment variable for CSRF_TRUSTED_ORIGINS #738

CSRF_TRUSTED_ORIGINS can now be set from ENV.

Add support for DeviceType components #742

Added initializers for DeviceType components

Contact startups #728

Added initializers for Contacs and related objects.

Add MAPS_URL to config #750

MAPS_URL can now be set from ENV.

Startup script for cables #736

Added initializers for cables.

Proposing SKIP_GIT now skips all git operations #768

SKIP_GIT now skips all git calls

Update dependency napalm to v4 #791

New major release of Napalm containing a fix that prevented our image from being build.

Compatibility

This version of Netbox Docker is only compatible with Netbox v3.2.x and above.
For older versions, use a previous release of Netbox Docker.

Version 1.6.1

Noteworthy Changes

Netbox 3.2 Database changes

WARNING: This release includes a database migration that will remove the asn, contact_name, contact_phone, and contact_email fields from the site model. (These fields have been superseded by the ASN and contact models introduced in NetBox v3.1.) To protect against the accidental destruction of data, the upgrade process will fail if any sites still have data in any of these fields. To bypass this safeguard, set the NETBOX_DELETE_LEGACY_DATA environment variable when running the upgrade script, which will permit the destruction of legacy data.

NOTE: A set of migration scripts is available to assist with the migration of legacy site data.

Github Actions

Use current versions for our workflow

Changes for Netbox 3.2

Some minor changes to add compatibility with Netbox 3.2 were needed.

Napalm

Version 3.4.0 of Napalm is used

Compatibility

This version of Netbox Docker is only compatible with Netbox v3.2.x and above.
For older versions, use a previous release of Netbox Docker.

Version 1.6.0

Noteworthy Changes

Added ASN initializer script #685

ASN instances can be created from initializers

Explicitly set GRAPHQL_ENABLED #695

GraphQL can now be configured from ENV variables

Cleanup & Reorg startup scripts #691

The initializer scripts have been re-sorted to make the ordering more logical. Duplicates were removed. Thanks to @ryanmerolle

Changes needed for Netbox 3.2

Some minor changes to add compatibility with Netbox 3.2 were needed (tzdata is installed, mkdocs fixed).

Compatibility

This version of Netbox Docker is only compatible with Netbox v3.1.x and above.
For older versions, use a previous release of 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-alpine

Publish 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.

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-ldap will also be tagged latest-ldap-1.4.1
• v3.0-ldap will also be tagged v3.0-ldap-1.4.1
• v3.0.2-ldap will also be tagged v3.0.2-ldap-1.4.1
• snapshot-ldap will also be tagged snapshot-ldap-1.4.1
• latest will also be tagged latest-1.4.1
• v3.0 will also be tagged v3.0-1.4.1
• v3.0.2 will also be tagged v3.0.2-1.4.1
• snapshot will also be tagged snapshot-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-crc32c dependency was updated to version 1.3.0.
  It's release notes claim Python 3.10 compatibility.
• The django-storage dependency was updated to version 1.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:

• Sponsor @cimnine
• Sponser @tobiasge

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:

• Sponsor @cimnine
• Sponser @tobiasge