Improve tools doc
This commit is contained in:
parent
f9a971c671
commit
d639c3bf14
|
@ -4,13 +4,13 @@
|
||||||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
||||||
**Table of Contents**
|
**Table of Contents**
|
||||||
|
|
||||||
- [CLI wrapper](#cli-wrapper)
|
|
||||||
- [Remote Tools](#remote-tools)
|
- [Remote Tools](#remote-tools)
|
||||||
- [Dependencies](#dependencies)
|
- [Dependencies](#dependencies)
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [peertube-import-videos.js](#peertube-import-videosjs)
|
- [CLI wrapper](#cli-wrapper)
|
||||||
- [peertube-upload.js](#peertube-uploadjs)
|
- [peertube-import-videos.js](#peertube-import-videosjs)
|
||||||
- [peertube-watch.js](#peertube-watchjs)
|
- [peertube-upload.js](#peertube-uploadjs)
|
||||||
|
- [peertube-watch.js](#peertube-watchjs)
|
||||||
- [Server tools](#server-tools)
|
- [Server tools](#server-tools)
|
||||||
- [parse-log](#parse-log)
|
- [parse-log](#parse-log)
|
||||||
- [create-transcoding-job.js](#create-transcoding-jobjs)
|
- [create-transcoding-job.js](#create-transcoding-jobjs)
|
||||||
|
@ -26,9 +26,40 @@
|
||||||
|
|
||||||
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
||||||
|
|
||||||
## CLI wrapper
|
## Remote Tools
|
||||||
|
|
||||||
The wrapper provides a convenient interface to most scripts, and requires the [same dependencies](#dependencies). You can access it as `peertube` via an alias in your `.bashrc` like `alias peertube="node ${PEERTUBE_PATH}/dist/server/tools/peertube.js"`:
|
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.
|
||||||
|
You need to follow all the following steps even if you are on a PeerTube server (including cloning the git repository in a different directory than your production installation because the scripts utilize non-production dependencies).
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
Install the [PeerTube dependencies](dependencies.md).
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
Clone the PeerTube repo to get the latest version (even if you are on your PeerTube server):
|
||||||
|
|
||||||
|
```
|
||||||
|
$ git clone https://github.com/Chocobozzz/PeerTube.git
|
||||||
|
$ CLONE="$(pwd)/PeerTube"
|
||||||
|
```
|
||||||
|
|
||||||
|
Run ``yarn install --pure-lockfile``
|
||||||
|
```
|
||||||
|
$ cd ${CLONE}
|
||||||
|
$ yarn install --pure-lockfile
|
||||||
|
```
|
||||||
|
|
||||||
|
Build server tools:
|
||||||
|
```
|
||||||
|
$ cd ${CLONE}
|
||||||
|
$ npm run build:server
|
||||||
|
```
|
||||||
|
|
||||||
|
### CLI wrapper
|
||||||
|
|
||||||
|
The wrapper provides a convenient interface to the following scripts. You can access it as `peertube` via an alias in your `.bashrc` like `alias peertube="node /your/peertube/directory/dist/server/tools/peertube.js"`:
|
||||||
|
|
||||||
```
|
```
|
||||||
Usage: peertube [command] [options]
|
Usage: peertube [command] [options]
|
||||||
|
@ -72,38 +103,7 @@ And now that your video is online, you can watch it from the confort of your ter
|
||||||
$ peertube watch https://peertube.cpy.re/videos/watch/e8a1af4e-414a-4d58-bfe6-2146eed06d10
|
$ peertube watch https://peertube.cpy.re/videos/watch/e8a1af4e-414a-4d58-bfe6-2146eed06d10
|
||||||
```
|
```
|
||||||
|
|
||||||
## Remote Tools
|
#### peertube-import-videos.js
|
||||||
|
|
||||||
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.
|
|
||||||
You need to follow all the following steps even if you are on a PeerTube server (including cloning the git repository in a different directory than your production installation because the scripts utilize non-production dependencies).
|
|
||||||
|
|
||||||
### Dependencies
|
|
||||||
|
|
||||||
Install the [PeerTube dependencies](dependencies.md).
|
|
||||||
|
|
||||||
### Installation
|
|
||||||
|
|
||||||
Clone the PeerTube repo to get the latest version (even if you are on your PeerTube server):
|
|
||||||
|
|
||||||
```
|
|
||||||
$ git clone https://github.com/Chocobozzz/PeerTube.git
|
|
||||||
$ CLONE="$(pwd)/PeerTube"
|
|
||||||
```
|
|
||||||
|
|
||||||
Run ``yarn install``
|
|
||||||
```
|
|
||||||
$ cd ${CLONE}
|
|
||||||
$ yarn install
|
|
||||||
```
|
|
||||||
|
|
||||||
Build server tools:
|
|
||||||
```
|
|
||||||
$ cd ${CLONE}
|
|
||||||
$ npm run build:server
|
|
||||||
```
|
|
||||||
|
|
||||||
### peertube-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.
|
||||||
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.
|
||||||
|
@ -133,7 +133,7 @@ Already downloaded videos will not be uploaded twice, so you can run and re-run
|
||||||
Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
|
Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
|
||||||
|
|
||||||
|
|
||||||
### peertube-upload.js
|
#### peertube-upload.js
|
||||||
|
|
||||||
You can use this script to import videos directly from the CLI.
|
You can use this script to import videos directly from the CLI.
|
||||||
|
|
||||||
|
@ -144,7 +144,7 @@ $ cd ${CLONE}
|
||||||
$ node dist/server/tools/peertube-upload.js --help
|
$ node dist/server/tools/peertube-upload.js --help
|
||||||
```
|
```
|
||||||
|
|
||||||
### peertube-watch.js
|
#### peertube-watch.js
|
||||||
|
|
||||||
You can use this script to play videos directly from the CLI.
|
You can use this script to play videos directly from the CLI.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue