Installing the App in Nautobot¶
Here you will find detailed instructions on how to install and configure the App within your Nautobot environment.
- The plugin is compatible with Nautobot 1.6.0 and higher.
- Databases supported: PostgreSQL, MySQL
Please check the dedicated page for a full compatibility matrix and the deprecation policy.
The plugin is available as a Python package via PyPI and can be installed with
To ensure Welcome Wizard is automatically re-installed during future upgrades, create a file named
local_requirements.txt (if not already existing) in the Nautobot root directory (alongside
requirements.txt) and list the
Once installed, the plugin needs to be enabled in your Nautobot configuration. The following block of code below shows the additional configuration required to be added to your
- Append the
"welcome_wizard"dictionary to the
PLUGINS_CONFIGdictionary and override any defaults.
Once the Nautobot configuration is updated, run the Post Upgrade command (
nautobot-server post_upgrade) to run migrations and clear any cache:
Then restart (if necessary) the Nautobot services which may include:
- Nautobot Workers
- Nautobot Scheduler
The plugin behavior can be controlled with the following list of settings:
||If enabled, the device type git repository will be automatically added for you.|
||If enabled, the Welcome Wizard banner will display on the home screen for authenticated users.|