X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=README.md;h=0f288fa3ffba69fc12cd8076449a43f26460a7a1;hb=df8c65d783cca3258c891f309aad0b8f39b7cda8;hp=a9b4eb54a0d7e9eca4b323040dbbe194077bc3c6;hpb=28f3d1b36a70426795240c9370e47b6c4ba847f8;p=oweals%2Fpeertube.git diff --git a/README.md b/README.md index a9b4eb54a..0f288fa3f 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,25 @@ Be part of a network of multiple small federated, interoperable video hosting providers. Follow video creators and create videos. No vendor lock-in. All on a platform that is community-owned and ad-free.

+

+:rocket::rocket::rocket: +

+ +

+Check, share and support PeerTube's v3 roadmap on https://joinpeertube.org/roadmap +

+ +

+:rocket: :rocket: :rocket: +

+

Developed with ❤ by Framasoft

- Framasoft logo + Framasoft logo

@@ -34,9 +46,9 @@ Be part of a network of multiple small federated, interoperable video hosting pr devDependency Status - - - + + +

@@ -45,8 +57,8 @@ Be part of a network of multiple small federated, interoperable video hosting pr
- - Build Status + + pipeline status @@ -66,14 +78,19 @@ Be part of a network of multiple small federated, interoperable video hosting pr

- screenshot + screenshot

Introduction ---------------------------------------------------------------- -PeerTube is a free, decentralized and federated video platform developed as an alternative to other platforms that centralize our data and attention, such as YouTube, Dailymotion or Vimeo. :clapper: But one organization hosting PeerTube alone may not have enough money to pay for bandwidth and video storage of its servers, all servers of PeerTube are interoperable as a federated network, and non-PeerTube servers can be part of the larger Vidiverse (federated video network) by talking our implementation of ActivityPub. Video load is reduced thanks to P2P (BitTorrent) in the web browser via WebTorrent. +PeerTube is a free, decentralized and federated video platform developed as an alternative to other platforms that centralize our data and attention, such as YouTube, Dailymotion or Vimeo. :clapper: + +But one organization hosting PeerTube alone may not have enough money to pay for bandwidth and video storage of its servers, +all servers of PeerTube are interoperable as a federated network, and non-PeerTube servers can be part of the larger Vidiverse +(federated video network) by talking our implementation of ActivityPub. +Video load is reduced thanks to P2P in the web browser using WebTorrent or p2p-media-loader. To learn more, see: * This [two-minute video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) (hosted on PeerTube) explaining what PeerTube is and how it works @@ -115,10 +132,10 @@ Be it as a user or an instance administrator, you can decide what your experienc

Communities that help each other

-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 redundancy guide). +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 redundancy guide).

-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 incentivize alter creativity (more about that in our FAQ). +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 incentivize alter creativity (more about that in our FAQ).

:raised_hands: Contributing @@ -127,7 +144,7 @@ Content creators can get help from their viewers in the simplest way possible: a You don't need to be a coder to help! You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the [contributing -guide](/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink: +guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink: You can also join the cheerful bunch that makes our community: @@ -136,7 +153,7 @@ You can also join the cheerful bunch that makes our community: * Matrix (bridged on IRC and [Discord](https://discord.gg/wj8DDUT)) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)** * Forum: * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube) - + Feel free to reach out if you have any questions or ideas! :speech_balloon: :package: Create your own instance @@ -147,44 +164,42 @@ Feel free to reach out if you have any questions or ideas! :speech_balloon: * nginx * **PostgreSQL >= 9.6** * **Redis >= 2.8.18** - * **NodeJS >= 8.x** + * **NodeJS >= 10.x** * **yarn >= 1.x** * **FFmpeg >= 3.x** -See the [production guide](/support/doc/production.md), which is the recommended way. +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/lang/en/docs/install.html), which cover various platforms (including [YunoHost](https://install-app.yunohost.org/?app=peertube) and [Docker](/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 ---------------------------------------------------------------- -If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first. +If you have a question, please try to find the answer in the [FAQ](https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md) first. ### User documentation -See the [user documentation](https://docs.joinpeertube.org/lang/en/userdocs/). +See the [user documentation](https://docs.joinpeertube.org/#/use-setup-account). ### Admin documentation -See [how to create your own instance](#package-create-your-own-instance). +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/lang/en/docs/). +See the more general [admin documentation](https://docs.joinpeertube.org/#/admin-following-instances). -#### Tools +### Tools documentation - * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md) - * [Upload videos from the CLI](/support/doc/tools.md) - * [Admin server tools (create transcoding jobs, prune storage...)](/support/doc/tools.md#server-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/lang/en/devdocs/architecture.html) 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](/support/doc/api/openapi.yaml) - * Spec explorer: [docs.joinpeertube.org/api.html](http://docs.joinpeertube.org/api.html) + * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/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/lang/en/devdocs/federation.html). +See our [ActivityPub documentation](https://docs.joinpeertube.org/#/api-activitypub). :heart: Supports of our crowdfunding ---------------------------------------------------------------- @@ -196,11 +211,11 @@ Quonfucius, IP Solution, \_Laure\_, @lex666, 0x010C, 3dsman, 3rw4n-G3D, aallrd, ## License -Copyright (C) 2018 PeerTube Contributors +Copyright (C) 2015-2020 PeerTube Contributors This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published -by the Free Software Foundation, either version 3 of the License, or +by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful,