PeerTube/support/doc/tools.md

76 lines
2.2 KiB
Markdown
Raw Normal View History

2018-03-05 10:00:15 +01:00
# CLI tools guide
- [Installation](#installation)
- [Usage](#usage)
2018-03-06 08:27:20 +01:00
- [import-videos.js](#import-videosjs)
- [upload.js](#uploadjs)
## Installation
## Prerequisites
2018-03-14 09:15:17 +01:00
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.
2018-03-22 11:32:43 +01:00
You need to follow all the following steps even if you are on a PeerTube server.
### Dependencies
2018-03-05 10:00:15 +01:00
Install the [PeerTube dependencies](dependencies.md).
### Installation
2018-03-14 09:15:17 +01:00
Clone the PeerTube repo to get the latest version (even if you are on your PeerTube server):
```
2018-03-22 11:32:43 +01:00
$ git clone https://github.com/Chocobozzz/PeerTube.git
$ CLONE="$(pwd)/PeerTube"
```
Run ``yarn install``
```
2018-03-22 11:32:43 +01:00
$ cd ${CLONE}
$ yarn install
```
Build server tools:
```
2018-03-22 11:32:43 +01:00
$ cd ${CLONE}
$ npm run build:server
```
2018-03-05 10:00:15 +01:00
## Tools
2018-03-05 10:00:15 +01:00
### 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.
Be sure you own the videos or have the author's authorization to do so.
```
2018-03-22 11:32:43 +01:00
$ cd ${CLONE}
$ node dist/server/tools/import-videos.js -u "PEERTUBE_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_USER : your PeerTube account where videos will be uploaded
2018-05-10 23:59:28 +02:00
* PEERTUBE_PASSWORD : password of your PeerTube account (if ommited, you will be prompted for)
* TARGET_URL : the target url you want to import. Examples:
* YouTube:
* Channel: https://www.youtube.com/channel/ChannelId
* User https://www.youtube.com/c/UserName or https://www.youtube.com/user/UserName
* Video https://www.youtube.com/watch?v=blabla
* Vimeo: https://vimeo.com/xxxxxx
* Dailymotion: https://www.dailymotion.com/xxxxx
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...
2018-03-05 10:00:15 +01:00
### upload.js
You can use this script to import videos directly from the CLI.
```
2018-03-22 11:32:43 +01:00
$ cd ${CLONE}
$ node dist/server/tools/upload.js --help
2018-03-05 10:00:15 +01:00
```