cff8b272b1
* Add basic support for hostname binding Signed-off-by: Pierre-Alain TORET <pierre-alain.toret@protonmail.com> * Make production example a bit more secure Signed-off-by: Pierre-Alain TORET <pierre-alain.toret@protonmail.com> * Make example config files compatible with hostname binding modification Signed-off-by: Pierre-Alain TORET <pierre-alain.toret@protonmail.com> * Fix typo Signed-off-by: Pierre-Alain TORET <pierre-alain.toret@protonmail.com> * Bind on 127.0.0.1 by default Signed-off-by: Pierre-Alain TORET <pierre-alain.toret@protonmail.com> * Update Docker configuration with hostname binding Signed-off-by: Pierre-Alain TORET <pierre-alain.toret@protonmail.com> |
||
|---|---|---|
| .github | ||
| client | ||
| config | ||
| scripts | ||
| server | ||
| shared | ||
| support | ||
| .codeclimate.yml | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitignore | ||
| .travis.yml | ||
| ARCHITECTURE.md | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CREDITS.md | ||
| FAQ.md | ||
| LICENSE | ||
| README.md | ||
| package.json | ||
| server.ts | ||
| tsconfig.json | ||
| tslint.json | ||
| yarn.lock | ||
README.md
PeerTube
Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent.
PeerTube is sponsored by Framasoft, 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 to them.
Client
Server
Demonstration
Want to see it in action?
- Demonstration servers:
- Video to see what the "decentralization feature" looks like
- Video to see the communication between PeerTube and Mastodon
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 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, we can make P2P (thus BitTorrent) inside the web browser, as of today.
Dependencies
- nginx
- PostgreSQL
- Redis
- NodeJS >= 8.x
- yarn
- OpenSSL (cli)
- FFmpeg >= 3.x
Run using Docker
See the docker guide
Production
See the production guide.
Contributing/Test
See the contributing guide to see how to test or contribute to PeerTube. Spoiler alert: you don't need to be a coder to help!
API REST documentation
Quick Start: /support/doc/api/quickstart.md
Endpoints documentation:
- HTML version: /support/doc/api/html/index.html
- Swagger/OpenAPI schema: /support/doc/api/openapi.yaml
Tools
FAQ
If you have a question, please try to find the answer in the FAQ first.
Architecture
See ARCHITECTURE.md for a more detailed explanation.
Backend
- The backend is a REST API.
- Servers communicate with each others with Activity Pub.
- 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) where the video was uploaded.
Here are some simple schemes:
License
Copyright (C) 2018 PeerTube Contributors
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.