]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame_incremental - README.md
Add delete button to my videos
[github/Chocobozzz/PeerTube.git] / README.md
... / ...
CommitLineData
1<h1 align="center">
2 PeerTube
3</h1>
4
5<h4 align="center">
6Decentralized 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**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/).**
10
11<p align="center">
12 <strong>Client</strong>
13
14 <br />
15
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" />
18 </a>
19
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" />
22 </a>
23</p>
24
25<p align="center">
26 <strong>Server</strong>
27
28 <br />
29
30 <a href="https://travis-ci.org/Chocobozzz/PeerTube">
31 <img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=develop" alt="Build Status" />
32 </a>
33
34 <a href="https://david-dm.org/Chocobozzz/PeerTube">
35 <img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" />
36 </a>
37
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" />
40 </a>
41
42 <a href="http://standardjs.com/">
43 <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
44 </a>
45
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" />
48 </a>
49</p>
50
51<br />
52
53<p align="center">
54 <a href="https://peertube.cpy.re">
55 <img src="https://lutim.cpy.re/9HOUfGK8" alt="screenshot" />
56 </a>
57</p>
58
59## Demonstration
60
61Want to see in action?
62
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.
66
67## Why
68
69We 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.
70
71So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
72But it's not enough because one video could become famous and overload the server.
73It's the reason why we need to use a P2P protocol to limit the server load.
74Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (thus bittorrent) inside the web browser right now.
75
76## Features
77
78- [X] Frontend
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
84- [X] Upload a video
85 - [X] Seed the video
86 - [X] Send the meta data with ActivityPub to followers
87- [X] Remove the video
88- [X] List the videos
89- [X] View the video in an HTML5 player with WebTorrent
90- [X] Admin panel
91- [X] OpenGraph tags
92- [X] OEmbed
93- [X] Update video
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
107- [ ] User playlist
108- [ ] User subscriptions (by tags, author...)
109- [ ] Add "DDOS" security
110
111
112## Installation
113
114See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installation commands.
115
116### Front compatibility
117
118 * Chromium
119 * Firefox (>= 42 for MediaSource support)
120
121### Dependencies
122
123 * **NodeJS >= 6.x**
124 * **npm >= 3.x**
125 * yarn
126 * OpenSSL (cli)
127 * PostgreSQL
128 * FFmpeg
129
130#### Debian
131
132 * Install NodeJS 6.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)
133 * Install yarn: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
134 * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
135 * Run:
136
137 # apt-get update
138 # apt-get install ffmpeg postgresql-9.4 openssl
139
140#### Other distribution... (PR welcome)
141
142
143### Sources
144
145 $ git clone -b master https://github.com/Chocobozzz/PeerTube
146 $ cd PeerTube
147 $ yarn install
148 $ npm run build
149
150## Usage
151
152### Production
153
154If you want to run PeerTube for production (bad idea for now :) ):
155
156 $ cp config/production.yaml.example config/production.yaml
157
158Then edit the `config/production.yaml` file according to your webserver configuration. Keys set in this file will override those of `config/default.yml`.
159
160Finally, run the server with the `production` `NODE_ENV` variable set.
161
162 $ NODE_ENV=production npm start
163
164The administrator password is automatically generated and can be found in the logs. You can set another password with:
165
166 $ NODE_ENV=production npm run reset-password -- -u root
167
168**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx <br />
169**Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
170
171You can check the application (CORS headers, tracker websocket...) by running:
172
173 $ NODE_ENV=production npm run check
174
175### Upgrade
176
177The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application:
178
179 # systemctl stop peertube
180 $ npm run upgrade-peertube
181 # systemctl start peertube
182
183### Development
184
185In this mode, the server will run requests between instances more quickly, the video durations are limited to a few seconds.
186
187To develop on the server-side (server files are automatically compiled when we modify them and the server restarts automatically too):
188
189 $ npm run dev:server
190
191The server (with the client) will listen on `localhost:9000`.
192
193
194To develop on the client side (client files are automatically compiled when we modify them):
195
196 $ npm run dev:client
197
198The 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).
199
200**Username**: *root* <br/>
201**Password**: *test*
202
203### Test with 3 fresh nodes
204
205 $ npm run clean:server:test
206 $ npm run play
207
208Then 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.
209
210### Other commands
211
212To print all available command run:
213
214 $ npm run help
215
216## Contributing
217
218See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md).
219
220See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
221
222See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md).
223
224
225## Architecture
226
227See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
228
229### Backend
230
231 * The backend is a REST API
232 * Servers communicate with each others with [Activity Pub](https://www.w3.org/TR/activitypub/)
233 * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
234 * If a user upload a video, the server seeds it and sends the video information (name, short description, torrent URI...) its followers
235 * A server is a tracker responsible for all the videos uploaded in it
236 * 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
237
238Here are some simple schemes:
239
240<p align="center">
241
242<img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" />
243
244<img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
245
246<img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
247
248</p>