+
+
+ 
+
Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent. - +
-**PeerTube is sponsored by [Framasoft](https://framatube.org/#en), a non-profit -that promotes, spreads and develops free culture in general, and free-libre -software in particular. If you want to support this project, please [consider -donating to them](https://soutenir.framasoft.org/en/).** ++We are running a crowdfunding campaign to pave the road to version 1.0 of PeerTube! +
Client
@@ -24,6 +23,10 @@ donating to them](https://soutenir.framasoft.org/en/).**
+
+
+
+
@@ -60,18 +63,24 @@ donating to them](https://soutenir.framasoft.org/en/).**
+## Getting Started + + * **[Website](https://joinpeertube.org)** + * **[Instances list](https://instances.joinpeertube.org)** + ## Demonstration Want to see it in action? * Demonstration servers: - * [peertube.cpy.re](http://peertube.cpy.re) - * [peertube2.cpy.re](http://peertube2.cpy.re) - * [peertube3.cpy.re](http://peertube3.cpy.re) + * [peertube.cpy.re](https://peertube.cpy.re) + * [peertube2.cpy.re](https://peertube2.cpy.re) + * [peertube3.cpy.re](https://peertube3.cpy.re) + * [Video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) What is PeerTube? * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504) to see what the "decentralization feature" looks like - -*Currently PeerTube is still in alpha (we plan to release a beta in march). Demonstration servers do not support public registration. If you really want to test PeerTube before the public release, here is a list of PeerTube servers: https://github.com/Chocobozzz/PeerTube/wiki#other-peertube-servers.* + * [Video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) to see + the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon) ## Why @@ -86,49 +95,6 @@ reason why we need to use a P2P protocol to limit the server load. Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus BitTorrent) inside the web browser, as of today. -## Features - -- [X] Angular frontend -- [X] Join the fediverse - - [X] Follow other instances - - [X] Unfollow an instance - - [X] Get for the followers/following list -- [X] Upload a video - - [X] Seed the video - - [X] Send the meta data with ActivityPub to followers -- [X] Remove the video -- [X] List the videos -- [X] View the video in an HTML5 player with WebTorrent -- [X] Admin panel -- [X] OpenGraph tags -- [X] OEmbed -- [X] Update video -- [X] Federated videos view counter -- [X] Federated videos likes/dislikes -- [X] Transcoding to different definitions -- [X] Download file/torrent -- [X] User video bytes quota -- [X] User video channels -- [X] NSFW warnings/settings -- [X] Video description in markdown -- [X] User roles (administrator, moderator) -- [X] User registration -- [X] Video privacy settings (public, unlisted or private) -- [X] Signaling a video to the admin origin PeerTube instance -- [X] Federated videos comments -- [ ] Video imports (URL, Torrent, YouTube...) -- [ ] Advanced search -- [ ] Subtitles -- [ ] User playlist -- [ ] User subscriptions (by tags, author...) -- [ ] Add "DDOS" security - - -## Front compatibility - - * Firefox - * Chrome/Chromium - ## Dependencies * nginx @@ -137,26 +103,46 @@ BitTorrent) inside the web browser, as of today. * **NodeJS >= 8.x** * yarn * OpenSSL (cli) - * FFmpeg + * **FFmpeg >= 3.x** + +## Run using Docker + +See the [docker guide](/support/doc/docker.md) + +## Run on YunoHost +[](https://install-app.yunohost.org/?app=peertube) + +Peertube app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/peertube_ynh) ## Production -See the [production guide](support/doc/production.md). +See the [production guide](/support/doc/production.md). -## Contributing +## Contribute/Translate/Test See the [contributing guide](/.github/CONTRIBUTING.md) -to see how to contribute to PeerTube. Spoiler alert: you don't need to be a +to see how to test or contribute to PeerTube (write documentation, translate, develop...). Spoiler alert: you don't need to be a coder to help! ## API REST documentation -For now only on Github: +Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md) + +Endpoints documentation: - * HTML version: [/support/doc/api/html/index.html](/support/doc/api/html/index.html) + * HTML version: [/support/doc/api/html/index.html](https://htmlpreview.github.io/?https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/html/index.html) * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml) +## Tools + + * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md) + * [Upload videos from the CLI](/support/doc/tools.md) + +## FAQ + +If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first. + ## Architecture See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation. @@ -186,3 +172,20 @@ Here are some simple schemes:
+
+## License
+
+Copyright (C) 2018 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
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see