X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=451e6612c9fe486b90ea383668b47e4314707833;hb=8ea021ef48fdaf3f2892f08be1aafa84c94b9d81;hp=202d6680de52f714445628c51d48f5cb3fb3e0bb;hpb=e8395f027b6c3e3f757c740e35b20e76c51b03bd;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 202d6680d..451e6612c 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,14 @@ PeerTube -

+

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 have run a crowdfunding campaign to pave the road to version 1.0 of PeerTube. Thanks to everyone who pitched in and shared the news around. You can now check out the corresponding milestone and help its development! +

Client @@ -24,6 +23,10 @@ donating to them](https://soutenir.framasoft.org/en/).** devDependency Status + + + +

@@ -46,10 +49,6 @@ donating to them](https://soutenir.framasoft.org/en/).** JavaScript Style Guide - - - PeerTube Freenode IRC -


@@ -60,18 +59,27 @@ donating to them](https://soutenir.framasoft.org/en/).**

+## Getting Started + + * **[Website](https://joinpeertube.org)** + * **[Instances list](https://instances.joinpeertube.org)** + * Chat: + * IRC : **[#peertube on chat.freenode.net:6697](https://kiwiirc.com/client/irc.freenode.net/#peertube)** + * Matrix (bridged on the IRC channel) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.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 @@ -81,54 +89,11 @@ enough money to pay for bandwidth and video storage of its servers. So we need to have a decentralized network of servers seeding videos (as [Diaspora](https://github.com/diaspora/diaspora) for example). But it's not -enough because one video could become famous and overload the server. It's the -reason why we need to use a P2P protocol to limit the server load. Thanks to +enough because one video could become famous and overload the server. That is +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,46 +102,47 @@ BitTorrent) inside the web browser, as of today. * **NodeJS >= 8.x** * yarn * OpenSSL (cli) - * FFmpeg - -## Run using Docker + * **FFmpeg >= 3.x** -You can quickly get a server running using Docker. You need to have [docker](https://www.docker.com/community-edition) and [docker-compose](https://docs.docker.com/compose/install/) installed. +## Run in production -For this example configuration, you should also run a reverse proxy. The example -Docker Compose file provides example labels for the Traefik load balancer, -though any HTTP reverse proxy is compatible. +See the [production guide](/support/doc/production.md). -Example for running a peertube server locally: +## Run on YunoHost +[![Install Peertube with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=peertube) -```bash -sudo \ - PEERTUBE_HOSTNAME=peertube.lvh.me \ - PEERTUBE_ADMIN_EMAIL=test@example.com \ - PEERTUBE_TRANSCODING_ENABLED=true \ - docker-compose up app -``` +Peertube app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/peertube_ynh). -(Get the initial root user password from the program output.) - -## Production +## Run using Docker -See the [production guide](support/doc/production.md). +See the [docker guide](/support/doc/docker.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) + * [Admin server tools (create transcoding jobs, prune storage...)](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/tools.md#server-tools) + +## 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. @@ -190,7 +156,7 @@ See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation. torrent URI of this specific video is...). * If a user uploads a video, the server seeds it and sends its followers some metadata (name, short description, torrent URI...). - * A server is a tracker responsible for all the videos uploaded in it. + * A server is a tracker responsible for all the videos uploaded on it. * Even if nobody watches a video, it is seeded by the server (through [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the video was uploaded. @@ -206,3 +172,20 @@ Here are some simple schemes: Watch a P2P video

+ +## 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 .