]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame - support/doc/tools.md
Generate translations
[github/Chocobozzz/PeerTube.git] / support / doc / tools.md
CommitLineData
c141f68b
RK
1# CLI tools guide
2
12b119c0
RK
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 -->
1f8ac024 5**Table of Contents**
c141f68b 6
c141f68b
RK
7- [Remote Tools](#remote-tools)
8 - [Dependencies](#dependencies)
9 - [Installation](#installation)
d639c3bf
C
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)
8dd2d050 14 - [peertube-plugins.js](#peertube-pluginsjs)
e669ff58 15 - [peertube-redundancy.js](#peertube-redundancyjs)
c141f68b
RK
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)
31b48aad 23 - [reset-password.js](#reset-passwordjs)
13126d99 24 - [plugin install/uninstall](#plugin-installuninstall)
c141f68b
RK
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)
12b119c0
RK
30
31<!-- END doctoc generated TOC please keep comment here to allow auto update -->
32
d639c3bf
C
33## Remote Tools
34
35You need at least 512MB RAM to run the script.
36Scripts can be launched directly from a PeerTube server, or from a separate server, even a desktop PC.
37You 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
7e9d3f25 41Install the [PeerTube dependencies](dependencies.md) except PostgreSQL and Redis.
51c35447 42PeerTube only supports NodeJS 10.x.
d639c3bf
C
43
44### Installation
45
46Clone 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"
d639c3bf 51$ cd ${CLONE}
d639c3bf
C
52```
53
7e9d3f25
C
54Install dependencies and build CLI tools:
55
d639c3bf 56```
7e9d3f25
C
57$ NOCLIENT=1 yarn install --pure-lockfile
58$ npm run setup:cli
d639c3bf
C
59```
60
61### CLI wrapper
8704acf4 62
bb8f7872
C
63The wrapper provides a convenient interface to the following scripts.
64You 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):
8704acf4
RK
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 ✩°。⋆
c141f68b 80 repl initiate a REPL to access internals
e669ff58
C
81 plugins|p [action] manage instance plugins
82 redundancy|r [action] manage video redundancies
8704acf4
RK
83 help [cmd] display help for [cmd]
84```
85
86The wrapper can keep track of instances you have an account on. We limit to one account per instance for now.
87
88```bash
5b036b8e 89$ peertube auth add -u 'PEERTUBE_URL' -U 'PEERTUBE_USER' --password 'PEERTUBE_PASSWORD'
8704acf4
RK
90$ peertube auth list
91┌──────────────────────────────┬──────────────────────────────┐
92│ instance │ login │
93├──────────────────────────────┼──────────────────────────────┤
5b036b8e 94│ 'PEERTUBE_URL' │ 'PEERTUBE_USER' │
8704acf4
RK
95└──────────────────────────────┴──────────────────────────────┘
96```
97
98You can now use that account to upload videos without feeding the same parameters again.
99
100```bash
101$ peertube up <videoFile>
102```
103
104And 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
9b474844
C
110To 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
d639c3bf 119#### peertube-import-videos.js
358770db 120
1f8ac024 121You can use this script to import videos from all [supported sites of youtube-dl](https://rg3.github.io/youtube-dl/supportedsites.html) into PeerTube.
358770db 122Be sure you own the videos or have the author's authorization to do so.
2519d9fe 123
a5f0521f 124```sh
8704acf4 125$ node dist/server/tools/peertube-import-videos.js \
5b036b8e
C
126 -u 'PEERTUBE_URL' \
127 -U 'PEERTUBE_USER' \
9024bece 128 --password 'PEERTUBE_PASSWORD' \
8a08bc1e 129 --target-url 'TARGET_URL'
2519d9fe
L
130```
131
a5f0521f
RK
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
e8a739e8 134* `PEERTUBE_PASSWORD` : password of your PeerTube account (if `--password PEERTUBE_PASSWORD` is omitted, you will be prompted for it)
a5f0521f
RK
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
2519d9fe 142
2186386c
C
143The script will get all public videos from Youtube, download them and upload to PeerTube.
144Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection...
145
146Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
147
1f8ac024
F
148**NB**: If you want to synchronize a Youtube channel to your PeerTube instance (ensure you have the agreement from the author),
149you can add a [crontab rule](https://help.ubuntu.com/community/CronHowto) (or an equivalent of your OS) and insert
150these rules (ensure to customize them to your needs):
151
152```
153# Update youtube-dl every day at midnight
1540 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
1570 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
160Also you may want to subscribe to the PeerTube channel in order to manually check the synchronization is successful.
358770db 161
d639c3bf 162#### peertube-upload.js
358770db
C
163
164You can use this script to import videos directly from the CLI.
165
2186386c
C
166Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
167
358770db 168```
05e67d62 169$ cd ${CLONE}
8704acf4 170$ node dist/server/tools/peertube-upload.js --help
358770db 171```
a5f0521f 172
d639c3bf 173#### peertube-watch.js
8704acf4
RK
174
175You can use this script to play videos directly from the CLI.
176
177It 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
54a3a12e 188
8dd2d050
C
189#### peertube-plugins.js
190
191Install/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
e669ff58
C
205#### peertube-redundancy.js
206
207Manage (list/add/remove) video redundancies:
208
209To list your videos that are duplicated by remote instances:
210
211```
212$ node dist/server/tools/peertube.js redundancy list-remote-redundancies
213```
214
215To list remote videos that your instance duplicated:
216
217```
218$ node dist/server/tools/peertube.js redundancy list-my-redundancies
219```
220
221To duplicate a specific video in your redundancy system:
222
223```
224$ node dist/server/tools/peertube.js redundancy add --video 823
225```
226
227To remove a video redundancy:
228
229```
230$ node dist/server/tools/peertube.js redundancy remove --video 823
231```
232
54a3a12e
C
233## Server tools
234
235These scripts should be run on the server, in `peertube-latest` directory.
a5f0521f 236
0ee02734
C
237### parse-log
238
239To 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
a5f0521f
RK
247### create-transcoding-job.js
248
12b119c0 249You can use this script to force transcoding of an existing video. PeerTube needs to be running.
a5f0521f
RK
250
251```
54a3a12e 252$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID]
a5f0521f 253```
05623b90
F
254
255Or 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```
1f8ac024 259
8b7bd166
C
260To generate an HLS playlist for a video:
261
262```
263$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- --generate-hls -v [videoUUID]
264```
265
a5f0521f
RK
266### create-import-video-file-job.js
267
12b119c0 268You 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.
a5f0521f
RK
269
270```
54a3a12e
C
271$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile]
272```
273
274### prune-storage.js
275
276Some transcoded videos or shutdown at a bad time can leave some unused files on your storage.
7089e7b4 277Stop PeerTube and delete these files (a confirmation will be demanded first):
54a3a12e 278
a5f0521f 279```
7089e7b4 280$ sudo systemctl stop peertube && sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage
23687332
C
281```
282
edb4ffc7
FA
283### optimize-old-videos.js
284
12b119c0
RK
285Before version v1.0.0-beta.16, Peertube did not specify a bitrate for the
286transcoding of uploaded videos. This means that videos might be encoded into
287very large files that are too large for streaming. This script re-transcodes
288these videos so that they can be watched properly, even on slow connections.
edb4ffc7
FA
289
290```
291$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run optimize-old-videos
292```
293
294
23687332
C
295### update-host.js
296
12b119c0
RK
297If you started PeerTube with a domain, and then changed it you will have
298invalid torrent files and invalid URLs in your database. To fix this, you have
299to run:
23687332
C
300
301```
302$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host
ecf06378 303```
1e59ca3b 304
31b48aad
C
305### reset-password.js
306
307To reset a user password from CLI, run:
308
309```
310$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u target_username
311```
312
9b474844
C
313
314### plugin install/uninstall
315
316The difference with `peertube plugins` CLI is that these scripts can be used even if PeerTube is not running.
317If 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).
318
8dd2d050 319To install/update a plugin or a theme from the disk:
9b474844
C
320
321```
e9bdf8b4 322$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:install -- --plugin-path /local/plugin/path
9b474844
C
323```
324
325From NPM:
326
327```
e9bdf8b4 328$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:install -- --npm-name peertube-plugin-myplugin
9b474844
C
329```
330
331To uninstall a plugin or a theme:
332
333```
e9bdf8b4 334$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:uninstall -- --npm-name peertube-plugin-myplugin
9b474844
C
335```
336
51c35447 337### REPL ([Read Eval Print Loop](https://nodejs.org/docs/latest-v10.x/api/repl.html))
1e59ca3b 338
12b119c0 339If you want to interact with the application libraries and objects even when PeerTube is not running, there is a REPL for that.
1e59ca3b 340
402b634b 341usage: `node ./dist/server/tools/peertube-repl.js`
1e59ca3b
BY
342
343"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."
344
345- type `.help` to list commands available in the repl, notice it starts with a dot
346- 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
347- 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
348- type `env` to see the loaded environment variables
349- type `path` to access path library
350- type `lodash` to access lodash library
351- type `uuidv1` to access uuid/v1 library
352- type `uuidv3` to access uuid/v3 library
353- type `uuidv4` to access uuid/v4 library
354- type `uuidv5` to access uuid/v5 library
355- type `YoutubeDL` to access youtube-dl library
356- type `cli` to access the cli helpers object
357- type `logger` to access the logger; if you log to it, it will write to stdout and to the peertube.log file
358- type `constants` to access the constants loaded by the server
359- type `coreUtils` to access the core-utils helpers object
360- type `ffmpegUtils` to access the ffmpeg-utils helpers object
361- type `peertubeCryptoUtils` to access the peertube-crypto helpers object
362- type `signupUtils` to access the signup helpers object
363- type `utils` to access the utils helpers object
364- type `YoutubeDLUtils` to access the youtube-dl helpers object
365- type `sequelizeTypescript` to access sequelizeTypescript
366- type `modelsUtils` to access the models/utils
367- type `models` to access the shortcut to sequelizeTypescript.models
368- type `transaction` to access the shortcut to sequelizeTypescript.transaction
369- type `query` to access the shortcut to sequelizeTypescript.query
370- type `queryInterface` to access the shortcut to sequelizeTypescript.queryInterface
371
372#### .help
373
374```
375PeerTube [1.0.0] (b10eb595)> .help
376.break Sometimes you get stuck, this gets you out
377.clear Break, and also clear the local context
378.editor Enter editor mode
379.exit Exit the repl
380.help Print this help message
381.load Load JS from a file into the REPL session
382.r Reset REPL
383.reset Reset REPL
384.save Save all evaluated commands in this REPL session to a file
385PeerTube [1.0.0] (b10eb595)>
386```
387
388#### Lodash example
389
390```
391PeerTube [1.0.0] (b10eb595)> lodash.keys(context)
392[ 'global',
393 'console',
394 'DTRACE_NET_SERVER_CONNECTION',
395 'DTRACE_NET_STREAM_END',
396 'DTRACE_HTTP_SERVER_REQUEST',
397 'DTRACE_HTTP_SERVER_RESPONSE',
398 'DTRACE_HTTP_CLIENT_REQUEST',
399 'DTRACE_HTTP_CLIENT_RESPONSE',
400 'process',
401 'Buffer',
402 'clearImmediate',
403 'clearInterval',
404 'clearTimeout',
405 'setImmediate',
406 'setInterval',
407 'setTimeout',
408 'XMLHttpRequest',
409 'compact2string',
410 'module',
411 'require',
412 'path',
413 'repl',
414 'context',
415 'env',
416 'lodash',
417 'uuidv1',
418 'uuidv3',
419 'uuidv4',
420 'uuidv5',
421 'cli',
422 'logger',
423 'constants',
424 'Sequelize',
425 'sequelizeTypescript',
426 'modelsUtils',
427 'models',
428 'transaction',
429 'query',
430 'queryInterface',
431 'YoutubeDL',
432 'coreUtils',
433 'ffmpegUtils',
434 'peertubeCryptoUtils',
435 'signupUtils',
436 'utils',
437 'YoutubeDLUtils' ]
438PeerTube [1.0.0] (b10eb595)>
439```
440
441#### YoutubeDL example
442```
443YoutubeDL.getInfo('https://www.youtube.com/watch?v=I5ZN289jjDo', function(err, data) {console.log(err, data)})
444```
445
446#### Models examples
447```
448PeerTube [1.0.0] (b10eb595)> new models.ActorModel({id: 3}).getVideoChannel().then(function(data){console.log(data.dataValues.name)})
449Promise {
450 _bitField: 0,
451 _fulfillmentHandler0: undefined,
452 _rejectionHandler0: undefined,
453 _promise0: undefined,
454 _receiver0: undefined }
455PeerTube [1.0.0] (b10eb595)> Main root channel
456PeerTube [1.0.0] (b10eb595)> let out; new models.UserModel({id: 1}).getAccount().then(function (data) {out = data.dataValues.id})
457Promise {
458 _bitField: 0,
459 _fulfillmentHandler0: undefined,
460 _rejectionHandler0: undefined,
461 _promise0: undefined,
462 _receiver0: undefined }
463PeerTube [1.0.0] (b10eb595)> out
4642
465PeerTube [1.0.0] (b10eb595)>
466```