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