Package: netbox-secrets
Netbox SecretsThis is the continuation of theNetBox Secretstoreapp. The original plugin
is minimally maintained and has a lot of issues. This plugin is a complete rewrite of the original plugin. It is more generic
and flexible than the original plugin. It is also regularly tested with the latest NetBox releases to ensure compatibility
and stability.FeaturesStore secrets in the database encrypted with a public key (RSA)More generic and flexible than the original plugin (e.g. secrets can be assigned to any object in NetBox)Secrets can be assigned to contacts to associate them with a secret (e.g. SSH key)Updated user interface to make it easier to use and more intuitive to navigateRegularly tested with the latest NetBox releases to ensure compatibility and stabilityCompatibilityNetBox VersionPlugin Version3.3.x1.4.x, 1.5.x3.4.x1.6.x, 1.7.x3.5.x1.8.x3.6.x1.9.x3.7.x1.10.xInstallationInstall NetBox as per NetBox documentationAdd to local_requirements.txt:netbox-secretsInstall requirements:./venv/bin/pip install -r local_requirements.txtAdd to PLUGINS in NetBox configuration:'netbox_secrets',Run migration:./venv/bin/python netbox/manage.py migrateRun collectstatic:./venv/bin/python netbox/manage.py collectstatic --no-inputYou can view releases at:https://github.com/Onemind-Services-LLC/netbox-secrets/releasesConfigurationThe following options are available in the configuration file:appsType:ListDescription: List of apps to enableDefault:['dcim.device', 'virtualization.virtualmachine']display_defaultType:StringDescription: Where to display the secret on the detail page of the defined appsDefault:left_pageOptions:left_page,right_page,full_width_page,tab_viewdisplay_settingType:DictDescription: Set display setting for concrete modelDefault:{}Options:{'app.model': 'display_default'}Example:{'dcim.device': 'full_width_page', 'virtualization.virtualmachine': 'right_page'}enable_contactsType:BooleanDescription: Enable contacts for secretDefault:Falsepublic_key_sizeType:IntegerDescription: Size of the public keyDefault:2048Options:2048,4096,8192top_level_menuType:BooleanDescription: Enable top level menuDefault:FalseExtra ConfigurationThe following options are inherited from NetBox to configure the cookies:SESSION_COOKIE_SECUREType:BooleanDescription:Session Cookie SecureLOGIN_TIMEOUTType:IntegerDescription:Login TimeoutNote: These options should be set in the NetBox configuration file.ScreenshotsUser key (Without Session)User key (With Session)Secret Object ViewSecret Panel on DeviceSecret Role Object ViewFAQHow can I migrate the data fromnetbox-secretstore?Note: This is a one-way migration. You can't migrate back tonetbox-secretstore. Ensure you do not have any data including tables for netbox-secrets already in the databaseThese instructions assume that you are running Netbox v3.4.x and the plugin version 1.7.x. Install a new version
ofnetbox_secretstoreas:pipinstallgit+https://github.com/Onemind-Services-LLC/netbox-secretstore@migration/nb34Note: You should have netbox-secretstore v1.4.4 installed now.Make sure to add both plugins to theconfiguration.pybefore the migration.Run the migration:pythonmanage.pymigrateFinally, readjust the indices for thenetbox-secretspluginpythonmanage.pysqlsequenceresetnetbox_secretsRun the output of the previous command in the database.You can now removenetbox-secretstorefrom the application. You may have clean up your database of the old tables manually.