casperklein/homeassistant-netbox repository overview

⁠Netbox for Home Assistant

Netbox⁠ is an open source web application designed to help manage and document computer networks.

⁠Installation

1. Add this⁠ Home Assistant add-ons repository to your Home Assistant instance or use the button above.
2. Install the netbox add-on.
3. Set user and password in the add-on options.
   • This will add a new superuser to netbox after the add-on starts.
   • The credentials must be removed from the add-on options afterwards, otherwise the addon will not start.
4. Start the add-on.
5. Click on the "OPEN WEB UI" button to open Netbox.

⁠Configuration

Note: Remember to restart the add-on when the configuration is changed.

Example add-on configuration:

"user": "admin"
"password": "insecure"
"https": true
"certfile": "fullchain.pem"
"keyfile": "privatekey.pem"

Note: This is just an example, don't copy and paste it! Create your own!

⁠Option: user / password

If set, a new netbox superuser is created on add-on start.

Important: Use these options only once. Check the log and after successful creation of the user, remove the credentials from the configuration.

⁠Option: https

Enables/Disables HTTPS on the web interface. Set it true to enable it, false otherwise.

⁠Option: certfile

A file containing a certificate, including its chain. If this file doesn't exist, the add-on start will fail.

Note: The file MUST be stored in the Home Assistant /ssl directory, which is the default for Home Assistant.

⁠Option: keyfile

A file containing the private key. If this file doesn't exist, the add-on start will fail.

Note: The file MUST be stored in the Home Assistant /ssl directory, which is the default for Home Assistant.

⁠Option: LOGIN_REQUIRED

Setting this to false will permit anonymous users to access most data in NetBox, but not make any changes. By default, anonymous users are not permitted to access any data in NetBox.

⁠Option: debug

If enabled, the merged Netbox configuration (default + custom) is stored in addon_configs/0da538cf_netbox/configuration-merged.py.

⁠Custom Netbox configuration

You can extend the default Netbox configuration, e.g. for plugins⁠:

• If the file addon_configs/0da538cf_netbox/configuration.py exists, it's content will be appended to the Netbox default configuration.
• If the file addon_configs/0da538cf_netbox/requirements.txt exists, the packages listed in that file will be installed by pip.

For example:

addon_configs/0da538cf_netbox/configuration.py:

PLUGINS = ['netbox_bgp','netbox_ipcalculator','netbox_qrcode', 'netbox_metatype_importer']

PLUGINS_CONFIG = {
    'netbox_metatype_importer': {
        'github_token': 'change-me'
    }
}

addon_configs/0da538cf_netbox/requirements.txt:

netbox-bgp
netbox-ipcalculator
netbox-qrcode
netbox-metatype-importer

The requirements are downloaded on addon start, so an internet connection is mandatory.

⁠Screenshots

⁠Main page

⁠Rack elevation

⁠Prefix hierarchy

⁠Cable Trace