diff options
Diffstat (limited to 'support')
-rw-r--r-- | support/doc/api/openapi.yaml | 34 | ||||
-rw-r--r-- | support/doc/dependencies.md | 2 | ||||
-rw-r--r-- | support/doc/docker.md | 4 | ||||
-rw-r--r-- | support/doc/production.md | 21 | ||||
-rw-r--r-- | support/openapi/kotlin/README.mustache | 2 |
5 files changed, 49 insertions, 14 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 294aa50ab..afd310c0b 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. |
@@ -1903,6 +1903,22 @@ paths: | |||
1903 | example: | | 1903 | example: | |
1904 | **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)** | 1904 | **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)** |
1905 | 1905 | ||
1906 | '/videos/{id}/source': | ||
1907 | post: | ||
1908 | summary: Get video source file metadata | ||
1909 | operationId: getVideoSource | ||
1910 | tags: | ||
1911 | - Video | ||
1912 | parameters: | ||
1913 | - $ref: '#/components/parameters/idOrUUID' | ||
1914 | responses: | ||
1915 | '200': | ||
1916 | description: successful operation | ||
1917 | content: | ||
1918 | application/json: | ||
1919 | schema: | ||
1920 | $ref: '#/components/schemas/VideoSource' | ||
1921 | |||
1906 | '/videos/{id}/views': | 1922 | '/videos/{id}/views': |
1907 | post: | 1923 | post: |
1908 | summary: Notify user is watching a video | 1924 | summary: Notify user is watching a video |
@@ -2053,7 +2069,7 @@ paths: | |||
2053 | x-summary: video file too large, due to quota or max body size limit set by the reverse-proxy | 2069 | x-summary: video file too large, due to quota or max body size limit set by the reverse-proxy |
2054 | description: | | 2070 | description: | |
2055 | If the response has no body, it means the reverse-proxy didn't let it through. Otherwise disambiguate via `type`: | 2071 | 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 | 2072 | - `quota_reached` for quota limits whether daily or global |
2057 | headers: | 2073 | headers: |
2058 | X-File-Maximum-Size: | 2074 | X-File-Maximum-Size: |
2059 | schema: | 2075 | schema: |
@@ -3602,7 +3618,7 @@ paths: | |||
3602 | - $ref: '#/components/parameters/name' | 3618 | - $ref: '#/components/parameters/name' |
3603 | - name: withStats | 3619 | - name: withStats |
3604 | in: query | 3620 | in: query |
3605 | description: include view statistics for the last 30 days (only if authentified as the account user) | 3621 | description: include daily view statistics for the last 30 days and total views (only if authentified as the account user) |
3606 | schema: | 3622 | schema: |
3607 | type: boolean | 3623 | type: boolean |
3608 | - $ref: '#/components/parameters/start' | 3624 | - $ref: '#/components/parameters/start' |
@@ -5277,7 +5293,7 @@ components: | |||
5277 | moderator: Moderator scope | 5293 | moderator: Moderator scope |
5278 | user: User scope | 5294 | user: User scope |
5279 | schemas: | 5295 | schemas: |
5280 | # Resuable core properties | 5296 | # Reusable core properties |
5281 | id: | 5297 | id: |
5282 | type: integer | 5298 | type: integer |
5283 | minimum: 1 | 5299 | minimum: 1 |
@@ -5443,7 +5459,7 @@ components: | |||
5443 | - 1 | 5459 | - 1 |
5444 | - 2 | 5460 | - 2 |
5445 | - 3 | 5461 | - 3 |
5446 | description: 'The live latency mode (Default = `1`, HIght latency = `2`, Small Latency = `3`)' | 5462 | description: 'The live latency mode (Default = `1`, High latency = `2`, Small Latency = `3`)' |
5447 | 5463 | ||
5448 | VideoStateConstant: | 5464 | VideoStateConstant: |
5449 | properties: | 5465 | properties: |
@@ -6141,6 +6157,10 @@ components: | |||
6141 | $ref: '#/components/schemas/VideoConstantString-Language' | 6157 | $ref: '#/components/schemas/VideoConstantString-Language' |
6142 | captionPath: | 6158 | captionPath: |
6143 | type: string | 6159 | type: string |
6160 | VideoSource: | ||
6161 | properties: | ||
6162 | filename: | ||
6163 | type: string | ||
6144 | ActorImage: | 6164 | ActorImage: |
6145 | properties: | 6165 | properties: |
6146 | path: | 6166 | path: |
@@ -7754,7 +7774,7 @@ components: | |||
7754 | - 5 | 7774 | - 5 |
7755 | nullable: true | 7775 | nullable: true |
7756 | description: > | 7776 | description: > |
7757 | Error type if an error occured during the live session: | 7777 | Error type if an error occurred during the live session: |
7758 | - `1`: Bad socket health (transcoding is too slow) | 7778 | - `1`: Bad socket health (transcoding is too slow) |
7759 | - `2`: Max duration exceeded | 7779 | - `2`: Max duration exceeded |
7760 | - `3`: Quota exceeded | 7780 | - `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 | ``` |
514 | net-libs/nodejs | 514 | net-libs/nodejs |
515 | sys-apps/yarn | 515 | sys-apps/yarn |
516 | media-video/ffmpeg[x264] # Optionnally add vorbis,vpx | 516 | media-video/ffmpeg[x264] # Optionally add vorbis,vpx |
517 | dev-db/postgresql | 517 | dev-db/postgresql |
518 | dev-db/redis | 518 | dev-db/redis |
519 | dev-vcs/git | 519 | dev-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 | ||
114 | See the production guide ["Administrator" section](https://docs.joinpeertube.org/install-any-os?id=administrator) | 114 | See 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 | ||
118 | See the production guide ["What now" section](https://docs.joinpeertube.org/install-any-os?id=what-now). | 118 | See 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..34e19fc8c 100644 --- a/support/doc/production.md +++ b/support/doc/production.md | |||
@@ -25,6 +25,12 @@ Set its password: | |||
25 | $ sudo passwd peertube | 25 | $ sudo passwd peertube |
26 | ``` | 26 | ``` |
27 | 27 | ||
28 | Ensure the peertube root directory is traversable by nginx: | ||
29 | |||
30 | ```bash | ||
31 | $ ls -ld /var/www/peertube # Should be drwxr-xr-x | ||
32 | ``` | ||
33 | |||
28 | **On FreeBSD** | 34 | **On FreeBSD** |
29 | 35 | ||
30 | ```bash | 36 | ```bash |
@@ -328,7 +334,7 @@ Copy new configuration defaults values and update your configuration file: | |||
328 | 334 | ||
329 | ```bash | 335 | ```bash |
330 | $ sudo -u peertube cp /var/www/peertube/versions/peertube-${VERSION}/config/default.yaml /var/www/peertube/config/default.yaml | 336 | $ 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 | 337 | $ diff -u /var/www/peertube/versions/peertube-${VERSION}/config/production.yaml.example /var/www/peertube/config/production.yaml |
332 | ``` | 338 | ``` |
333 | 339 | ||
334 | Change the link to point to the latest version: | 340 | Change the link to point to the latest version: |
@@ -339,13 +345,22 @@ $ cd /var/www/peertube && \ | |||
339 | sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest | 345 | sudo -u peertube ln -s versions/peertube-${VERSION} ./peertube-latest |
340 | ``` | 346 | ``` |
341 | 347 | ||
348 | ### Configuration | ||
349 | |||
350 | You can check for configuration changes, and report them in your `config/production.yaml` file: | ||
351 | |||
352 | ```bash | ||
353 | $ cd /var/www/peertube/versions | ||
354 | $ diff -u "$(ls --sort=t | head -2 | tail -1)/config/production.yaml.example" "$(ls --sort=t | head -1)/config/production.yaml.example" | ||
355 | ``` | ||
356 | |||
342 | ### nginx | 357 | ### nginx |
343 | 358 | ||
344 | Check changes in nginx configuration: | 359 | Check changes in nginx configuration: |
345 | 360 | ||
346 | ```bash | 361 | ```bash |
347 | $ cd /var/www/peertube/versions | 362 | $ 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" | 363 | $ diff -u "$(ls --sort=t | head -2 | tail -1)/support/nginx/peertube" "$(ls --sort=t | head -1)/support/nginx/peertube" |
349 | ``` | 364 | ``` |
350 | 365 | ||
351 | ### systemd | 366 | ### systemd |
@@ -354,7 +369,7 @@ Check changes in systemd configuration: | |||
354 | 369 | ||
355 | ```bash | 370 | ```bash |
356 | $ cd /var/www/peertube/versions | 371 | $ 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" | 372 | $ diff -u "$(ls --sort=t | head -2 | tail -1)/support/systemd/peertube.service" "$(ls --sort=t | head -1)/support/systemd/peertube.service" |
358 | ``` | 373 | ``` |
359 | 374 | ||
360 | ### Restart PeerTube | 375 | ### 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 | ||
37 | All URIs are relative to *{{{basePath}}}*. Change it when instanciating `ApiClient(basePath)`. | 37 | All URIs are relative to *{{{basePath}}}*. Change it when instantiating `ApiClient(basePath)`. |
38 | 38 | ||
39 | Class | Method | HTTP request | Description | 39 | Class | Method | HTTP request | Description |
40 | ------------ | ------------- | ------------- | ------------- | 40 | ------------ | ------------- | ------------- | ------------- |