6 Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
9 **PeerTube is sponsored by [Framasoft](https://framatube.org/#en), a non-profit that promotes, spreads and develops free-libre software. If you want to support this project, please [consider donating them](https://soutenir.framasoft.org/en/).**
12 <strong>Client</strong>
16 <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client">
17 <img src="https://david-dm.org/Chocobozzz/PeerTube.svg?path=client" alt="Dependency Status" />
20 <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=dev">
21 <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
26 <strong>Server</strong>
30 <a href="https://travis-ci.org/Chocobozzz/PeerTube">
31 <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=develop" alt="Build Status" />
34 <a href="https://david-dm.org/Chocobozzz/PeerTube">
35 <img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" />
38 <a href="https://david-dm.org/Chocobozzz/PeerTube#info=dev">
39 <img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
42 <a href="http://standardjs.com/">
43 <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
46 <a href="https://kiwiirc.com/client/irc.freenode.net/#peertube">
47 <img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" />
54 <a href="https://peertube.cpy.re">
55 <img src="https://lutim.cpy.re/mRdBAdeD.png" alt="screenshot" />
61 Want to see in action?
63 * [Demo server](http://peertube.cpy.re)
64 * [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504) to see how the "decentralization feature" looks like
65 * 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.
69 We can't build a FOSS video streaming alternatives to YouTube, Dailymotion, Vimeo... with a centralized software. One organization alone cannot have enough money to pay bandwidth and video storage of its server.
71 So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
72 But it's not enough because one video could become famous and overload the server.
73 It's the reason why we need to use a P2P protocol to limit the server load.
74 Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
79 - [X] Angular frontend
80 - [X] Join the fediverse
81 - [X] Follow other instances
82 - [X] Unfollow an instance
83 - [X] Get for the followers/following list
86 - [X] Send the meta data with ActivityPub to followers
87 - [X] Remove the video
89 - [X] View the video in an HTML5 player with WebTorrent
94 - [X] Videos view counter
95 - [X] Videos likes/dislikes
96 - [X] Transcoding to different definitions
97 - [X] Download file/torrent
98 - [X] User video bytes quota
99 - [X] User video channels
100 - [X] NSFW warnings/settings
101 - [X] Video description in markdown
102 - [X] User roles (administrator, moderator)
103 - [X] User registration
104 - [X] Video privacy settings (public, unlisted or private)
105 - [X] Signaling a video to the admin origin PeerTube instance
106 - [ ] Videos comments
108 - [ ] User subscriptions (by tags, author...)
109 - [ ] Add "DDOS" security
114 See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installation commands.
116 ### Front compatibility
119 * Firefox (>= 42 for MediaSource support)
131 1. Install NodeJS 8.x (current 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)
132 2. Install yarn: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
136 $ apt-get install ffmpeg postgresql openssl
140 1. Install NodeJS 8.x (current LTS): (same as Debian)
141 2. Install yarn: (same as Debian)
145 $ apt-get install ffmpeg postgresql openssl
147 #### Other distribution... (PR welcome)
152 $ git clone -b master https://github.com/Chocobozzz/PeerTube
161 If you want to run PeerTube for production (bad idea for now :) ):
163 $ cp config/production.yaml.example config/production.yaml
165 Then edit the `config/production.yaml` file according to your webserver configuration. Keys set in this file will override those of `config/default.yml`.
167 Finally, run the server with the `production` `NODE_ENV` variable set.
169 $ NODE_ENV=production npm start
171 The administrator password is automatically generated and can be found in the logs. You can set another password with:
173 $ NODE_ENV=production npm run reset-password -- -u root
175 **Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx <br />
176 **Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
178 You can check the application (CORS headers, tracker websocket...) by running:
180 $ NODE_ENV=production npm run check
184 The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application:
186 # systemctl stop peertube
187 $ npm run upgrade-peertube
188 # systemctl start peertube
192 In this mode, the server will run requests between instances more quickly, the video durations are limited to a few seconds.
194 To develop on the server-side (server files are automatically compiled when we modify them and the server restarts automatically too):
198 The server (with the client) will listen on `localhost:9000`.
201 To develop on the client side (client files are automatically compiled when we modify them):
205 The API will listen on `localhost:9000` and the frontend on `localhost:3000` (with hot module replacement, you don't need to refresh the web browser).
207 **Username**: *root* <br/>
210 ### Test with 3 fresh nodes
212 $ npm run clean:server:test
215 Then you will get 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.
219 To print all available command run:
225 See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
227 See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
229 See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md).
234 See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
238 * The backend is a REST API
239 * Servers communicate with each others with [Activity Pub](https://www.w3.org/TR/activitypub/)
240 * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
241 * If a user upload a video, the server seeds it and sends the video information (name, short description, torrent URI...) its followers
242 * A server is a tracker responsible for all the videos uploaded in it
243 * 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
245 Here are some simple schemes:
249 <img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" />
251 <img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
253 <img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />