Update README roadmap
[oweals/peertube.git] / README.md
1 <h1 align="center">
2   PeerTube
3 </h1>
4
5 <h4 align="center">
6 Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
7 </h4>
8
9 <p align="center">
10   <strong>Client</strong>
11
12   <br />
13
14   <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client">
15     <img src="https://david-dm.org/Chocobozzz/PeerTube.svg?path=client" alt="Dependency Status" />
16   </a>
17
18   <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=devDependencies">
19     <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
20   </a>
21 </p>
22
23 <p align="center">
24   <strong>Server</strong>
25
26   <br />
27
28   <a href="https://travis-ci.org/Chocobozzz/PeerTube">
29     <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master" alt="Build Status" />
30   </a>
31
32   <a href="https://david-dm.org/Chocobozzz/PeerTube">
33     <img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" />
34   </a>
35
36   <a href="https://david-dm.org/Chocobozzz/PeerTube#info=devDependencies">
37     <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
38   </a>
39
40   <a href="https://codeclimate.com/github/Chocobozzz/PeerTube">
41     <img src="https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg" alt="Code climate" />
42   </a>
43
44   <a href="http://standardjs.com/">
45     <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
46   </a>
47 </p>
48
49 <br />
50
51 <p align="center">
52   <a href="http://peertube.cpy.re">
53     <img src="https://lutim.cpy.re/vC2loRww" alt="screenshot" />
54   </a>
55 </p>
56
57 ## Demonstration
58
59 Want to see in action?
60
61    * 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)
62    * You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
63
64 ## Why
65
66 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.
67
68 So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
69 But it's not enought because one video could become famous and overload the server.
70 It's the reason why we need to use a P2P protocol to limit the server load.
71 Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
72
73 ## Features
74
75 - [X] Frontend
76   - [X] ~~Simple frontend (All elements are generated by jQuery)~~
77   - [X] Angular 2 frontend
78 - [X] Join a network
79   - [X] Generate a RSA key
80   - [X] Ask for the friend list of other pods and make friend with them
81   - [X] Get the list of the videos owned by a pod when making friend with it
82   - [X] Post the list of its own videos when making friend with another pod
83 - [X] Quit a network
84 - [X] Upload a video
85   - [X] Seed the video
86   - [X] Send the meta data to all other friends
87 - [X] Remove the video
88 - [X] List the videos
89 - [X] Search a video name (local index)
90 - [X] View the video in an HTML5 page with WebTorrent
91 - [X] Manage admin account
92   - [X] Connection
93   - [X] Account rights (upload...)
94 - [X] Make the network auto sufficient (eject bad pods etc)
95 - [ ] Validate the prototype (test PeerTube in a real world with many pods and videos)
96 - [ ] Manage API breaks
97 - [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
98 - [X] Admin panel
99   - [X] Stats
100   - [X] Friends list
101   - [X] Manage users (create/remove)
102 - [ ] User playlists
103 - [ ] User subscriptions (by tags, author...)
104
105
106 ## Installation
107
108 ### Front compatibility
109
110   * Chromium
111   * Firefox (>= 42 for MediaSource support)
112
113 ### Dependencies
114
115   * **NodeJS >= 4.2**
116   * **npm >= 3.0**
117   * OpenSSL (cli)
118   * MongoDB
119   * ffmpeg xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
120
121 #### Debian
122
123   * Install NodeJS 4.2: [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)
124   * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
125   * Run:
126
127         # apt-get update
128         # apt-get install ffmpeg mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin
129         # npm install -g npm@3
130         # npm install -g electron-prebuilt
131
132 #### Other distribution... (PR welcome)
133
134
135 ### Sources
136
137     $ git clone https://github.com/Chocobozzz/PeerTube
138     $ cd PeerTube
139     $ npm install
140     $ npm run build
141
142 ## Usage
143
144 ### Development
145
146     $ npm run dev
147
148 ### Test with 3 fresh nodes
149
150     $ npm run clean:server:test
151     $ npm run play
152
153 Then you will can access to the three nodes at `http://localhost:900{1,2,3}` with the `root` as username and `test{1,2,3}` for the password. 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 :)
154
155 ### Production
156
157 If you want to run PeerTube for production (bad idea for now :) ):
158
159     $ cp config/production.yaml.example config/production.yaml
160
161 Then edit the `config/production.yaml` file according to your webserver configuration.
162
163 Finally, run the server with the `production` `NODE_ENV` variable set.
164
165     $ NODE_ENV=production npm start
166
167 ### Other commands
168
169 To print all available command run:
170
171     $ npm run help
172
173 ## Dockerfile
174
175 You can test it inside Docker with the [PeerTube-Docker repository](https://github.com/Chocobozzz/PeerTube-Docker). Moreover it can help you to check how to create an environment with the required dependencies for PeerTube on a GNU/Linux distribution.
176
177 ## Contributing
178
179 See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
180
181 See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
182
183
184 ## Architecture
185
186 See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
187
188 ### Backend
189
190   * The backend is a REST API
191   * Servers communicate with each others through it
192     * A network is composed by servers that communicate between them
193     * Each server of a network has a list of all other servers of this network
194     * When a new installed server wants to join a network, it just has to get the servers list through a server that is already in the network and tell "Hi I'm new in the network, communicate with me and share me your servers list please". Then the server will "make friend" with each server of this list
195     * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
196     * If a user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network
197     * Each server has a RSA key to encrypt and sign communications with other servers
198   * A server is a tracker responsible for all the videos uploaded in it
199   * Even if nobody watches a video, it is seeded by the server where the video was uploaded
200   * A network can live and evolve by expelling bad pod (with too many downtimes for example)
201   * A server **would** run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol
202
203 See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
204
205 Here are some simple schemes:
206
207 <p align="center">
208
209 <img src="https://lutim.cpy.re/Q7mnNdJP" alt="Decentralized" />
210
211 <img src="https://lutim.cpy.re/0riSzAp1" alt="Watch a video" />
212
213 <img src="https://lutim.cpy.re/OzMSOtxG" alt="Watch a P2P video" />
214
215 <img src="https://lutim.cpy.re/uVjNNRa9" alt="Join a network" />
216
217 <img src="https://lutim.cpy.re/udTMqcb0" alt="Many networks"
218
219 </p>
220
221 ### Frontend
222
223 There already is a frontend (Angular 2) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...).
224 The backend uses bittorrent protocol, so users could use their favorite bittorrent client to download/play the video with its torrent URI.