X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=9ceab565c4ef0e758075d31adcbf1669fd207145;hb=e43b5a3fa887e82e32ac43a9736cf2c784fb7717;hp=68c2f907b2a04283b112a0cda1db6da9ecb3b438;hpb=8c67719c80cef7319afecdf1078d5447149ad8e7;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 68c2f907b..9ceab565c 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,64 @@
+ Website + | Join an instance + | Create an instance + | Chat with us + | Donate +
- Client +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 +
- - ++ +
- Server
+ Client
-
-
+
+
-
-
+
+
+
+ Server
+
+
-
-
+
+
@@ -49,196 +69,134 @@ Prototype of a decentralized video streaming platform using P2P (bittorrent) dir
-## Demonstration
-
-Want to see in action?
-
- * You can directly test in your browser with this [demo server](http://peertube.cpy.re). Don't forget to use the latest version of Firefox/Chromium/(Opera?) and check your firewall configuration (for WebRTC)
- * You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
- * Experimental demo servers that share videos (they are in the same network): [peertube2](http://peertube2.cpy.re), [peertube3](http://peertube3.cpy.re). Since I do experiments with them, sometimes they might not work correctly.
-
-## Why
+Introduction
+----------------------------------------------------------------
-We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, Vimeo... with a centralized software. One organization alone cannot have enought money to pay bandwith and video storage of its server.
+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:
-So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
-But it's not enought 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 [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
+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.
-## Features
+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
+* PeerTube's project homepage, [joinpeertube.org](https://joinpeertube.org)
+* Demonstration instances:
+ * [peertube.cpy.re](https://peertube.cpy.re)
+ * [peertube2.cpy.re](https://peertube2.cpy.re)
+ * [peertube3.cpy.re](https://peertube3.cpy.re)
+* This [video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) demonstrating the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon) (a decentralized Twitter alternative)
-- [X] Frontend
- - [X] ~~Simple frontend (All elements are generated by jQuery)~~
- - [X] Angular 2 frontend
-- [X] Join a network
- - [X] Generate a RSA key
- - [X] Ask for the friend list of other pods and make friend with them
- - [X] Get the list of the videos owned by a pod when making friend with it
- - [X] Post the list of its own videos when making friend with another pod
-- [X] Quit a network
-- [X] Upload a video
- - [X] Seed the video
- - [X] Send the meta data to all other friends
-- [X] Remove the video
-- [X] List the videos
-- [X] Search a video name (local index)
-- [X] View the video in an HTML5 page with WebTorrent
-- [X] Manage admin account
- - [X] Connection
- - [X] Account rights (upload...)
-- [X] Make the network auto sufficient (eject bad pods etc)
-- [ ] Validate the prototype (test PeerTube in a real world with many pods and videos)
-- [ ] Manage API breaks
-- [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
-- [X] Admin panel
- - [X] Stats
- - [X] Friends list
- - [X] Manage users (create/remove)
-- [X] OpenGraph tags
-- [ ] User playlists
-- [ ] User subscriptions (by tags, author...)
-- [ ] Signaling a video to the admin pod
+:sparkles: Features
+----------------------------------------------------------------
-## Installation
-
-### Front compatibility
-
- * Chromium
- * Firefox (>= 42 for MediaSource support)
-
-### Dependencies
-
- * **NodeJS >= 4.x**
- * **npm >= 3.x**
- * OpenSSL (cli)
- * PostgreSQL
- * ffmpeg
-
-#### Debian
-
- * Install NodeJS 4.x (actual LTS): [https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)
- * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
- * Run:
-
- # apt-get update
- # apt-get install ffmpeg postgresql-9.4 openssl
- # npm install -g npm@3
-
-#### Other distribution... (PR welcome)
-
-
-### Sources
-
- $ git clone https://github.com/Chocobozzz/PeerTube
- $ cd PeerTube
- $ npm install # Or npm install --unsafe-perm for root user
- $ npm run build
-
-## Usage
-
-### Production
-
-If you want to run PeerTube for production (bad idea for now :) ):
-
- $ cp config/production.yaml.example config/production.yaml
-
-Then edit the `config/production.yaml` file according to your webserver configuration. Keys set in this file will override those of `config/default.yml`.
-
-Finally, run the server with the `production` `NODE_ENV` variable set.
-
- $ NODE_ENV=production npm start
-
-**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx
-
-**Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
-
-You can check the application (CORS headers, tracker websocket...) by running:
+
+
+Just upload your videos, and be sure they will stream anywhere. Add a description, some tags and your video will be discoverable by the entire video fediverse, not just your instance. You can even embed a player on your favorite website! +
- $ NODE_ENV=production npm run check +--- -### Upgrade + -The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application: ++Follow your favorite channels from PeerTube or really any other place. No need to have an account on the instance you watched a video to follow its author, you can do all of that from the Fediverse (Mastodon, Pleroma, and plenty others), or just with good ol' RSS. +
- # systemctl stop peertube - $ npm run upgrade - # systemctl start peertube +--- -### Development + -In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds and the client files are automatically compiled when we modify them: ++Be it as a user or an instance administrator, you can decide what your experience will be like. Don't like the colors? They are easy to change. Don't want to list videos of an instance but let your users subscribe to them? Don't like the regular web client? All of that can be changed, and much more. No UX dark pattern, no mining your data, no video recommendation bullshitâ¢. +
- $ npm run dev +--- -### Test with 3 fresh nodes ++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).
+
+### Technical documentation - +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). - +## License - +Copyright (C) 2015-2020 PeerTube Contributors (see [CREDITS.md](CREDITS.md)) -
+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. -### Frontend +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. -There already is a frontend (Angular 2) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...). -The backend uses BitTorrent protocol, so users could use their favorite BitTorrent client to download/play the video with its torrent URI. +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see