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 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.
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-floor-plan
.
The app is available as a Python package via PyPI and can be installed with pip
:
To ensure Nautobot Floor Plan 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-floor-plan
package:
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_floor_plan"
to thePLUGINS
list.
# In your nautobot_config.py
PLUGINS = ["nautobot_floor_plan"]
# Optionally you can override default settings for config items to make grid labels like a chessboard (as seen in this example)
PLUGINS_CONFIG = {
"nautobot_floor_plan": {
"default_x_axis_labels": "letters",
"default_statuses": {
"FloorPlanTile": [
{"name": "Active", "color": "4caf50"},
],
}
}
Once the Nautobot configuration is updated, run the Post Upgrade command (nautobot-server post_upgrade
) to run migrations and clear any cache:
Then restart the Nautobot services which may include:
- Nautobot
- Nautobot Workers
- Nautobot Scheduler
If the App has been installed successfully, the Nautobot web UI should now show a new "Location Floor Plans" menu item under the "Organization" menu.
App Configuration¶
The app behavior can be controlled with the following list of settings:
Key | Example | Default | Description |
---|---|---|---|
default_x_axis_labels | "letters" | "numbers" | Label style for the floor plan grid. Can use numbers or letters in order. This setting will set the default selected value in the create form. |
default_y_axis_labels | "numbers" | "numbers" | Label style for the floor plan grid. Can use numbers or letters in order. This setting will set the default selected value in the create form. |
default_statuses | "name": "Active", "color": "4caf50" | See Note Below | A list of name and color key value pairs for the FloorPlanTile model |
Note
Defaults for statuses are as follows: