10 files changed, 79 insertions, 32 deletions

diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
index 2566f5ba8..ab1780c74 100644
--- a/.github/workflows/benchmark.yml
+++ b/.github/workflows/benchmark.yml
@@ -35,7 +35,7 @@ jobs:
 
       - uses: './.github/actions/reusable-prepare-peertube-build'
         with:
-          node-version: '14.x'
+          node-version: '16.x'
 
       - uses: './.github/actions/reusable-prepare-peertube-run'
 
diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
index 0bb685ff1..bb1f27a6b 100644
--- a/.github/workflows/nightly.yml
+++ b/.github/workflows/nightly.yml
@@ -18,7 +18,7 @@ jobs:
 
       - uses: './.github/actions/reusable-prepare-peertube-build'
         with:
-          node-version: '14.x'
+          node-version: '16.x'
 
       - name: Build
         run: npm run nightly
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 678b0674b..407907e53 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -55,7 +55,7 @@ jobs:
 
       - uses: './.github/actions/reusable-prepare-peertube-build'
         with:
-          node-version: '14.x'
+          node-version: '16.x'
 
       - uses: './.github/actions/reusable-prepare-peertube-run'
 
diff --git a/packages/peertube-runner/.gitignore b/packages/peertube-runner/.gitignore
index f06235c46..6426ab063 100644
--- a/packages/peertube-runner/.gitignore
+++ b/packages/peertube-runner/.gitignore
@@ -1,2 +1,3 @@
 node_modules
 dist
+meta.json
diff --git a/packages/peertube-runner/.npmignore b/packages/peertube-runner/.npmignore
new file mode 100644
index 000000000..f38d9947c
--- /dev/null
+++ b/packages/peertube-runner/.npmignore
@@ -0,0 +1,6 @@
+register
+server
+shared
+meta.json
+peertube-runner.ts
+tsconfig.json
diff --git a/packages/peertube-runner/package.json b/packages/peertube-runner/package.json
index dde0e2d62..f04d0b64f 100644
--- a/packages/peertube-runner/package.json
+++ b/packages/peertube-runner/package.json
@@ -1,7 +1,8 @@
 {
-  "name": "peertube-runner",
-  "version": "1.0.0",
+  "name": "@peertube/peertube-runner",
+  "version": "0.0.2",
   "main": "dist/peertube-runner.js",
+  "bin": "dist/peertube-runner.js",
   "license": "AGPL-3.0",
   "dependencies": {},
   "devDependencies": {
diff --git a/packages/peertube-runner/peertube-runner.ts b/packages/peertube-runner/peertube-runner.ts
index f02526ef9..9c3e498d6 100644
--- a/packages/peertube-runner/peertube-runner.ts
+++ b/packages/peertube-runner/peertube-runner.ts
@@ -1,9 +1,14 @@
+#!/usr/bin/env node
+
 import { Command, InvalidArgumentError } from '@commander-js/extra-typings'
 import { listRegistered, registerRunner, unregisterRunner } from './register'
 import { RunnerServer } from './server'
 import { ConfigManager, logger } from './shared'
 
+const packageJSON = require('./package.json')
+
 const program = new Command()
+  .version(packageJSON.version)
   .option(
     '--id <id>',
     'Runner server id, so you can run multiple PeerTube server runners with different configurations on the same machine',
diff --git a/scripts/build/peertube-runner.sh b/scripts/build/peertube-runner.sh
index 9c326747b..7f6ad5ede 100755
--- a/scripts/build/peertube-runner.sh
+++ b/scripts/build/peertube-runner.sh
@@ -10,4 +10,4 @@ rm -rf ./dist
 rm -rf ./dist
 mkdir ./dist
 
-./node_modules/.bin/esbuild ./peertube-runner.ts --bundle --platform=node --target=node14 --external:"./lib-cov/fluent-ffmpeg" --external:pg-hstore --outfile=dist/peertube-runner.js
+./node_modules/.bin/esbuild ./peertube-runner.ts --bundle --platform=node --target=node16 --external:"./lib-cov/fluent-ffmpeg" --external:pg-hstore --outfile=dist/peertube-runner.js
diff --git a/server/tests/api/live/live-save-replay.ts b/server/tests/api/live/live-save-replay.ts
index 3a9a84f7e..676d0af69 100644
--- a/server/tests/api/live/live-save-replay.ts
+++ b/server/tests/api/live/live-save-replay.ts
@@ -217,7 +217,7 @@ describe('Save replay setting', function () {
     })
 
     it('Should correctly terminate the stream on blacklist and delete the live', async function () {
-      this.timeout(40000)
+      this.timeout(60000)
 
       await publishLiveAndBlacklist({ permanent: false, replay: false })
 
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 @@
 # CLI tools guide
 
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-**Table of Contents**
-
-- [Remote Tools](#remote-tools)
-  - [Dependencies](#dependencies)
-  - [Installation](#installation)
-  - [CLI wrapper](#cli-wrapper)
-    - [peertube-import-videos.js](#peertube-import-videosjs)
-    - [peertube-upload.js](#peertube-uploadjs)
-    - [peertube-plugins.js](#peertube-pluginsjs)
-    - [peertube-redundancy.js](#peertube-redundancyjs)
-- [Server tools](#server-tools)
-  - [parse-log](#parse-log)
-  - [regenerate-thumbnails.js](#regenerate-thumbnailsjs)
-  - [create-import-video-file-job.js](#create-import-video-file-jobjs)
-  - [create-move-video-storage-job.js](#create-move-video-storage-jobjs)
-  - [prune-storage.js](#prune-storagejs)
-  - [update-host.js](#update-hostjs)
-  - [reset-password.js](#reset-passwordjs)
-  - [plugin install/uninstall](#plugin-installuninstall)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-
-## Remote Tools
+[[toc]]
+
+## Remote PeerTube CLI
 
 You need at least 512MB RAM to run the script.
 Scripts 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
 cd /var/www/peertube-docker
 docker-compose exec -u peertube peertube npm run plugin:uninstall -- --npm-name peertube-plugin-myplugin
 ```
+
+## PeerTube runner
+
+PeerTube >= 5.2 supports VOD or Live transcoding by a remote PeerTube runner.
+
+
+### Installation
+
+```bash
+sudo npm install -g @peertube/peertube-runner
+```
+
+### Configuration
+
+The runner uses env paths like `~/.config`, `~/.cache` and `~/.local/share` directories to store runner configuration or temporary files.
+
+Multiple PeerTube runners can run on the same OS by using the `--id` CLI option (each runner uses its own config/tmp directories):
+
+```bash
+peertube-runner [commands] --id instance-1
+peertube-runner [commands] --id instance-2
+peertube-runner [commands] --id instance-3
+```
+
+
+### Run the server
+
+Run the runner in server mode so it can run transcoding jobs of registered PeerTube instances:
+
+```bash
+peertube-runner server
+```
+
+### Register
+
+To register the runner on a new PeerTube instance so the runner can process its transcoding job:
+
+```bash
+peertube-runner register --url http://peertube.example.com --registration-token ptrrt-... --runner-name my-runner-name
+```
+
+The runner will then use a websocket connection with the PeerTube instance to be notified about new available transcoding jobs.
+
+### Unregister
+
+To unregister a PeerTube instance:
+
+```bash
+peertube-runner unregister --url http://peertube.example.com
+```
+
+### List registered instances
+
+```bash
+peertube-runner list-registered
+```