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