Proposal to Add New Public Repository to NetBox Community for Dockerizing the NetBox Code #10005

Closed
opened 2025-12-29 21:25:31 +01:00 by adam · 2 comments
Owner

Originally created by @pawannitk on GitHub (Jul 24, 2024).

NetBox version

v4.0.3-dev

Feature type

New functionality

Proposed functionality

The proposed functionality is to provide a flexible Dockerization solution for NetBox by creating a new repository, netbox-code-dockerization, which uses NetBox version 4.0.3-dev ( offcourse user can pull new changes of netbox code into this repo). Unlike the existing netbox-docker repository, this new setup allows users to make custom changes to the NetBox code and new netbox versions can also be easily incorporated by pulling the latest changes of netbox into this repository. Additionally, it includes configurations for database, Redis, and cache, which can be imported from environment variables.

LINK to my repo: <removed>

Use case

This Dockerization approach is useful for users and developers who need to:

  1. Customize NetBox Code: Modify the NetBox code as per their requirements without being constrained by a fixed Docker image.
  2. Upgrade Easily: Pull the latest changes and use new NetBox versions with minimal or no changes to the existing structure.
  3. Flexible Configuration: Utilize database, Redis, and cache configurations through environment variables, enhancing deployment flexibility.
  4. Simplified Deployment: Quickly set up the NetBox environment using docker-compose, making it easy to manage and deploy NetBox along with its dependencies like PostgreSQL and Redis on any platform unlike venv where each user has to do the initial setup on each platform where user want to run the netbox.
  5. It will be very helpful for the setup where kubernetes is being used.

Database changes

No response

External dependencies

No response

Originally created by @pawannitk on GitHub (Jul 24, 2024). ### NetBox version v4.0.3-dev ### Feature type New functionality ### Proposed functionality The proposed functionality is to provide a flexible Dockerization solution for NetBox by creating a new repository, netbox-code-dockerization, which uses NetBox version 4.0.3-dev ( offcourse user can pull new changes of netbox code into this repo). Unlike the existing netbox-docker repository, this new setup allows users to make custom changes to the NetBox code and new netbox versions can also be easily incorporated by pulling the latest changes of netbox into this repository. Additionally, it includes configurations for database, Redis, and cache, which can be imported from environment variables. **LINK to my repo:** `<removed>` ### Use case This Dockerization approach is useful for users and developers who need to: 1. Customize NetBox Code: Modify the NetBox code as per their requirements without being constrained by a fixed Docker image. 2. Upgrade Easily: Pull the latest changes and use new NetBox versions with minimal or no changes to the existing structure. 3. Flexible Configuration: Utilize database, Redis, and cache configurations through environment variables, enhancing deployment flexibility. 4. Simplified Deployment: Quickly set up the NetBox environment using docker-compose, making it easy to manage and deploy NetBox along with its dependencies like PostgreSQL and Redis on any platform unlike venv where each user has to do the initial setup on each platform where user want to run the netbox. 5. It will be very helpful for the setup where kubernetes is being used. ### Database changes _No response_ ### External dependencies _No response_
adam closed this issue 2025-12-29 21:25:31 +01:00
Author
Owner

@jeremystretch commented on GitHub (Jul 24, 2024):

This is not a NetBox feature request. Please don't use our issues to promote your projects.

@jeremystretch commented on GitHub (Jul 24, 2024): This is not a NetBox feature request. Please don't use our issues to promote your projects.
Author
Owner

@pawannitk commented on GitHub (Jul 24, 2024):

Hi @jeremystretch this is not for promotion but for helping people. Currently there is no such useful resource over the internet that with few commands can run netbox with all its dependencies and that too with netbox code. There is netbox-docker repo but that is not having the code and we can't make our own changes as it is using fixed docker image. When i started dockerizing this code i faced problems due to non availability of resources and my significant time was wasted on trying the things even on small issues like configuring database using env variables so it is help people so that no other person should face the same. You can suggest the ways to get it onboarded on netbox-community.

Thanks and Regards

@pawannitk commented on GitHub (Jul 24, 2024): Hi @jeremystretch this is not for promotion but for helping people. Currently there is no such useful resource over the internet that with few commands can run netbox with all its dependencies and that too with netbox code. There is netbox-docker repo but that is not having the code and we can't make our own changes as it is using fixed docker image. When i started dockerizing this code i faced problems due to non availability of resources and my significant time was wasted on trying the things even on small issues like configuring database using env variables so it is help people so that no other person should face the same. You can suggest the ways to get it onboarded on netbox-community. Thanks and Regards
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#10005