From cb6a78c291a52950c85eecbf172b8ec6b7d2efe2 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Tue, 13 Apr 2021 08:29:03 +0200 Subject: [PATCH] Improve docker tools doc --- support/doc/tools.md | 73 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 70 insertions(+), 3 deletions(-) diff --git a/support/doc/tools.md b/support/doc/tools.md index 175c22cd8..1956dc572 100644 --- a/support/doc/tools.md +++ b/support/doc/tools.md @@ -239,26 +239,43 @@ These scripts should be run on the server, in `peertube-latest` directory. To parse PeerTube last log file: ```bash +$ # Basic installation $ cd /var/www/peertube/peertube-latest $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level info + +$ # Docker installation +$ cd /var/www/peertube-docker +$ docker-compose exec -u peertube peertube npm run parse-log -- --level info ``` `--level` is optional and could be `info`/`warn`/`error` -You can also remove SQL or HTTP logs using `--not-tags`: +You can also remove SQL or HTTP logs using `--not-tags` (PeerTube >= 3.2): -``` +```bash +$ # Basic installation $ cd /var/www/peertube/peertube-latest $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level debug --not-tags http sql + +$ # Docker installation +$ cd /var/www/peertube-docker +$ docker-compose exec -u peertube peertube npm run parse-log -- --level debug --not-tags http sql ``` ### regenerate-thumbnails.js +**PeerTube >= 3.2** + Regenerating local video thumbnails could be useful because new PeerTube releases may increase thumbnail sizes: -``` +```bash +$ # Basic installation $ cd /var/www/peertube/peertube-latest $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run regenerate-thumbnails + +$ # Docker installation +$ cd /var/www/peertube-docker +$ docker-compose exec -u peertube peertube npm run regenerate-thumbnails ``` ### create-transcoding-job.js @@ -266,23 +283,41 @@ $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production You can use this script to force transcoding of an existing video. PeerTube needs to be running. To generate transcoding jobs depending on the instance configuration: + ```bash +$ # Basic installation $ cd /var/www/peertube/peertube-latest $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] + +$ # Docker installation +$ cd /var/www/peertube-docker +$ docker-compose exec -u peertube peertube npm run create-transcoding-job -- -v [videoUUID] ``` Or to transcode to a specific resolution: + ```bash +$ # Basic installation $ cd /var/www/peertube/peertube-latest $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] -r [resolution] + +$ # Docker installation +$ cd /var/www/peertube-docker +$ docker-compose exec -u peertube peertube npm run create-transcoding-job -- -v [videoUUID] -r [resolution] ``` + The resolution should be an integer (`1080`, `720`, `480`, etc.) To generate an HLS playlist for a video: ```bash +$ # Basic installation $ cd /var/www/peertube/peertube-latest $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- --generate-hls -v [videoUUID] + +$ # Docker installation +$ cd /var/www/peertube-docker +$ docker-compose exec -u peertube peertube npm run create-transcoding-job -- --generate-hls -v [videoUUID] ``` ### create-import-video-file-job.js @@ -290,8 +325,13 @@ $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production You can use this script to import a video file to replace an already uploaded file or to add a new resolution to a video. PeerTube needs to be running. ```bash +$ # Basic installation $ cd /var/www/peertube/peertube-latest $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile] + +$ # Docker installation +$ cd /var/www/peertube-docker +$ docker-compose exec -u peertube peertube npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile] ``` ### prune-storage.js @@ -312,8 +352,13 @@ very large files that are too large for streaming. This script re-transcodes these videos so that they can be watched properly, even on slow connections. ```bash +$ # Basic installation $ cd /var/www/peertube/peertube-latest $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run optimize-old-videos + +$ # Docker installation +$ cd /var/www/peertube-docker +$ docker-compose exec -u peertube peertube npm run optimize-old-videos ``` @@ -325,8 +370,13 @@ invalid torrent files and invalid URLs in your database. To fix this, you have to run the command below (keep in mind your follower instances will NOT update their URLs). ```bash +$ # Basic installation $ cd /var/www/peertube/peertube-latest $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host + +$ # Docker installation +$ cd /var/www/peertube-docker +$ docker-compose exec -u peertube peertube npm run update-host ``` ### reset-password.js @@ -334,8 +384,13 @@ $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production To reset a user password from CLI, run: ```bash +$ # Basic installation $ cd /var/www/peertube/peertube-latest $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u target_username + +$ # Docker installation +$ cd /var/www/peertube-docker +$ docker-compose exec -u peertube peertube npm run reset-password -- -u target_username ``` @@ -349,6 +404,10 @@ To install/update a plugin or a theme from the disk: ```bash $ cd /var/www/peertube/peertube-latest $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:install -- --plugin-path /local/plugin/path + +$ # Docker installation +$ cd /var/www/peertube-docker +$ docker-compose exec -u peertube peertube npm run plugin:install -- --plugin-path /local/plugin/path ``` From NPM: @@ -356,6 +415,10 @@ From NPM: ```bash $ cd /var/www/peertube/peertube-latest $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:install -- --npm-name peertube-plugin-myplugin + +$ # Docker installation +$ cd /var/www/peertube-docker +$ docker-compose exec -u peertube peertube npm run plugin:install -- --npm-name peertube-plugin-myplugin ``` To uninstall a plugin or a theme: @@ -363,6 +426,10 @@ To uninstall a plugin or a theme: ```bash $ cd /var/www/peertube/peertube-latest $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:uninstall -- --npm-name peertube-plugin-myplugin + +$ # Docker installation +$ cd /var/www/peertube-docker +$ docker-compose exec -u peertube peertube npm run plugin:uninstall -- --npm-name peertube-plugin-myplugin ``` ### REPL (Read Eval Print Loop)