diff options
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/tools.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/support/doc/tools.md b/support/doc/tools.md index ba6e2b12d..f0d3b15b2 100644 --- a/support/doc/tools.md +++ b/support/doc/tools.md | |||
@@ -75,6 +75,7 @@ You can access it as `peertube` via an alias in your `.bashrc` like `alias peert | |||
75 | import-videos|import import a video from a streaming platform | 75 | import-videos|import import a video from a streaming platform |
76 | watch|w watch a video in the terminal ✩°。⋆ | 76 | watch|w watch a video in the terminal ✩°。⋆ |
77 | repl initiate a REPL to access internals | 77 | repl initiate a REPL to access internals |
78 | plugins|p [action] manag instance plugins | ||
78 | help [cmd] display help for [cmd] | 79 | help [cmd] display help for [cmd] |
79 | ``` | 80 | ``` |
80 | 81 | ||
@@ -102,6 +103,15 @@ And now that your video is online, you can watch it from the confort of your ter | |||
102 | $ peertube watch https://peertube.cpy.re/videos/watch/e8a1af4e-414a-4d58-bfe6-2146eed06d10 | 103 | $ peertube watch https://peertube.cpy.re/videos/watch/e8a1af4e-414a-4d58-bfe6-2146eed06d10 |
103 | ``` | 104 | ``` |
104 | 105 | ||
106 | To list, install, uninstall dynamically plugins/themes of an instance: | ||
107 | |||
108 | ```bash | ||
109 | $ peertube plugins list | ||
110 | $ peertube plugins install --path /local/plugin/path | ||
111 | $ peertube plugins install --npm-name peertube-plugin-myplugin | ||
112 | $ peertube plugins uninstall --npm-name peertube-plugin-myplugin | ||
113 | ``` | ||
114 | |||
105 | #### peertube-import-videos.js | 115 | #### peertube-import-videos.js |
106 | 116 | ||
107 | You can use this script to import videos from all [supported sites of youtube-dl](https://rg3.github.io/youtube-dl/supportedsites.html) into PeerTube. | 117 | You can use this script to import videos from all [supported sites of youtube-dl](https://rg3.github.io/youtube-dl/supportedsites.html) into PeerTube. |
@@ -233,6 +243,30 @@ To reset a user password from CLI, run: | |||
233 | $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u target_username | 243 | $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u target_username |
234 | ``` | 244 | ``` |
235 | 245 | ||
246 | |||
247 | ### plugin install/uninstall | ||
248 | |||
249 | The difference with `peertube plugins` CLI is that these scripts can be used even if PeerTube is not running. | ||
250 | If 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). | ||
251 | |||
252 | To install a plugin or a theme from the disk: | ||
253 | |||
254 | ``` | ||
255 | $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run npm run plugin:install -- --plugin-path /local/plugin/path | ||
256 | ``` | ||
257 | |||
258 | From NPM: | ||
259 | |||
260 | ``` | ||
261 | $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run npm run plugin:install -- --npm-name peertube-plugin-myplugin | ||
262 | ``` | ||
263 | |||
264 | To uninstall a plugin or a theme: | ||
265 | |||
266 | ``` | ||
267 | $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run npm run plugin:uninstall -- --npm-name peertube-plugin-myplugin | ||
268 | ``` | ||
269 | |||
236 | ### REPL ([Read Eval Print Loop](https://nodejs.org/docs/latest-v8.x/api/repl.html)) | 270 | ### REPL ([Read Eval Print Loop](https://nodejs.org/docs/latest-v8.x/api/repl.html)) |
237 | 271 | ||
238 | If you want to interact with the application libraries and objects even when PeerTube is not running, there is a REPL for that. | 272 | If you want to interact with the application libraries and objects even when PeerTube is not running, there is a REPL for that. |