X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=b37d79e554f7ba16b8bf85c4446df491fb5df267;hb=304016c52ba275a293a2c8ee3287e569b398dc68;hp=02fcaef7290d24669c3d3992eaec1aeaecd9d2a0;hpb=88c8d45819e425eb690bccb5ee7928d2f82b7e6a;p=github%2FChocobozzz%2FPeerTube.git
diff --git a/README.md b/README.md
index 02fcaef72..b37d79e55 100644
--- a/README.md
+++ b/README.md
@@ -1,111 +1,178 @@
-# PeerTube
+
+ PeerTube
+
-[](https://travis-ci.org/Chocobozzz/PeerTube)
+
+Federated (ActivityPub) video streaming platform using P2P (BitTorrent)
+directly in the web browser with WebTorrent.
+
-Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [webtorrent](https://github.com/feross/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 them](https://soutenir.framasoft.org/en/).**
-[](https://github.com/feross/standard)
+
+ Client
-## Why
+
-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.
+
+ 
+
-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.
+
+ 
+
+
-## Features
+
+ Server
-- [ ] Frontend
- - [X] Simple frontend (All elements are generated by jQuery)
- - [ ] AngularJS frontend
-- [ ] Join a network
- - [X] Generate a RSA key
- - [X] Ask for the friend list of other pods and make friend with them
- - [ ] Get the list of the videos owned by a pod when making friend with it
- - [ ] Post the list of its own videos when making friend with another pod
-- [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
-- [ ] Manage user accounts
- - [ ] Inscription
- - [ ] Connection
- - [ ] Account rights (upload...)
-- [ ] Make the network auto sufficient (eject bad pods etc)
-- [ ] Manage API breaks
-- [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
+
+
+ 
+
-## Usage
+
+ 
+
-### Front compatibility
+
+ 
+
- * Chromium
- * Firefox (>= 42 for MediaSource support)
+
+ 
+
-### Dependencies
+
+ 
+
+
- * NodeJS == 0.12
- * Grunt-cli (npm install -g grunt-cli)
- * OpenSSL (cli)
- * MongoDB
- * xvfb-run (for electron)
+
-### Test It!
+
+
+ 
+
+
- $ git clone https://github.com/Chocobozzz/PeerTube
- $ cd PeerTube
- # npm install -g electron-prebuilt
- $ npm install
- $ npm start
+## Demonstration
-### Test with 3 fresh nodes
+Want to see it in action?
- $ scripts/clean_test.sh
- $ scripts/run_servers.sh
+ * Demonstration servers:
+ * [peertube.cpy.re](http://peertube.cpy.re)
+ * [peertube2.cpy.re](http://peertube2.cpy.re)
+ * [peertube3.cpy.re](http://peertube3.cpy.re)
+ * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504)
+ to see how the "decentralization feature" looks like
-Then you will can access to the three nodes at http://localhost:900{1,2,3}. If you call "make friends" on http://localhost:9002, the pod 2 and 3 will become friends. Then if you call "make friends" on http://localhost:9001 it will become friend with the pod 2 and 3 (check the configuration files). Then the pod will communicate with each others. If you add a video on the pod 3 you'll can see it on the pod 1 and 2 :)
+## Why
+We can't build a FOSS video streaming alternatives to YouTube, Dailymotion,
+Vimeo... with a centralized software. One organization alone may not have
+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
+[WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus
+BitTorrent) inside the web browser, as of today.
-## Architecture
+## Features
-See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
+- [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
+ * PostgreSQL
+ * **NodeJS >= 8.x**
+ * yarn
+ * OpenSSL (cli)
+ * FFmpeg
-### Backend
+## Production
- * The backend whould be a REST API
- * Servers would communicate with each others with it
- * Each server of a network has a list of all other servers of the network
- * When a new installed server wants to join a network, it just has to get the list of the servers via one server and tell them "Hi I'm new in the network, communicate with me too please"
- * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
- * Server begins to seed and sends to the other servers of the network the video information (name, short description, torrent URI) of a new uploaded video
- * Each server has a RSA key to encrypt and sign communications with other servers
- * A server is a tracker responsible for all the videos uploaded in it
- * Even if nobody watches a video, it is seeded by the server where the video was uploaded
- * A server would run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol
- * A network can live and evolve by expelling bad pod (with too many downtimes for example)
+See the [production guide](support/doc/production.md).
-See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
+## Contributing
-Here are some simple schemes:
+See the [contributing
+guide](/.github/CONTRIBUTING.md)
+to see how to contribute to PeerTube. Spoiler alert: you don't need to be a
+coder to help!
-
+## Architecture
-
+See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.
+
+### Backend
+
+ * The backend is a REST API.
+ * Servers communicate with each others with [Activity
+ Pub](https://www.w3.org/TR/activitypub/).
+ * Each server has its own users who query it (search videos, query where the
+ 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.
+ * 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.
+
+Here are some simple schemes:
-
+
-
+
-
+
-### Frontend
+
-There would be a simple frontend (Bootstrap, AngularJS) but since the backend is a REST API anybody could 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 after having its torrent URI.
+