Skip to content

Installing the App in Nautobot


  • The plugin is compatible with Nautobot 1.4.0 and higher.
  • Databases supported: PostgreSQL, MySQL


Please check the dedicated page for a full compatibility matrix and the deprecation policy.

Install Guide


Plugins can be installed manually or using Python's pip. See the nautobot documentation for more details. The pip package name for this plugin is nautobot-ssot.

The plugin is available as a Python package via PyPI and can be installed with pip:

pip install nautobot-ssot

To ensure Single Source of Truth 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 nautobot-ssot package:

echo nautobot-ssot >> local_requirements.txt

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 file:

  • Append "nautobot_ssot" to the PLUGINS list.
  • Append the "nautobot_ssot" dictionary to the PLUGINS_CONFIG dictionary and override any defaults.
# In your
PLUGINS = ["nautobot_ssot"]

#   "nautobot_ssot": {
#     "hide_example_jobs": True
#   }
# }

Once the Nautobot configuration is updated, run the Post Upgrade command (nautobot-server post_upgrade) to run migrations and clear any cache:

nautobot-server post_upgrade

Then restart (if necessary) the Nautobot services which may include:

  • Nautobot
  • Nautobot Workers
  • Nautobot Scheduler
sudo systemctl restart nautobot nautobot-worker nautobot-scheduler

App Configuration

The plugin behavior can be controlled with the following list of settings:

Key Example Default Description
hide_example_jobs True False A boolean to represent whether or display the example job.