PeerTube/README.md

289 lines
8.1 KiB
Markdown
Raw Normal View History

2016-07-21 10:24:18 +02:00
<h1 align="center">
PeerTube
</h1>
2015-06-09 17:41:40 +02:00
2016-07-21 10:24:18 +02:00
<h4 align="center">
Federated (ActivityPub) video streaming platform using P2P (BitTorrent)
directly in the web browser with <a href="https://github.com/feross/webtorrent">WebTorrent</a>.
2016-07-21 10:24:18 +02:00
</h4>
**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/).**
2017-11-23 18:22:40 +01:00
2016-07-21 10:24:18 +02:00
<p align="center">
<strong>Client</strong>
2016-04-30 08:56:21 +02:00
2016-07-21 10:24:18 +02:00
<br />
2015-06-09 17:41:40 +02:00
2016-07-21 10:24:18 +02:00
<a href="https://david-dm.org/Chocobozzz/PeerTube?path=client">
<img src="https://david-dm.org/Chocobozzz/PeerTube.svg?path=client" alt="Dependency Status" />
</a>
2017-03-27 18:52:16 +02:00
<a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=dev">
2016-07-21 10:24:18 +02:00
<img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
</a>
</p>
<p align="center">
<strong>Server</strong>
<br />
<a href="https://travis-ci.org/Chocobozzz/PeerTube">
<img src="https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=develop" alt="Build Status" />
2016-07-21 10:24:18 +02:00
</a>
<a href="https://david-dm.org/Chocobozzz/PeerTube">
<img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" />
</a>
2017-03-27 18:52:16 +02:00
<a href="https://david-dm.org/Chocobozzz/PeerTube#info=dev">
2016-07-21 10:24:18 +02:00
<img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
</a>
2016-07-21 11:56:38 +02:00
<a href="http://standardjs.com/">
<img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
2016-07-21 10:24:18 +02:00
</a>
2017-01-12 19:17:12 +01:00
2016-12-14 22:47:20 +01:00
<a href="https://kiwiirc.com/client/irc.freenode.net/#peertube">
2016-12-14 22:52:57 +01:00
<img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" />
2016-12-14 22:47:20 +01:00
</a>
2016-07-21 10:24:18 +02:00
</p>
2016-05-11 20:01:01 +02:00
2016-07-21 11:56:38 +02:00
<br />
<p align="center">
2017-04-30 19:34:41 +02:00
<a href="https://peertube.cpy.re">
<img src="https://lutim.cpy.re/mRdBAdeD.png" alt="screenshot" />
2016-07-21 11:56:38 +02:00
</a>
</p>
## Demonstration
Want to see it in action?
2016-06-05 10:49:01 +02:00
2017-05-05 18:17:19 +02:00
* [Demo server](http://peertube.cpy.re)
* [Video](https://peertube.cpy.re/videos/watch/f78a97f8-a142-4ce1-a5bd-154bf9386504)
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
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.
2015-06-09 17:41:40 +02:00
## Features
2016-04-28 19:31:08 +02:00
- [X] Frontend
2017-02-18 09:31:41 +01:00
- [X] Angular frontend
2017-11-27 16:06:13 +01:00
- [X] Join the fediverse
- [X] Follow other instances
- [X] Unfollow an instance
- [X] Get for the followers/following list
2015-06-09 17:41:40 +02:00
- [X] Upload a video
- [X] Seed the video
2017-11-27 16:06:13 +01:00
- [X] Send the meta data with ActivityPub to followers
2015-06-09 17:41:40 +02:00
- [X] Remove the video
- [X] List the videos
2017-11-27 16:06:13 +01:00
- [X] View the video in an HTML5 player with WebTorrent
2016-10-01 09:57:05 +02:00
- [X] Admin panel
2016-11-20 15:27:43 +01:00
- [X] OpenGraph tags
2017-10-31 16:11:38 +01:00
- [X] OEmbed
2017-04-16 14:26:40 +02:00
- [X] Update video
2017-10-31 16:11:38 +01:00
- [X] Videos view counter
- [X] Videos likes/dislikes
2017-10-31 16:11:38 +01:00
- [X] Transcoding to different definitions
- [X] Download file/torrent
- [X] User video bytes quota
2017-11-27 16:06:13 +01:00
- [X] User video channels
2017-10-31 16:11:38 +01:00
- [X] NSFW warnings/settings
- [X] Video description in markdown
- [X] User roles (administrator, moderator)
2017-04-16 14:26:40 +02:00
- [X] User registration
2017-10-31 16:11:38 +01:00
- [X] Video privacy settings (public, unlisted or private)
2017-11-27 16:06:13 +01:00
- [X] Signaling a video to the admin origin PeerTube instance
2017-10-31 16:11:38 +01:00
- [ ] Videos comments
- [ ] User playlist
- [ ] User subscriptions (by tags, author...)
2017-11-27 16:06:13 +01:00
- [ ] Add "DDOS" security
2017-04-16 14:26:40 +02:00
2015-06-09 17:41:40 +02:00
2016-04-30 12:56:44 +02:00
## Installation
2015-06-09 17:41:40 +02:00
See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete
installation commands.
2017-04-09 12:13:51 +02:00
### Front compatibility
2015-06-09 17:41:40 +02:00
* Chromium
* Firefox (>= 42 for MediaSource support)
2015-06-09 17:41:40 +02:00
### Dependencies
* **NodeJS >= 8.x**
2017-04-26 22:45:27 +02:00
* yarn
2015-06-09 17:41:40 +02:00
* OpenSSL (cli)
2016-12-25 09:43:08 +01:00
* PostgreSQL
2017-01-12 19:17:12 +01:00
* FFmpeg
2015-06-09 17:41:40 +02:00
2016-02-14 10:29:35 +01:00
#### Debian
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)
2. Install yarn:
[https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
4. Run:
2016-02-14 10:29:35 +01:00
```bash
$ apt-get update
2017-12-14 10:20:05 +01:00
$ apt-get install ffmpeg postgresql openssl
```
#### Ubuntu 16.04
1. Install NodeJS 8.x (current LTS): (same as Debian)
2. Install yarn: (same as Debian)
3. Run:
```bash
$ apt-get update
$ apt-get install ffmpeg postgresql openssl
```
2016-02-14 10:29:35 +01:00
#### Arch Linux
1. Run:
```bash
$ pacman -S nodejs yarn ffmpeg postgresql openssl
```
#### Other distributions
2016-04-30 12:56:44 +02:00
Feel free to update this README file in a pull request!
2016-02-14 10:29:35 +01:00
### Build from the sources
2015-06-09 17:41:40 +02:00
```bash
2017-01-12 19:17:12 +01:00
$ git clone -b master https://github.com/Chocobozzz/PeerTube
$ cd PeerTube
2017-04-26 22:45:27 +02:00
$ yarn install
2016-04-26 23:02:46 +02:00
$ npm run build
```
2016-04-30 12:56:44 +02:00
## Usage
2016-05-20 15:27:16 +02:00
### Production
If you want to run PeerTube in production (which might be a bad idea for now :) ):
2016-05-20 15:27:16 +02:00
```bash
2016-05-20 15:27:16 +02:00
$ cp config/production.yaml.example config/production.yaml
```
2016-05-20 15:27:16 +02:00
Then edit the `config/production.yaml` file according to your webserver
configuration. Keys set in this file will override those of
`config/default.yml`.
2016-05-20 15:27:16 +02:00
Finally, run the server with the `NODE_ENV` environment variable set to
`production`:
2016-05-20 15:27:16 +02:00
```bash
2016-05-20 15:27:16 +02:00
$ NODE_ENV=production npm start
```
2016-05-20 15:27:16 +02:00
The administrator password is automatically generated and can be found in the
logs. You can set another password with:
2017-01-27 11:18:53 +01:00
```bash
2017-01-27 11:18:53 +01:00
$ NODE_ENV=production npm run reset-password -- -u root
```
2017-01-27 11:18:53 +01:00
2017-04-09 12:13:51 +02:00
**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx <br />
**Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd
2016-10-21 12:16:07 +02:00
You can check the application (CORS headers, tracker websocket...) by running:
```bash
2016-10-21 12:16:07 +02:00
$ NODE_ENV=production npm run check
```
2016-10-21 12:16:07 +02:00
2016-10-21 14:52:21 +02:00
### Upgrade
The following commands will upgrade the source (according to your current
branch), upgrade node modules and rebuild client application:
2016-10-21 14:52:21 +02:00
```bash
2016-10-21 14:52:21 +02:00
# systemctl stop peertube
$ npm run upgrade-peertube
2016-10-21 14:52:21 +02:00
# systemctl start peertube
```
2016-10-21 14:52:21 +02:00
### Test with three fresh nodes
2016-12-01 22:19:34 +01:00
```bash
2016-12-01 22:19:34 +01:00
$ npm run clean:server:test
$ npm run play
```
2016-12-01 22:19:34 +01:00
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.
2016-12-01 22:19:34 +01:00
2016-04-30 12:56:44 +02:00
### Other commands
To print all available commands, run:
2016-04-30 12:56:44 +02:00
```bash
2016-04-30 12:56:44 +02:00
$ npm run help
```
2016-04-30 12:56:44 +02:00
2016-07-22 11:45:48 +02:00
## Contributing
See the [contributing
guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md)
to see how to contribute to PeerTube. Spoiler alert: you don't need to be a
coder to help!
2016-07-22 11:45:48 +02:00
2015-06-09 17:41:40 +02:00
## Architecture
See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explanation.
2015-10-29 23:18:17 +01:00
2015-06-09 17:41:40 +02:00
### 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.
2015-06-09 17:41:40 +02:00
Here are some simple schemes:
2016-07-21 10:24:18 +02:00
<p align="center">
2017-06-20 18:52:57 +02:00
<img src="https://lutim.cpy.re/6Qut3ure.png" alt="Decentralized" />
2016-07-21 10:24:18 +02:00
2017-06-20 18:52:57 +02:00
<img src="https://lutim.cpy.re/NvRAcv6U.png" alt="Watch a video" />
2015-06-09 17:41:40 +02:00
2017-06-20 18:52:57 +02:00
<img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
2015-06-09 17:41:40 +02:00
2016-07-21 10:24:18 +02:00
</p>