Skip to content

Commit 20db8f5

Browse files
committed
update README to include new config
1 parent a992d0a commit 20db8f5

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -59,28 +59,23 @@ or by adding to your `local_requirements.txt` or `plugin_requirements.txt` (netb
5959
netbox-acls
6060
```
6161

62+
## Configuration
63+
6264
Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
6365
or if you use netbox-docker, your `/configuration/plugins.py` file :
6466

6567
```python
6668
PLUGINS = [
67-
'netbox_acls'
69+
"netbox_acls"
6870
]
6971

7072
PLUGINS_CONFIG = {
71-
"netbox_acls": {},
73+
"netbox_acls": {
74+
"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.
75+
},
7276
}
7377
```
7478

75-
## Configuration
76-
77-
The following options are available in the configuration file:
78-
79-
- `top_level_menu`
80-
- - __Type__: `Boolean`
81-
- - __Default__: `True`
82-
- __Description__: 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.
83-
8479
## Developing
8580

8681
### VSCode + Docker + Dev Containers

0 commit comments

Comments
 (0)