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 **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):
 147
 148 ```
 149 # Update youtube-dl every day at midnight
 150 0 0 * * * /usr/bin/npm rebuild youtube-dl --prefix /PATH/TO/PEERTUBE/
 151
 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)
 154 ```
 155
 156 Also you may want to subscribe to the PeerTube channel in order to manually check the synchronization is successful.
 157
 158 #### peertube-upload.js
 159
 160 You can use this script to import videos directly from the CLI.
 161
 162 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
 163
 164 ```
 165 $ cd ${CLONE}
 166 $ node dist/server/tools/peertube-upload.js --help
 167 ```
 168
 169 #### peertube-watch.js
 170
 171 You can use this script to play videos directly from the CLI.
 172
 173 It provides support for different players:
 174
 175 - ascii (default ; plays in ascii art in your terminal!)
 176 - mpv
 177 - mplayer
 178 - vlc
 179 - stdout
 180 - xbmc
 181 - airplay
 182 - chromecast
 183
 184
 185 ## Server tools
 186
 187 These scripts should be run on the server, in `peertube-latest` directory.
 188
 189 ### parse-log
 190
 191 To parse PeerTube last log file:
 192
 193 ```
 194 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level info
 195 ```
 196
 197 `--level` is optional and could be `info`/`warn`/`error`
 198
 199 ### create-transcoding-job.js
 200
 201 You can use this script to force transcoding of an existing 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-transcoding-job -- -v [videoUUID]
 205 ```
 206
 207 Or to transcode to a specific resolution:
 208 ```
 209 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] -r [resolution]
 210 ```
 211
 212 ### create-import-video-file-job.js
 213
 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.
 215
 216 ```
 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]
 218 ```
 219
 220 ### prune-storage.js
 221
 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):
 224
 225 ```
 226 $ sudo systemctl stop peertube && sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage
 227 ```
 228
 229 ### optimize-old-videos.js
 230
 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.
 235
 236 ```
 237 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run optimize-old-videos
 238 ```
 239
 240
 241 ### update-host.js
 242
 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
 245 to run:
 246
 247 ```
 248 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host
 249 ```
 250
 251 ### reset-password.js
 252
 253 To reset a user password from CLI, run:
 254
 255 ```
 256 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u target_username
 257 ```
 258
 259
 260 ### plugin install/uninstall
 261
 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).
 264
 265 To install a plugin or a theme from the disk:
 266
 267 ```
 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
 269 ```
 270
 271 From NPM:
 272
 273 ```
 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
 275 ```
 276
 277 To uninstall a plugin or a theme:
 278
 279 ```
 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
 281 ```
 282
 283 ### REPL ([Read Eval Print Loop](https://nodejs.org/docs/latest-v8.x/api/repl.html))
 284
 285 If you want to interact with the application libraries and objects even when PeerTube is not running, there is a REPL for that.
 286
 287 usage: `node ./dist/server/tools/peertube-repl.js`
 288
 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."
 290
 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
 317
 318 #### .help
 319
 320 ```
 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
 325 .exit     Exit the repl
 326 .help     Print this help message
 327 .load     Load JS from a file into the REPL session
 328 .r        Reset REPL
 329 .reset    Reset REPL
 330 .save     Save all evaluated commands in this REPL session to a file
 331 PeerTube [1.0.0] (b10eb595)>
 332 ```
 333
 334 #### Lodash example
 335
 336 ```
 337 PeerTube [1.0.0] (b10eb595)> lodash.keys(context)
 338 [ 'global',
 339   'console',
 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',
 346   'process',
 347   'Buffer',
 348   'clearImmediate',
 349   'clearInterval',
 350   'clearTimeout',
 351   'setImmediate',
 352   'setInterval',
 353   'setTimeout',
 354   'XMLHttpRequest',
 355   'compact2string',
 356   'module',
 357   'require',
 358   'path',
 359   'repl',
 360   'context',
 361   'env',
 362   'lodash',
 363   'uuidv1',
 364   'uuidv3',
 365   'uuidv4',
 366   'uuidv5',
 367   'cli',
 368   'logger',
 369   'constants',
 370   'Sequelize',
 371   'sequelizeTypescript',
 372   'modelsUtils',
 373   'models',
 374   'transaction',
 375   'query',
 376   'queryInterface',
 377   'YoutubeDL',
 378   'coreUtils',
 379   'ffmpegUtils',
 380   'peertubeCryptoUtils',
 381   'signupUtils',
 382   'utils',
 383   'YoutubeDLUtils' ]
 384 PeerTube [1.0.0] (b10eb595)>
 385 ```
 386
 387 #### YoutubeDL example
 388 ```
 389 YoutubeDL.getInfo('https://www.youtube.com/watch?v=I5ZN289jjDo', function(err, data) {console.log(err, data)})
 390 ```
 391
 392 #### Models examples
 393 ```
 394 PeerTube [1.0.0] (b10eb595)> new models.ActorModel({id: 3}).getVideoChannel().then(function(data){console.log(data.dataValues.name)})
 395 Promise {
 396   _bitField: 0,
 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})
 403 Promise {
 404   _bitField: 0,
 405   _fulfillmentHandler0: undefined,
 406   _rejectionHandler0: undefined,
 407   _promise0: undefined,
 408   _receiver0: undefined }
 409 PeerTube [1.0.0] (b10eb595)> out
 410 2
 411 PeerTube [1.0.0] (b10eb595)>
 412 ```