Skip to content

Installing the App in Nautobot

Here you will find detailed instructions on how to install and configure the App within your Nautobot environment.

Prerequisites

  • The app requires Nautobot 3.1.8 or later, below 4.0.0.
  • Databases supported: PostgreSQL, MySQL
  • Python 3.10 through 3.13
  • Operational Map archive uploads/tile reads require Python 3.11 or later and a persistent private filesystem directory. See the map deployment guide before enabling the map or upgrading an installation with existing archives.

Note

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

Access Requirements

No external systems are required for core operation of Nautobot TRAX. Integrations can be added as part of your broader Nautobot deployment.

Install Guide

Note

Apps can be installed from the Python Package Index or locally. See the Nautobot documentation for more details. The pip package name for this app is nautobot-trax.

The app is available as a Python package via PyPI and can be installed with pip.

Install the latest release:

pip install nautobot-trax

For a specific version pin:

pip install nautobot-trax==0.1.0

To ensure Nautobot TRAX 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-trax package:

echo nautobot-trax >> local_requirements.txt

Once installed, the app needs to be enabled in your Nautobot configuration. The following block of code below shows the additional configuration required to be added to your nautobot_config.py file:

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

# PLUGINS_CONFIG = {
#   "nautobot_trax": {}
# }

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

Core TRAX functions can use the default settings. For Operational Map deployment, configure private archive storage in your existing plugin configuration:

PLUGINS_CONFIG["nautobot_trax"] = {
    "map_storage_root": "/opt/nautobot/trax-private-map-tiles",
    "enable_demo_user": False,
}

The directory must be writable by Nautobot, persist across container recreation, and stay outside MEDIA_ROOT and STATIC_ROOT. Mount it in web, worker, and migration services. The map guide explains ownership, backups, migration of existing files, upload limits, and permissions.

Migration does not create the fixed-password demo operator by default. Use your own users and permissions for normal environments. The supplied development configuration explicitly enables the demo account; existing demo installations can run nautobot-server setup_operator_user to refresh its permissions.