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 - [prune-storage.js](#prune-storagejs)
21 - [update-host.js](#update-hostjs)
22 - [reset-password.js](#reset-passwordjs)
23 - [plugin install/uninstall](#plugin-installuninstall)
25 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
29 You need at least 512MB RAM to run the script.
30 Scripts can be launched directly from a PeerTube server, or from a separate server, even a desktop PC.
31 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 Install the [PeerTube dependencies](dependencies.md) except PostgreSQL and Redis.
39 Clone the PeerTube repo to get the latest version (even if you are on your PeerTube server):
42 $ git clone https://github.com/Chocobozzz/PeerTube.git
43 $ CLONE="$(pwd)/PeerTube"
47 Install dependencies and build CLI tools:
50 $ NOCLIENT=1 yarn install --pure-lockfile
56 The wrapper provides a convenient interface to the following scripts.
57 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):
60 Usage: peertube [command] [options]
64 -v, --version output the version number
65 -h, --help output usage information
69 auth [action] register your accounts on remote instances to use them with other commands
70 upload|up upload a video
71 import-videos|import import a video from a streaming platform
72 plugins|p [action] manage instance plugins
73 redundancy|r [action] manage video redundancies
74 help [cmd] display help for [cmd]
77 The wrapper can keep track of instances you have an account on. We limit to one account per instance for now.
80 $ peertube auth add -u 'PEERTUBE_URL' -U 'PEERTUBE_USER' --password 'PEERTUBE_PASSWORD'
82 ┌──────────────────────────────┬──────────────────────────────┐
84 ├──────────────────────────────┼──────────────────────────────┤
85 │ 'PEERTUBE_URL' │ 'PEERTUBE_USER' │
86 └──────────────────────────────┴──────────────────────────────┘
89 You can now use that account to upload videos without feeding the same parameters again.
92 $ peertube up <videoFile>
95 To list, install, uninstall dynamically plugins/themes of an instance:
98 $ peertube plugins list
99 $ peertube plugins install --path /local/plugin/path
100 $ peertube plugins install --npm-name peertube-plugin-myplugin
101 $ peertube plugins uninstall --npm-name peertube-plugin-myplugin
104 #### peertube-import-videos.js
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.
110 $ node dist/server/tools/peertube-import-videos.js \
113 --password 'PEERTUBE_PASSWORD' \
114 --target-url 'TARGET_URL'
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
119 * `PEERTUBE_PASSWORD` : password of your PeerTube account (if `--password PEERTUBE_PASSWORD` is omitted, you will be prompted for it)
120 * `TARGET_URL` : the target url you want to import. Examples:
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
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...
131 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
133 **NB**: If you want to synchronize a Youtube channel to your PeerTube instance (ensure you have the agreement from the author),
134 you can add a [crontab rule](https://help.ubuntu.com/community/CronHowto) (or an equivalent of your OS) and insert
135 these rules (ensure to customize them to your needs):
138 # Update youtube-dl every day at midnight
139 0 0 * * * /usr/bin/npm rebuild youtube-dl --prefix /PATH/TO/PEERTUBE/
141 # Synchronize the YT channel every sunday at 22:00 all the videos published since last monday included
142 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)
145 Also you may want to subscribe to the PeerTube channel in order to manually check the synchronization is successful.
147 #### peertube-upload.js
149 You can use this script to import videos directly from the CLI.
151 Videos will be publicly available after transcoding (you can see them before that in your account on the web interface).
155 $ node dist/server/tools/peertube-upload.js --help
158 #### peertube-plugins.js
160 Install/update/uninstall or list local or NPM PeerTube plugins:
164 $ node dist/server/tools/peertube-plugins.js --help
165 $ node dist/server/tools/peertube-plugins.js list --help
166 $ node dist/server/tools/peertube-plugins.js install --help
167 $ node dist/server/tools/peertube-plugins.js update --help
168 $ node dist/server/tools/peertube-plugins.js uninstall --help
170 $ node dist/server/tools/peertube-plugins.js install --path /my/plugin/path
171 $ node dist/server/tools/peertube-plugins.js install --npm-name peertube-theme-example
174 #### peertube-redundancy.js
176 Manage (list/add/remove) video redundancies:
178 To list your videos that are duplicated by remote instances:
181 $ node dist/server/tools/peertube.js redundancy list-remote-redundancies
184 To list remote videos that your instance duplicated:
187 $ node dist/server/tools/peertube.js redundancy list-my-redundancies
190 To duplicate a specific video in your redundancy system:
193 $ node dist/server/tools/peertube.js redundancy add --video 823
196 To remove a video redundancy:
199 $ node dist/server/tools/peertube.js redundancy remove --video 823
204 These scripts should be run on the server, in `peertube-latest` directory.
208 To parse PeerTube last log file:
211 $ # Basic installation
212 $ cd /var/www/peertube/peertube-latest
213 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level info
215 $ # Docker installation
216 $ cd /var/www/peertube-docker
217 $ docker-compose exec -u peertube peertube npm run parse-log -- --level info
220 `--level` is optional and could be `info`/`warn`/`error`
222 You can also remove SQL or HTTP logs using `--not-tags` (PeerTube >= 3.2):
225 $ # Basic installation
226 $ cd /var/www/peertube/peertube-latest
227 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run parse-log -- --level debug --not-tags http sql
229 $ # Docker installation
230 $ cd /var/www/peertube-docker
231 $ docker-compose exec -u peertube peertube npm run parse-log -- --level debug --not-tags http sql
234 ### regenerate-thumbnails.js
238 Regenerating local video thumbnails could be useful because new PeerTube releases may increase thumbnail sizes:
241 $ # Basic installation
242 $ cd /var/www/peertube/peertube-latest
243 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run regenerate-thumbnails
245 $ # Docker installation
246 $ cd /var/www/peertube-docker
247 $ docker-compose exec -u peertube peertube npm run regenerate-thumbnails
250 ### create-transcoding-job.js
252 You can use this script to force transcoding of an existing video. PeerTube needs to be running.
254 To generate transcoding jobs depending on the instance configuration:
257 $ # Basic installation
258 $ cd /var/www/peertube/peertube-latest
259 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID]
261 $ # Docker installation
262 $ cd /var/www/peertube-docker
263 $ docker-compose exec -u peertube peertube npm run create-transcoding-job -- -v [videoUUID]
266 Or to transcode to a specific resolution:
269 $ # Basic installation
270 $ cd /var/www/peertube/peertube-latest
271 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] -r [resolution]
273 $ # Docker installation
274 $ cd /var/www/peertube-docker
275 $ docker-compose exec -u peertube peertube npm run create-transcoding-job -- -v [videoUUID] -r [resolution]
278 The resolution should be an integer (`1080`, `720`, `480`, etc.)
280 To generate an HLS playlist for a video:
283 $ # Basic installation
284 $ cd /var/www/peertube/peertube-latest
285 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- --generate-hls -v [videoUUID]
287 $ # Docker installation
288 $ cd /var/www/peertube-docker
289 $ docker-compose exec -u peertube peertube npm run create-transcoding-job -- --generate-hls -v [videoUUID]
292 ### create-import-video-file-job.js
294 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.
297 $ # Basic installation
298 $ cd /var/www/peertube/peertube-latest
299 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile]
301 $ # Docker installation
302 $ cd /var/www/peertube-docker
303 $ docker-compose exec -u peertube peertube npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile]
308 Some transcoded videos or shutdown at a bad time can leave some unused files on your storage.
309 Stop PeerTube and delete these files (a confirmation will be demanded first):
312 $ cd /var/www/peertube/peertube-latest
313 $ sudo systemctl stop peertube && sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage
319 **Changing the hostname is unsupported and may be a risky operation, especially if you have already federated.**
320 If you started PeerTube with a domain, and then changed it you will have
321 invalid torrent files and invalid URLs in your database. To fix this, you have
322 to run the command below (keep in mind your follower instances will NOT update their URLs).
325 $ # Basic installation
326 $ cd /var/www/peertube/peertube-latest
327 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host
329 $ # Docker installation
330 $ cd /var/www/peertube-docker
331 $ docker-compose exec -u peertube peertube npm run update-host
334 ### reset-password.js
336 To reset a user password from CLI, run:
339 $ # Basic installation
340 $ cd /var/www/peertube/peertube-latest
341 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run reset-password -- -u target_username
343 $ # Docker installation
344 $ cd /var/www/peertube-docker
345 $ docker-compose exec -u peertube peertube npm run reset-password -- -u target_username
349 ### plugin install/uninstall
351 The difference with `peertube plugins` CLI is that these scripts can be used even if PeerTube is not running.
352 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).
354 To install/update a plugin or a theme from the disk:
357 $ cd /var/www/peertube/peertube-latest
358 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:install -- --plugin-path /local/plugin/path
360 $ # Docker installation
361 $ cd /var/www/peertube-docker
362 $ docker-compose exec -u peertube peertube npm run plugin:install -- --plugin-path /local/plugin/path
368 $ cd /var/www/peertube/peertube-latest
369 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:install -- --npm-name peertube-plugin-myplugin
371 $ # Docker installation
372 $ cd /var/www/peertube-docker
373 $ docker-compose exec -u peertube peertube npm run plugin:install -- --npm-name peertube-plugin-myplugin
376 To uninstall a plugin or a theme:
379 $ cd /var/www/peertube/peertube-latest
380 $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run plugin:uninstall -- --npm-name peertube-plugin-myplugin
382 $ # Docker installation
383 $ cd /var/www/peertube-docker
384 $ docker-compose exec -u peertube peertube npm run plugin:uninstall -- --npm-name peertube-plugin-myplugin