aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/tools.md
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2023-04-21 15:03:14 +0200
committerChocobozzz <chocobozzz@cpy.re>2023-05-09 08:57:34 +0200
commitb708c9e46410693f7f8fe2e0b7d48dfbb4b60f77 (patch)
tree88db692891d8105d2a15f504d4d86f7a201d1a8f /support/doc/tools.md
parentc50bb3c5611621bf4891039f1ecad3ca16767b11 (diff)
downloadPeerTube-b708c9e46410693f7f8fe2e0b7d48dfbb4b60f77.tar.gz
PeerTube-b708c9e46410693f7f8fe2e0b7d48dfbb4b60f77.tar.zst
PeerTube-b708c9e46410693f7f8fe2e0b7d48dfbb4b60f77.zip
Update tools doc
Diffstat (limited to 'support/doc/tools.md')
-rw-r--r--support/doc/tools.md45
1 files changed, 1 insertions, 44 deletions
diff --git a/support/doc/tools.md b/support/doc/tools.md
index 3b8eec4b1..ae52f2c7d 100644
--- a/support/doc/tools.md
+++ b/support/doc/tools.md
@@ -15,7 +15,6 @@
15- [Server tools](#server-tools) 15- [Server tools](#server-tools)
16 - [parse-log](#parse-log) 16 - [parse-log](#parse-log)
17 - [regenerate-thumbnails.js](#regenerate-thumbnailsjs) 17 - [regenerate-thumbnails.js](#regenerate-thumbnailsjs)
18 - [create-transcoding-job.js](#create-transcoding-jobjs)
19 - [create-import-video-file-job.js](#create-import-video-file-jobjs) 18 - [create-import-video-file-job.js](#create-import-video-file-jobjs)
20 - [create-move-video-storage-job.js](#create-move-video-storage-jobjs) 19 - [create-move-video-storage-job.js](#create-move-video-storage-jobjs)
21 - [prune-storage.js](#prune-storagejs) 20 - [prune-storage.js](#prune-storagejs)
@@ -248,52 +247,10 @@ cd /var/www/peertube-docker
248docker-compose exec -u peertube peertube npm run regenerate-thumbnails 247docker-compose exec -u peertube peertube npm run regenerate-thumbnails
249``` 248```
250 249
251### create-transcoding-job.js
252
253You can use this script to force transcoding of an existing video. PeerTube needs to be running.
254
255To generate transcoding jobs depending on the instance configuration:
256
257```bash
258# Basic installation
259cd /var/www/peertube/peertube-latest
260sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID]
261
262# Docker installation
263cd /var/www/peertube-docker
264docker-compose exec -u peertube peertube npm run create-transcoding-job -- -v [videoUUID]
265```
266
267Or to transcode to a specific resolution:
268
269```bash
270# Basic installation
271cd /var/www/peertube/peertube-latest
272sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] -r [resolution]
273
274# Docker installation
275cd /var/www/peertube-docker
276docker-compose exec -u peertube peertube npm run create-transcoding-job -- -v [videoUUID] -r [resolution]
277```
278
279The resolution should be an integer (`1080`, `720`, `480`, etc.)
280
281To generate an HLS playlist for a video:
282
283```bash
284# Basic installation
285cd /var/www/peertube/peertube-latest
286sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- --generate-hls -v [videoUUID]
287
288# Docker installation
289cd /var/www/peertube-docker
290docker-compose exec -u peertube peertube npm run create-transcoding-job -- --generate-hls -v [videoUUID]
291```
292
293### create-import-video-file-job.js 250### create-import-video-file-job.js
294 251
295You 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. 252You 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.
296You can then create a transcoding job using `npm run create-transcoding-job` if you need to optimize your file or create an HLS version of it. 253You can then create a transcoding job using the web interface if you need to optimize your file or create an HLS version of it.
297 254
298```bash 255```bash
299# Basic installation 256# Basic installation