Use new doc links
This commit is contained in:
Chocobozzz
parent
9ee4876a73
commit
7cf88d098a
36
CHANGELOG.md
36
CHANGELOG.md
|
|
@ -25,7 +25,7 @@
|
|||
|
||||
* 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)
|
||||
* Add `input-password` setting to plugins [#3375](https://github.com/Chocobozzz/PeerTube/issues/3375)
|
||||
* Add server plugin hooks (https://docs.joinpeertube.org/#/api-plugins):
|
||||
* Add server plugin hooks (https://docs.joinpeertube.org/api-plugins):
|
||||
* `filter:api.accounts.videos.list.params`
|
||||
* `filter:api.accounts.videos.list.result`
|
||||
* `filter:api.video-channels.videos.list.params`
|
||||
|
|
@ -176,16 +176,16 @@
|
|||
|
||||
### Plugins/Themes/Embed API
|
||||
|
||||
* Add embed API (https://docs.joinpeertube.org/#/api-embed-player):
|
||||
* Add embed API (https://docs.joinpeertube.org/api-embed-player):
|
||||
* `playNextVideo` method
|
||||
* `playPreviousVideo` method
|
||||
* `getCurrentPosition` method
|
||||
* Embed URL parameters
|
||||
* Add ability to disable PeerTube link in embed using an URL param (`peertubeLink=0`)
|
||||
* Add plugins support in embed
|
||||
* Add client plugin hooks (https://docs.joinpeertube.org/#/api-plugins):
|
||||
* Add client plugin hooks (https://docs.joinpeertube.org/api-plugins):
|
||||
* `action:embed.player.loaded` (for embed)
|
||||
* Add custom fields in video update/upload form using `registerVideoField` (https://docs.joinpeertube.org/#/contribute-plugins?id=add-custom-fields-to-video-form)
|
||||
* Add custom fields in video update/upload form using `registerVideoField` (https://docs.joinpeertube.org/contribute-plugins?id=add-custom-fields-to-video-form)
|
||||
|
||||
### Features
|
||||
|
||||
|
|
@ -395,7 +395,7 @@ A new endpoint to report videos will be created in PeerTube 2.4 and will also al
|
|||
|
||||
### CLI tools
|
||||
|
||||
* Add redundancy CLI: https://docs.joinpeertube.org/#/maintain-tools?id=peertube-redundancyjs
|
||||
* Add redundancy CLI: https://docs.joinpeertube.org/maintain-tools?id=peertube-redundancyjs
|
||||
* Add ability to pass remaining options to youtube-dl binary in peertube-import script ([@drzraf](https://github.com/drzraf))
|
||||
|
||||
### Docker
|
||||
|
|
@ -405,19 +405,19 @@ A new endpoint to report videos will be created in PeerTube 2.4 and will also al
|
|||
|
||||
### Maintenance
|
||||
|
||||
* 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).
|
||||
* 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).
|
||||
|
||||
### Plugins/Themes/Embed API
|
||||
|
||||
* Add embed API (https://docs.joinpeertube.org/#/api-embed-player):
|
||||
* Add embed API (https://docs.joinpeertube.org/api-embed-player):
|
||||
* `playbackState` can be `ended`
|
||||
* `playbackStatusUpdate` has a `duration` field
|
||||
* `setCaption` and `getCaptions` methods
|
||||
* Add client plugin hooks (https://docs.joinpeertube.org/#/api-plugins):
|
||||
* Add client plugin hooks (https://docs.joinpeertube.org/api-plugins):
|
||||
* `action:login.init`
|
||||
* `action:video-watch.video-threads.loaded`
|
||||
* `action:video-watch.video-thread-replies.loaded` ([@ipbc-dev](https://github.com/ipbc-dev))
|
||||
* Add server plugin hooks (https://docs.joinpeertube.org/#/api-plugins):
|
||||
* Add server plugin hooks (https://docs.joinpeertube.org/api-plugins):
|
||||
* `filter:api.video.pre-import-url.accept.result`
|
||||
* `filter:api.video.pre-import-torrent.accept.result`
|
||||
* `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
|
|||
|
||||
We added some sections in the documentation website:
|
||||
|
||||
* S3 remote storage: https://docs.joinpeertube.org/#/admin-remote-storage
|
||||
* Instances redundancy: https://docs.joinpeertube.org/#/admin-following-instances
|
||||
* Moderate your instance: https://docs.joinpeertube.org/#/admin-moderation
|
||||
* Customize your instance (install plugins & themes): https://docs.joinpeertube.org/#/admin-customize-instance
|
||||
* PeerTube logs (standard log/audit log): https://docs.joinpeertube.org/#/admin-logs
|
||||
* Mute accounts/instances: https://docs.joinpeertube.org/#/use-mute
|
||||
* Controlled player embed API: https://docs.joinpeertube.org/#/api-embed-player
|
||||
* S3 remote storage: https://docs.joinpeertube.org/admin-remote-storage
|
||||
* Instances redundancy: https://docs.joinpeertube.org/admin-following-instances
|
||||
* Moderate your instance: https://docs.joinpeertube.org/admin-moderation
|
||||
* Customize your instance (install plugins & themes): https://docs.joinpeertube.org/admin-customize-instance
|
||||
* PeerTube logs (standard log/audit log): https://docs.joinpeertube.org/admin-logs
|
||||
* Mute accounts/instances: https://docs.joinpeertube.org/use-mute
|
||||
* Controlled player embed API: https://docs.joinpeertube.org/api-embed-player
|
||||
|
||||
### Docker
|
||||
|
||||
|
|
@ -650,7 +650,7 @@ We added some sections in the documentation website:
|
|||
|
||||
* PeerTube moved translations from Zanata to Weblate. Here is the new translations website URL: https://weblate.framasoft.org/projects/peertube/
|
||||
* We now provide a JavaScript library to control a PeerTube embed: https://www.npmjs.com/package/@peertube/embed-api
|
||||
* Add ability to generate HLS videos using `create-transcoding-job` script (see [the documentation](https://docs.joinpeertube.org/#/maintain-tools?id=create-transcoding-jobjs))
|
||||
* Add ability to generate HLS videos using `create-transcoding-job` script (see [the documentation](https://docs.joinpeertube.org/maintain-tools?id=create-transcoding-jobjs))
|
||||
* Update nginx template: (you need to [update manually](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/production.md#nginx))
|
||||
* Add streaming playlists endpoint
|
||||
* Add `client_body_temp_path` hint
|
||||
|
|
@ -919,7 +919,7 @@ We added some sections in the documentation website:
|
|||
### Features
|
||||
|
||||
* :tada: Support Finnish, Greek and Scottish Gaelic languages
|
||||
* :tada: Add basic plugins and themes support (**beta**): https://docs.joinpeertube.org/#/contribute-plugins
|
||||
* :tada: Add basic plugins and themes support (**beta**): https://docs.joinpeertube.org/contribute-plugins
|
||||
* Install plugins or themes from the administration panel
|
||||
* Choose a default theme for your instance
|
||||
* Users can choose the theme they want among the list of themes their administrator installed
|
||||
|
|
|
|||
6
FAQ.md
6
FAQ.md
|
|
@ -59,7 +59,7 @@ is named "Framatube".
|
|||
|
||||
Yes, the origin server always seeds videos uploaded on it thanks to
|
||||
[Webseed](http://www.bittorrent.org/beps/bep_0019.html).
|
||||
It can also be helped by other servers using [redundancy](https://docs.joinpeertube.org/#/contribute-architecture?id=redundancy-between-instances).
|
||||
It can also be helped by other servers using [redundancy](https://docs.joinpeertube.org/contribute-architecture?id=redundancy-between-instances).
|
||||
|
||||
|
||||
## What is WebSeed?
|
||||
|
|
@ -89,7 +89,7 @@ and FLV formats when transcoding is enabled on their instance.
|
|||
|
||||
## I want to change my domain name, how can I do that?
|
||||
|
||||
It's not officially supported, but you can try the `update-host` script: https://docs.joinpeertube.org/#/maintain-tools?id=update-hostjs
|
||||
It's not officially supported, but you can try the `update-host` script: https://docs.joinpeertube.org/maintain-tools?id=update-hostjs
|
||||
|
||||
|
||||
## 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
|
|||
|
||||
But 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.
|
||||
|
||||
If 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).
|
||||
If 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).
|
||||
|
||||
## Can I seed videos with my classic BitTorrent client (Transmission, rTorrent...)?
|
||||
|
||||
|
|
|
|||
14
README.md
14
README.md
|
|
@ -112,7 +112,7 @@ Be it as a user or an instance administrator, you can decide what your experienc
|
|||
|
||||
<h3 align="right">Communities that help each other</h3>
|
||||
<p align="right">
|
||||
In 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>).
|
||||
In 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>).
|
||||
</p>
|
||||
<p align="right">
|
||||
Content 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:
|
|||
|
||||
See 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.
|
||||
|
||||
See 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)).
|
||||
See 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)).
|
||||
|
||||
:book: Documentation
|
||||
----------------------------------------------------------------
|
||||
|
|
@ -150,27 +150,27 @@ If you have a question, please try to find the answer in the [FAQ](https://githu
|
|||
|
||||
### User documentation
|
||||
|
||||
See the [user documentation](https://docs.joinpeertube.org/#/use-setup-account).
|
||||
See the [user documentation](https://docs.joinpeertube.org/use-setup-account).
|
||||
|
||||
### Admin documentation
|
||||
|
||||
See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance).
|
||||
|
||||
See the more general [admin documentation](https://docs.joinpeertube.org/#/admin-following-instances).
|
||||
See the more general [admin documentation](https://docs.joinpeertube.org/admin-following-instances).
|
||||
|
||||
### Tools documentation
|
||||
|
||||
Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/#/maintain-tools).
|
||||
Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/maintain-tools).
|
||||
|
||||
### Technical documentation
|
||||
|
||||
See the [architecture blueprint](https://docs.joinpeertube.org/#/contribute-architecture) for a more detailed explanation of the architectural choices.
|
||||
See the [architecture blueprint](https://docs.joinpeertube.org/contribute-architecture) for a more detailed explanation of the architectural choices.
|
||||
|
||||
See our REST API documentation:
|
||||
* OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml)
|
||||
* Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html)
|
||||
|
||||
See our [ActivityPub documentation](https://docs.joinpeertube.org/#/api-activitypub).
|
||||
See our [ActivityPub documentation](https://docs.joinpeertube.org/api-activitypub).
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
# @peertube/embed-api
|
||||
|
||||
See https://docs.joinpeertube.org/#/api-embed-player
|
||||
See https://docs.joinpeertube.org/api-embed-player
|
||||
|
|
|
|||
|
|
@ -113,11 +113,11 @@ peertube._domainkey.mydomain.tld. IN TXT ( "v=DKIM1; h=sha256; k=rsa; "
|
|||
|
||||
### Administrator password
|
||||
|
||||
See the production guide ["Administrator" section](https://docs.joinpeertube.org/#/install-any-os?id=administrator)
|
||||
See the production guide ["Administrator" section](https://docs.joinpeertube.org/install-any-os?id=administrator)
|
||||
|
||||
### What now?
|
||||
|
||||
See the production guide ["What now" section](https://docs.joinpeertube.org/#/install-any-os?id=what-now).
|
||||
See the production guide ["What now" section](https://docs.joinpeertube.org/install-any-os?id=what-now).
|
||||
|
||||
### Upgrade
|
||||
|
||||
|
|
|
|||
|
|
@ -636,7 +636,7 @@ and republish it on NPM. Remember that the PeerTube index will take into account
|
|||
|
||||
## Plugin & Theme hooks/helpers API
|
||||
|
||||
See the dedicated documentation: https://docs.joinpeertube.org/#/api-plugins
|
||||
See the dedicated documentation: https://docs.joinpeertube.org/api-plugins
|
||||
|
||||
|
||||
## Tips
|
||||
|
|
|
|||
|
|
@ -91,7 +91,7 @@ $ cd /var/www/peertube && sudo -u peertube cp peertube-latest/config/production.
|
|||
Then edit the `config/production.yaml` file according to your webserver
|
||||
configuration. Keys defined in `config/production.yaml` will override keys defined in `config/default.yaml`.
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
### Webserver
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue