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-plugins.js](#peertube-pluginsjs)
14 - [peertube-redundancy.js](#peertube-redundancyjs)
15 - [Server tools](#server-tools)
16 - [parse-log](#parse-log)
17 - [regenerate-thumbnails.js](#regenerate-thumbnailsjs)
18 - [create-transcoding-job.js](#create-transcoding-jobjs)
19 - [create-import-video-file-job.js](#create-import-video-file-jobjs)
20 - [create-move-video-storage-job.js](#create-move-video-storage-jobjs)
21 - [prune-storage.js](#prune-storagejs)
22 - [update-host.js](#update-hostjs)
23 - [reset-password.js](#reset-passwordjs)
24 - [plugin install/uninstall](#plugin-installuninstall)
26 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
30 You need at least 512MB RAM to run the script.
31 Scripts can be launched directly from a PeerTube server, or from a separate server, even a desktop PC.
32 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 Install the [PeerTube dependencies](dependencies.md) except PostgreSQL and Redis.
40 Clone the PeerTube repo to get the latest version (even if you are on your PeerTube server):
43 $ git clone https://github.com/Chocobozzz/PeerTube.git
44 $ CLONE="$(pwd)/PeerTube"
48 Install dependencies and build CLI tools:
51 $ NOCLIENT=1 yarn install --pure-lockfile
57 The wrapper provides a convenient interface to the following scripts.
58 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):
61 Usage: peertube [command] [options]
65 -v, --version output the version number
66 -h, --help output usage information
70 auth [action] register your accounts on remote instances to use them with other commands
71 upload|up upload a video
72 import-videos|import import a video from a streaming platform
73 plugins|p [action] manage instance plugins
74 redundancy|r [action] manage video redundancies
75 help [cmd] display help for [cmd]
78 The wrapper can keep track of instances you have an account on. We limit to one account per instance for now.
81 $ peertube auth add -u 'PEERTUBE_URL' -U 'PEERTUBE_USER' --password 'PEERTUBE_PASSWORD'
83 ┌──────────────────────────────┬──────────────────────────────┐
85 ├──────────────────────────────┼──────────────────────────────┤
86 │ 'PEERTUBE_URL' │ 'PEERTUBE_USER' │
87 └──────────────────────────────┴──────────────────────────────┘
90 You can now use that account to upload videos without feeding the same parameters again.
93 $ peertube up <videoFile>
96 To list, install, uninstall dynamically plugins/themes of an instance:
99 $ peertube plugins list
100 $ peertube plugins install --path /local/plugin/path
101 $ peertube plugins install --npm-name peertube-plugin-myplugin
102 $ peertube plugins uninstall --npm-name peertube-plugin-myplugin
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' \
115 --target-url 'TARGET_URL'
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).
134 **NB**: If you want to synchronize a Youtube channel to your PeerTube instance (ensure you have the agreement from the author),
135 you can add a [crontab rule](https://help.ubuntu.com/community/CronHowto) (or an equivalent of your OS) and insert
136 these rules (ensure to customize them to your needs):
139 # Update youtube-dl every day at midnight
140 0 0 * * * /usr/bin/npm rebuild youtube-dl --prefix /PATH/TO/PEERTUBE/
142 # Synchronize the YT channel every sunday at 22:00 all the videos published since last monday included
143 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)
146 Also you may want to subscribe to the PeerTube channel in order to manually check the synchronization is successful.
148 #### peertube-upload.js
150 You can use this script to import videos directly from the CLI.
152 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
156 $ node dist/server/tools/peertube-upload.js --help
159 #### peertube-plugins.js
161 Install/update/uninstall or list local or NPM PeerTube plugins:
165 $ node dist/server/tools/peertube-plugins.js --help
166 $ node dist/server/tools/peertube-plugins.js list --help
167 $ node dist/server/tools/peertube-plugins.js install --help
168 $ node dist/server/tools/peertube-plugins.js update --help
169 $ node dist/server/tools/peertube-plugins.js uninstall --help
171 $ node dist/server/tools/peertube-plugins.js install --path /my/plugin/path
172 $ node dist/server/tools/peertube-plugins.js install --npm-name peertube-theme-example
175 #### peertube-redundancy.js
177 Manage (list/add/remove) video redundancies:
179 To list your videos that are duplicated by remote instances:
182 $ node dist/server/tools/peertube.js redundancy list-remote-redundancies
185 To list remote videos that your instance duplicated:
188 $ node dist/server/tools/peertube.js redundancy list-my-redundancies
191 To duplicate a specific video in your redundancy system:
194 $ node dist/server/tools/peertube.js redundancy add --video 823
197 To remove a video redundancy:
200 $ node dist/server/tools/peertube.js redundancy remove --video 823
205 These scripts should be run on the server, in `peertube-latest` directory.
209 To parse PeerTube last log file:
212 $ # Basic installation
213 $ cd /var/www/peertube/peertube-latest
214 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level info
216 $ # Docker installation
217 $ cd /var/www/peertube-docker
218 $ docker-compose exec -u peertube peertube npm run parse-log -- --level info
221 `--level` is optional and could be `info`/`warn`/`error`
223 You can also remove SQL or HTTP logs using `--not-tags` (PeerTube >= 3.2):
226 $ # Basic installation
227 $ cd /var/www/peertube/peertube-latest
228 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level debug --not-tags http sql
230 $ # Docker installation
231 $ cd /var/www/peertube-docker
232 $ docker-compose exec -u peertube peertube npm run parse-log -- --level debug --not-tags http sql
235 ### regenerate-thumbnails.js
239 Regenerating local video thumbnails could be useful because new PeerTube releases may increase thumbnail sizes:
242 $ # Basic installation
243 $ cd /var/www/peertube/peertube-latest
244 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run regenerate-thumbnails
246 $ # Docker installation
247 $ cd /var/www/peertube-docker
248 $ docker-compose exec -u peertube peertube npm run regenerate-thumbnails
251 ### create-transcoding-job.js
253 You can use this script to force transcoding of an existing video. PeerTube needs to be running.
255 To generate transcoding jobs depending on the instance configuration:
258 $ # Basic installation
259 $ cd /var/www/peertube/peertube-latest
260 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID]
262 $ # Docker installation
263 $ cd /var/www/peertube-docker
264 $ docker-compose exec -u peertube peertube npm run create-transcoding-job -- -v [videoUUID]
267 Or to transcode to a specific resolution:
270 $ # Basic installation
271 $ cd /var/www/peertube/peertube-latest
272 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] -r [resolution]
274 $ # Docker installation
275 $ cd /var/www/peertube-docker
276 $ docker-compose exec -u peertube peertube npm run create-transcoding-job -- -v [videoUUID] -r [resolution]
279 The resolution should be an integer (`1080`, `720`, `480`, etc.)
281 To generate an HLS playlist for a video:
284 $ # Basic installation
285 $ cd /var/www/peertube/peertube-latest
286 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- --generate-hls -v [videoUUID]
288 $ # Docker installation
289 $ cd /var/www/peertube-docker
290 $ docker-compose exec -u peertube peertube npm run create-transcoding-job -- --generate-hls -v [videoUUID]
293 ### create-import-video-file-job.js
295 You can use this script to import a video file to replace an already uploaded file or to add a new webtorrent resolution to a video. PeerTube needs to be running.
296 You can then create a transcoding job using `npm run create-transcoding-job` if you need to optimize your file or create an HLS version of it.
299 $ # Basic installation
300 $ cd /var/www/peertube/peertube-latest
301 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile]
303 $ # Docker installation
304 $ cd /var/www/peertube-docker
305 $ docker-compose exec -u peertube peertube npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile]
308 ### create-move-video-storage-job.js
312 Use this script to move all video files or a specific video file to object storage.
315 $ # Basic installation
316 $ cd /var/www/peertube/peertube-latest
317 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-move-video-storage-job -- --to-object-storage -v [videoUUID]
319 $ # Docker installation
320 $ cd /var/www/peertube-docker
321 $ docker-compose exec -u peertube peertube npm run create-move-video-storage-job -- --to-object-storage -v [videoUUID]
324 The script can also move all video files that are not already in object storage:
327 $ # Basic installation
328 $ cd /var/www/peertube/peertube-latest
329 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-move-video-storage-job -- --to-object-storage --all-videos
331 $ # Docker installation
332 $ cd /var/www/peertube-docker
333 $ docker-compose exec -u peertube peertube npm run create-move-video-storage-job -- --to-object-storage --all-videos
339 Some transcoded videos or shutdown at a bad time can leave some unused files on your storage.
340 Stop PeerTube and delete these files (a confirmation will be demanded first):
343 $ cd /var/www/peertube/peertube-latest
344 $ sudo systemctl stop peertube && sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage
350 **Changing the hostname is unsupported and may be a risky operation, especially if you have already federated.**
351 If you started PeerTube with a domain, and then changed it you will have
352 invalid torrent files and invalid URLs in your database. To fix this, you have
353 to run the command below (keep in mind your follower instances will NOT update their URLs).
356 $ # Basic installation
357 $ cd /var/www/peertube/peertube-latest
358 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host
360 $ # Docker installation
361 $ cd /var/www/peertube-docker
362 $ docker-compose exec -u peertube peertube npm run update-host
365 ### reset-password.js
367 To reset a user password from CLI, run:
370 $ # Basic installation
371 $ cd /var/www/peertube/peertube-latest
372 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u target_username
374 $ # Docker installation
375 $ cd /var/www/peertube-docker
376 $ docker-compose exec -u peertube peertube npm run reset-password -- -u target_username
380 ### plugin install/uninstall
382 The difference with `peertube plugins` CLI is that these scripts can be used even if PeerTube is not running.
383 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).
385 To install/update a plugin or a theme from the disk:
388 $ cd /var/www/peertube/peertube-latest
389 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:install -- --plugin-path /local/plugin/path
391 $ # Docker installation
392 $ cd /var/www/peertube-docker
393 $ docker-compose exec -u peertube peertube npm run plugin:install -- --plugin-path /local/plugin/path
399 $ cd /var/www/peertube/peertube-latest
400 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:install -- --npm-name peertube-plugin-myplugin
402 $ # Docker installation
403 $ cd /var/www/peertube-docker
404 $ docker-compose exec -u peertube peertube npm run plugin:install -- --npm-name peertube-plugin-myplugin
407 To uninstall a plugin or a theme:
410 $ cd /var/www/peertube/peertube-latest
411 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:uninstall -- --npm-name peertube-plugin-myplugin
413 $ # Docker installation
414 $ cd /var/www/peertube-docker
415 $ docker-compose exec -u peertube peertube npm run plugin:uninstall -- --npm-name peertube-plugin-myplugin