support/doc/tools.md

   1 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
   2 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
   3 **Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
   4
   5 - [CLI tools guide](#cli-tools-guide)
   6   - [CLI wrapper](#cli-wrapper)
   7   - [Remote Tools](#remote-tools)
   8     - [Dependencies](#dependencies)
   9     - [Installation](#installation)
  10     - [peertube-import-videos.js](#peertube-import-videosjs)
  11     - [peertube-upload.js](#peertube-uploadjs)
  12     - [peertube-watch.js](#peertube-watchjs)
  13   - [Server tools](#server-tools)
  14     - [parse-log](#parse-log)
  15     - [create-transcoding-job.js](#create-transcoding-jobjs)
  16     - [create-import-video-file-job.js](#create-import-video-file-jobjs)
  17     - [prune-storage.js](#prune-storagejs)
  18     - [optimize-old-videos.js](#optimize-old-videosjs)
  19     - [update-host.js](#update-hostjs)
  20     - [REPL (Read Eval Print Loop)](#repl-read-eval-print-loop)
  21       - [.help](#help)
  22       - [Lodash example](#lodash-example)
  23       - [YoutubeDL example](#youtubedl-example)
  24       - [Models examples](#models-examples)
  25
  26 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
  27
  28 # CLI tools guide
  29  - [CLI wrapper](#cli-wrapper)
  30  - [Remote tools](#remote-tools)
  31    - [peertube-import-videos.js](#peertube-import-videosjs)
  32    - [peertube-upload.js](#peertube-uploadjs)
  33    - [peertube-watch.js](#peertube-watch)
  34  - [Server tools](#server-tools)
  35    - [parse-log](#parse-log)
  36    - [create-transcoding-job.js](#create-transcoding-jobjs)
  37    - [create-import-video-file-job.js](#create-import-video-file-jobjs)
  38    - [prune-storage.js](#prune-storagejs)
  39
  40 ## CLI wrapper
  41
  42 The wrapper provides a convenient interface to most scripts, and requires the [same dependencies](#dependencies). You can access it as `peertube` via an alias in your `.bashrc` like `alias peertube="node ${PEERTUBE_PATH}/dist/server/tools/peertube.js"`:
  43
  44 ```
  45   Usage: peertube [command] [options]
  46
  47   Options:
  48
  49     -v, --version         output the version number
  50     -h, --help            output usage information
  51
  52   Commands:
  53
  54     auth [action]         register your accounts on remote instances to use them with other commands
  55     upload|up             upload a video
  56     import-videos|import  import a video from a streaming platform
  57     watch|w               watch a video in the terminal ✩°｡⋆
  58     help [cmd]            display help for [cmd]
  59 ```
  60
  61 The wrapper can keep track of instances you have an account on. We limit to one account per instance for now.
  62
  63 ```bash
  64 $ peertube auth add -u "PEERTUBE_URL" -U "PEERTUBE_USER" --password "PEERTUBE_PASSWORD"
  65 $ peertube auth list
  66 ┌──────────────────────────────┬──────────────────────────────┐
  67 │ instance                     │ login                        │
  68 ├──────────────────────────────┼──────────────────────────────┤
  69 │ "PEERTUBE_URL"               │ "PEERTUBE_USER"              │
  70 └──────────────────────────────┴──────────────────────────────┘
  71 ```
  72
  73 You can now use that account to upload videos without feeding the same parameters again.
  74
  75 ```bash
  76 $ peertube up <videoFile>
  77 ```
  78
  79 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):
  80
  81 ```bash
  82 $ peertube watch https://peertube.cpy.re/videos/watch/e8a1af4e-414a-4d58-bfe6-2146eed06d10
  83 ```
  84
  85 ## Remote Tools
  86
  87 You need at least 512MB RAM to run the script.
  88 Scripts can be launched directly from a PeerTube server, or from a separate server, even a desktop PC.
  89 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).
  90
  91 ### Dependencies
  92
  93 Install the [PeerTube dependencies](dependencies.md).
  94
  95 ### Installation
  96
  97 Clone the PeerTube repo to get the latest version (even if you are on your PeerTube server):
  98
  99 ```
 100 $ git clone https://github.com/Chocobozzz/PeerTube.git
 101 $ CLONE="$(pwd)/PeerTube"
 102 ```
 103
 104 Run ``yarn install``
 105 ```
 106 $ cd ${CLONE}
 107 $ yarn install
 108 ```
 109
 110 Build server tools:
 111 ```
 112 $ cd ${CLONE}
 113 $ npm run build:server
 114 ```
 115
 116 ### peertube-import-videos.js
 117
 118 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.
 119 Be sure you own the videos or have the author's authorization to do so.
 120
 121 ```sh
 122 $ node dist/server/tools/peertube-import-videos.js \
 123     -u "PEERTUBE_URL" \
 124     -U "PEERTUBE_USER" \
 125     --password "PEERTUBE_PASSWORD" \
 126     -t "TARGET_URL"
 127 ```
 128
 129 * `PEERTUBE_URL` : the full URL of your PeerTube server where you want to import, eg: https://peertube.cpy.re
 130 * `PEERTUBE_USER` : your PeerTube account where videos will be uploaded
 131 * `PEERTUBE_PASSWORD` : password of your PeerTube account (if omitted, you will be prompted for it)
 132 * `TARGET_URL` : the target url you want to import. Examples:
 133   * YouTube:
 134     * Channel: https://www.youtube.com/channel/ChannelId
 135     * User https://www.youtube.com/c/UserName or https://www.youtube.com/user/UserName
 136     * Video https://www.youtube.com/watch?v=blabla
 137   * Vimeo: https://vimeo.com/xxxxxx
 138   * Dailymotion: https://www.dailymotion.com/xxxxx
 139
 140 The script will get all public videos from Youtube, download them and upload to PeerTube.
 141 Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection...
 142
 143 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
 144
 145
 146 ### peertube-upload.js
 147
 148 You can use this script to import videos directly from the CLI.
 149
 150 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
 151
 152 ```
 153 $ cd ${CLONE}
 154 $ node dist/server/tools/peertube-upload.js --help
 155 ```
 156
 157 ### peertube-watch.js
 158
 159 You can use this script to play videos directly from the CLI.
 160
 161 It provides support for different players:
 162
 163 - ascii (default ; plays in ascii art in your terminal!)
 164 - mpv
 165 - mplayer
 166 - vlc
 167 - stdout
 168 - xbmc
 169 - airplay
 170 - chromecast
 171
 172
 173 ## Server tools
 174
 175 These scripts should be run on the server, in `peertube-latest` directory.
 176
 177 ### parse-log
 178
 179 To parse PeerTube last log file:
 180
 181 ```
 182 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level info
 183 ```
 184
 185 `--level` is optional and could be `info`/`warn`/`error`
 186
 187 ### create-transcoding-job.js
 188
 189 You can use this script to force transcoding of an existing video. PeerTube needs to be running.
 190
 191 ```
 192 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID]
 193 ```
 194
 195 Or to transcode to a specific resolution:
 196 ```
 197 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] -r [resolution]
 198 ```
 199
 200 ### create-import-video-file-job.js
 201
 202 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.
 203
 204 ```
 205 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile]
 206 ```
 207
 208 ### prune-storage.js
 209
 210 Some transcoded videos or shutdown at a bad time can leave some unused files on your storage.
 211 To delete them (a confirmation will be demanded first):
 212
 213 ```
 214 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage
 215 ```
 216
 217 ### optimize-old-videos.js
 218
 219 Before version v1.0.0-beta.16, Peertube did not specify a bitrate for the
 220 transcoding of uploaded videos. This means that videos might be encoded into
 221 very large files that are too large for streaming. This script re-transcodes
 222 these videos so that they can be watched properly, even on slow connections.
 223
 224 ```
 225 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run optimize-old-videos
 226 ```
 227
 228
 229 ### update-host.js
 230
 231 If you started PeerTube with a domain, and then changed it you will have
 232 invalid torrent files and invalid URLs in your database. To fix this, you have
 233 to run:
 234
 235 ```
 236 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host
 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/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 ```