{"id":17906699,"url":"https://github.com/netboxlabs/netbox-branching","last_synced_at":"2025-04-07T06:07:43.431Z","repository":{"id":252839146,"uuid":"831108233","full_name":"netboxlabs/netbox-branching","owner":"netboxlabs","description":"Official NetBox Labs plugin that implements git-like branching functionality for NetBox","archived":false,"fork":false,"pushed_at":"2025-03-18T17:52:08.000Z","size":523,"stargazers_count":87,"open_issues_count":35,"forks_count":6,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-03-31T05:03:14.764Z","etag":null,"topics":["netbox","version-control"],"latest_commit_sha":null,"homepage":"http://netboxlabs.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/netboxlabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-19T17:17:23.000Z","updated_at":"2025-03-28T21:46:50.000Z","dependencies_parsed_at":"2024-12-02T22:21:55.668Z","dependency_job_id":"a5269fd5-06f8-4e0b-8568-d15aed2c84fc","html_url":"https://github.com/netboxlabs/netbox-branching","commit_stats":null,"previous_names":["netboxlabs/netbox-branching"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netboxlabs%2Fnetbox-branching","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netboxlabs%2Fnetbox-branching/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netboxlabs%2Fnetbox-branching/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netboxlabs%2Fnetbox-branching/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netboxlabs","download_url":"https://codeload.github.com/netboxlabs/netbox-branching/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247601448,"owners_count":20964864,"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":["netbox","version-control"],"created_at":"2024-10-28T19:01:31.613Z","updated_at":"2025-04-07T06:07:43.401Z","avatar_url":"https://github.com/netboxlabs.png","language":"Python","funding_links":[],"categories":["Plugins"],"sub_categories":[],"readme":"# NetBox Branching\n\nThis [NetBox](http://netboxlabs.com/oss/netbox/) plugin introduces branching functionality. A branch is a discrete, static snapshot of the NetBox database which can be modified independently and later merged back into the main database. This enables users to make \"offline\" changes to objects within NetBox and avoid interfering with its integrity as the network source of truth. It also provides the opportunity to review changes in bulk prior to their application.\n\n## Requirements\n\n* NetBox v4.1 or later\n* PostgreSQL 12 or later\n\n## Installation\n\nBrief installation instructions are provided below. For a complete installation guide, please refer to the included documentation.\n\n1. Grant PostgreSQL permission for the NetBox database user to create schemas:\n\n```postgresql\nGRANT CREATE ON DATABASE $database TO $user;\n```\n\n2. Activate the NetBox virtual environment:\n\n```\n$ source /opt/netbox/venv/bin/activate\n```\n\n3. Install the plugin from [PyPI](https://pypi.org/project/netboxlabs-netbox-branching/):\n\n```\n$ pip install netboxlabs-netbox-branching\n```\n\n4. Add `netbox_branching` to the end of `PLUGINS` in `configuration.py`. Note that `netbox_branching` **MUST** be the last plugin listed.\n\n```python\nPLUGINS = [\n    # ...\n    'netbox_branching',\n]\n```\n\n5. Create `local_settings.py` (in the same directory as `settings.py`) to override the `DATABASES` \u0026 `DATABASE_ROUTERS` settings. This enables dynamic schema support.\n\n```python\nfrom netbox_branching.utilities import DynamicSchemaDict\nfrom .configuration import DATABASE\n\n# Wrap DATABASES with DynamicSchemaDict for dynamic schema support\nDATABASES = DynamicSchemaDict({\n    'default': DATABASE,\n})\n\n# Employ our custom database router\nDATABASE_ROUTERS = [\n    'netbox_branching.database.BranchAwareRouter',\n]\n```\n\n6. Run NetBox migrations:\n\n```\n$ ./manage.py migrate\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetboxlabs%2Fnetbox-branching","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetboxlabs%2Fnetbox-branching","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetboxlabs%2Fnetbox-branching/lists"}