Skip to content

Commit

Permalink
docs: 📝 Update documentation to reference how to install an App from …
Browse files Browse the repository at this point in the history
…PyPI or in plugins folder.
  • Loading branch information
jdrew82 committed Sep 10, 2024
1 parent 92149d1 commit 3b1e0a0
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion docs/plugins.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# App Installation

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

## Getting Started Using Apps

### Adding Apps using PyPI

1. Follow the steps in the README to create your Poetry environment and ensure you can build a container.
2. There are two methods by which to add a specific App to your environment with Poetry:

Expand Down Expand Up @@ -43,6 +45,28 @@ invoke build --no-cache
invoke stop start
```

### Adding Apps Using Plugins Folder

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:

#### Reference App in pyproject.toml

You can point to the App folder in the project `pyproject.toml` like so:

`nautobot-example-plugin = {path = "plugins/plugin_example"}`

### Install App from Wheel

The other option to install an App would be to uncomment the section of the Dockerfile that starts at line 37:

```text
# RUN for plugin in /source/plugins/*; do \
# cd $plugin && \
# poetry build && \
# cp dist/*.whl /tmp/dist; \
# done
```

## Nautobot Configuration

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:
Expand Down

0 comments on commit 3b1e0a0

Please sign in to comment.