{"id":13791988,"url":"https://github.com/netbox-community/netbox-acls","last_synced_at":"2025-05-16T11:04:26.350Z","repository":{"id":41362637,"uuid":"509227188","full_name":"netbox-community/netbox-acls","owner":"netbox-community","description":"A NetBox plugin for Access Lists based off of the NetBox Plugin Demo","archived":false,"fork":false,"pushed_at":"2025-04-20T18:59:51.000Z","size":3164,"stargazers_count":105,"open_issues_count":30,"forks_count":31,"subscribers_count":8,"default_branch":"dev","last_synced_at":"2025-05-13T03:43:11.586Z","etag":null,"topics":["hacktoberfest","netbox-plugin"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/netbox-acls/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"netbox-community/netbox-plugin-demo","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":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","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":"2022-06-30T20:41:02.000Z","updated_at":"2025-05-11T16:58:26.000Z","dependencies_parsed_at":"2023-10-15T05:38:19.294Z","dependency_job_id":"d60745d3-ef39-4cc2-8a33-9cebf4b0fb1c","html_url":"https://github.com/netbox-community/netbox-acls","commit_stats":{"total_commits":215,"total_committers":9,"mean_commits":23.88888888888889,"dds":"0.49302325581395345","last_synced_commit":"68f9860a1feede52441c42d5e93c04143bf8504b"},"previous_names":["ryanmerolle/netbox-acls"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netbox-community%2Fnetbox-acls","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netbox-community%2Fnetbox-acls/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netbox-community%2Fnetbox-acls/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netbox-community%2Fnetbox-acls/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netbox-community","download_url":"https://codeload.github.com/netbox-community/netbox-acls/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254518384,"owners_count":22084374,"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":["hacktoberfest","netbox-plugin"],"created_at":"2024-08-03T22:01:06.706Z","updated_at":"2025-05-16T11:04:26.333Z","avatar_url":"https://github.com/netbox-community.png","language":"Python","funding_links":[],"categories":["Plugins"],"sub_categories":[],"readme":"# NetBox Access Lists Plugin\n\nA [Netbox](https://github.com/netbox-community/netbox) plugin for Access List management.\n\n## Features\n\nThis plugin provides the following models:\n\n- Access Lists\n- Access List to Interface Assignment\n- Access List Rules (abstract model basis for other rules)\n- Access List Standard Rules\n- Access List Extended Rules\n\n## Origin\n\nBased on the NetBox plugin tutorial by [jeremystretch](https://github.com/jeremystretch):\n\n- [demo repository](https://github.com/netbox-community/netbox-plugin-demo)\n- [tutorial](https://github.com/netbox-community/netbox-plugin-tutorial)\n\nAll credit should go to Jeremy. Thanks, Jeremy!\n\nThis project just looks to build on top of this framework and model presented.\n\n## Contributing\n\nThis project is currently maintained by the [netbox-community](https://github.com/netbox-community).\n\nSee the [CONTRIBUTING](CONTRIBUTING.md) for more information.\n\n## Compatibility\n\nEach Plugin Version listed below has been tested with its corresponding NetBox Version.\n\n| NetBox Version      | Plugin Version |\n|:-------------------:|:--------------:|\n|      4.2.x          |     1.8.1      |\n|      4.1.x          |     1.7.0      |\n|   \u003e= 4.0.2 \u003c 4.1.0  |     1.6.1      |\n|      3.7.x          |     1.5.0      |\n|      3.6.x          |     1.4.0      |\n|      3.5.x          |     1.3.0      |\n|      3.4.x          |     1.2.2      |\n|      3.3.x          |     1.1.0      |\n|      3.2.x          |     1.0.1      |\n\n## Installing\n\nFor adding to a NetBox Docker setup see\n[the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).\n\nYou can install with pip:\n\n```bash\npip install netbox-acls\n```\n\nor by adding to your `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker):\n\n```bash\nnetbox-acls\n```\n\n## Configuration\n\nEnable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,\n or if you use netbox-docker, your `/configuration/plugins.py` file :\n\n```python\nPLUGINS = [\n    \"netbox_acls\"\n]\n\nPLUGINS_CONFIG = {\n    \"netbox_acls\": {\n        \"top_level_menu\": True # If set to True the plugin will add a top level menu item for the plugin. If set to False the plugin will add a menu item under the Plugins menu item.  Default is set to True.\n    },\n}\n```\n\nTo add the required `netbox-acls` tables to your NetBox database, run the `migrate` manager subcommand in the NetBox virtual environment:\n```\ncd /opt/netbox\nsudo ./venv/bin/python3 netbox/manage.py migrate\n```\n\n## Developing\n\n### VSCode + Docker + Dev Containers\n\nTo develop this plugin further one can use the included .devcontainer configuration. This configuration creates a docker container which includes a fully working netbox installation. Currently it should work when using WSL 2. For this to work make sure you have Docker Desktop installed and the WSL 2 integrations activated.\n\n1. In the WSL terminal, enter `code` to run Visual studio code.\n2. Install the devcontainer extension \"ms-vscode-remote.remote-containers\"\n3. Press Ctrl+Shift+P and use the \"Dev Container: Clone Repository in Container Volume\" function to clone this repository. This will take a while depending on your computer\n4. If you'd like the netbox instance to be prepopulated with example data from [netbox-initializers](https://github.com/tobiasge/netbox-initializers) run `make  initializers`\n5. Start the netbox instance using `make all`\n\nYour netbox instance will be served under 0.0.0.0:8000, so it should now be available under localhost:8000.\n\n## Screenshots\n\nAccess List - List View\n![Access List - List View](docs/img/access_lists.png)\n\nAccess List (Type Extended) - Individual View\n![Access List Type Extended - Individual View](docs/img/access_list_type_extended.png)\n\nAccess List (Type Standard) - Individual View\n![Access List Type Standard - Individual View](docs/img/access_list_type_standard.png)\n\nExtended Access List Rules - List View\n![Extended Access List Rules - List View](docs/img/acl_extended_rules.png)\n\nStandard Access List Rules - List View\n![Standard Access List Rules - List View](docs/img/acl_standard_rules.png)\n\nAccess List Interface Assignments- List View\n![Access List Interface Assignments- List View](docs/img/acl_interface_assignments.png)\n\nHost (device, virtual_chassis, virtual_machine) Access Lists - New Card\n![Host Access Lists - New Card](docs/img/acl_host_view.png)\n\nHost Interface (vminterface interface) Access Lists - New Card\n![Host Interface Access Lists - New Card](docs/img/access_list_type_standard.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetbox-community%2Fnetbox-acls","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetbox-community%2Fnetbox-acls","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetbox-community%2Fnetbox-acls/lists"}