aboutsummaryrefslogtreecommitdiffhomepage
path: root/support
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2023-05-09 11:18:26 +0200
committerChocobozzz <me@florianbigard.com>2023-05-09 11:20:08 +0200
commit76ad705ecb08270c01b4759413a5dadc4ed4433e (patch)
tree0315d952eb05b2d1890933a9a2e01d27a9d51140 /support
parent5b2ee4e6cacd8371058168a75d66d61944f069fd (diff)
downloadPeerTube-76ad705ecb08270c01b4759413a5dadc4ed4433e.tar.gz
PeerTube-76ad705ecb08270c01b4759413a5dadc4ed4433e.tar.zst
PeerTube-76ad705ecb08270c01b4759413a5dadc4ed4433e.zip
Add peertube-runner CLI doc
Diffstat (limited to 'support')
-rw-r--r--support/doc/tools.md84
1 files changed, 59 insertions, 25 deletions
diff --git a/support/doc/tools.md b/support/doc/tools.md
index ae52f2c7d..c86f0d12b 100644
--- a/support/doc/tools.md
+++ b/support/doc/tools.md
@@ -1,30 +1,8 @@
1# CLI tools guide 1# CLI tools guide
2 2
3<!-- START doctoc generated TOC please keep comment here to allow auto update --> 3[[toc]]
4<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> 4
5**Table of Contents** 5## Remote PeerTube CLI
6
7- [Remote Tools](#remote-tools)
8 - [Dependencies](#dependencies)
9 - [Installation](#installation)
10 - [CLI wrapper](#cli-wrapper)
11 - [peertube-import-videos.js](#peertube-import-videosjs)
12 - [peertube-upload.js](#peertube-uploadjs)
13 - [peertube-plugins.js](#peertube-pluginsjs)
14 - [peertube-redundancy.js](#peertube-redundancyjs)
15- [Server tools](#server-tools)
16 - [parse-log](#parse-log)
17 - [regenerate-thumbnails.js](#regenerate-thumbnailsjs)
18 - [create-import-video-file-job.js](#create-import-video-file-jobjs)
19 - [create-move-video-storage-job.js](#create-move-video-storage-jobjs)
20 - [prune-storage.js](#prune-storagejs)
21 - [update-host.js](#update-hostjs)
22 - [reset-password.js](#reset-passwordjs)
23 - [plugin install/uninstall](#plugin-installuninstall)
24
25<!-- END doctoc generated TOC please keep comment here to allow auto update -->
26
27## Remote Tools
28 6
29You need at least 512MB RAM to run the script. 7You need at least 512MB RAM to run the script.
30Scripts can be launched directly from a PeerTube server, or from a separate server, even a desktop PC. 8Scripts can be launched directly from a PeerTube server, or from a separate server, even a desktop PC.
@@ -371,3 +349,59 @@ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production np
371cd /var/www/peertube-docker 349cd /var/www/peertube-docker
372docker-compose exec -u peertube peertube npm run plugin:uninstall -- --npm-name peertube-plugin-myplugin 350docker-compose exec -u peertube peertube npm run plugin:uninstall -- --npm-name peertube-plugin-myplugin
373``` 351```
352
353## PeerTube runner
354
355PeerTube >= 5.2 supports VOD or Live transcoding by a remote PeerTube runner.
356
357
358### Installation
359
360```bash
361sudo npm install -g @peertube/peertube-runner
362```
363
364### Configuration
365
366The runner uses env paths like `~/.config`, `~/.cache` and `~/.local/share` directories to store runner configuration or temporary files.
367
368Multiple PeerTube runners can run on the same OS by using the `--id` CLI option (each runner uses its own config/tmp directories):
369
370```bash
371peertube-runner [commands] --id instance-1
372peertube-runner [commands] --id instance-2
373peertube-runner [commands] --id instance-3
374```
375
376
377### Run the server
378
379Run the runner in server mode so it can run transcoding jobs of registered PeerTube instances:
380
381```bash
382peertube-runner server
383```
384
385### Register
386
387To register the runner on a new PeerTube instance so the runner can process its transcoding job:
388
389```bash
390peertube-runner register --url http://peertube.example.com --registration-token ptrrt-... --runner-name my-runner-name
391```
392
393The runner will then use a websocket connection with the PeerTube instance to be notified about new available transcoding jobs.
394
395### Unregister
396
397To unregister a PeerTube instance:
398
399```bash
400peertube-runner unregister --url http://peertube.example.com
401```
402
403### List registered instances
404
405```bash
406peertube-runner list-registered
407```