{"id":13575518,"url":"https://github.com/netbox-community/netbox-docker","last_synced_at":"2025-05-12T13:11:49.580Z","repository":{"id":37759437,"uuid":"88978363","full_name":"netbox-community/netbox-docker","owner":"netbox-community","description":"🐳  Docker Image of NetBox","archived":false,"fork":false,"pushed_at":"2025-05-12T12:54:52.000Z","size":1307,"stargazers_count":2112,"open_issues_count":21,"forks_count":975,"subscribers_count":48,"default_branch":"release","last_synced_at":"2025-05-12T13:11:42.730Z","etag":null,"topics":["docker","docker-compose","docker-image","hacktoberfest","netbox","python"],"latest_commit_sha":null,"homepage":"https://github.com/netbox-community/netbox-docker/wiki","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/netbox-community.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["cimnine","tobiasge"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2017-04-21T11:46:28.000Z","updated_at":"2025-05-12T01:34:37.000Z","dependencies_parsed_at":"2023-12-02T10:29:50.627Z","dependency_job_id":"11e7c493-752d-40b4-95ca-9872f87a6c7e","html_url":"https://github.com/netbox-community/netbox-docker","commit_stats":{"total_commits":867,"total_committers":115,"mean_commits":7.539130434782609,"dds":0.7808535178777394,"last_synced_commit":"27bf52cf3ea882324273fbabbf23f0af6a194f12"},"previous_names":[],"tags_count":74,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netbox-community%2Fnetbox-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netbox-community%2Fnetbox-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netbox-community%2Fnetbox-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netbox-community%2Fnetbox-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netbox-community","download_url":"https://codeload.github.com/netbox-community/netbox-docker/tar.gz/refs/heads/release","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253745175,"owners_count":21957318,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","docker-image","hacktoberfest","netbox","python"],"created_at":"2024-08-01T15:01:01.752Z","updated_at":"2025-05-12T13:11:49.519Z","avatar_url":"https://github.com/netbox-community.png","language":"Python","readme":"# netbox-docker\n\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/netbox-community/netbox-docker)][github-release]\n[![GitHub stars](https://img.shields.io/github/stars/netbox-community/netbox-docker)][github-stargazers]\n![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/netbox-community/netbox-docker)\n![Github release workflow](https://img.shields.io/github/actions/workflow/status/netbox-community/netbox-docker/release.yml?branch=release)\n![Docker Pulls](https://img.shields.io/docker/pulls/netboxcommunity/netbox)\n[![GitHub license](https://img.shields.io/github/license/netbox-community/netbox-docker)][netbox-docker-license]\n\n[The GitHub repository][netbox-docker-github] houses the components needed to build NetBox as a container.\nImages are built regularly using the code in that repository\nand are pushed to [Docker Hub][netbox-dockerhub],\n[Quay.io][netbox-quayio] and [GitHub Container Registry][netbox-ghcr].\n_NetBox Docker_ is a project developed and maintained by the _NetBox_ community.\n\nDo you have any questions?\nBefore opening an issue on GitHub,\nplease join [our Slack][netbox-docker-slack]\nand ask for help in the [`#netbox-docker`][netbox-docker-slack-channel] channel,\nor start a new [GitHub Discussion][github-discussions].\n\n[github-stargazers]: https://github.com/netbox-community/netbox-docker/stargazers\n[github-release]: https://github.com/netbox-community/netbox-docker/releases\n[netbox-dockerhub]: https://hub.docker.com/r/netboxcommunity/netbox/\n[netbox-quayio]: https://quay.io/repository/netboxcommunity/netbox\n[netbox-ghcr]: https://github.com/netbox-community/netbox-docker/pkgs/container/netbox\n[netbox-docker-github]: https://github.com/netbox-community/netbox-docker/\n[netbox-docker-slack]: https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ\n[netbox-docker-slack-channel]: https://netdev-community.slack.com/archives/C01P0GEVBU7\n[netbox-slack-channel]: https://netdev-community.slack.com/archives/C01P0FRSXRV\n[netbox-docker-license]: https://github.com/netbox-community/netbox-docker/blob/release/LICENSE\n[github-discussions]: https://github.com/netbox-community/netbox-docker/discussions\n\n## Quickstart\n\nTo get _NetBox Docker_ up and running run the following commands.\nThere is a more complete [_Getting Started_ guide on our wiki][wiki-getting-started] which explains every step.\n\n```bash\ngit clone -b release https://github.com/netbox-community/netbox-docker.git\ncd netbox-docker\ntee docker-compose.override.yml \u003c\u003cEOF\nservices:\n  netbox:\n    ports:\n      - 8000:8080\nEOF\ndocker compose pull\ndocker compose up\n```\n\nThe whole application will be available after a few minutes.\nOpen the URL `http://0.0.0.0:8000/` in a web-browser.\nYou should see the NetBox homepage.\n\nTo create the first admin user run this command:\n\n```bash\ndocker compose exec netbox /opt/netbox/netbox/manage.py createsuperuser\n```\n\nIf you need to restart Netbox from an empty database often,\nyou can also set the `SUPERUSER_*` variables in your `docker-compose.override.yml`.\n\n[wiki-getting-started]: https://github.com/netbox-community/netbox-docker/wiki/Getting-Started\n\n## Container Image Tags\n\nNew container images are built and published automatically every ~24h.\n\n\u003e We recommend to use either the `vX.Y.Z-a.b.c` tags or the `vX.Y-a.b.c` tags in production!\n\n- `vX.Y.Z-a.b.c`, `vX.Y-a.b.c`:\n  These are release builds containing _NetBox version_ `vX.Y.Z`.\n  They contain the support files of _NetBox Docker version_ `a.b.c`.\n  You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.\n  These images are automatically built from [the corresponding releases of NetBox][netbox-releases].\n- `latest-a.b.c`:\n  These are release builds, containing the latest stable version of NetBox.\n  They contain the support files of _NetBox Docker version_ `a.b.c`.\n  You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.\n- `snapshot-a.b.c`:\n  These are prerelease builds.\n  They contain the support files of _NetBox Docker version_ `a.b.c`.\n  You must use _NetBox Docker version_ `a.b.c` to guarantee the compatibility.\n  These images are automatically built from the [`main` branch of NetBox][netbox-main].\n\nFor each of the above tag, there is an extra tag:\n\n- `vX.Y.Z`, `vX.Y`:\n  This is the same version as `vX.Y.Z-a.b.c` (or `vX.Y-a.b.c`, respectively).\n- `latest`\n  This is the same version as `latest-a.b.c`.\n  It always points to the latest version of _NetBox Docker_.\n- `snapshot`\n  This is the same version as `snapshot-a.b.c`.\n  It always points to the latest version of _NetBox Docker_.\n\n[netbox-releases]: https://github.com/netbox-community/netbox/releases\n[netbox-main]: https://github.com/netbox-community/netbox/tree/main\n\n## Documentation\n\nPlease refer [to our wiki on GitHub][netbox-docker-wiki] for further information on how to use the NetBox Docker image properly.\nThe wiki covers advanced topics such as using files for secrets, configuring TLS, deployment to Kubernetes, monitoring and configuring LDAP.\n\nOur wiki is a community effort.\nFeel free to correct errors, update outdated information or provide additional guides and insights.\n\n[netbox-docker-wiki]: https://github.com/netbox-community/netbox-docker/wiki/\n\n## Getting Help\n\nFeel free to ask questions in our [GitHub Community][netbox-community]\nor [join our Slack][netbox-docker-slack] and ask [in our channel `#netbox-docker`][netbox-docker-slack-channel],\nwhich is free to use and where there are almost always people online that can help you.\n\nIf you need help with using NetBox or developing for it or against it's API\nyou may find [the `#netbox` channel][netbox-slack-channel] on the same Slack instance very helpful.\n\n[netbox-community]: https://github.com/netbox-community/netbox-docker/discussions\n\n## Dependencies\n\nThis project relies only on _Docker_ and _docker-compose_ meeting these requirements:\n\n- The _Docker version_ must be at least `20.10.10`.\n- The _containerd version_ must be at least `1.5.6`.\n- The _docker-compose version_ must be at least `1.28.0`.\n\nTo check the version installed on your system run `docker --version` and `docker compose version`.\n\n## Updating\n\nPlease read [the release notes][releases] carefully when updating to a new image version.\nNote that the version of the NetBox Docker container image must stay in sync with the version of the Git repository.\n\nIf you update for the first time, be sure [to follow our _How To Update NetBox Docker_ guide in the wiki][netbox-docker-wiki-updating].\n\n[releases]: https://github.com/netbox-community/netbox-docker/releases\n[netbox-docker-wiki-updating]: https://github.com/netbox-community/netbox-docker/wiki/Updating\n\n## Rebuilding the Image\n\n`./build.sh` can be used to rebuild the container image.\nSee `./build.sh --help` for more information or `./build-latest.sh` for an example.\n\nFor more details on custom builds [consult our wiki][netbox-docker-wiki-build].\n\n[netbox-docker-wiki-build]: https://github.com/netbox-community/netbox-docker/wiki/Build\n\n## Tests\n\nWe have a test script.\nIt runs NetBox's own unit tests and ensures that NetBox starts:\n\n```bash\nIMAGE=docker.io/netboxcommunity/netbox:latest ./test.sh\n```\n\n## Support\n\nThis repository is currently maintained by the community.\nThe community is expected to help each other.\n\nPlease consider sponsoring the maintainers of this project.\n","funding_links":["https://github.com/sponsors/cimnine","https://github.com/sponsors/tobiasge"],"categories":["Python","Deployment","python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetbox-community%2Fnetbox-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetbox-community%2Fnetbox-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetbox-community%2Fnetbox-docker/lists"}