aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2019-08-22 09:17:41 +0200
committerChocobozzz <me@florianbigard.com>2019-08-22 09:17:41 +0200
commit8dd2d05058b52abf965614e6efbfe45f38df549f (patch)
tree6eaa5dd9241835b1305f9c64364b42046409343a
parent13126d9961184ae5bd1eac8b23fd02de09f598d9 (diff)
downloadPeerTube-8dd2d05058b52abf965614e6efbfe45f38df549f.tar.gz
PeerTube-8dd2d05058b52abf965614e6efbfe45f38df549f.tar.zst
PeerTube-8dd2d05058b52abf965614e6efbfe45f38df549f.zip
Improve plugin management documentation
-rw-r--r--support/doc/tools.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/support/doc/tools.md b/support/doc/tools.md
index 6b831ae99..88586bfaa 100644
--- a/support/doc/tools.md
+++ b/support/doc/tools.md
@@ -11,6 +11,7 @@
11 - [peertube-import-videos.js](#peertube-import-videosjs) 11 - [peertube-import-videos.js](#peertube-import-videosjs)
12 - [peertube-upload.js](#peertube-uploadjs) 12 - [peertube-upload.js](#peertube-uploadjs)
13 - [peertube-watch.js](#peertube-watchjs) 13 - [peertube-watch.js](#peertube-watchjs)
14 - [peertube-plugins.js](#peertube-pluginsjs)
14- [Server tools](#server-tools) 15- [Server tools](#server-tools)
15 - [parse-log](#parse-log) 16 - [parse-log](#parse-log)
16 - [create-transcoding-job.js](#create-transcoding-jobjs) 17 - [create-transcoding-job.js](#create-transcoding-jobjs)
@@ -183,6 +184,22 @@ It provides support for different players:
183- chromecast 184- chromecast
184 185
185 186
187#### peertube-plugins.js
188
189Install/update/uninstall or list local or NPM PeerTube plugins:
190
191```
192$ cd ${CLONE}
193$ node dist/server/tools/peertube-plugins.js --help
194$ node dist/server/tools/peertube-plugins.js list --help
195$ node dist/server/tools/peertube-plugins.js install --help
196$ node dist/server/tools/peertube-plugins.js update --help
197$ node dist/server/tools/peertube-plugins.js uninstall --help
198
199$ node dist/server/tools/peertube-plugins.js install --path /my/plugin/path
200$ node dist/server/tools/peertube-plugins.js install --npm-name peertube-theme-example
201```
202
186## Server tools 203## Server tools
187 204
188These scripts should be run on the server, in `peertube-latest` directory. 205These scripts should be run on the server, in `peertube-latest` directory.
@@ -263,7 +280,7 @@ $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production
263The difference with `peertube plugins` CLI is that these scripts can be used even if PeerTube is not running. 280The difference with `peertube plugins` CLI is that these scripts can be used even if PeerTube is not running.
264If PeerTube is running, you need to restart it for the changes to take effect (whereas with `peertube plugins` CLI, plugins/themes are dynamically loaded on the server). 281If PeerTube is running, you need to restart it for the changes to take effect (whereas with `peertube plugins` CLI, plugins/themes are dynamically loaded on the server).
265 282
266To install a plugin or a theme from the disk: 283To install/update a plugin or a theme from the disk:
267 284
268``` 285```
269$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run npm run plugin:install -- --plugin-path /local/plugin/path 286$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run npm run plugin:install -- --plugin-path /local/plugin/path