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 - [reset-password.js](#reset-passwordjs)
22 - [REPL (Read Eval Print Loop)](#repl-read-eval-print-loop)
24 - [Lodash example](#lodash-example)
25 - [YoutubeDL example](#youtubedl-example)
26 - [Models examples](#models-examples)
28 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
32 You need at least 512MB RAM to run the script.
33 Scripts can be launched directly from a PeerTube server, or from a separate server, even a desktop PC.
34 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).
38 Install the [PeerTube dependencies](dependencies.md) except PostgreSQL and Redis.
39 PeerTube only supports NodeJS 8.x or 10.x.
43 Clone the PeerTube repo to get the latest version (even if you are on your PeerTube server):
46 $ git clone https://github.com/Chocobozzz/PeerTube.git
47 $ CLONE="$(pwd)/PeerTube"
51 Install dependencies and build CLI tools:
54 $ NOCLIENT=1 yarn install --pure-lockfile
60 The wrapper provides a convenient interface to the following scripts.
61 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):
64 Usage: peertube [command] [options]
68 -v, --version output the version number
69 -h, --help output usage information
73 auth [action] register your accounts on remote instances to use them with other commands
74 upload|up upload a video
75 import-videos|import import a video from a streaming platform
76 watch|w watch a video in the terminal ✩°。⋆
77 repl initiate a REPL to access internals
78 plugins|p [action] manag instance plugins
79 help [cmd] display help for [cmd]
82 The wrapper can keep track of instances you have an account on. We limit to one account per instance for now.
85 $ peertube auth add -u 'PEERTUBE_URL' -U 'PEERTUBE_USER' --password 'PEERTUBE_PASSWORD'
87 ┌──────────────────────────────┬──────────────────────────────┐
89 ├──────────────────────────────┼──────────────────────────────┤
90 │ 'PEERTUBE_URL' │ 'PEERTUBE_USER' │
91 └──────────────────────────────┴──────────────────────────────┘
94 You can now use that account to upload videos without feeding the same parameters again.
97 $ peertube up <videoFile>
100 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):
103 $ peertube watch https://peertube.cpy.re/videos/watch/e8a1af4e-414a-4d58-bfe6-2146eed06d10
106 To list, install, uninstall dynamically plugins/themes of an instance:
109 $ peertube plugins list
110 $ peertube plugins install --path /local/plugin/path
111 $ peertube plugins install --npm-name peertube-plugin-myplugin
112 $ peertube plugins uninstall --npm-name peertube-plugin-myplugin
115 #### peertube-import-videos.js
117 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.
118 Be sure you own the videos or have the author's authorization to do so.
121 $ node dist/server/tools/peertube-import-videos.js \
124 --password 'PEERTUBE_PASSWORD' \
128 * `PEERTUBE_URL` : the full URL of your PeerTube server where you want to import, eg: https://peertube.cpy.re
129 * `PEERTUBE_USER` : your PeerTube account where videos will be uploaded
130 * `PEERTUBE_PASSWORD` : password of your PeerTube account (if `--password PEERTUBE_PASSWORD` is omitted, you will be prompted for it)
131 * `TARGET_URL` : the target url you want to import. Examples:
133 * Channel: https://www.youtube.com/channel/ChannelId
134 * User https://www.youtube.com/c/UserName or https://www.youtube.com/user/UserName
135 * Video https://www.youtube.com/watch?v=blabla
136 * Vimeo: https://vimeo.com/xxxxxx
137 * Dailymotion: https://www.dailymotion.com/xxxxx
139 The script will get all public videos from Youtube, download them and upload to PeerTube.
140 Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection...
142 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
144 **NB**: If you want to synchronize a Youtube channel to your PeerTube instance (ensure you have the agreement from the author),
145 you can add a [crontab rule](https://help.ubuntu.com/community/CronHowto) (or an equivalent of your OS) and insert
146 these rules (ensure to customize them to your needs):
149 # Update youtube-dl every day at midnight
150 0 0 * * * /usr/bin/npm rebuild youtube-dl --prefix /PATH/TO/PEERTUBE/
152 # Synchronize the YT channel every sunday at 22:00 all the videos published since last monday included
153 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)
156 Also you may want to subscribe to the PeerTube channel in order to manually check the synchronization is successful.
158 #### peertube-upload.js
160 You can use this script to import videos directly from the CLI.
162 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
166 $ node dist/server/tools/peertube-upload.js --help
169 #### peertube-watch.js
171 You can use this script to play videos directly from the CLI.
173 It provides support for different players:
175 - ascii (default ; plays in ascii art in your terminal!)
187 These scripts should be run on the server, in `peertube-latest` directory.
191 To parse PeerTube last log file:
194 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level info
197 `--level` is optional and could be `info`/`warn`/`error`
199 ### create-transcoding-job.js
201 You can use this script to force transcoding of an existing video. PeerTube needs to be running.
204 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID]
207 Or to transcode to a specific resolution:
209 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] -r [resolution]
212 ### create-import-video-file-job.js
214 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.
217 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile]
222 Some transcoded videos or shutdown at a bad time can leave some unused files on your storage.
223 Stop PeerTube and delete these files (a confirmation will be demanded first):
226 $ sudo systemctl stop peertube && sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage
229 ### optimize-old-videos.js
231 Before version v1.0.0-beta.16, Peertube did not specify a bitrate for the
232 transcoding of uploaded videos. This means that videos might be encoded into
233 very large files that are too large for streaming. This script re-transcodes
234 these videos so that they can be watched properly, even on slow connections.
237 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run optimize-old-videos
243 If you started PeerTube with a domain, and then changed it you will have
244 invalid torrent files and invalid URLs in your database. To fix this, you have
248 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host
251 ### reset-password.js
253 To reset a user password from CLI, run:
256 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u target_username
260 ### plugin install/uninstall
262 The difference with `peertube plugins` CLI is that these scripts can be used even if PeerTube is not running.
263 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).
265 To install a plugin or a theme from the disk:
268 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run npm run plugin:install -- --plugin-path /local/plugin/path
274 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run npm run plugin:install -- --npm-name peertube-plugin-myplugin
277 To uninstall a plugin or a theme:
280 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run npm run plugin:uninstall -- --npm-name peertube-plugin-myplugin
283 ### REPL ([Read Eval Print Loop](https://nodejs.org/docs/latest-v8.x/api/repl.html))
285 If you want to interact with the application libraries and objects even when PeerTube is not running, there is a REPL for that.
287 usage: `node ./dist/server/tools/peertube-repl.js`
289 "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."
291 - type `.help` to list commands available in the repl, notice it starts with a dot
292 - 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
293 - 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
294 - type `env` to see the loaded environment variables
295 - type `path` to access path library
296 - type `lodash` to access lodash library
297 - type `uuidv1` to access uuid/v1 library
298 - type `uuidv3` to access uuid/v3 library
299 - type `uuidv4` to access uuid/v4 library
300 - type `uuidv5` to access uuid/v5 library
301 - type `YoutubeDL` to access youtube-dl library
302 - type `cli` to access the cli helpers object
303 - type `logger` to access the logger; if you log to it, it will write to stdout and to the peertube.log file
304 - type `constants` to access the constants loaded by the server
305 - type `coreUtils` to access the core-utils helpers object
306 - type `ffmpegUtils` to access the ffmpeg-utils helpers object
307 - type `peertubeCryptoUtils` to access the peertube-crypto helpers object
308 - type `signupUtils` to access the signup helpers object
309 - type `utils` to access the utils helpers object
310 - type `YoutubeDLUtils` to access the youtube-dl helpers object
311 - type `sequelizeTypescript` to access sequelizeTypescript
312 - type `modelsUtils` to access the models/utils
313 - type `models` to access the shortcut to sequelizeTypescript.models
314 - type `transaction` to access the shortcut to sequelizeTypescript.transaction
315 - type `query` to access the shortcut to sequelizeTypescript.query
316 - type `queryInterface` to access the shortcut to sequelizeTypescript.queryInterface
321 PeerTube [1.0.0] (b10eb595)> .help
322 .break Sometimes you get stuck, this gets you out
323 .clear Break, and also clear the local context
324 .editor Enter editor mode
326 .help Print this help message
327 .load Load JS from a file into the REPL session
330 .save Save all evaluated commands in this REPL session to a file
331 PeerTube [1.0.0] (b10eb595)>
337 PeerTube [1.0.0] (b10eb595)> lodash.keys(context)
340 'DTRACE_NET_SERVER_CONNECTION',
341 'DTRACE_NET_STREAM_END',
342 'DTRACE_HTTP_SERVER_REQUEST',
343 'DTRACE_HTTP_SERVER_RESPONSE',
344 'DTRACE_HTTP_CLIENT_REQUEST',
345 'DTRACE_HTTP_CLIENT_RESPONSE',
371 'sequelizeTypescript',
380 'peertubeCryptoUtils',
384 PeerTube [1.0.0] (b10eb595)>
387 #### YoutubeDL example
389 YoutubeDL.getInfo('https://www.youtube.com/watch?v=I5ZN289jjDo', function(err, data) {console.log(err, data)})
394 PeerTube [1.0.0] (b10eb595)> new models.ActorModel({id: 3}).getVideoChannel().then(function(data){console.log(data.dataValues.name)})
397 _fulfillmentHandler0: undefined,
398 _rejectionHandler0: undefined,
399 _promise0: undefined,
400 _receiver0: undefined }
401 PeerTube [1.0.0] (b10eb595)> Main root channel
402 PeerTube [1.0.0] (b10eb595)> let out; new models.UserModel({id: 1}).getAccount().then(function (data) {out = data.dataValues.id})
405 _fulfillmentHandler0: undefined,
406 _rejectionHandler0: undefined,
407 _promise0: undefined,
408 _receiver0: undefined }
409 PeerTube [1.0.0] (b10eb595)> out
411 PeerTube [1.0.0] (b10eb595)>