From 54a3a12ed2d972386c12d59717eedfadd7203767 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Mon, 11 Jun 2018 15:47:32 +0200 Subject: [PATCH] Improve tools documentation --- support/doc/tools.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/support/doc/tools.md b/support/doc/tools.md index 8f897dbfa..85ce0428d 100644 --- a/support/doc/tools.md +++ b/support/doc/tools.md @@ -1,15 +1,14 @@ # CLI tools guide - - [Installation](#installation) - - [Usage](#usage) + - [Remote tools](#remote-tools) - [import-videos.js](#import-videosjs) - [upload.js](#uploadjs) + - [Server tools](#server-tools) - [create-transcoding-job.js](#create-transcoding-jobjs) - [create-import-video-file-job.js](#create-import-video-file-jobjs) + - [prune-storage.js](#prune-storagejs) -## Installation - -## Prerequisites +## Remote Tools 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. @@ -40,8 +39,6 @@ $ cd ${CLONE} $ npm run build:server ``` -## Tools - ### import-videos.js You can use this script to import videos from all [supported sites of youtube-dl](https://rg3.github.io/youtube-dl/supportedsites.html) into PeerTube. @@ -78,14 +75,17 @@ $ cd ${CLONE} $ node dist/server/tools/upload.js --help ``` -## Tools to create jobs in the queue + +## Server tools + +These scripts should be run on the server, in `peertube-latest` directory. ### create-transcoding-job.js You can use this script to force transcoding of an existing video. ``` -$ npm run create-transcoding-job -- -v [videoUUID] +$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] ``` ### create-import-video-file-job.js @@ -93,5 +93,14 @@ $ npm run create-transcoding-job -- -v [videoUUID] 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. ``` -$ npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile] +$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile] +``` + +### prune-storage.js + +Some transcoded videos or shutdown at a bad time can leave some unused files on your storage. +To delete them (a confirmation will be demanded first): + ``` +$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage +``` \ No newline at end of file -- 2.25.1