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