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 -->
7 - [Remote Tools](#remote-tools)
8 - [Dependencies](#dependencies)
9 - [Installation](#installation)
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)
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 - [reset-password.js](#reset-passwordjs)
22 - [REPL (Read Eval Print Loop)](#repl-read-eval-print-loop)
24 - [Lodash example](#lodash-example)
25 - [YoutubeDL example](#youtubedl-example)
26 - [Models examples](#models-examples)
28 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
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).
38 Install the [PeerTube dependencies](dependencies.md) except PostgreSQL and Redis.
39 PeerTube only supports NodeJS 8.x or 10.x.
43 Clone the PeerTube repo to get the latest version (even if you are on your PeerTube server):
46 $ git clone https://github.com/Chocobozzz/PeerTube.git
47 $ CLONE="$(pwd)/PeerTube"
51 Install dependencies and build CLI tools:
54 $ NOCLIENT=1 yarn install --pure-lockfile
60 The wrapper provides a convenient interface to the following scripts.
61 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):
64 Usage: peertube [command] [options]
68 -v, --version output the version number
69 -h, --help output usage information
73 auth [action] register your accounts on remote instances to use them with other commands
74 upload|up upload a video
75 import-videos|import import a video from a streaming platform
76 watch|w watch a video in the terminal ✩°。⋆
77 repl initiate a REPL to access internals
78 help [cmd] display help for [cmd]
81 The wrapper can keep track of instances you have an account on. We limit to one account per instance for now.
84 $ peertube auth add -u 'PEERTUBE_URL' -U 'PEERTUBE_USER' --password 'PEERTUBE_PASSWORD'
86 ┌──────────────────────────────┬──────────────────────────────┐
88 ├──────────────────────────────┼──────────────────────────────┤
89 │ 'PEERTUBE_URL' │ 'PEERTUBE_USER' │
90 └──────────────────────────────┴──────────────────────────────┘
93 You can now use that account to upload videos without feeding the same parameters again.
96 $ peertube up <videoFile>
99 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 $ peertube watch https://peertube.cpy.re/videos/watch/e8a1af4e-414a-4d58-bfe6-2146eed06d10
105 #### peertube-import-videos.js
107 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.
108 Be sure you own the videos or have the author's authorization to do so.
111 $ node dist/server/tools/peertube-import-videos.js \
114 --password 'PEERTUBE_PASSWORD' \
118 * `PEERTUBE_URL` : the full URL of your PeerTube server where you want to import, eg: https://peertube.cpy.re
119 * `PEERTUBE_USER` : your PeerTube account where videos will be uploaded
120 * `PEERTUBE_PASSWORD` : password of your PeerTube account (if `--password PEERTUBE_PASSWORD` is omitted, you will be prompted for it)
121 * `TARGET_URL` : the target url you want to import. Examples:
123 * Channel: https://www.youtube.com/channel/ChannelId
124 * User https://www.youtube.com/c/UserName or https://www.youtube.com/user/UserName
125 * Video https://www.youtube.com/watch?v=blabla
126 * Vimeo: https://vimeo.com/xxxxxx
127 * Dailymotion: https://www.dailymotion.com/xxxxx
129 The script will get all public videos from Youtube, download them and upload to PeerTube.
130 Already downloaded videos will not be uploaded twice, so you can run and re-run the script in case of crash, disconnection...
132 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
135 #### peertube-upload.js
137 You can use this script to import videos directly from the CLI.
139 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
143 $ node dist/server/tools/peertube-upload.js --help
146 #### peertube-watch.js
148 You can use this script to play videos directly from the CLI.
150 It provides support for different players:
152 - ascii (default ; plays in ascii art in your terminal!)
164 These scripts should be run on the server, in `peertube-latest` directory.
168 To parse PeerTube last log file:
171 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level info
174 `--level` is optional and could be `info`/`warn`/`error`
176 ### create-transcoding-job.js
178 You can use this script to force transcoding of an existing video. PeerTube needs to be running.
181 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID]
184 Or to transcode to a specific resolution:
186 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] -r [resolution]
189 ### create-import-video-file-job.js
191 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.
194 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile]
199 Some transcoded videos or shutdown at a bad time can leave some unused files on your storage.
200 Stop PeerTube and delete these files (a confirmation will be demanded first):
203 $ sudo systemctl stop peertube && sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage
206 ### optimize-old-videos.js
208 Before version v1.0.0-beta.16, Peertube did not specify a bitrate for the
209 transcoding of uploaded videos. This means that videos might be encoded into
210 very large files that are too large for streaming. This script re-transcodes
211 these videos so that they can be watched properly, even on slow connections.
214 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run optimize-old-videos
220 If you started PeerTube with a domain, and then changed it you will have
221 invalid torrent files and invalid URLs in your database. To fix this, you have
225 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host
228 ### reset-password.js
230 To reset a user password from CLI, run:
233 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u target_username
236 ### REPL ([Read Eval Print Loop](https://nodejs.org/docs/latest-v8.x/api/repl.html))
238 If you want to interact with the application libraries and objects even when PeerTube is not running, there is a REPL for that.
240 usage: `node ./dist/server/tools/peertube-repl.js`
242 "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."
244 - type `.help` to list commands available in the repl, notice it starts with a dot
245 - 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
246 - 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
247 - type `env` to see the loaded environment variables
248 - type `path` to access path library
249 - type `lodash` to access lodash library
250 - type `uuidv1` to access uuid/v1 library
251 - type `uuidv3` to access uuid/v3 library
252 - type `uuidv4` to access uuid/v4 library
253 - type `uuidv5` to access uuid/v5 library
254 - type `YoutubeDL` to access youtube-dl library
255 - type `cli` to access the cli helpers object
256 - type `logger` to access the logger; if you log to it, it will write to stdout and to the peertube.log file
257 - type `constants` to access the constants loaded by the server
258 - type `coreUtils` to access the core-utils helpers object
259 - type `ffmpegUtils` to access the ffmpeg-utils helpers object
260 - type `peertubeCryptoUtils` to access the peertube-crypto helpers object
261 - type `signupUtils` to access the signup helpers object
262 - type `utils` to access the utils helpers object
263 - type `YoutubeDLUtils` to access the youtube-dl helpers object
264 - type `sequelizeTypescript` to access sequelizeTypescript
265 - type `modelsUtils` to access the models/utils
266 - type `models` to access the shortcut to sequelizeTypescript.models
267 - type `transaction` to access the shortcut to sequelizeTypescript.transaction
268 - type `query` to access the shortcut to sequelizeTypescript.query
269 - type `queryInterface` to access the shortcut to sequelizeTypescript.queryInterface
274 PeerTube [1.0.0] (b10eb595)> .help
275 .break Sometimes you get stuck, this gets you out
276 .clear Break, and also clear the local context
277 .editor Enter editor mode
279 .help Print this help message
280 .load Load JS from a file into the REPL session
283 .save Save all evaluated commands in this REPL session to a file
284 PeerTube [1.0.0] (b10eb595)>
290 PeerTube [1.0.0] (b10eb595)> lodash.keys(context)
293 'DTRACE_NET_SERVER_CONNECTION',
294 'DTRACE_NET_STREAM_END',
295 'DTRACE_HTTP_SERVER_REQUEST',
296 'DTRACE_HTTP_SERVER_RESPONSE',
297 'DTRACE_HTTP_CLIENT_REQUEST',
298 'DTRACE_HTTP_CLIENT_RESPONSE',
324 'sequelizeTypescript',
333 'peertubeCryptoUtils',
337 PeerTube [1.0.0] (b10eb595)>
340 #### YoutubeDL example
342 YoutubeDL.getInfo('https://www.youtube.com/watch?v=I5ZN289jjDo', function(err, data) {console.log(err, data)})
347 PeerTube [1.0.0] (b10eb595)> new models.ActorModel({id: 3}).getVideoChannel().then(function(data){console.log(data.dataValues.name)})
350 _fulfillmentHandler0: undefined,
351 _rejectionHandler0: undefined,
352 _promise0: undefined,
353 _receiver0: undefined }
354 PeerTube [1.0.0] (b10eb595)> Main root channel
355 PeerTube [1.0.0] (b10eb595)> let out; new models.UserModel({id: 1}).getAccount().then(function (data) {out = data.dataValues.id})
358 _fulfillmentHandler0: undefined,
359 _rejectionHandler0: undefined,
360 _promise0: undefined,
361 _receiver0: undefined }
362 PeerTube [1.0.0] (b10eb595)> out
364 PeerTube [1.0.0] (b10eb595)>