Skip to content

Commit 9583f80

Browse files
committed
Update plugin guide docker options
- Fix paths to container installation directory - Modify some examples to show `custom-extensions` and `EXTENSIONS_DOWNLOAD` installation options specific to the container environment. - Add code groups to show file names Signed-off-by: Tony Germano <tony@germano.name>
1 parent d420d7d commit 9583f80

1 file changed

Lines changed: 15 additions & 11 deletions

File tree

docs/engine/plugins.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -69,27 +69,29 @@ For environments where UI-based installation is not feasible, you can install pl
6969

7070
When running OIE in a Docker container, you have several options for installing plugins:
7171

72-
#### Option 1: Volume Mount (Recommended)
72+
#### Example 1: Docker CLI with `custom-extensions` Volume Mount
7373

74-
Mount a host directory containing plugins to the container's extensions directory:
74+
Mount a host directory containing plugin zip files to the container's `custom-extensions` directory. The container's entrypoint script will unzip and install them to the `extensions` directory prior to launching the server:
7575

7676
```bash
7777
docker run -d \
78-
-v /path/to/local/extensions:/opt/oie/extensions \
78+
-v /path/to/local/custom-extensions:/opt/engine/custom-extensions \
7979
openintegrationengine/engine:latest
8080
```
8181

82-
#### Option 2: Custom Dockerfile
82+
#### Example 2: Custom Dockerfile with manual installation
8383

8484
Create a custom Docker image with plugins pre-installed:
8585

86-
```dockerfile
86+
::: code-group
87+
```dockerfile [Dockerfile]
8788
FROM openintegrationengine/engine:latest
8889

8990
COPY my-plugin.zip /tmp/
90-
RUN unzip /tmp/my-plugin.zip -d /opt/oie/extensions/ && \
91+
RUN unzip /tmp/my-plugin.zip -d /opt/engine/extensions/ && \
9192
rm /tmp/my-plugin.zip
9293
```
94+
:::
9395

9496
Build and run:
9597

@@ -98,21 +100,23 @@ docker build -t oie-with-plugins .
98100
docker run -d oie-with-plugins
99101
```
100102

101-
#### Option 3: Docker Compose
103+
#### Example 3: Docker Compose with `EXTENSIONS_DOWNLOAD` URL
102104

103-
Using Docker Compose with volume mounts:
105+
The container supports downloading a bundle of extensions from a remote web server and installing them prior to launching the server. The bundle file is a zip file that contains one or more extension zip files to be installed:
104106

105-
```yaml
107+
::: code-group
108+
```yaml [compose.yaml]
106109
version: '3.8'
107110
services:
108111
oie:
109112
image: openintegrationengine/engine:latest
110-
volumes:
111-
- ./extensions:/opt/oie/extensions
113+
environment:
114+
- EXTENSIONS_DOWNLOAD=https://my-bucket.s3.us-east-1.amazonaws.com/my-oie-extensions-bundle.zip
112115
ports:
113116
- "8080:8080"
114117
- "8443:8443"
115118
```
119+
:::
116120
117121
## Uninstalling Plugins
118122

0 commit comments

Comments
 (0)