Skip to content

Commit 3b1e0a0

Browse files
committed
docs: 📝 Update documentation to reference how to install an App from PyPI or in plugins folder.
1 parent 92149d1 commit 3b1e0a0

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

docs/plugins.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# App Installation
22

3-
To add Apps you will need to build a custom container with the App(s) installed. There are multiple ways to add an App to your environment but this document will show the standard method pulling from PyPI.
3+
To add Apps you will need to build a custom container with the App(s) installed. There are multiple ways to add an App to your environment but this document will describe two options, the first is the [standard method pulling from PyPI](#adding-apps-using-pypi) and the second will be to [using the `plugins` folder](#adding-apps-using-plugins-folder).
44

55
## Getting Started Using Apps
66

7+
### Adding Apps using PyPI
8+
79
1. Follow the steps in the README to create your Poetry environment and ensure you can build a container.
810
2. There are two methods by which to add a specific App to your environment with Poetry:
911

@@ -43,6 +45,28 @@ invoke build --no-cache
4345
invoke stop start
4446
```
4547

48+
### Adding Apps Using Plugins Folder
49+
50+
In addition to adding Apps via PyPI, you can add Apps into your instance by having the code in the `plugins` folder. As long as the App folder contains a `pyproject.toml` file you can add the App with the following methods:
51+
52+
#### Reference App in pyproject.toml
53+
54+
You can point to the App folder in the project `pyproject.toml` like so:
55+
56+
`nautobot-example-plugin = {path = "plugins/plugin_example"}`
57+
58+
### Install App from Wheel
59+
60+
The other option to install an App would be to uncomment the section of the Dockerfile that starts at line 37:
61+
62+
```text
63+
# RUN for plugin in /source/plugins/*; do \
64+
# cd $plugin && \
65+
# poetry build && \
66+
# cp dist/*.whl /tmp/dist; \
67+
# done
68+
```
69+
4670
## Nautobot Configuration
4771

4872
The configuration file is the same file that is used by the Dockerfile in the Nautobot repo. This file should be updated to match what is required for each of the Apps. An example update for the Onboarding App looks like:

0 commit comments

Comments
 (0)