support/doc/tools.md

   1 # CLI tools guide
   2
   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 -->
   5 **Table of Contents**
   6
   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   - [create-transcoding-job.js](#create-transcoding-jobjs)
  19   - [create-import-video-file-job.js](#create-import-video-file-jobjs)
  20   - [prune-storage.js](#prune-storagejs)
  21   - [optimize-old-videos.js](#optimize-old-videosjs)
  22   - [update-host.js](#update-hostjs)
  23   - [reset-password.js](#reset-passwordjs)
  24   - [plugin install/uninstall](#plugin-installuninstall)
  25   - [REPL (Read Eval Print Loop)](#repl-read-eval-print-loop)
  26     - [.help](#help)
  27     - [Lodash example](#lodash-example)
  28     - [YoutubeDL example](#youtubedl-example)
  29     - [Models examples](#models-examples)
  30
  31 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
  32
  33 ## Remote Tools
  34
  35 You need at least 512MB RAM to run the script.
  36 Scripts can be launched directly from a PeerTube server, or from a separate server, even a desktop PC.
  37 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
  39 ### Dependencies
  40
  41 Install the [PeerTube dependencies](dependencies.md) except PostgreSQL and Redis.
  42 PeerTube only supports NodeJS 10.x.
  43
  44 ### Installation
  45
  46 Clone the PeerTube repo to get the latest version (even if you are on your PeerTube server):
  47
  48 ```
  49 $ git clone https://github.com/Chocobozzz/PeerTube.git
  50 $ CLONE="$(pwd)/PeerTube"
  51 $ cd ${CLONE}
  52 ```
  53
  54 Install dependencies and build CLI tools:
  55
  56 ```
  57 $ NOCLIENT=1 yarn install --pure-lockfile
  58 $ npm run setup:cli
  59 ```
  60
  61 ### CLI wrapper
  62
  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):
  65
  66 ```
  67   Usage: peertube [command] [options]
  68
  69   Options:
  70
  71     -v, --version         output the version number
  72     -h, --help            output usage information
  73
  74   Commands:
  75
  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]
  84 ```
  85
  86 The wrapper can keep track of instances you have an account on. We limit to one account per instance for now.
  87
  88 ```bash
  89 $ peertube auth add -u 'PEERTUBE_URL' -U 'PEERTUBE_USER' --password 'PEERTUBE_PASSWORD'
  90 $ peertube auth list
  91 ┌──────────────────────────────┬──────────────────────────────┐
  92 │ instance                     │ login                        │
  93 ├──────────────────────────────┼──────────────────────────────┤
  94 │ 'PEERTUBE_URL'               │ 'PEERTUBE_USER'              │
  95 └──────────────────────────────┴──────────────────────────────┘
  96 ```
  97
  98 You can now use that account to upload videos without feeding the same parameters again.
  99
 100 ```bash
 101 $ peertube up <videoFile>
 102 ```
 103
 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):
 105
 106 ```bash
 107 $ peertube watch https://peertube.cpy.re/videos/watch/e8a1af4e-414a-4d58-bfe6-2146eed06d10
 108 ```
 109
 110 To list, install, uninstall dynamically plugins/themes of an instance:
 111
 112 ```bash
 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
 117 ```
 118
 119 #### peertube-import-videos.js
 120
 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.
 123
 124 ```sh
 125 $ node dist/server/tools/peertube-import-videos.js \
 126     -u 'PEERTUBE_URL' \
 127     -U 'PEERTUBE_USER' \
 128     --password 'PEERTUBE_PASSWORD' \
 129     --target-url 'TARGET_URL'
 130 ```
 131
 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:
 136   * YouTube:
 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
 142
 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...
 145
 146 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
 147
 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):
 151
 152 ```
 153 # Update youtube-dl every day at midnight
 154 0 0 * * * /usr/bin/npm rebuild youtube-dl --prefix /PATH/TO/PEERTUBE/
 155
 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)
 158 ```
 159
 160 Also you may want to subscribe to the PeerTube channel in order to manually check the synchronization is successful.
 161
 162 #### peertube-upload.js
 163
 164 You can use this script to import videos directly from the CLI.
 165
 166 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
 167
 168 ```
 169 $ cd ${CLONE}
 170 $ node dist/server/tools/peertube-upload.js --help
 171 ```
 172
 173 #### peertube-watch.js
 174
 175 You can use this script to play videos directly from the CLI.
 176
 177 It provides support for different players:
 178
 179 - ascii (default ; plays in ascii art in your terminal!)
 180 - mpv
 181 - mplayer
 182 - vlc
 183 - stdout
 184 - xbmc
 185 - airplay
 186 - chromecast
 187
 188
 189 #### peertube-plugins.js
 190
 191 Install/update/uninstall or list local or NPM PeerTube plugins:
 192
 193 ```
 194 $ cd ${CLONE}
 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
 200
 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
 203 ```
 204
 205 #### peertube-redundancy.js
 206
 207 Manage (list/add/remove) video redundancies:
 208
 209 To list your videos that are duplicated by remote instances:
 210
 211 ```
 212 $ node dist/server/tools/peertube.js redundancy list-remote-redundancies
 213 ```
 214
 215 To list remote videos that your instance duplicated:
 216
 217 ```
 218 $ node dist/server/tools/peertube.js redundancy list-my-redundancies
 219 ```
 220
 221 To duplicate a specific video in your redundancy system:
 222
 223 ```
 224 $ node dist/server/tools/peertube.js redundancy add --video 823
 225 ```
 226
 227 To remove a video redundancy:
 228
 229 ```
 230 $ node dist/server/tools/peertube.js redundancy remove --video 823
 231 ```
 232
 233 ## Server tools
 234
 235 These scripts should be run on the server, in `peertube-latest` directory.
 236
 237 ### parse-log
 238
 239 To parse PeerTube last log file:
 240
 241 ```
 242 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level info
 243 ```
 244
 245 `--level` is optional and could be `info`/`warn`/`error`
 246
 247 ### create-transcoding-job.js
 248
 249 You can use this script to force transcoding of an existing video. PeerTube needs to be running.
 250
 251 ```
 252 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID]
 253 ```
 254
 255 Or to transcode to a specific resolution:
 256 ```
 257 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] -r [resolution]
 258 ```
 259 The resolution should be an integer (`1080`, `720`, `480`, etc.)
 260
 261 To generate an HLS playlist for a video:
 262
 263 ```
 264 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- --generate-hls -v [videoUUID]
 265 ```
 266
 267 ### create-import-video-file-job.js
 268
 269 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.
 270
 271 ```
 272 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile]
 273 ```
 274
 275 ### prune-storage.js
 276
 277 Some transcoded videos or shutdown at a bad time can leave some unused files on your storage.
 278 Stop PeerTube and delete these files (a confirmation will be demanded first):
 279
 280 ```
 281 $ sudo systemctl stop peertube && sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage
 282 ```
 283
 284 ### optimize-old-videos.js
 285
 286 Before version v1.0.0-beta.16, Peertube did not specify a bitrate for the
 287 transcoding of uploaded videos. This means that videos might be encoded into
 288 very large files that are too large for streaming. This script re-transcodes
 289 these videos so that they can be watched properly, even on slow connections.
 290
 291 ```
 292 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run optimize-old-videos
 293 ```
 294
 295
 296 ### update-host.js
 297
 298 If you started PeerTube with a domain, and then changed it you will have
 299 invalid torrent files and invalid URLs in your database. To fix this, you have
 300 to run:
 301
 302 ```
 303 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host
 304 ```
 305
 306 ### reset-password.js
 307
 308 To reset a user password from CLI, run:
 309
 310 ```
 311 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u target_username
 312 ```
 313
 314
 315 ### plugin install/uninstall
 316
 317 The difference with `peertube plugins` CLI is that these scripts can be used even if PeerTube is not running.
 318 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).
 319
 320 To install/update a plugin or a theme from the disk:
 321
 322 ```
 323 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:install -- --plugin-path /local/plugin/path
 324 ```
 325
 326 From NPM:
 327
 328 ```
 329 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:install -- --npm-name peertube-plugin-myplugin
 330 ```
 331
 332 To uninstall a plugin or a theme:
 333
 334 ```
 335 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:uninstall -- --npm-name peertube-plugin-myplugin
 336 ```
 337
 338 ### REPL ([Read Eval Print Loop](https://nodejs.org/docs/latest-v10.x/api/repl.html))
 339
 340 If you want to interact with the application libraries and objects even when PeerTube is not running, there is a REPL for that.
 341
 342 usage: `node ./dist/server/tools/peertube-repl.js`
 343
 344 "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."
 345
 346 - type `.help` to list commands available in the repl, notice it starts with a dot
 347 - 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
 348 - 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
 349 - type `env` to see the loaded environment variables
 350 - type `path` to access path library
 351 - type `lodash` to access lodash library
 352 - type `uuidv1` to access uuid/v1 library
 353 - type `uuidv3` to access uuid/v3 library
 354 - type `uuidv4` to access uuid/v4 library
 355 - type `uuidv5` to access uuid/v5 library
 356 - type `YoutubeDL` to access youtube-dl library
 357 - type `cli` to access the cli helpers object
 358 - type `logger` to access the logger; if you log to it, it will write to stdout and to the peertube.log file
 359 - type `constants` to access the constants loaded by the server
 360 - type `coreUtils` to access the core-utils helpers object
 361 - type `ffmpegUtils` to access the ffmpeg-utils helpers object
 362 - type `peertubeCryptoUtils` to access the peertube-crypto helpers object
 363 - type `signupUtils` to access the signup helpers object
 364 - type `utils` to access the utils helpers object
 365 - type `YoutubeDLUtils` to access the youtube-dl helpers object
 366 - type `sequelizeTypescript` to access sequelizeTypescript
 367 - type `modelsUtils` to access the models/utils
 368 - type `models` to access the shortcut to sequelizeTypescript.models
 369 - type `transaction` to access the shortcut to sequelizeTypescript.transaction
 370 - type `query` to access the shortcut to sequelizeTypescript.query
 371 - type `queryInterface` to access the shortcut to sequelizeTypescript.queryInterface
 372
 373 #### .help
 374
 375 ```
 376 PeerTube [1.0.0] (b10eb595)> .help
 377 .break    Sometimes you get stuck, this gets you out
 378 .clear    Break, and also clear the local context
 379 .editor   Enter editor mode
 380 .exit     Exit the repl
 381 .help     Print this help message
 382 .load     Load JS from a file into the REPL session
 383 .r        Reset REPL
 384 .reset    Reset REPL
 385 .save     Save all evaluated commands in this REPL session to a file
 386 PeerTube [1.0.0] (b10eb595)>
 387 ```
 388
 389 #### Lodash example
 390
 391 ```
 392 PeerTube [1.0.0] (b10eb595)> lodash.keys(context)
 393 [ 'global',
 394   'console',
 395   'DTRACE_NET_SERVER_CONNECTION',
 396   'DTRACE_NET_STREAM_END',
 397   'DTRACE_HTTP_SERVER_REQUEST',
 398   'DTRACE_HTTP_SERVER_RESPONSE',
 399   'DTRACE_HTTP_CLIENT_REQUEST',
 400   'DTRACE_HTTP_CLIENT_RESPONSE',
 401   'process',
 402   'Buffer',
 403   'clearImmediate',
 404   'clearInterval',
 405   'clearTimeout',
 406   'setImmediate',
 407   'setInterval',
 408   'setTimeout',
 409   'XMLHttpRequest',
 410   'compact2string',
 411   'module',
 412   'require',
 413   'path',
 414   'repl',
 415   'context',
 416   'env',
 417   'lodash',
 418   'uuidv1',
 419   'uuidv3',
 420   'uuidv4',
 421   'uuidv5',
 422   'cli',
 423   'logger',
 424   'constants',
 425   'Sequelize',
 426   'sequelizeTypescript',
 427   'modelsUtils',
 428   'models',
 429   'transaction',
 430   'query',
 431   'queryInterface',
 432   'YoutubeDL',
 433   'coreUtils',
 434   'ffmpegUtils',
 435   'peertubeCryptoUtils',
 436   'signupUtils',
 437   'utils',
 438   'YoutubeDLUtils' ]
 439 PeerTube [1.0.0] (b10eb595)>
 440 ```
 441
 442 #### YoutubeDL example
 443 ```
 444 YoutubeDL.getInfo('https://www.youtube.com/watch?v=I5ZN289jjDo', function(err, data) {console.log(err, data)})
 445 ```
 446
 447 #### Models examples
 448 ```
 449 PeerTube [1.0.0] (b10eb595)> new models.ActorModel({id: 3}).getVideoChannel().then(function(data){console.log(data.dataValues.name)})
 450 Promise {
 451   _bitField: 0,
 452   _fulfillmentHandler0: undefined,
 453   _rejectionHandler0: undefined,
 454   _promise0: undefined,
 455   _receiver0: undefined }
 456 PeerTube [1.0.0] (b10eb595)> Main root channel
 457 PeerTube [1.0.0] (b10eb595)> let out; new models.UserModel({id: 1}).getAccount().then(function (data) {out = data.dataValues.id})
 458 Promise {
 459   _bitField: 0,
 460   _fulfillmentHandler0: undefined,
 461   _rejectionHandler0: undefined,
 462   _promise0: undefined,
 463   _receiver0: undefined }
 464 PeerTube [1.0.0] (b10eb595)> out
 465 2
 466 PeerTube [1.0.0] (b10eb595)>
 467 ```