aboutsummaryrefslogtreecommitdiffhomepage
path: root/support
diff options
context:
space:
mode:
Diffstat (limited to 'support')
-rw-r--r--support/doc/api/openapi.yaml14
-rw-r--r--support/doc/dependencies.md2
-rw-r--r--support/doc/docker.md4
-rw-r--r--support/doc/production.md15
-rw-r--r--support/openapi/kotlin/README.mustache2
5 files changed, 23 insertions, 14 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 294aa50ab..bd36c41cd 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -247,8 +247,8 @@ tags:
247 ### Import 247 ### Import
248 248
249 - _URL_-based: where the URL points to any service supported by [youtube-dl](https://ytdl-org.github.io/youtube-dl/) 249 - _URL_-based: where the URL points to any service supported by [youtube-dl](https://ytdl-org.github.io/youtube-dl/)
250 - _magnet_-based: where the URI resolves to a BitTorrent ressource containing a single supported video file 250 - _magnet_-based: where the URI resolves to a BitTorrent resource containing a single supported video file
251 - _torrent_-based: where the metainfo file resolves to a BitTorrent ressource containing a single supported video file 251 - _torrent_-based: where the metainfo file resolves to a BitTorrent resource containing a single supported video file
252 252
253 The import function is practical when the desired video/audio is available online. It makes PeerTube 253 The import function is practical when the desired video/audio is available online. It makes PeerTube
254 download it for you, saving you as much bandwidth and avoiding any instability or limitation your network might have. 254 download it for you, saving you as much bandwidth and avoiding any instability or limitation your network might have.
@@ -2053,7 +2053,7 @@ paths:
2053 x-summary: video file too large, due to quota or max body size limit set by the reverse-proxy 2053 x-summary: video file too large, due to quota or max body size limit set by the reverse-proxy
2054 description: | 2054 description: |
2055 If the response has no body, it means the reverse-proxy didn't let it through. Otherwise disambiguate via `type`: 2055 If the response has no body, it means the reverse-proxy didn't let it through. Otherwise disambiguate via `type`:
2056 - `quota_reached` for quota limits wether daily or global 2056 - `quota_reached` for quota limits whether daily or global
2057 headers: 2057 headers:
2058 X-File-Maximum-Size: 2058 X-File-Maximum-Size:
2059 schema: 2059 schema:
@@ -3602,7 +3602,7 @@ paths:
3602 - $ref: '#/components/parameters/name' 3602 - $ref: '#/components/parameters/name'
3603 - name: withStats 3603 - name: withStats
3604 in: query 3604 in: query
3605 description: include view statistics for the last 30 days (only if authentified as the account user) 3605 description: include daily view statistics for the last 30 days and total views (only if authentified as the account user)
3606 schema: 3606 schema:
3607 type: boolean 3607 type: boolean
3608 - $ref: '#/components/parameters/start' 3608 - $ref: '#/components/parameters/start'
@@ -5277,7 +5277,7 @@ components:
5277 moderator: Moderator scope 5277 moderator: Moderator scope
5278 user: User scope 5278 user: User scope
5279 schemas: 5279 schemas:
5280 # Resuable core properties 5280 # Reusable core properties
5281 id: 5281 id:
5282 type: integer 5282 type: integer
5283 minimum: 1 5283 minimum: 1
@@ -5443,7 +5443,7 @@ components:
5443 - 1 5443 - 1
5444 - 2 5444 - 2
5445 - 3 5445 - 3
5446 description: 'The live latency mode (Default = `1`, HIght latency = `2`, Small Latency = `3`)' 5446 description: 'The live latency mode (Default = `1`, High latency = `2`, Small Latency = `3`)'
5447 5447
5448 VideoStateConstant: 5448 VideoStateConstant:
5449 properties: 5449 properties:
@@ -7754,7 +7754,7 @@ components:
7754 - 5 7754 - 5
7755 nullable: true 7755 nullable: true
7756 description: > 7756 description: >
7757 Error type if an error occured during the live session: 7757 Error type if an error occurred during the live session:
7758 - `1`: Bad socket health (transcoding is too slow) 7758 - `1`: Bad socket health (transcoding is too slow)
7759 - `2`: Max duration exceeded 7759 - `2`: Max duration exceeded
7760 - `3`: Quota exceeded 7760 - `3`: Quota exceeded
diff --git a/support/doc/dependencies.md b/support/doc/dependencies.md
index c6cbe83a6..378cb8502 100644
--- a/support/doc/dependencies.md
+++ b/support/doc/dependencies.md
@@ -513,7 +513,7 @@ If `sudo -u postgres createuser -P peertube` gives you an `unknown user: postgre
513``` 513```
514net-libs/nodejs 514net-libs/nodejs
515sys-apps/yarn 515sys-apps/yarn
516media-video/ffmpeg[x264] # Optionnally add vorbis,vpx 516media-video/ffmpeg[x264] # Optionally add vorbis,vpx
517dev-db/postgresql 517dev-db/postgresql
518dev-db/redis 518dev-db/redis
519dev-vcs/git 519dev-vcs/git
diff --git a/support/doc/docker.md b/support/doc/docker.md
index 036ea19d4..97eecc3ad 100644
--- a/support/doc/docker.md
+++ b/support/doc/docker.md
@@ -111,11 +111,11 @@ peertube._domainkey.mydomain.tld. IN TXT ( "v=DKIM1; h=sha256; k=rsa; "
111 111
112#### Administrator password 112#### Administrator password
113 113
114See the production guide ["Administrator" section](https://docs.joinpeertube.org/install-any-os?id=administrator) 114See the production guide ["Administrator" section](https://docs.joinpeertube.org/install-any-os?id=technologist-administrator)
115 115
116#### What now? 116#### What now?
117 117
118See the production guide ["What now" section](https://docs.joinpeertube.org/install-any-os?id=what-now). 118See the production guide ["What now" section](https://docs.joinpeertube.org/install-any-os?id=tada-what-now).
119 119
120## Upgrade 120## Upgrade
121 121
diff --git a/support/doc/production.md b/support/doc/production.md
index 3c75b6cab..ea0a98395 100644
--- a/support/doc/production.md
+++ b/support/doc/production.md
@@ -328,7 +328,7 @@ Copy new configuration defaults values and update your configuration file:
328 328
329```bash 329```bash
330$ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml 330$ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml
331$ diff /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml 331$ diff -u /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml
332``` 332```
333 333
334Change the link to point to the latest version: 334Change the link to point to the latest version:
@@ -339,13 +339,22 @@ $ cd /var/www/peertube && \
339 sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest 339 sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest
340``` 340```
341 341
342### Configuration
343
344You can check for configuration changes, and report them in your `config/production.yaml` file:
345
346```bash
347$ cd /var/www/peertube/versions
348$ diff -u "$(ls --sort=t | head -2 | tail -1)/config/production.yaml.example" "$(ls --sort=t | head -1)/config/production.yaml.example"
349```
350
342### nginx 351### nginx
343 352
344Check changes in nginx configuration: 353Check changes in nginx configuration:
345 354
346```bash 355```bash
347$ cd /var/www/peertube/versions 356$ cd /var/www/peertube/versions
348$ diff "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube" 357$ diff -u "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube"
349``` 358```
350 359
351### systemd 360### systemd
@@ -354,7 +363,7 @@ Check changes in systemd configuration:
354 363
355```bash 364```bash
356$ cd /var/www/peertube/versions 365$ cd /var/www/peertube/versions
357$ diff "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service" 366$ diff -u "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service"
358``` 367```
359 368
360### Restart PeerTube 369### Restart PeerTube
diff --git a/support/openapi/kotlin/README.mustache b/support/openapi/kotlin/README.mustache
index ac7fbdea9..376314650 100644
--- a/support/openapi/kotlin/README.mustache
+++ b/support/openapi/kotlin/README.mustache
@@ -34,7 +34,7 @@ This runs all tests and packages the library.
34<a name="documentation-for-api-endpoints"></a> 34<a name="documentation-for-api-endpoints"></a>
35## Documentation for API Endpoints 35## Documentation for API Endpoints
36 36
37All URIs are relative to *{{{basePath}}}*. Change it when instanciating `ApiClient(basePath)`. 37All URIs are relative to *{{{basePath}}}*. Change it when instantiating `ApiClient(basePath)`.
38 38
39Class | Method | HTTP request | Description 39Class | Method | HTTP request | Description
40------------ | ------------- | ------------- | ------------- 40------------ | ------------- | ------------- | -------------