diff options
Diffstat (limited to 'support')
-rw-r--r-- | support/doc/tools.md | 179 | ||||
-rw-r--r-- | support/docker/dev/Dockerfile | 48 | ||||
-rw-r--r-- | support/docker/dev/setup_postgres.sql | 6 | ||||
-rw-r--r-- | support/docker/dev/usage.md | 20 | ||||
-rw-r--r-- | support/docker/janitor/Dockerfile | 32 | ||||
-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/config/custom-environment-variables.yaml | 20 |
9 files changed, 285 insertions, 20 deletions
diff --git a/support/doc/tools.md b/support/doc/tools.md index 1db29edc0..7f93c94f2 100644 --- a/support/doc/tools.md +++ b/support/doc/tools.md | |||
@@ -1,3 +1,30 @@ | |||
1 | <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
2 | <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
3 | **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* | ||
4 | |||
5 | - [CLI tools guide](#cli-tools-guide) | ||
6 | - [CLI wrapper](#cli-wrapper) | ||
7 | - [Remote Tools](#remote-tools) | ||
8 | - [Dependencies](#dependencies) | ||
9 | - [Installation](#installation) | ||
10 | - [peertube-import-videos.js](#peertube-import-videosjs) | ||
11 | - [peertube-upload.js](#peertube-uploadjs) | ||
12 | - [peertube-watch.js](#peertube-watchjs) | ||
13 | - [Server tools](#server-tools) | ||
14 | - [parse-log](#parse-log) | ||
15 | - [create-transcoding-job.js](#create-transcoding-jobjs) | ||
16 | - [create-import-video-file-job.js](#create-import-video-file-jobjs) | ||
17 | - [prune-storage.js](#prune-storagejs) | ||
18 | - [optimize-old-videos.js](#optimize-old-videosjs) | ||
19 | - [update-host.js](#update-hostjs) | ||
20 | - [REPL (Read Eval Print Loop)](#repl-read-eval-print-loop) | ||
21 | - [.help](#help) | ||
22 | - [Lodash example](#lodash-example) | ||
23 | - [YoutubeDL example](#youtubedl-example) | ||
24 | - [Models examples](#models-examples) | ||
25 | |||
26 | <!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
27 | |||
1 | # CLI tools guide | 28 | # CLI tools guide |
2 | - [CLI wrapper](#cli-wrapper) | 29 | - [CLI wrapper](#cli-wrapper) |
3 | - [Remote tools](#remote-tools) | 30 | - [Remote tools](#remote-tools) |
@@ -159,7 +186,7 @@ $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production | |||
159 | 186 | ||
160 | ### create-transcoding-job.js | 187 | ### create-transcoding-job.js |
161 | 188 | ||
162 | You can use this script to force transcoding of an existing video. | 189 | You can use this script to force transcoding of an existing video. PeerTube needs to be running. |
163 | 190 | ||
164 | ``` | 191 | ``` |
165 | $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] | 192 | $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run create-transcoding-job -- -v [videoUUID] |
@@ -172,7 +199,7 @@ $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production | |||
172 | 199 | ||
173 | ### create-import-video-file-job.js | 200 | ### create-import-video-file-job.js |
174 | 201 | ||
175 | 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. | 202 | 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. |
176 | 203 | ||
177 | ``` | 204 | ``` |
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] | 205 | $ 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 +214,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 | 214 | $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run prune-storage |
188 | ``` | 215 | ``` |
189 | 216 | ||
217 | ### optimize-old-videos.js | ||
218 | |||
219 | Before version v1.0.0-beta.16, Peertube did not specify a bitrate for the | ||
220 | transcoding of uploaded videos. This means that videos might be encoded into | ||
221 | very large files that are too large for streaming. This script re-transcodes | ||
222 | these videos so that they can be watched properly, even on slow connections. | ||
223 | |||
224 | ``` | ||
225 | $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run optimize-old-videos | ||
226 | ``` | ||
227 | |||
228 | |||
190 | ### update-host.js | 229 | ### update-host.js |
191 | 230 | ||
192 | If you started PeerTube with a domain, and then changed it you will have invalid torrent files and invalid URLs in your database. | 231 | If you started PeerTube with a domain, and then changed it you will have |
193 | To fix this, you have to run: | 232 | invalid torrent files and invalid URLs in your database. To fix this, you have |
233 | to run: | ||
194 | 234 | ||
195 | ``` | 235 | ``` |
196 | $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host | 236 | $ sudo -u peertube NODE_CONFIG_DIR=/var/www/peertube/config NODE_ENV=production npm run update-host |
197 | ``` | 237 | ``` |
238 | |||
239 | ### REPL ([Read Eval Print Loop](https://nodejs.org/docs/latest-v8.x/api/repl.html)) | ||
240 | |||
241 | If you want to interact with the application libraries and objects even when PeerTube is not running, there is a REPL for that. | ||
242 | |||
243 | usage: `node ./dist/server/tools/repl.js` | ||
244 | |||
245 | "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." | ||
246 | |||
247 | - type `.help` to list commands available in the repl, notice it starts with a dot | ||
248 | - 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 | ||
249 | - 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 | ||
250 | - type `env` to see the loaded environment variables | ||
251 | - type `path` to access path library | ||
252 | - type `lodash` to access lodash library | ||
253 | - type `uuidv1` to access uuid/v1 library | ||
254 | - type `uuidv3` to access uuid/v3 library | ||
255 | - type `uuidv4` to access uuid/v4 library | ||
256 | - type `uuidv5` to access uuid/v5 library | ||
257 | - type `YoutubeDL` to access youtube-dl library | ||
258 | - type `cli` to access the cli helpers object | ||
259 | - type `logger` to access the logger; if you log to it, it will write to stdout and to the peertube.log file | ||
260 | - type `constants` to access the constants loaded by the server | ||
261 | - type `coreUtils` to access the core-utils helpers object | ||
262 | - type `ffmpegUtils` to access the ffmpeg-utils helpers object | ||
263 | - type `peertubeCryptoUtils` to access the peertube-crypto helpers object | ||
264 | - type `signupUtils` to access the signup helpers object | ||
265 | - type `utils` to access the utils helpers object | ||
266 | - type `YoutubeDLUtils` to access the youtube-dl helpers object | ||
267 | - type `sequelizeTypescript` to access sequelizeTypescript | ||
268 | - type `modelsUtils` to access the models/utils | ||
269 | - type `models` to access the shortcut to sequelizeTypescript.models | ||
270 | - type `transaction` to access the shortcut to sequelizeTypescript.transaction | ||
271 | - type `query` to access the shortcut to sequelizeTypescript.query | ||
272 | - type `queryInterface` to access the shortcut to sequelizeTypescript.queryInterface | ||
273 | |||
274 | #### .help | ||
275 | |||
276 | ``` | ||
277 | PeerTube [1.0.0] (b10eb595)> .help | ||
278 | .break Sometimes you get stuck, this gets you out | ||
279 | .clear Break, and also clear the local context | ||
280 | .editor Enter editor mode | ||
281 | .exit Exit the repl | ||
282 | .help Print this help message | ||
283 | .load Load JS from a file into the REPL session | ||
284 | .r Reset REPL | ||
285 | .reset Reset REPL | ||
286 | .save Save all evaluated commands in this REPL session to a file | ||
287 | PeerTube [1.0.0] (b10eb595)> | ||
288 | ``` | ||
289 | |||
290 | #### Lodash example | ||
291 | |||
292 | ``` | ||
293 | PeerTube [1.0.0] (b10eb595)> lodash.keys(context) | ||
294 | [ 'global', | ||
295 | 'console', | ||
296 | 'DTRACE_NET_SERVER_CONNECTION', | ||
297 | 'DTRACE_NET_STREAM_END', | ||
298 | 'DTRACE_HTTP_SERVER_REQUEST', | ||
299 | 'DTRACE_HTTP_SERVER_RESPONSE', | ||
300 | 'DTRACE_HTTP_CLIENT_REQUEST', | ||
301 | 'DTRACE_HTTP_CLIENT_RESPONSE', | ||
302 | 'process', | ||
303 | 'Buffer', | ||
304 | 'clearImmediate', | ||
305 | 'clearInterval', | ||
306 | 'clearTimeout', | ||
307 | 'setImmediate', | ||
308 | 'setInterval', | ||
309 | 'setTimeout', | ||
310 | 'XMLHttpRequest', | ||
311 | 'compact2string', | ||
312 | 'module', | ||
313 | 'require', | ||
314 | 'path', | ||
315 | 'repl', | ||
316 | 'context', | ||
317 | 'env', | ||
318 | 'lodash', | ||
319 | 'uuidv1', | ||
320 | 'uuidv3', | ||
321 | 'uuidv4', | ||
322 | 'uuidv5', | ||
323 | 'cli', | ||
324 | 'logger', | ||
325 | 'constants', | ||
326 | 'Sequelize', | ||
327 | 'sequelizeTypescript', | ||
328 | 'modelsUtils', | ||
329 | 'models', | ||
330 | 'transaction', | ||
331 | 'query', | ||
332 | 'queryInterface', | ||
333 | 'YoutubeDL', | ||
334 | 'coreUtils', | ||
335 | 'ffmpegUtils', | ||
336 | 'peertubeCryptoUtils', | ||
337 | 'signupUtils', | ||
338 | 'utils', | ||
339 | 'YoutubeDLUtils' ] | ||
340 | PeerTube [1.0.0] (b10eb595)> | ||
341 | ``` | ||
342 | |||
343 | #### YoutubeDL example | ||
344 | ``` | ||
345 | YoutubeDL.getInfo('https://www.youtube.com/watch?v=I5ZN289jjDo', function(err, data) {console.log(err, data)}) | ||
346 | ``` | ||
347 | |||
348 | #### Models examples | ||
349 | ``` | ||
350 | PeerTube [1.0.0] (b10eb595)> new models.ActorModel({id: 3}).getVideoChannel().then(function(data){console.log(data.dataValues.name)}) | ||
351 | Promise { | ||
352 | _bitField: 0, | ||
353 | _fulfillmentHandler0: undefined, | ||
354 | _rejectionHandler0: undefined, | ||
355 | _promise0: undefined, | ||
356 | _receiver0: undefined } | ||
357 | PeerTube [1.0.0] (b10eb595)> Main root channel | ||
358 | PeerTube [1.0.0] (b10eb595)> let out; new models.UserModel({id: 1}).getAccount().then(function (data) {out = data.dataValues.id}) | ||
359 | Promise { | ||
360 | _bitField: 0, | ||
361 | _fulfillmentHandler0: undefined, | ||
362 | _rejectionHandler0: undefined, | ||
363 | _promise0: undefined, | ||
364 | _receiver0: undefined } | ||
365 | PeerTube [1.0.0] (b10eb595)> out | ||
366 | 2 | ||
367 | PeerTube [1.0.0] (b10eb595)> | ||
368 | ``` | ||
diff --git a/support/docker/dev/Dockerfile b/support/docker/dev/Dockerfile index 2b4f2b215..aa4a8a3d6 100644 --- a/support/docker/dev/Dockerfile +++ b/support/docker/dev/Dockerfile | |||
@@ -1,32 +1,48 @@ | |||
1 | FROM janitortechnology/ubuntu-dev | 1 | FROM ubuntu:bionic |
2 | |||
3 | # Avoid tzdata interactive dialog | ||
4 | ENV 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 |
5 | RUN sudo apt-get update -q && sudo apt-get install -qy \ | 8 | RUN apt-get update -q && apt-get install -qy \ |
9 | curl \ | ||
10 | nano \ | ||
6 | ffmpeg \ | 11 | ffmpeg \ |
7 | postgresql \ | 12 | postgresql \ |
8 | openssl | 13 | postgresql-contrib \ |
14 | openssl \ | ||
15 | g++ \ | ||
16 | make \ | ||
17 | redis-server \ | ||
18 | git \ | ||
19 | gnupg | ||
20 | |||
21 | # Install NodeJS 8.x | ||
22 | RUN curl -sL https://deb.nodesource.com/setup_8.x | bash - && \ | ||
23 | apt-get install -y nodejs | ||
24 | |||
25 | # Install Yarn | ||
26 | RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \ | ||
27 | echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list && \ | ||
28 | apt-get update && apt-get install yarn | ||
9 | 29 | ||
10 | # Download PeerTube's source code. | 30 | # Download PeerTube's source code. |
11 | RUN git clone -b develop https://github.com/Chocobozzz/PeerTube /home/user/PeerTube | 31 | RUN git clone -b develop https://github.com/Chocobozzz/PeerTube /home/user/PeerTube |
12 | WORKDIR /home/user/PeerTube | 32 | WORKDIR /home/user/PeerTube |
13 | 33 | ||
14 | # Configure the IDEs to use Janitor's source directory as workspace. | ||
15 | ENV WORKSPACE /home/user/PeerTube/ | ||
16 | |||
17 | # Install dependencies. | 34 | # Install dependencies. |
18 | RUN yarn install --pure-lockfile | 35 | RUN yarn install --pure-lockfile |
19 | 36 | ||
20 | # Configure Janitor for PeerTube. | 37 | # Configure and run PeerTube. |
21 | COPY --chown=user:user janitor.json /home/user/ | 38 | COPY setup_postgres.sql /tmp/ |
39 | RUN service postgresql start \ | ||
40 | && su postgres -c "psql --file=/tmp/setup_postgres.sql" | ||
22 | 41 | ||
23 | # Configure and build PeerTube. | 42 | # Expose PeerTube sources as a volume |
24 | COPY create_user.sql /tmp/ | 43 | VOLUME /home/user/PeerTube |
25 | RUN sudo service postgresql start \ | ||
26 | && sudo -u postgres psql --file=/tmp/create_user.sql \ | ||
27 | && npm run build | ||
28 | |||
29 | COPY --chown=user:user supervisord.conf /tmp/supervisord-extra.conf | ||
30 | RUN cat /tmp/supervisord-extra.conf | sudo tee -a /etc/supervisord.conf | ||
31 | 44 | ||
32 | EXPOSE 3000 9000 | 45 | EXPOSE 3000 9000 |
46 | |||
47 | # Start PostgreSQL and Redis | ||
48 | CMD 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 @@ | |||
1 | create database peertube_dev; | ||
2 | create user peertube password 'peertube'; | ||
3 | grant all privileges on database peertube_dev to peertube; | ||
4 | \c peertube_dev | ||
5 | CREATE EXTENSION pg_trgm; | ||
6 | CREATE 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 | ||
2 | 1. Build the image: | ||
3 | ``` | ||
4 | docker build -t my_peertube_dev . | ||
5 | ``` | ||
6 | 1. 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 | |||
12 | 1. Start PeerTube inside the container: | ||
13 | ``` | ||
14 | docker exec -it peertube npm run dev | ||
15 | ``` | ||
16 | 1. 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 @@ | |||
1 | FROM janitortechnology/ubuntu-dev | ||
2 | |||
3 | # Install PeerTube's dependencies. | ||
4 | # Packages are from https://github.com/Chocobozzz/PeerTube#dependencies | ||
5 | RUN sudo apt-get update -q && sudo apt-get install -qy \ | ||
6 | ffmpeg \ | ||
7 | postgresql \ | ||
8 | openssl | ||
9 | |||
10 | # Download PeerTube's source code. | ||
11 | RUN git clone -b develop https://github.com/Chocobozzz/PeerTube /home/user/PeerTube | ||
12 | WORKDIR /home/user/PeerTube | ||
13 | |||
14 | # Configure the IDEs to use Janitor's source directory as workspace. | ||
15 | ENV WORKSPACE /home/user/PeerTube/ | ||
16 | |||
17 | # Install dependencies. | ||
18 | RUN yarn install --pure-lockfile | ||
19 | |||
20 | # Configure Janitor for PeerTube. | ||
21 | COPY --chown=user:user janitor.json /home/user/ | ||
22 | |||
23 | # Configure and build PeerTube. | ||
24 | COPY create_user.sql /tmp/ | ||
25 | RUN sudo service postgresql start \ | ||
26 | && sudo -u postgres psql --file=/tmp/create_user.sql \ | ||
27 | && npm run build | ||
28 | |||
29 | COPY --chown=user:user supervisord.conf /tmp/supervisord-extra.conf | ||
30 | RUN cat /tmp/supervisord-extra.conf | sudo tee -a /etc/supervisord.conf | ||
31 | |||
32 | EXPOSE 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/config/custom-environment-variables.yaml b/support/docker/production/config/custom-environment-variables.yaml index daf885813..1f7fbf849 100644 --- a/support/docker/production/config/custom-environment-variables.yaml +++ b/support/docker/production/config/custom-environment-variables.yaml | |||
@@ -56,6 +56,26 @@ signup: | |||
56 | __name: "PEERTUBE_SIGNUP_LIMIT" | 56 | __name: "PEERTUBE_SIGNUP_LIMIT" |
57 | __format: "json" | 57 | __format: "json" |
58 | 58 | ||
59 | search: | ||
60 | remote_uri: | ||
61 | users: | ||
62 | __name: "PEERTUBE_SEARCH_REMOTEURI_USERS" | ||
63 | __format: "json" | ||
64 | anonymous: | ||
65 | __name: "PEERTUBE_SEARCH_REMOTEURI_ANONYMOUS" | ||
66 | __format: "json" | ||
67 | |||
68 | import: | ||
69 | videos: | ||
70 | http: | ||
71 | enabled: | ||
72 | __name: "PEERTUBE_IMPORT_VIDEOS_HTTP" | ||
73 | __format: "json" | ||
74 | torrent: | ||
75 | enabled: | ||
76 | __name: "PEERTUBE_IMPORT_VIDEOS_TORRENT" | ||
77 | __format: "json" | ||
78 | |||
59 | transcoding: | 79 | transcoding: |
60 | enabled: | 80 | enabled: |
61 | __name: "PEERTUBE_TRANSCODING_ENABLED" | 81 | __name: "PEERTUBE_TRANSCODING_ENABLED" |