aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2021-01-05 11:01:12 +0100
committerChocobozzz <me@florianbigard.com>2021-01-05 11:01:12 +0100
commit7cf88d098adb543074f85be9c874ee9453371de9 (patch)
tree7d0ba94105063496dd84f9e54fcd03335b2433d8
parent9ee4876a73ceb8277cfa088eb37890534bf153b5 (diff)
downloadPeerTube-7cf88d098adb543074f85be9c874ee9453371de9.tar.gz
PeerTube-7cf88d098adb543074f85be9c874ee9453371de9.tar.zst
PeerTube-7cf88d098adb543074f85be9c874ee9453371de9.zip
Use new doc links
-rw-r--r--CHANGELOG.md36
-rw-r--r--FAQ.md6
-rw-r--r--README.md14
-rw-r--r--client/src/standalone/player/README.md2
-rw-r--r--support/doc/docker.md4
-rw-r--r--support/doc/plugins/guide.md2
-rw-r--r--support/doc/production.md2
7 files changed, 33 insertions, 33 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7706f8e9e..8a1ad2c0b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -25,7 +25,7 @@
25 25
26 * Add ability for auth plugins to redirect user on logout [#32](https://framagit.org/framasoft/peertube/PeerTube/-/merge_requests/32) & [#33](https://framagit.org/framasoft/peertube/PeerTube/-/merge_requests/33) 26 * Add ability for auth plugins to redirect user on logout [#32](https://framagit.org/framasoft/peertube/PeerTube/-/merge_requests/32) & [#33](https://framagit.org/framasoft/peertube/PeerTube/-/merge_requests/33)
27 * Add `input-password` setting to plugins [#3375](https://github.com/Chocobozzz/PeerTube/issues/3375) 27 * Add `input-password` setting to plugins [#3375](https://github.com/Chocobozzz/PeerTube/issues/3375)
28 * Add server plugin hooks (https://docs.joinpeertube.org/#/api-plugins): 28 * Add server plugin hooks (https://docs.joinpeertube.org/api-plugins):
29 * `filter:api.accounts.videos.list.params` 29 * `filter:api.accounts.videos.list.params`
30 * `filter:api.accounts.videos.list.result` 30 * `filter:api.accounts.videos.list.result`
31 * `filter:api.video-channels.videos.list.params` 31 * `filter:api.video-channels.videos.list.params`
@@ -176,16 +176,16 @@
176 176
177### Plugins/Themes/Embed API 177### Plugins/Themes/Embed API
178 178
179 * Add embed API (https://docs.joinpeertube.org/#/api-embed-player): 179 * Add embed API (https://docs.joinpeertube.org/api-embed-player):
180 * `playNextVideo` method 180 * `playNextVideo` method
181 * `playPreviousVideo` method 181 * `playPreviousVideo` method
182 * `getCurrentPosition` method 182 * `getCurrentPosition` method
183 * Embed URL parameters 183 * Embed URL parameters
184 * Add ability to disable PeerTube link in embed using an URL param (`peertubeLink=0`) 184 * Add ability to disable PeerTube link in embed using an URL param (`peertubeLink=0`)
185 * Add plugins support in embed 185 * Add plugins support in embed
186 * Add client plugin hooks (https://docs.joinpeertube.org/#/api-plugins): 186 * Add client plugin hooks (https://docs.joinpeertube.org/api-plugins):
187 * `action:embed.player.loaded` (for embed) 187 * `action:embed.player.loaded` (for embed)
188 * Add custom fields in video update/upload form using `registerVideoField` (https://docs.joinpeertube.org/#/contribute-plugins?id=add-custom-fields-to-video-form) 188 * Add custom fields in video update/upload form using `registerVideoField` (https://docs.joinpeertube.org/contribute-plugins?id=add-custom-fields-to-video-form)
189 189
190### Features 190### Features
191 191
@@ -395,7 +395,7 @@ A new endpoint to report videos will be created in PeerTube 2.4 and will also al
395 395
396### CLI tools 396### CLI tools
397 397
398 * Add redundancy CLI: https://docs.joinpeertube.org/#/maintain-tools?id=peertube-redundancyjs 398 * Add redundancy CLI: https://docs.joinpeertube.org/maintain-tools?id=peertube-redundancyjs
399 * Add ability to pass remaining options to youtube-dl binary in peertube-import script ([@drzraf](https://github.com/drzraf)) 399 * Add ability to pass remaining options to youtube-dl binary in peertube-import script ([@drzraf](https://github.com/drzraf))
400 400
401### Docker 401### Docker
@@ -405,19 +405,19 @@ A new endpoint to report videos will be created in PeerTube 2.4 and will also al
405 405
406### Maintenance 406### Maintenance
407 407
408 * Add nginx configuration to redirect videos to an S3 bucket ([@rigelk](https://github.com/rigelk)) and update of the [corresponding documentation](https://docs.joinpeertube.org/#/admin-remote-storage). 408 * Add nginx configuration to redirect videos to an S3 bucket ([@rigelk](https://github.com/rigelk)) and update of the [corresponding documentation](https://docs.joinpeertube.org/admin-remote-storage).
409 409
410### Plugins/Themes/Embed API 410### Plugins/Themes/Embed API
411 411
412 * Add embed API (https://docs.joinpeertube.org/#/api-embed-player): 412 * Add embed API (https://docs.joinpeertube.org/api-embed-player):
413 * `playbackState` can be `ended` 413 * `playbackState` can be `ended`
414 * `playbackStatusUpdate` has a `duration` field 414 * `playbackStatusUpdate` has a `duration` field
415 * `setCaption` and `getCaptions` methods 415 * `setCaption` and `getCaptions` methods
416 * Add client plugin hooks (https://docs.joinpeertube.org/#/api-plugins): 416 * Add client plugin hooks (https://docs.joinpeertube.org/api-plugins):
417 * `action:login.init` 417 * `action:login.init`
418 * `action:video-watch.video-threads.loaded` 418 * `action:video-watch.video-threads.loaded`
419 * `action:video-watch.video-thread-replies.loaded` ([@ipbc-dev](https://github.com/ipbc-dev)) 419 * `action:video-watch.video-thread-replies.loaded` ([@ipbc-dev](https://github.com/ipbc-dev))
420 * Add server plugin hooks (https://docs.joinpeertube.org/#/api-plugins): 420 * Add server plugin hooks (https://docs.joinpeertube.org/api-plugins):
421 * `filter:api.video.pre-import-url.accept.result` 421 * `filter:api.video.pre-import-url.accept.result`
422 * `filter:api.video.pre-import-torrent.accept.result` 422 * `filter:api.video.pre-import-torrent.accept.result`
423 * `filter:api.video.post-import-url.accept.result` 423 * `filter:api.video.post-import-url.accept.result`
@@ -609,13 +609,13 @@ A new endpoint to report videos will be created in PeerTube 2.4 and will also al
609 609
610We added some sections in the documentation website: 610We added some sections in the documentation website:
611 611
612 * S3 remote storage: https://docs.joinpeertube.org/#/admin-remote-storage 612 * S3 remote storage: https://docs.joinpeertube.org/admin-remote-storage
613 * Instances redundancy: https://docs.joinpeertube.org/#/admin-following-instances 613 * Instances redundancy: https://docs.joinpeertube.org/admin-following-instances
614 * Moderate your instance: https://docs.joinpeertube.org/#/admin-moderation 614 * Moderate your instance: https://docs.joinpeertube.org/admin-moderation
615 * Customize your instance (install plugins & themes): https://docs.joinpeertube.org/#/admin-customize-instance 615 * Customize your instance (install plugins & themes): https://docs.joinpeertube.org/admin-customize-instance
616 * PeerTube logs (standard log/audit log): https://docs.joinpeertube.org/#/admin-logs 616 * PeerTube logs (standard log/audit log): https://docs.joinpeertube.org/admin-logs
617 * Mute accounts/instances: https://docs.joinpeertube.org/#/use-mute 617 * Mute accounts/instances: https://docs.joinpeertube.org/use-mute
618 * Controlled player embed API: https://docs.joinpeertube.org/#/api-embed-player 618 * Controlled player embed API: https://docs.joinpeertube.org/api-embed-player
619 619
620### Docker 620### Docker
621 621
@@ -650,7 +650,7 @@ We added some sections in the documentation website:
650 650
651 * PeerTube moved translations from Zanata to Weblate. Here is the new translations website URL: https://weblate.framasoft.org/projects/peertube/ 651 * PeerTube moved translations from Zanata to Weblate. Here is the new translations website URL: https://weblate.framasoft.org/projects/peertube/
652 * We now provide a JavaScript library to control a PeerTube embed: https://www.npmjs.com/package/@peertube/embed-api 652 * We now provide a JavaScript library to control a PeerTube embed: https://www.npmjs.com/package/@peertube/embed-api
653 * Add ability to generate HLS videos using `create-transcoding-job` script (see [the documentation](https://docs.joinpeertube.org/#/maintain-tools?id=create-transcoding-jobjs)) 653 * Add ability to generate HLS videos using `create-transcoding-job` script (see [the documentation](https://docs.joinpeertube.org/maintain-tools?id=create-transcoding-jobjs))
654 * Update nginx template: (you need to [update manually](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/production.md#nginx)) 654 * Update nginx template: (you need to [update manually](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/production.md#nginx))
655 * Add streaming playlists endpoint 655 * Add streaming playlists endpoint
656 * Add `client_body_temp_path` hint 656 * Add `client_body_temp_path` hint
@@ -919,7 +919,7 @@ We added some sections in the documentation website:
919### Features 919### Features
920 920
921 * :tada: Support Finnish, Greek and Scottish Gaelic languages 921 * :tada: Support Finnish, Greek and Scottish Gaelic languages
922 * :tada: Add basic plugins and themes support (**beta**): https://docs.joinpeertube.org/#/contribute-plugins 922 * :tada: Add basic plugins and themes support (**beta**): https://docs.joinpeertube.org/contribute-plugins
923 * Install plugins or themes from the administration panel 923 * Install plugins or themes from the administration panel
924 * Choose a default theme for your instance 924 * Choose a default theme for your instance
925 * Users can choose the theme they want among the list of themes their administrator installed 925 * Users can choose the theme they want among the list of themes their administrator installed
diff --git a/FAQ.md b/FAQ.md
index 56da720ce..e785e54af 100644
--- a/FAQ.md
+++ b/FAQ.md
@@ -59,7 +59,7 @@ is named "Framatube".
59 59
60Yes, the origin server always seeds videos uploaded on it thanks to 60Yes, the origin server always seeds videos uploaded on it thanks to
61[Webseed](http://www.bittorrent.org/beps/bep_0019.html). 61[Webseed](http://www.bittorrent.org/beps/bep_0019.html).
62It can also be helped by other servers using [redundancy](https://docs.joinpeertube.org/#/contribute-architecture?id=redundancy-between-instances). 62It can also be helped by other servers using [redundancy](https://docs.joinpeertube.org/contribute-architecture?id=redundancy-between-instances).
63 63
64 64
65## What is WebSeed? 65## What is WebSeed?
@@ -89,7 +89,7 @@ and FLV formats when transcoding is enabled on their instance.
89 89
90## I want to change my domain name, how can I do that? 90## I want to change my domain name, how can I do that?
91 91
92It's not officially supported, but you can try the `update-host` script: https://docs.joinpeertube.org/#/maintain-tools?id=update-hostjs 92It's not officially supported, but you can try the `update-host` script: https://docs.joinpeertube.org/maintain-tools?id=update-hostjs
93 93
94 94
95## Why do we have to put our Twitter username in the PeerTube configuration? 95## Why do we have to put our Twitter username in the PeerTube configuration?
@@ -141,7 +141,7 @@ Take a server for example with a 1 Gbit/s uplink for example pushing out 1080p60
141 141
142But what if you need to serve more users? That's where PeerTube's federation feature shines. If other PeerTube instances following yours, chances are they have decided to mirror part of your instance! The feature is called "server redundancy" and caches your most popular videos to help serve additional viewers. While viewers themselves contribute a little additional bandwidth while watching the video in their browsers (mostly during surges), mirroring servers have a much greater uplink and will help your instance with sustained higher concurrent streaming. 142But what if you need to serve more users? That's where PeerTube's federation feature shines. If other PeerTube instances following yours, chances are they have decided to mirror part of your instance! The feature is called "server redundancy" and caches your most popular videos to help serve additional viewers. While viewers themselves contribute a little additional bandwidth while watching the video in their browsers (mostly during surges), mirroring servers have a much greater uplink and will help your instance with sustained higher concurrent streaming.
143 143
144If all your preparations and friends' bandwidth is not enough, you might prefer serving files from a CDN ; see our [remote storage guide](https://docs.joinpeertube.org/#/admin-remote-storage). 144If all your preparations and friends' bandwidth is not enough, you might prefer serving files from a CDN ; see our [remote storage guide](https://docs.joinpeertube.org/admin-remote-storage).
145 145
146## Can I seed videos with my classic BitTorrent client (Transmission, rTorrent...)? 146## Can I seed videos with my classic BitTorrent client (Transmission, rTorrent...)?
147 147
diff --git a/README.md b/README.md
index d13287bb5..630d688ab 100644
--- a/README.md
+++ b/README.md
@@ -112,7 +112,7 @@ Be it as a user or an instance administrator, you can decide what your experienc
112 112
113<h3 align="right">Communities that help each other</h3> 113<h3 align="right">Communities that help each other</h3>
114<p align="right"> 114<p align="right">
115In addition to visitors using WebTorrent to share the load among them, instances can help each other by caching one another's videos. This way even small instances have a way to show content to a wider audience, as they will be shouldered by friend instances (more about that in our <a href="https://docs.joinpeertube.org/#/contribute-architecture?id=redundancy-between-instances">redundancy guide</a>). 115In addition to visitors using WebTorrent to share the load among them, instances can help each other by caching one another's videos. This way even small instances have a way to show content to a wider audience, as they will be shouldered by friend instances (more about that in our <a href="https://docs.joinpeertube.org/contribute-architecture?id=redundancy-between-instances">redundancy guide</a>).
116</p> 116</p>
117<p align="right"> 117<p align="right">
118Content creators can get help from their viewers in the simplest way possible: a support button showing a message linking to their donation accounts or really anything else. No more pay-per-view and advertisements that hurt visitors and <strike>incentivize</strike> alter creativity (more about that in our <a href="https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md">FAQ</a>). 118Content creators can get help from their viewers in the simplest way possible: a support button showing a message linking to their donation accounts or really anything else. No more pay-per-view and advertisements that hurt visitors and <strike>incentivize</strike> alter creativity (more about that in our <a href="https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md">FAQ</a>).
@@ -141,7 +141,7 @@ Feel free to reach out if you have any questions or ideas! :speech_balloon:
141 141
142See the [production guide](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/production.md), which is the recommended way to install or upgrade PeerTube. For hardware requirements, see [Should I have a big server to run PeerTube?](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md#should-i-have-a-big-server-to-run-peertube) in the FAQ. 142See the [production guide](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/production.md), which is the recommended way to install or upgrade PeerTube. For hardware requirements, see [Should I have a big server to run PeerTube?](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md#should-i-have-a-big-server-to-run-peertube) in the FAQ.
143 143
144See the [community packages](https://docs.joinpeertube.org/#/install-unofficial), which cover various platforms (including [YunoHost](https://install-app.yunohost.org/?app=peertube) and [Docker](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/docker.md)). 144See the [community packages](https://docs.joinpeertube.org/install-unofficial), which cover various platforms (including [YunoHost](https://install-app.yunohost.org/?app=peertube) and [Docker](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/docker.md)).
145 145
146:book: Documentation 146:book: Documentation
147---------------------------------------------------------------- 147----------------------------------------------------------------
@@ -150,27 +150,27 @@ If you have a question, please try to find the answer in the [FAQ](https://githu
150 150
151### User documentation 151### User documentation
152 152
153See the [user documentation](https://docs.joinpeertube.org/#/use-setup-account). 153See the [user documentation](https://docs.joinpeertube.org/use-setup-account).
154 154
155### Admin documentation 155### Admin documentation
156 156
157See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance). 157See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance).
158 158
159See the more general [admin documentation](https://docs.joinpeertube.org/#/admin-following-instances). 159See the more general [admin documentation](https://docs.joinpeertube.org/admin-following-instances).
160 160
161### Tools documentation 161### Tools documentation
162 162
163Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/#/maintain-tools). 163Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/maintain-tools).
164 164
165### Technical documentation 165### Technical documentation
166 166
167See the [architecture blueprint](https://docs.joinpeertube.org/#/contribute-architecture) for a more detailed explanation of the architectural choices. 167See the [architecture blueprint](https://docs.joinpeertube.org/contribute-architecture) for a more detailed explanation of the architectural choices.
168 168
169See our REST API documentation: 169See our REST API documentation:
170 * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml) 170 * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml)
171 * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html) 171 * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html)
172 172
173See our [ActivityPub documentation](https://docs.joinpeertube.org/#/api-activitypub). 173See our [ActivityPub documentation](https://docs.joinpeertube.org/api-activitypub).
174 174
175## License 175## License
176 176
diff --git a/client/src/standalone/player/README.md b/client/src/standalone/player/README.md
index 5cb5a1d10..0639b4650 100644
--- a/client/src/standalone/player/README.md
+++ b/client/src/standalone/player/README.md
@@ -1,3 +1,3 @@
1# @peertube/embed-api 1# @peertube/embed-api
2 2
3See https://docs.joinpeertube.org/#/api-embed-player 3See https://docs.joinpeertube.org/api-embed-player
diff --git a/support/doc/docker.md b/support/doc/docker.md
index e9315293f..40fc1f5fa 100644
--- a/support/doc/docker.md
+++ b/support/doc/docker.md
@@ -113,11 +113,11 @@ peertube._domainkey.mydomain.tld. IN TXT ( "v=DKIM1; h=sha256; k=rsa; "
113 113
114### Administrator password 114### Administrator password
115 115
116See the production guide ["Administrator" section](https://docs.joinpeertube.org/#/install-any-os?id=administrator) 116See the production guide ["Administrator" section](https://docs.joinpeertube.org/install-any-os?id=administrator)
117 117
118### What now? 118### What now?
119 119
120See the production guide ["What now" section](https://docs.joinpeertube.org/#/install-any-os?id=what-now). 120See the production guide ["What now" section](https://docs.joinpeertube.org/install-any-os?id=what-now).
121 121
122### Upgrade 122### Upgrade
123 123
diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md
index a276143e6..0d35820e5 100644
--- a/support/doc/plugins/guide.md
+++ b/support/doc/plugins/guide.md
@@ -636,7 +636,7 @@ and republish it on NPM. Remember that the PeerTube index will take into account
636 636
637## Plugin & Theme hooks/helpers API 637## Plugin & Theme hooks/helpers API
638 638
639See the dedicated documentation: https://docs.joinpeertube.org/#/api-plugins 639See the dedicated documentation: https://docs.joinpeertube.org/api-plugins
640 640
641 641
642## Tips 642## Tips
diff --git a/support/doc/production.md b/support/doc/production.md
index 9df79f870..a55c7930f 100644
--- a/support/doc/production.md
+++ b/support/doc/production.md
@@ -91,7 +91,7 @@ $ cd /var/www/peertube && sudo -u peertube cp peertube-latest/config/production.
91Then edit the `config/production.yaml` file according to your webserver 91Then edit the `config/production.yaml` file according to your webserver
92configuration. Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`. 92configuration. Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`.
93 93
94**PeerTube does not support webserver host change**. Even though [PeerTube CLI can help you to switch hostname](https://docs.joinpeertube.org/#/maintain-tools?id=update-hostjs) there's no official support for that since it is a risky operation that might result in unforeseen errors. 94**PeerTube does not support webserver host change**. Even though [PeerTube CLI can help you to switch hostname](https://docs.joinpeertube.org/maintain-tools?id=update-hostjs) there's no official support for that since it is a risky operation that might result in unforeseen errors.
95 95
96### Webserver 96### Webserver
97 97