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 - [peertube-plugins.js](#peertube-pluginsjs)
15 - [peertube-redundancy.js](#peertube-redundancyjs)
16 - [Server tools](#server-tools)
17 - [parse-log](#parse-log)
18 - [regenerate-thumbnails.js](#regenerate-thumbnailsjs)
19 - [create-transcoding-job.js](#create-transcoding-jobjs)
20 - [create-import-video-file-job.js](#create-import-video-file-jobjs)
21 - [prune-storage.js](#prune-storagejs)
22 - [optimize-old-videos.js](#optimize-old-videosjs)
23 - [update-host.js](#update-hostjs)
24 - [reset-password.js](#reset-passwordjs)
25 - [plugin install/uninstall](#plugin-installuninstall)
26 - [REPL (Read Eval Print Loop)](#repl-read-eval-print-loop)
28 - [Lodash example](#lodash-example)
29 - [YoutubeDL example](#youtubedl-example)
30 - [Models examples](#models-examples)
32 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
36 You need at least 512MB RAM to run the script.
37 Scripts can be launched directly from a PeerTube server, or from a separate server, even a desktop PC.
38 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).
42 Install the [PeerTube dependencies](dependencies.md) except PostgreSQL and Redis.
46 Clone the PeerTube repo to get the latest version (even if you are on your PeerTube server):
49 $ git clone https://github.com/Chocobozzz/PeerTube.git
50 $ CLONE="$(pwd)/PeerTube"
54 Install dependencies and build CLI tools:
57 $ NOCLIENT=1 yarn install --pure-lockfile
63 The wrapper provides a convenient interface to the following scripts.
64 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):
67 Usage: peertube [command] [options]
71 -v, --version output the version number
72 -h, --help output usage information
76 auth [action] register your accounts on remote instances to use them with other commands
77 upload|up upload a video
78 import-videos|import import a video from a streaming platform
79 watch|w watch a video in the terminal ✩°。⋆
80 repl initiate a REPL to access internals
81 plugins|p [action] manage instance plugins
82 redundancy|r [action] manage video redundancies
83 help [cmd] display help for [cmd]
86 The wrapper can keep track of instances you have an account on. We limit to one account per instance for now.
89 $ peertube auth add -u 'PEERTUBE_URL' -U 'PEERTUBE_USER' --password 'PEERTUBE_PASSWORD'
91 ┌──────────────────────────────┬──────────────────────────────┐
93 ├──────────────────────────────┼──────────────────────────────┤
94 │ 'PEERTUBE_URL' │ 'PEERTUBE_USER' │
95 └──────────────────────────────┴──────────────────────────────┘
98 You can now use that account to upload videos without feeding the same parameters again.
101 $ peertube up <videoFile>
104 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):
107 $ peertube watch https://peertube.cpy.re/videos/watch/e8a1af4e-414a-4d58-bfe6-2146eed06d10
110 To list, install, uninstall dynamically plugins/themes of an instance:
113 $ peertube plugins list
114 $ peertube plugins install --path /local/plugin/path
115 $ peertube plugins install --npm-name peertube-plugin-myplugin
116 $ peertube plugins uninstall --npm-name peertube-plugin-myplugin
119 #### peertube-import-videos.js
121 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.
122 Be sure you own the videos or have the author's authorization to do so.
125 $ node dist/server/tools/peertube-import-videos.js \
128 --password 'PEERTUBE_PASSWORD' \
129 --target-url 'TARGET_URL'
132 * `PEERTUBE_URL` : the full URL of your PeerTube server where you want to import, eg: https://peertube.cpy.re
133 * `PEERTUBE_USER` : your PeerTube account where videos will be uploaded
134 * `PEERTUBE_PASSWORD` : password of your PeerTube account (if `--password PEERTUBE_PASSWORD` is omitted, you will be prompted for it)
135 * `TARGET_URL` : the target url you want to import. Examples:
137 * Channel: https://www.youtube.com/channel/ChannelId
138 * User https://www.youtube.com/c/UserName or https://www.youtube.com/user/UserName
139 * Video https://www.youtube.com/watch?v=blabla
140 * Vimeo: https://vimeo.com/xxxxxx
141 * Dailymotion: https://www.dailymotion.com/xxxxx
143 The script will get all public videos from Youtube, download them and upload to PeerTube.
144 Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection...
146 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
148 **NB**: If you want to synchronize a Youtube channel to your PeerTube instance (ensure you have the agreement from the author),
149 you can add a [crontab rule](https://help.ubuntu.com/community/CronHowto) (or an equivalent of your OS) and insert
150 these rules (ensure to customize them to your needs):
153 # Update youtube-dl every day at midnight
154 0 0 * * * /usr/bin/npm rebuild youtube-dl --prefix /PATH/TO/PEERTUBE/
156 # Synchronize the YT channel every sunday at 22:00 all the videos published since last monday included
157 0 22 * * 0 /usr/bin/node /PATH/TO/PEERTUBE/dist/server/tools/peertube-import-videos.js -u '__PEERTUBE_URL__' -U '__USER__' --password '__PASSWORD__' --target-url 'https://www.youtube.com/channel/___CHANNEL__' --since $(date --date="-6 days" +%Y-%m-%d)
160 Also you may want to subscribe to the PeerTube channel in order to manually check the synchronization is successful.
162 #### peertube-upload.js
164 You can use this script to import videos directly from the CLI.
166 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
170 $ node dist/server/tools/peertube-upload.js --help
173 #### peertube-watch.js
175 You can use this script to play videos directly from the CLI.
177 It provides support for different players:
179 - ascii (default ; plays in ascii art in your terminal!)
189 #### peertube-plugins.js
191 Install/update/uninstall or list local or NPM PeerTube plugins:
195 $ node dist/server/tools/peertube-plugins.js --help
196 $ node dist/server/tools/peertube-plugins.js list --help
197 $ node dist/server/tools/peertube-plugins.js install --help
198 $ node dist/server/tools/peertube-plugins.js update --help
199 $ node dist/server/tools/peertube-plugins.js uninstall --help
201 $ node dist/server/tools/peertube-plugins.js install --path /my/plugin/path
202 $ node dist/server/tools/peertube-plugins.js install --npm-name peertube-theme-example
205 #### peertube-redundancy.js
207 Manage (list/add/remove) video redundancies:
209 To list your videos that are duplicated by remote instances:
212 $ node dist/server/tools/peertube.js redundancy list-remote-redundancies
215 To list remote videos that your instance duplicated:
218 $ node dist/server/tools/peertube.js redundancy list-my-redundancies
221 To duplicate a specific video in your redundancy system:
224 $ node dist/server/tools/peertube.js redundancy add --video 823
227 To remove a video redundancy:
230 $ node dist/server/tools/peertube.js redundancy remove --video 823
235 These scripts should be run on the server, in `peertube-latest` directory.
239 To parse PeerTube last log file:
242 $ cd /var/www/peertube/peertube-latest
243 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level info
246 `--level` is optional and could be `info`/`warn`/`error`
248 You can also remove SQL or HTTP logs using `--not-tags`:
251 $ cd /var/www/peertube/peertube-latest
252 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level debug --not-tags http sql
255 ### regenerate-thumbnails.js
257 Regenerating local video thumbnails could be useful because new PeerTube releases may increase thumbnail sizes:
260 $ cd /var/www/peertube/peertube-latest
261 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run regenerate-thumbnails
264 ### create-transcoding-job.js
266 You can use this script to force transcoding of an existing video. PeerTube needs to be running.
268 To generate transcoding jobs depending on the instance configuration:
270 $ cd /var/www/peertube/peertube-latest
271 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID]
274 Or to transcode to a specific resolution:
276 $ cd /var/www/peertube/peertube-latest
277 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] -r [resolution]
279 The resolution should be an integer (`1080`, `720`, `480`, etc.)
281 To generate an HLS playlist for a video:
284 $ cd /var/www/peertube/peertube-latest
285 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- --generate-hls -v [videoUUID]
288 ### create-import-video-file-job.js
290 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.
293 $ cd /var/www/peertube/peertube-latest
294 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile]
299 Some transcoded videos or shutdown at a bad time can leave some unused files on your storage.
300 Stop PeerTube and delete these files (a confirmation will be demanded first):
303 $ cd /var/www/peertube/peertube-latest
304 $ sudo systemctl stop peertube && sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage
307 ### optimize-old-videos.js
309 Before version v1.0.0-beta.16, Peertube did not specify a bitrate for the
310 transcoding of uploaded videos. This means that videos might be encoded into
311 very large files that are too large for streaming. This script re-transcodes
312 these videos so that they can be watched properly, even on slow connections.
315 $ cd /var/www/peertube/peertube-latest
316 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run optimize-old-videos
322 **Changing the hostname is unsupported and may be a risky operation, especially if you have already federated.**
323 If you started PeerTube with a domain, and then changed it you will have
324 invalid torrent files and invalid URLs in your database. To fix this, you have
325 to run the command below (keep in mind your follower instances will NOT update their URLs).
328 $ cd /var/www/peertube/peertube-latest
329 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host
332 ### reset-password.js
334 To reset a user password from CLI, run:
337 $ cd /var/www/peertube/peertube-latest
338 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u target_username
342 ### plugin install/uninstall
344 The difference with `peertube plugins` CLI is that these scripts can be used even if PeerTube is not running.
345 If PeerTube is running, you need to restart it for the changes to take effect (whereas with `peertube plugins` CLI, plugins/themes are dynamically loaded on the server).
347 To install/update a plugin or a theme from the disk:
350 $ cd /var/www/peertube/peertube-latest
351 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:install -- --plugin-path /local/plugin/path
357 $ cd /var/www/peertube/peertube-latest
358 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:install -- --npm-name peertube-plugin-myplugin
361 To uninstall a plugin or a theme:
364 $ cd /var/www/peertube/peertube-latest
365 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:uninstall -- --npm-name peertube-plugin-myplugin
368 ### REPL (Read Eval Print Loop)
370 If you want to interact with the application libraries and objects even when PeerTube is not running, there is a REPL for that.
372 usage: `node ./dist/server/tools/peertube-repl.js`
374 "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."
376 - type `.help` to list commands available in the repl, notice it starts with a dot
377 - 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
378 - 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
379 - type `env` to see the loaded environment variables
380 - type `path` to access path library
381 - type `lodash` to access lodash library
382 - type `uuidv1` to access uuid/v1 library
383 - type `uuidv3` to access uuid/v3 library
384 - type `uuidv4` to access uuid/v4 library
385 - type `uuidv5` to access uuid/v5 library
386 - type `YoutubeDL` to access youtube-dl library
387 - type `cli` to access the cli helpers object
388 - type `logger` to access the logger; if you log to it, it will write to stdout and to the peertube.log file
389 - type `constants` to access the constants loaded by the server
390 - type `coreUtils` to access the core-utils helpers object
391 - type `ffmpegUtils` to access the ffmpeg-utils helpers object
392 - type `peertubeCryptoUtils` to access the peertube-crypto helpers object
393 - type `signupUtils` to access the signup helpers object
394 - type `utils` to access the utils helpers object
395 - type `YoutubeDLUtils` to access the youtube-dl helpers object
396 - type `sequelizeTypescript` to access sequelizeTypescript
397 - type `modelsUtils` to access the models/utils
398 - type `models` to access the shortcut to sequelizeTypescript.models
399 - type `transaction` to access the shortcut to sequelizeTypescript.transaction
400 - type `query` to access the shortcut to sequelizeTypescript.query
401 - type `queryInterface` to access the shortcut to sequelizeTypescript.queryInterface
406 PeerTube [1.0.0] (b10eb595)> .help
407 .break Sometimes you get stuck, this gets you out
408 .clear Break, and also clear the local context
409 .editor Enter editor mode
411 .help Print this help message
412 .load Load JS from a file into the REPL session
415 .save Save all evaluated commands in this REPL session to a file
416 PeerTube [1.0.0] (b10eb595)>
422 PeerTube [1.0.0] (b10eb595)> lodash.keys(context)
425 'DTRACE_NET_SERVER_CONNECTION',
426 'DTRACE_NET_STREAM_END',
427 'DTRACE_HTTP_SERVER_REQUEST',
428 'DTRACE_HTTP_SERVER_RESPONSE',
429 'DTRACE_HTTP_CLIENT_REQUEST',
430 'DTRACE_HTTP_CLIENT_RESPONSE',
456 'sequelizeTypescript',
465 'peertubeCryptoUtils',
469 PeerTube [1.0.0] (b10eb595)>
472 #### YoutubeDL example
474 YoutubeDL.getInfo('https://www.youtube.com/watch?v=I5ZN289jjDo', function(err, data) {console.log(err, data)})
479 PeerTube [1.0.0] (b10eb595)> new models.ActorModel({id: 3}).getVideoChannel().then(function(data){console.log(data.dataValues.name)})
482 _fulfillmentHandler0: undefined,
483 _rejectionHandler0: undefined,
484 _promise0: undefined,
485 _receiver0: undefined }
486 PeerTube [1.0.0] (b10eb595)> Main root channel
487 PeerTube [1.0.0] (b10eb595)> let out; new models.UserModel({id: 1}).getAccount().then(function (data) {out = data.dataValues.id})
490 _fulfillmentHandler0: undefined,
491 _rejectionHandler0: undefined,
492 _promise0: undefined,
493 _receiver0: undefined }
494 PeerTube [1.0.0] (b10eb595)> out
496 PeerTube [1.0.0] (b10eb595)>