interesting
/
PeerTube
mirror of https://github.com/Chocobozzz/PeerTube.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Improve tools documentation

This commit is contained in:
Chocobozzz 2018-06-11 15:47:32 +02:00
parent 86bed4a6aa
commit 54a3a12ed2
No known key found for this signature in database
GPG Key ID: 583A612D890159BE
1 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
support/doc/tools.md
View File

@ -1,15 +1,14 @@
# CLI tools guide # CLI tools guide
- [Installation](#installation) - [Remote tools](#remote-tools)
- [Usage](#usage)
- [import-videos.js](#import-videosjs) - [import-videos.js](#import-videosjs)
- [upload.js](#uploadjs) - [upload.js](#uploadjs)
- [Server tools](#server-tools)
- [create-transcoding-job.js](#create-transcoding-jobjs) - [create-transcoding-job.js](#create-transcoding-jobjs)
- [create-import-video-file-job.js](#create-import-video-file-jobjs) - [create-import-video-file-job.js](#create-import-video-file-jobjs)
- [prune-storage.js](#prune-storagejs)
## Installation ## Remote Tools
## Prerequisites
You need at least 512MB RAM to run the script. 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. 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 $ npm run build:server
``` ```
## Tools
### import-videos.js ### 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. 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 $ 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 ### create-transcoding-job.js
You can use this script to force transcoding of an existing video. 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 ### 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. 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
``` ```