(doc) adding tools documentation for job creation

pull/636/head
Rigel Kent 2018-06-07 11:55:34 +02:00 committed by Chocobozzz
parent 9e32b99c20
commit a5f0521f03
1 changed files with 36 additions and 14 deletions

View File

@ -4,6 +4,8 @@
- [Usage](#usage) - [Usage](#usage)
- [import-videos.js](#import-videosjs) - [import-videos.js](#import-videosjs)
- [upload.js](#uploadjs) - [upload.js](#uploadjs)
- [create-transcoding-job.js](#create-transcoding-jobjs)
- [create-import-video-file-job.js](#create-import-video-file-jobjs)
## Installation ## Installation
@ -45,22 +47,24 @@ $ npm run build:server
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.
Be sure you own the videos or have the author's authorization to do so. Be sure you own the videos or have the author's authorization to do so.
```sh
``` $ node dist/server/tools/import-videos.js \
$ cd ${CLONE} -u "PEERTUBE_URL" \
$ node dist/server/tools/import-videos.js -u "PEERTUBE_URL" -U "PEERTUBE_USER" --password "PEERTUBE_PASSWORD" -t "TARGET_URL" -U "PEERTUBE_USER" \
--password "PEERTUBE_PASSWORD" \
-t "TARGET_URL"
``` ```
* PEERTUBE_URL : the full URL of your PeerTube server where you want to import, eg: https://peertube.cpy.re * `PEERTUBE_URL` : the full URL of your PeerTube server where you want to import, eg: https://peertube.cpy.re
* PEERTUBE_USER : your PeerTube account where videos will be uploaded * `PEERTUBE_USER` : your PeerTube account where videos will be uploaded
* PEERTUBE_PASSWORD : password of your PeerTube account (if ommited, you will be prompted for) * `PEERTUBE_PASSWORD` : password of your PeerTube account (if omitted, you will be prompted for it)
* TARGET_URL : the target url you want to import. Examples: * `TARGET_URL` : the target url you want to import. Examples:
* YouTube: * YouTube:
* Channel: https://www.youtube.com/channel/ChannelId * Channel: https://www.youtube.com/channel/ChannelId
* User https://www.youtube.com/c/UserName or https://www.youtube.com/user/UserName * User https://www.youtube.com/c/UserName or https://www.youtube.com/user/UserName
* Video https://www.youtube.com/watch?v=blabla * Video https://www.youtube.com/watch?v=blabla
* Vimeo: https://vimeo.com/xxxxxx * Vimeo: https://vimeo.com/xxxxxx
* Dailymotion: https://www.dailymotion.com/xxxxx * Dailymotion: https://www.dailymotion.com/xxxxx
The script will get all public videos from Youtube, download them and upload to PeerTube. The script will get all public videos from Youtube, download them and upload to PeerTube.
Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection... Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection...
@ -73,3 +77,21 @@ You can use this script to import videos directly from the CLI.
$ cd ${CLONE} $ cd ${CLONE}
$ node dist/server/tools/upload.js --help $ node dist/server/tools/upload.js --help
``` ```
## Tools to create jobs in the queue
### create-transcoding-job.js
You can use this script to force transcoding of an existing video.
```
$ npm run create-transcoding-job -- -v [videoUUID]
```
### create-import-video-file-job.js
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]
```