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.

Developer Note - Remove Me!

Detailed instructions on installing the App. You will need to update this section based on any additional dependencies or prerequisites.

Prerequisites

  • The app is compatible with Nautobot 2.0.0 and higher.
  • Databases supported: PostgreSQL, MySQL

Note

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

Access Requirements

Developer Note - Remove Me!

What external systems (if any) it needs access to in order to work.

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_app_vpn.

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

pip install nautobot_app_vpn

To ensure VPN APP 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_app_vpn package:

echo nautobot_app_vpn >> 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_app_vpn" to the PLUGINS list.
  • Append the "nautobot_app_vpn" dictionary to the PLUGINS_CONFIG dictionary and override any defaults.
# In your nautobot_config.py
PLUGINS = ["nautobot_app_vpn"]

# PLUGINS_CONFIG = {
#   "nautobot_app_vpn": {
#     ADD YOUR SETTINGS HERE
#   }
# }

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

Developer Note - Remove Me!

Any configuration required to get the App set up. Edit the table below as per the examples provided.

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

Key Example Default Description
enable_backup True True A boolean to represent whether or not to run backup configurations within the app.
platform_slug_map {"cisco_wlc": "cisco_aireos"} None A dictionary in which the key is the platform slug and the value is what netutils uses in any "network_os" parameter.
per_feature_bar_width 0.15 0.15 The width of the table bar within the overview report