aboutsummaryrefslogtreecommitdiffhomepage
path: root/support
diff options
context:
space:
mode:
Diffstat (limited to 'support')
-rw-r--r--support/doc/api/openapi.yaml2
-rw-r--r--support/doc/tools.md189
-rw-r--r--support/docker/dev/Dockerfile54
-rw-r--r--support/docker/dev/setup_postgres.sql6
-rw-r--r--support/docker/dev/usage.md20
-rw-r--r--support/docker/janitor/Dockerfile32
-rw-r--r--support/docker/janitor/create_user.sql (renamed from support/docker/dev/create_user.sql)0
-rw-r--r--support/docker/janitor/janitor.json (renamed from support/docker/dev/janitor.json)0
-rw-r--r--support/docker/janitor/supervisord.conf (renamed from support/docker/dev/supervisord.conf)0
-rw-r--r--support/docker/production/.env5
-rw-r--r--support/docker/production/config/custom-environment-variables.yaml24
11 files changed, 295 insertions, 37 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 59ca8b29a..f3520a7b1 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -1,7 +1,7 @@
1swagger: '2.0' 1swagger: '2.0'
2info: 2info:
3 title: PeerTube 3 title: PeerTube
4 version: 1.0.0-beta 4 version: 1.1.0-alpha.2
5 description: Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular. 5 description: Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.
6host: peertube.example.com 6host: peertube.example.com
7securityDefinitions: 7securityDefinitions:
diff --git a/support/doc/tools.md b/support/doc/tools.md
index 1db29edc0..1c7739525 100644
--- a/support/doc/tools.md
+++ b/support/doc/tools.md
@@ -1,14 +1,30 @@
1# CLI tools guide 1# CLI tools guide
2 - [CLI wrapper](#cli-wrapper) 2
3 - [Remote tools](#remote-tools) 3<!-- START doctoc generated TOC please keep comment here to allow auto update -->
4 - [peertube-import-videos.js](#peertube-import-videosjs) 4<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
5 - [peertube-upload.js](#peertube-uploadjs) 5**Table of Contents**
6 - [peertube-watch.js](#peertube-watch) 6
7 - [Server tools](#server-tools) 7- [CLI wrapper](#cli-wrapper)
8 - [parse-log](#parse-log) 8- [Remote Tools](#remote-tools)
9 - [create-transcoding-job.js](#create-transcoding-jobjs) 9 - [Dependencies](#dependencies)
10 - [create-import-video-file-job.js](#create-import-video-file-jobjs) 10 - [Installation](#installation)
11 - [prune-storage.js](#prune-storagejs) 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 - [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)
26
27<!-- END doctoc generated TOC please keep comment here to allow auto update -->
12 28
13## CLI wrapper 29## CLI wrapper
14 30
@@ -28,6 +44,7 @@ The wrapper provides a convenient interface to most scripts, and requires the [s
28 upload|up upload a video 44 upload|up upload a video
29 import-videos|import import a video from a streaming platform 45 import-videos|import import a video from a streaming platform
30 watch|w watch a video in the terminal ✩°。⋆ 46 watch|w watch a video in the terminal ✩°。⋆
47 repl initiate a REPL to access internals
31 help [cmd] display help for [cmd] 48 help [cmd] display help for [cmd]
32``` 49```
33 50
@@ -159,7 +176,7 @@ $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production
159 176
160### create-transcoding-job.js 177### create-transcoding-job.js
161 178
162You can use this script to force transcoding of an existing video. 179You can use this script to force transcoding of an existing video. PeerTube needs to be running.
163 180
164``` 181```
165$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] 182$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID]
@@ -172,7 +189,7 @@ $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production
172 189
173### create-import-video-file-job.js 190### create-import-video-file-job.js
174 191
175You can use this script to import a video file to replace an already uploaded file or to add a new resolution to a video. 192You 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.
176 193
177``` 194```
178$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile] 195$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-import-video-file-job -- -v [videoUUID] -i [videoFile]
@@ -187,11 +204,155 @@ To delete them (a confirmation will be demanded first):
187$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage 204$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage
188``` 205```
189 206
207### optimize-old-videos.js
208
209Before version v1.0.0-beta.16, Peertube did not specify a bitrate for the
210transcoding of uploaded videos. This means that videos might be encoded into
211very large files that are too large for streaming. This script re-transcodes
212these videos so that they can be watched properly, even on slow connections.
213
214```
215$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run optimize-old-videos
216```
217
218
190### update-host.js 219### update-host.js
191 220
192If you started PeerTube with a domain, and then changed it you will have invalid torrent files and invalid URLs in your database. 221If you started PeerTube with a domain, and then changed it you will have
193To fix this, you have to run: 222invalid torrent files and invalid URLs in your database. To fix this, you have
223to run:
194 224
195``` 225```
196$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host 226$ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host
197``` 227```
228
229### REPL ([Read Eval Print Loop](https://nodejs.org/docs/latest-v8.x/api/repl.html))
230
231If you want to interact with the application libraries and objects even when PeerTube is not running, there is a REPL for that.
232
233usage: `node ./dist/server/tools/peertube-repl.js`
234
235"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."
236
237- type `.help` to list commands available in the repl, notice it starts with a dot
238- 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
239- 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
240- type `env` to see the loaded environment variables
241- type `path` to access path library
242- type `lodash` to access lodash library
243- type `uuidv1` to access uuid/v1 library
244- type `uuidv3` to access uuid/v3 library
245- type `uuidv4` to access uuid/v4 library
246- type `uuidv5` to access uuid/v5 library
247- type `YoutubeDL` to access youtube-dl library
248- type `cli` to access the cli helpers object
249- type `logger` to access the logger; if you log to it, it will write to stdout and to the peertube.log file
250- type `constants` to access the constants loaded by the server
251- type `coreUtils` to access the core-utils helpers object
252- type `ffmpegUtils` to access the ffmpeg-utils helpers object
253- type `peertubeCryptoUtils` to access the peertube-crypto helpers object
254- type `signupUtils` to access the signup helpers object
255- type `utils` to access the utils helpers object
256- type `YoutubeDLUtils` to access the youtube-dl helpers object
257- type `sequelizeTypescript` to access sequelizeTypescript
258- type `modelsUtils` to access the models/utils
259- type `models` to access the shortcut to sequelizeTypescript.models
260- type `transaction` to access the shortcut to sequelizeTypescript.transaction
261- type `query` to access the shortcut to sequelizeTypescript.query
262- type `queryInterface` to access the shortcut to sequelizeTypescript.queryInterface
263
264#### .help
265
266```
267PeerTube [1.0.0] (b10eb595)> .help
268.break Sometimes you get stuck, this gets you out
269.clear Break, and also clear the local context
270.editor Enter editor mode
271.exit Exit the repl
272.help Print this help message
273.load Load JS from a file into the REPL session
274.r Reset REPL
275.reset Reset REPL
276.save Save all evaluated commands in this REPL session to a file
277PeerTube [1.0.0] (b10eb595)>
278```
279
280#### Lodash example
281
282```
283PeerTube [1.0.0] (b10eb595)> lodash.keys(context)
284[ 'global',
285 'console',
286 'DTRACE_NET_SERVER_CONNECTION',
287 'DTRACE_NET_STREAM_END',
288 'DTRACE_HTTP_SERVER_REQUEST',
289 'DTRACE_HTTP_SERVER_RESPONSE',
290 'DTRACE_HTTP_CLIENT_REQUEST',
291 'DTRACE_HTTP_CLIENT_RESPONSE',
292 'process',
293 'Buffer',
294 'clearImmediate',
295 'clearInterval',
296 'clearTimeout',
297 'setImmediate',
298 'setInterval',
299 'setTimeout',
300 'XMLHttpRequest',
301 'compact2string',
302 'module',
303 'require',
304 'path',
305 'repl',
306 'context',
307 'env',
308 'lodash',
309 'uuidv1',
310 'uuidv3',
311 'uuidv4',
312 'uuidv5',
313 'cli',
314 'logger',
315 'constants',
316 'Sequelize',
317 'sequelizeTypescript',
318 'modelsUtils',
319 'models',
320 'transaction',
321 'query',
322 'queryInterface',
323 'YoutubeDL',
324 'coreUtils',
325 'ffmpegUtils',
326 'peertubeCryptoUtils',
327 'signupUtils',
328 'utils',
329 'YoutubeDLUtils' ]
330PeerTube [1.0.0] (b10eb595)>
331```
332
333#### YoutubeDL example
334```
335YoutubeDL.getInfo('https://www.youtube.com/watch?v=I5ZN289jjDo', function(err, data) {console.log(err, data)})
336```
337
338#### Models examples
339```
340PeerTube [1.0.0] (b10eb595)> new models.ActorModel({id: 3}).getVideoChannel().then(function(data){console.log(data.dataValues.name)})
341Promise {
342 _bitField: 0,
343 _fulfillmentHandler0: undefined,
344 _rejectionHandler0: undefined,
345 _promise0: undefined,
346 _receiver0: undefined }
347PeerTube [1.0.0] (b10eb595)> Main root channel
348PeerTube [1.0.0] (b10eb595)> let out; new models.UserModel({id: 1}).getAccount().then(function (data) {out = data.dataValues.id})
349Promise {
350 _bitField: 0,
351 _fulfillmentHandler0: undefined,
352 _rejectionHandler0: undefined,
353 _promise0: undefined,
354 _receiver0: undefined }
355PeerTube [1.0.0] (b10eb595)> out
3562
357PeerTube [1.0.0] (b10eb595)>
358```
diff --git a/support/docker/dev/Dockerfile b/support/docker/dev/Dockerfile
index 2b4f2b215..8e049f3f6 100644
--- a/support/docker/dev/Dockerfile
+++ b/support/docker/dev/Dockerfile
@@ -1,32 +1,46 @@
1FROM janitortechnology/ubuntu-dev 1FROM ubuntu:bionic
2
3# Avoid tzdata interactive dialog
4ENV DEBIAN_FRONTEND=noninteractive
2 5
3# Install PeerTube's dependencies. 6# Install PeerTube's dependencies.
4# Packages are from https://github.com/Chocobozzz/PeerTube#dependencies 7# Packages are from https://github.com/Chocobozzz/PeerTube#dependencies
5RUN sudo apt-get update -q && sudo apt-get install -qy \ 8RUN apt-get update -q && apt-get install -qy \
6 ffmpeg \ 9 curl \
7 postgresql \ 10 ffmpeg \
8 openssl 11 g++ \
12 git \
13 gnupg \
14 make \
15 nano \
16 openssl \
17 postgresql \
18 postgresql-contrib \
19 redis-server \
20 && curl -sL https://deb.nodesource.com/setup_8.x | bash - \
21 && curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - \
22 && echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list \
23 && apt-get update \
24 && apt-get install -qy nodejs yarn \
25 && rm -rf /var/lib/apt/lists/*
9 26
10# Download PeerTube's source code. 27# Download PeerTube's source code.
11RUN git clone -b develop https://github.com/Chocobozzz/PeerTube /home/user/PeerTube 28RUN git clone -b develop https://github.com/Chocobozzz/PeerTube /home/user/PeerTube
12WORKDIR /home/user/PeerTube 29WORKDIR /home/user/PeerTube
13 30
14# Configure the IDEs to use Janitor's source directory as workspace. 31# Copy postgresql setup script
15ENV WORKSPACE /home/user/PeerTube/ 32COPY setup_postgres.sql /tmp/
16
17# Install dependencies.
18RUN yarn install --pure-lockfile
19 33
20# Configure Janitor for PeerTube. 34# Install Node.js dependencies and setup PostgreSQL
21COPY --chown=user:user janitor.json /home/user/ 35RUN yarn install --pure-lockfile \
36 && service postgresql start \
37 && su postgres -c "psql --file=/tmp/setup_postgres.sql"
22 38
23# Configure and build PeerTube. 39# Expose PeerTube sources as a volume
24COPY create_user.sql /tmp/ 40VOLUME /home/user/PeerTube
25RUN sudo service postgresql start \
26 && sudo -u postgres psql --file=/tmp/create_user.sql \
27 && npm run build
28
29COPY --chown=user:user supervisord.conf /tmp/supervisord-extra.conf
30RUN cat /tmp/supervisord-extra.conf | sudo tee -a /etc/supervisord.conf
31 41
42# Expose API and frontend
32EXPOSE 3000 9000 43EXPOSE 3000 9000
44
45# Start PostgreSQL and Redis
46CMD ["service postgresql start && redis-server"]
diff --git a/support/docker/dev/setup_postgres.sql b/support/docker/dev/setup_postgres.sql
new file mode 100644
index 000000000..0937f9d19
--- /dev/null
+++ b/support/docker/dev/setup_postgres.sql
@@ -0,0 +1,6 @@
1create database peertube_dev;
2create user peertube password 'peertube';
3grant all privileges on database peertube_dev to peertube;
4\c peertube_dev
5CREATE EXTENSION pg_trgm;
6CREATE EXTENSION unaccent;
diff --git a/support/docker/dev/usage.md b/support/docker/dev/usage.md
new file mode 100644
index 000000000..319d7db30
--- /dev/null
+++ b/support/docker/dev/usage.md
@@ -0,0 +1,20 @@
1### Usage
21. Build the image:
3 ```
4 docker build -t my_peertube_dev .
5 ```
61. Start the container:
7 ```
8 docker run -d -i -p 3000:3000 -p 9000:9000 --name peertube my_peertube_dev
9 ```
10 This will create a new Docker volume containing PeerTube sources.
11
121. Start PeerTube inside the container:
13 ```
14 docker exec -it peertube npm run dev
15 ```
161. In another window, find the path to the Docker volume
17 ```
18 docker inspect peertube | less +/Mounts
19 ```
20 You can now make changes to the files. They should be automatically recompiled.
diff --git a/support/docker/janitor/Dockerfile b/support/docker/janitor/Dockerfile
new file mode 100644
index 000000000..2b4f2b215
--- /dev/null
+++ b/support/docker/janitor/Dockerfile
@@ -0,0 +1,32 @@
1FROM janitortechnology/ubuntu-dev
2
3# Install PeerTube's dependencies.
4# Packages are from https://github.com/Chocobozzz/PeerTube#dependencies
5RUN sudo apt-get update -q && sudo apt-get install -qy \
6 ffmpeg \
7 postgresql \
8 openssl
9
10# Download PeerTube's source code.
11RUN git clone -b develop https://github.com/Chocobozzz/PeerTube /home/user/PeerTube
12WORKDIR /home/user/PeerTube
13
14# Configure the IDEs to use Janitor's source directory as workspace.
15ENV WORKSPACE /home/user/PeerTube/
16
17# Install dependencies.
18RUN yarn install --pure-lockfile
19
20# Configure Janitor for PeerTube.
21COPY --chown=user:user janitor.json /home/user/
22
23# Configure and build PeerTube.
24COPY create_user.sql /tmp/
25RUN sudo service postgresql start \
26 && sudo -u postgres psql --file=/tmp/create_user.sql \
27 && npm run build
28
29COPY --chown=user:user supervisord.conf /tmp/supervisord-extra.conf
30RUN cat /tmp/supervisord-extra.conf | sudo tee -a /etc/supervisord.conf
31
32EXPOSE 3000 9000
diff --git a/support/docker/dev/create_user.sql b/support/docker/janitor/create_user.sql
index c2fbcf27e..c2fbcf27e 100644
--- a/support/docker/dev/create_user.sql
+++ b/support/docker/janitor/create_user.sql
diff --git a/support/docker/dev/janitor.json b/support/docker/janitor/janitor.json
index 5acdf3060..5acdf3060 100644
--- a/support/docker/dev/janitor.json
+++ b/support/docker/janitor/janitor.json
diff --git a/support/docker/dev/supervisord.conf b/support/docker/janitor/supervisord.conf
index b2e1682df..b2e1682df 100644
--- a/support/docker/dev/supervisord.conf
+++ b/support/docker/janitor/supervisord.conf
diff --git a/support/docker/production/.env b/support/docker/production/.env
index 8af161b2a..4a649d655 100644
--- a/support/docker/production/.env
+++ b/support/docker/production/.env
@@ -3,7 +3,10 @@ PEERTUBE_DB_PASSWORD=postgres_password
3PEERTUBE_WEBSERVER_HOSTNAME=domain.tld 3PEERTUBE_WEBSERVER_HOSTNAME=domain.tld
4PEERTUBE_WEBSERVER_PORT=443 4PEERTUBE_WEBSERVER_PORT=443
5PEERTUBE_WEBSERVER_HTTPS=true 5PEERTUBE_WEBSERVER_HTTPS=true
6PEERTUBE_TRUST_PROXY=127.0.0.1 6# If you need more than one IP as trust_proxy
7# pass them as a comma separated array:
8PEERTUBE_TRUST_PROXY=["127.0.0.1"]
9#PEERTUBE_TRUST_PROXY=["127.0.0.1", "loopback", "192.168.1.0/24"]
7PEERTUBE_SMTP_USERNAME= 10PEERTUBE_SMTP_USERNAME=
8PEERTUBE_SMTP_PASSWORD= 11PEERTUBE_SMTP_PASSWORD=
9PEERTUBE_SMTP_HOSTNAME= 12PEERTUBE_SMTP_HOSTNAME=
diff --git a/support/docker/production/config/custom-environment-variables.yaml b/support/docker/production/config/custom-environment-variables.yaml
index daf885813..cfc30632c 100644
--- a/support/docker/production/config/custom-environment-variables.yaml
+++ b/support/docker/production/config/custom-environment-variables.yaml
@@ -7,7 +7,9 @@ webserver:
7 __name: "PEERTUBE_WEBSERVER_HTTPS" 7 __name: "PEERTUBE_WEBSERVER_HTTPS"
8 __format: "json" 8 __format: "json"
9 9
10trust_proxy: "PEERTUBE_TRUST_PROXY" 10trust_proxy:
11 __name: "PEERTUBE_TRUST_PROXY"
12 __format: "json"
11 13
12database: 14database:
13 hostname: "PEERTUBE_DB_HOSTNAME" 15 hostname: "PEERTUBE_DB_HOSTNAME"
@@ -56,6 +58,26 @@ signup:
56 __name: "PEERTUBE_SIGNUP_LIMIT" 58 __name: "PEERTUBE_SIGNUP_LIMIT"
57 __format: "json" 59 __format: "json"
58 60
61search:
62 remote_uri:
63 users:
64 __name: "PEERTUBE_SEARCH_REMOTEURI_USERS"
65 __format: "json"
66 anonymous:
67 __name: "PEERTUBE_SEARCH_REMOTEURI_ANONYMOUS"
68 __format: "json"
69
70import:
71 videos:
72 http:
73 enabled:
74 __name: "PEERTUBE_IMPORT_VIDEOS_HTTP"
75 __format: "json"
76 torrent:
77 enabled:
78 __name: "PEERTUBE_IMPORT_VIDEOS_TORRENT"
79 __format: "json"
80
59transcoding: 81transcoding:
60 enabled: 82 enabled:
61 __name: "PEERTUBE_TRANSCODING_ENABLED" 83 __name: "PEERTUBE_TRANSCODING_ENABLED"