diff options
Diffstat (limited to 'support/doc/tools.md')
-rw-r--r-- | support/doc/tools.md | 42 |
1 files changed, 40 insertions, 2 deletions
diff --git a/support/doc/tools.md b/support/doc/tools.md index 39f5ab787..2b3ebf159 100644 --- a/support/doc/tools.md +++ b/support/doc/tools.md | |||
@@ -227,7 +227,7 @@ docker-compose exec -u peertube peertube npm run regenerate-thumbnails | |||
227 | 227 | ||
228 | ### create-import-video-file-job.js | 228 | ### create-import-video-file-job.js |
229 | 229 | ||
230 | You can use this script to import a video file to replace an already uploaded file or to add a new webtorrent resolution to a video. PeerTube needs to be running. | 230 | You can use this script to import a video file to replace an already uploaded file or to add a new web compatible resolution to a video. PeerTube needs to be running. |
231 | You can then create a transcoding job using the web interface if you need to optimize your file or create an HLS version of it. | 231 | You can then create a transcoding job using the web interface if you need to optimize your file or create an HLS version of it. |
232 | 232 | ||
233 | ```bash | 233 | ```bash |
@@ -268,6 +268,35 @@ cd /var/www/peertube-docker | |||
268 | docker-compose exec -u peertube peertube npm run create-move-video-storage-job -- --to-object-storage --all-videos | 268 | docker-compose exec -u peertube peertube npm run create-move-video-storage-job -- --to-object-storage --all-videos |
269 | ``` | 269 | ``` |
270 | 270 | ||
271 | <!-- TODO: uncomment when PeerTube 6 is released | ||
272 | ### create-generate-storyboard-job | ||
273 | |||
274 | **PeerTube >= 6.0** | ||
275 | |||
276 | Use this script to generate storyboard of a specific video: | ||
277 | |||
278 | ```bash | ||
279 | # Basic installation | ||
280 | cd /var/www/peertube/peertube-latest | ||
281 | sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-generate-storyboard-job -- -v [videoUUID] | ||
282 | |||
283 | # Docker installation | ||
284 | cd /var/www/peertube-docker | ||
285 | docker-compose exec -u peertube peertube npm run create-generate-storyboard-job -- -v [videoUUID] | ||
286 | ``` | ||
287 | |||
288 | The script can also generate all missing storyboards of local videos: | ||
289 | |||
290 | ```bash | ||
291 | # Basic installation | ||
292 | cd /var/www/peertube/peertube-latest | ||
293 | sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-generate-storyboard-job -- --all-videos | ||
294 | |||
295 | # Docker installation | ||
296 | cd /var/www/peertube-docker | ||
297 | docker-compose exec -u peertube peertube npm run create-generate-storyboard-job -- --all-videos | ||
298 | ``` | ||
299 | --> | ||
271 | 300 | ||
272 | ### prune-storage.js | 301 | ### prune-storage.js |
273 | 302 | ||
@@ -357,6 +386,15 @@ PeerTube >= 5.2 supports VOD or Live transcoding by a remote PeerTube runner. | |||
357 | 386 | ||
358 | ### Installation | 387 | ### Installation |
359 | 388 | ||
389 | Ensure you have `ffmpeg` and `ffprobe` installed on your system: | ||
390 | |||
391 | ```bash | ||
392 | ffprobe -version # Should be >= 4.3 | ||
393 | ffmpeg -version # Should be >= 4.3 | ||
394 | ``` | ||
395 | |||
396 | Then install the CLI: | ||
397 | |||
360 | ```bash | 398 | ```bash |
361 | sudo npm install -g @peertube/peertube-runner | 399 | sudo npm install -g @peertube/peertube-runner |
362 | ``` | 400 | ``` |
@@ -385,7 +423,7 @@ peertube-runner server | |||
385 | 423 | ||
386 | ### Register | 424 | ### Register |
387 | 425 | ||
388 | Then, you can register the runner on a new PeerTube instance so the runner can process its transcoding job: | 426 | Then, you can register the runner to process transcoding job of a remote PeerTube instance: |
389 | 427 | ||
390 | ```bash | 428 | ```bash |
391 | peertube-runner register --url http://peertube.example.com --registration-token ptrrt-... --runner-name my-runner-name | 429 | peertube-runner register --url http://peertube.example.com --registration-token ptrrt-... --runner-name my-runner-name |