diff options
| author | HimbeerserverDE <himbeerserverde@gmail.com> | 2023-11-26 16:12:39 +0100 |
|---|---|---|
| committer | HimbeerserverDE <himbeerserverde@gmail.com> | 2023-11-26 16:12:39 +0100 |
| commit | 1291e68002cce2209b7bdb05431c7fe8eb4c85bc (patch) | |
| tree | 82319dc48e544452d56c666af06b9ddb02eca8bf | |
| parent | 1fa55f6aeac8d5c21492bf28eccbe49058875ce9 (diff) | |
document plugin auto building
| -rw-r--r-- | doc/plugins.md | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/plugins.md b/doc/plugins.md index 6c386ce..1a8ab92 100644 --- a/doc/plugins.md +++ b/doc/plugins.md @@ -5,7 +5,19 @@ from being loaded. Plugins **cannot** be (re)loaded at runtime, you need to restart the proxy. ## Installing plugins -To install a plugin, clone the repository, cd into it and run: +The recommended way to install plugins is cd'ing into the `plugins` directory, +downloading the source code (e.g. using `git clone`) into it +and starting the proxy without setting the `NoAutoPlugins` config option +to `true`. + +The proxy will detect its own version automatically +and attempt to build the plugin against it, making this the easiest way +for end users to deal with versioning. + +This won't work in development builds. + +### Manual installation +To install a plugin manually, clone the repository, cd into it and run: ``` go build -buildmode=plugin |