You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/plugins.md
+25-1Lines changed: 25 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,11 @@
1
1
# App Installation
2
2
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).
4
4
5
5
## Getting Started Using Apps
6
6
7
+
### Adding Apps using PyPI
8
+
7
9
1. Follow the steps in the README to create your Poetry environment and ensure you can build a container.
8
10
2. There are two methods by which to add a specific App to your environment with Poetry:
9
11
@@ -43,6 +45,28 @@ invoke build --no-cache
43
45
invoke stop start
44
46
```
45
47
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:
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
+
46
70
## Nautobot Configuration
47
71
48
72
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