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