3 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
4 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
7 - [Remote Tools](#remote-tools)
8 - [Dependencies](#dependencies)
9 - [Installation](#installation)
10 - [CLI wrapper](#cli-wrapper)
11 - [peertube-import-videos.js](#peertube-import-videosjs)
12 - [peertube-upload.js](#peertube-uploadjs)
13 - [peertube-watch.js](#peertube-watchjs)
14 - [Server tools](#server-tools)
15 - [parse-log](#parse-log)
16 - [create-transcoding-job.js](#create-transcoding-jobjs)
17 - [create-import-video-file-job.js](#create-import-video-file-jobjs)
18 - [prune-storage.js](#prune-storagejs)
19 - [optimize-old-videos.js](#optimize-old-videosjs)
20 - [update-host.js](#update-hostjs)
21 - [REPL (Read Eval Print Loop)](#repl-read-eval-print-loop)
23 - [Lodash example](#lodash-example)
24 - [YoutubeDL example](#youtubedl-example)
25 - [Models examples](#models-examples)
27 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
31 You need at least 512MB RAM to run the script.
32 Scripts can be launched directly from a PeerTube server, or from a separate server, even a desktop PC.
33 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).
37 Install the [PeerTube dependencies](dependencies.md).
41 Clone the PeerTube repo to get the latest version (even if you are on your PeerTube server):
44 $ git clone https://github.com/Chocobozzz/PeerTube.git
45 $ CLONE="$(pwd)/PeerTube"
48 Run ``yarn install --pure-lockfile``
51 $ yarn install --pure-lockfile
57 $ npm run build:server
62 The wrapper provides a convenient interface to the following scripts.
63 You can access it as `peertube` via an alias in your `.bashrc` like `alias peertube="cd /your/peertube/directory/ && node ./dist/server/tools/peertube.js"` (you have to keep the `cd` command):
66 Usage: peertube [command] [options]
70 -v, --version output the version number
71 -h, --help output usage information
75 auth [action] register your accounts on remote instances to use them with other commands
76 upload|up upload a video
77 import-videos|import import a video from a streaming platform
78 watch|w watch a video in the terminal ✩°。⋆
79 repl initiate a REPL to access internals
80 help [cmd] display help for [cmd]
83 The wrapper can keep track of instances you have an account on. We limit to one account per instance for now.
86 $ peertube auth add -u 'PEERTUBE_URL' -U 'PEERTUBE_USER' --password 'PEERTUBE_PASSWORD'
88 ┌──────────────────────────────┬──────────────────────────────┐
90 ├──────────────────────────────┼──────────────────────────────┤
91 │ 'PEERTUBE_URL' │ 'PEERTUBE_USER' │
92 └──────────────────────────────┴──────────────────────────────┘
95 You can now use that account to upload videos without feeding the same parameters again.
98 $ peertube up <videoFile>
101 And now that your video is online, you can watch it from the confort of your terminal (use `peertube watch --help` to see the supported players):
104 $ peertube watch https://peertube.cpy.re/videos/watch/e8a1af4e-414a-4d58-bfe6-2146eed06d10
107 #### peertube-import-videos.js
109 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.
110 Be sure you own the videos or have the author's authorization to do so.
113 $ node dist/server/tools/peertube-import-videos.js \
116 --password 'PEERTUBE_PASSWORD' \
120 * `PEERTUBE_URL` : the full URL of your PeerTube server where you want to import, eg: https://peertube.cpy.re
121 * `PEERTUBE_USER` : your PeerTube account where videos will be uploaded
122 * `PEERTUBE_PASSWORD` : password of your PeerTube account (if `PEERTUBE_PASSWORD` is omitted, you will be prompted for it)
123 * `TARGET_URL` : the target url you want to import. Examples:
125 * Channel: https://www.youtube.com/channel/ChannelId
126 * User https://www.youtube.com/c/UserName or https://www.youtube.com/user/UserName
127 * Video https://www.youtube.com/watch?v=blabla
128 * Vimeo: https://vimeo.com/xxxxxx
129 * Dailymotion: https://www.dailymotion.com/xxxxx
131 The script will get all public videos from Youtube, download them and upload to PeerTube.
132 Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection...
134 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
137 #### peertube-upload.js
139 You can use this script to import videos directly from the CLI.
141 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
145 $ node dist/server/tools/peertube-upload.js --help
148 #### peertube-watch.js
150 You can use this script to play videos directly from the CLI.
152 It provides support for different players:
154 - ascii (default ; plays in ascii art in your terminal!)
166 These scripts should be run on the server, in `peertube-latest` directory.
170 To parse PeerTube last log file:
173 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level info
176 `--level` is optional and could be `info`/`warn`/`error`
178 ### create-transcoding-job.js
180 You can use this script to force transcoding of an existing video. PeerTube needs to be running.
183 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID]
186 Or to transcode to a specific resolution:
188 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] -r [resolution]
191 ### create-import-video-file-job.js
193 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. PeerTube needs to be running.
196 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile]
201 Some transcoded videos or shutdown at a bad time can leave some unused files on your storage.
202 Stop PeerTube and delete these files (a confirmation will be demanded first):
205 $ sudo systemctl stop peertube && sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage
208 ### optimize-old-videos.js
210 Before version v1.0.0-beta.16, Peertube did not specify a bitrate for the
211 transcoding of uploaded videos. This means that videos might be encoded into
212 very large files that are too large for streaming. This script re-transcodes
213 these videos so that they can be watched properly, even on slow connections.
216 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run optimize-old-videos
222 If you started PeerTube with a domain, and then changed it you will have
223 invalid torrent files and invalid URLs in your database. To fix this, you have
227 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host
230 ### REPL ([Read Eval Print Loop](https://nodejs.org/docs/latest-v8.x/api/repl.html))
232 If you want to interact with the application libraries and objects even when PeerTube is not running, there is a REPL for that.
234 usage: `node ./dist/server/tools/peertube-repl.js`
236 "The default evaluator will, by default, assign the result of the most recently evaluated expression to the special variable `_` (underscore). Explicitly setting `_` to a value will disable this behavior."
238 - type `.help` to list commands available in the repl, notice it starts with a dot
239 - type `.exit` to exit, note that you still have to press CTRL-C to actually exit, or press CTRL-C (3 times) without typing `.exit` to exit
240 - type `context` to list all available objects and libraries in the context, note: `Promise` is also available but it's not listed in the context, in case you need promises for something
241 - type `env` to see the loaded environment variables
242 - type `path` to access path library
243 - type `lodash` to access lodash library
244 - type `uuidv1` to access uuid/v1 library
245 - type `uuidv3` to access uuid/v3 library
246 - type `uuidv4` to access uuid/v4 library
247 - type `uuidv5` to access uuid/v5 library
248 - type `YoutubeDL` to access youtube-dl library
249 - type `cli` to access the cli helpers object
250 - type `logger` to access the logger; if you log to it, it will write to stdout and to the peertube.log file
251 - type `constants` to access the constants loaded by the server
252 - type `coreUtils` to access the core-utils helpers object
253 - type `ffmpegUtils` to access the ffmpeg-utils helpers object
254 - type `peertubeCryptoUtils` to access the peertube-crypto helpers object
255 - type `signupUtils` to access the signup helpers object
256 - type `utils` to access the utils helpers object
257 - type `YoutubeDLUtils` to access the youtube-dl helpers object
258 - type `sequelizeTypescript` to access sequelizeTypescript
259 - type `modelsUtils` to access the models/utils
260 - type `models` to access the shortcut to sequelizeTypescript.models
261 - type `transaction` to access the shortcut to sequelizeTypescript.transaction
262 - type `query` to access the shortcut to sequelizeTypescript.query
263 - type `queryInterface` to access the shortcut to sequelizeTypescript.queryInterface
268 PeerTube [1.0.0] (b10eb595)> .help
269 .break Sometimes you get stuck, this gets you out
270 .clear Break, and also clear the local context
271 .editor Enter editor mode
273 .help Print this help message
274 .load Load JS from a file into the REPL session
277 .save Save all evaluated commands in this REPL session to a file
278 PeerTube [1.0.0] (b10eb595)>
284 PeerTube [1.0.0] (b10eb595)> lodash.keys(context)
287 'DTRACE_NET_SERVER_CONNECTION',
288 'DTRACE_NET_STREAM_END',
289 'DTRACE_HTTP_SERVER_REQUEST',
290 'DTRACE_HTTP_SERVER_RESPONSE',
291 'DTRACE_HTTP_CLIENT_REQUEST',
292 'DTRACE_HTTP_CLIENT_RESPONSE',
318 'sequelizeTypescript',
327 'peertubeCryptoUtils',
331 PeerTube [1.0.0] (b10eb595)>
334 #### YoutubeDL example
336 YoutubeDL.getInfo('https://www.youtube.com/watch?v=I5ZN289jjDo', function(err, data) {console.log(err, data)})
341 PeerTube [1.0.0] (b10eb595)> new models.ActorModel({id: 3}).getVideoChannel().then(function(data){console.log(data.dataValues.name)})
344 _fulfillmentHandler0: undefined,
345 _rejectionHandler0: undefined,
346 _promise0: undefined,
347 _receiver0: undefined }
348 PeerTube [1.0.0] (b10eb595)> Main root channel
349 PeerTube [1.0.0] (b10eb595)> let out; new models.UserModel({id: 1}).getAccount().then(function (data) {out = data.dataValues.id})
352 _fulfillmentHandler0: undefined,
353 _rejectionHandler0: undefined,
354 _promise0: undefined,
355 _receiver0: undefined }
356 PeerTube [1.0.0] (b10eb595)> out
358 PeerTube [1.0.0] (b10eb595)>