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