-# PeerTube
+<h1 align="center">
+ <a href="https://joinpeertube.org">
+ <img src="https://joinpeertube.org/img/brand.png" alt="PeerTube">
+ </a>
+</h1>
+
+<p align=center>
+ <strong><a href="https://joinpeertube.org">Website</a></strong>
+ | <strong><a href="https://joinpeertube.org/instances">Join an instance</a></strong>
+ | <strong><a href="https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance">Create an instance</a></strong>
+ | <strong><a href="https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#contact">Chat with us</a></strong>
+ | <strong><a href="https://framasoft.org/en/#soutenir">Donate</a></strong>
+</p>
+
+<p align="center">
+Be part of a network of multiple small federated, interoperable video hosting providers. Follow video creators and create videos. No vendor lock-in. All on a platform that is community-owned and ad-free.
+</p>
+
+<p align="center">
+ <strong>Developed with ❤ by <a href="https://framasoft.org">Framasoft</a></strong>
+</p>
+
+<p align="center">
+ <a href="https://framasoft.org">
+ <img width="150px" src="https://lutim.cpy.re/FeRgHH8r.png" alt="Framasoft logo"/>
+ </a>
+</p>
+
+<p align="center">
+ <strong>Client</strong>
-**Server**
-[](https://travis-ci.org/Chocobozzz/PeerTube)
-[](https://david-dm.org/Chocobozzz/PeerTube)
-[](https://david-dm.org/Chocobozzz/PeerTube#info=devDependencies)
-[](https://codeclimate.com/github/Chocobozzz/PeerTube)
+ <br />
-**Client**
-[](https://david-dm.org/Chocobozzz/PeerTube?path=client)
-[](https://david-dm.org/Chocobozzz/PeerTube?path=client#info=devDependencies)
+ <a href="https://automate.browserstack.com/public-build/ZEZqamJQUXFQd1l3cFp3QmxLSVVwdjBGZjNGc3J2M09INFpka296em9VYz0tLUowWVdoemxkY1hBOU9aZzNlY1htZ3c9PQ==--68e0184ce76481d36559d681d9cddc68235ff536">
+ <img src="https://automate.browserstack.com/badge.svg?badge_key=ZEZqamJQUXFQd1l3cFp3QmxLSVVwdjBGZjNGc3J2M09INFpka296em9VYz0tLUowWVdoemxkY1hBOU9aZzNlY1htZ3c9PQ==--68e0184ce76481d36559d681d9cddc68235ff536"/>
+ </a>
-[](https://github.com/feross/standard)
+ <a href="https://weblate.framasoft.org/projects/peertube/angular/">
+ <img src="https://weblate.framasoft.org/widgets/peertube/-/angular/svg-badge.svg"/>
+ </a>
+</p>
-Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [WebTorrent](https://github.com/feross/webtorrent).
+<p align="center">
+ <strong>Server</strong>
-
+ <br />
-## Demonstration
+ <a href="https://github.com/Chocobozzz/PeerTube/actions?query=workflow%3A%22Test+Suite%22+branch%3Adevelop">
+ <img alt="test suite status" src="https://github.com/Chocobozzz/PeerTube/workflows/Test%20Suite/badge.svg" />
+ </a>
-Want to see in action?
+ <a href="https://standardjs.com/">
+ <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
+ </a>
+</p>
- * 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)
- * You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like
+<br />
-## Why
+<p align="center">
+ <a href="https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3">
+ <img src="https://lutim.cpy.re/9CLXh0Ys.png" alt="screenshot" />
+ </a>
+</p>
-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.
+Introduction
+----------------------------------------------------------------
-So we need to have a decentralized network (as [Diaspora](https://github.com/diaspora/diaspora) for example).
-But it's not enought 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 right now.
+PeerTube is a free, decentralized and federated video platform developed as an alternative to other platforms that centralize our data and attention, such as YouTube, Dailymotion or Vimeo. :clapper:
-## Features
+To learn more:
+* This [two-minute video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) (hosted on PeerTube) explaining what PeerTube is and how it works
+* PeerTube's project homepage, [joinpeertube.org](https://joinpeertube.org)
+* Demonstration instances:
+ * [peertube.cpy.re](https://peertube.cpy.re) (stable)
+ * [peertube2.cpy.re](https://peertube2.cpy.re) (Nightly)
+ * [peertube3.cpy.re](https://peertube3.cpy.re) (RC)
+* This [video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) demonstrating the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon) (a decentralized Twitter alternative)
-- [X] Frontend
- - [X] ~~Simple frontend (All elements are generated by jQuery)~~
- - [X] Angular 2 frontend
-- [X] Join a network
- - [X] Generate a RSA key
- - [X] Ask for the friend list of other pods and make friend with them
- - [X] Get the list of the videos owned by a pod when making friend with it
- - [X] Post the list of its own videos when making friend with another pod
-- [X] Quit a network
-- [X] Upload a video
- - [X] Seed the video
- - [X] Send the meta data to all other friends
-- [X] Remove the video
-- [X] List the videos
-- [X] Search a video name (local index)
-- [X] View the video in an HTML5 page with WebTorrent
-- [X] Manage admin account
- - [X] Connection
- - [X] Account rights (upload...)
-- [X] Make the network auto sufficient (eject bad pods etc)
-- [ ] Validate the prototype (test PeerTube in a real world with many pods and videos)
-- [ ] Manage API breaks
-- [ ] Add "DDOS" security (check if a pod don't send too many requests for example)
-- [ ] Admin panel
- - [ ] Stats about the network (how many friends, how many requests per hour...)
- - [ ] Stats about videos
- - [ ] Manage users (create/remove)
+:sparkles: Features
+----------------------------------------------------------------
+<p align=center>
+ <strong><a href="https://joinpeertube.org/faq#what-are-the-peertube-features-for-viewers">All features for viewers</a></strong>
+ | <strong><a href="https://joinpeertube.org/faq#what-are-the-peertube-features-for-content-creators">All features for content creators</a></strong>
+ | <strong><a href="https://joinpeertube.org/faq#what-are-the-peertube-features-for-administrators">All features for administrators</a></strong>
+</p>
-## Installation
+<img src="https://lutim.cpy.re/AHbctLjn.png" align="left" height="300px"/>
+<h3 align="left">Video streaming, even in live!</h3>
+<p align="left">
+Just upload your videos, and be sure they will stream anywhere. Add a description, some tags and your video will be discoverable by the entire video fediverse, not just your instance. You can even embed a player on your favorite website!
+</p>
+<p align="left">
+You are used to hosting live events? We got you covered too! Start livestreaming from your favorite client, and even host permanent streams!
+</p>
-### Front compatibility
+---
- * Chromium
- * Firefox (>= 42 for MediaSource support)
+<img src="https://lutim.cpy.re/cxWccUK7.png" align="right" height="200px"/>
-### Dependencies
+<h3 align="right">Keep in touch with video creators</h3>
+<p align="right">
+Follow your favorite channels from PeerTube or really any other place. No need to have an account on the instance you watched a video to follow its author, you can do all of that from the Fediverse (Mastodon, Pleroma, and plenty others), or just with good ol' RSS.
+</p>
- * **NodeJS >= 4.2**
- * OpenSSL (cli)
- * MongoDB
- * ffmpeg xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron)
+---
-#### Debian
+<img src="https://lutim.cpy.re/K07EhFbt.png" align="left" height="200px"/>
- * 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)
- * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/
- * Run:
+<h3 align="left">An interface to call home</h3>
+<p align="left">
+Be it as a user or an instance administrator, you can decide what your experience will be like. Don't like the colors? They are easy to change. Don't want to list videos of an instance but let your users subscribe to them? Don't like the regular web client? All of that can be changed, and much more. No UX dark pattern, no mining your data, no video recommendation bullshit™.
+</p>
- # apt-get update
- # apt-get install ffmpeg mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin
- # npm install -g electron-prebuilt
+---
-#### Other distribution... (PR welcome)
+<h3 align="right">Communities that help each other</h3>
+<p align="right">
+In addition to visitors using WebTorrent to share the load among them, instances can help each other by caching one another's videos. This way even small instances have a way to show content to a wider audience, as they will be shouldered by friend instances (more about that in our <a href="https://docs.joinpeertube.org/contribute/architecture#redundancy-between-instances">redundancy guide</a>).
+</p>
+<p align="right">
+Content creators can get help from their viewers in the simplest way possible: a support button showing a message linking to their donation accounts or really anything else. No more pay-per-view and advertisements that hurt visitors and alter creativity (more about that in our <a href="https://github.com/Chocobozzz/PeerTube/blob/develop/FAQ.md">FAQ</a>).
+</p>
-### Sources
- $ git clone https://github.com/Chocobozzz/PeerTube
- $ cd PeerTube
- $ npm install
- $ npm run build
+:raised_hands: Contributing
+----------------------------------------------------------------
-## Usage
+You don't need to be a programmer to help!
-### Development
+You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the [contributing
+guide](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md) to know how, it takes less than 2 minutes to get started. :wink:
- $ npm start
+You can also join the cheerful bunch that makes our community:
-### Test with 3 fresh nodes
+* Chat<a name="contact"></a>:
+ * Matrix (bridged on IRC and [Discord](https://discord.gg/wj8DDUT)) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)**
+ * IRC : **[#peertube on irc.libera.chat:6697](https://web.libera.chat/#peertube)**
+* Forum:
+ * Framacolibri: [https://framacolibri.org/c/peertube](https://framacolibri.org/c/peertube)
- $ npm run clean:server:test
- $ npm run play
+Feel free to reach out if you have any questions or ideas! :speech_balloon:
-Then you will can access to the three nodes at `http://localhost:900{1,2,3}`. 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 :)
+:package: Create your own instance
+----------------------------------------------------------------
-### Production
+See the [production guide](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/production.md), which is the recommended way to install or upgrade PeerTube. For hardware requirements, see [Should I have a big server to run PeerTube?](https://joinpeertube.org/faq#should-i-have-a-big-server-to-run-peertube) in the FAQ.
-If you want to run PeerTube for production (bad idea for now :) ):
+See the [community packages](https://docs.joinpeertube.org/install/unofficial), which cover various platforms (including [YunoHost](https://install-app.yunohost.org/?app=peertube) and [Docker](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/docker.md)).
- $ cp config/production.yaml.example config/production.yaml
+:book: Documentation
+----------------------------------------------------------------
-Then edit the `config/production.yaml` file according to your webserver configuration.
+If you have a question, please try to find the answer in the [FAQ](https://joinpeertube.org/faq) first.
-Finally, run the server with the `production` `NODE_ENV` variable set.
+### User documentation
- $ NODE_ENV=production npm start
+See the [user documentation](https://docs.joinpeertube.org/use/setup-account).
-### Other commands
+### Admin documentation
-To print all available command run:
+See [how to create your own instance](https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance).
- $ npm run help
+See the more general [admin documentation](https://docs.joinpeertube.org/admin/following-instances).
-## Dockerfile
+### Tools documentation
-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.
+Learn how to import/upload videos from CLI or admin your PeerTube instance with the [tools documentation](https://docs.joinpeertube.org/maintain/tools).
-## Architecture
+### Technical documentation
-See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication.
+See the [architecture blueprint](https://docs.joinpeertube.org/contribute/architecture) for a more detailed explanation of the architectural choices.
-### Backend
+See our REST API documentation:
+ * OpenAPI 3.0.0 schema: [/support/doc/api/openapi.yaml](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml)
+ * Spec explorer: [docs.joinpeertube.org/api-rest-reference.html](https://docs.joinpeertube.org/api-rest-reference.html)
- * The backend whould be a REST API
- * Servers would communicate with each others with it
- * Each server of a network has a list of all other servers of the network
- * When a new installed server wants to join a network, it just has to get the list of the servers via one server and tell them "Hi I'm new in the network, communicate with me too please"
- * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...)
- * Server begins to seed and sends to the other servers of the network the video information (name, short description, torrent URI) of a new uploaded video
- * Each server has a RSA key to encrypt and sign communications with other servers
- * 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 where the video was uploaded
- * A server would run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol
- * A network can live and evolve by expelling bad pod (with too many downtimes for example)
+See our [ActivityPub documentation](https://docs.joinpeertube.org/api/activitypub).
-See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :)
+## License
-Here are some simple schemes:
+### Logo
-
+[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/), by [Framasoft](https://framasoft.org)
-
+### Code
-
+Copyright (C) 2015-2023 PeerTube Contributors (see [CREDITS.md](/CREDITS.md))
-
+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.
-### Frontend
-
-There would be a simple frontend (Bootstrap, AngularJS) but since the backend is a REST API anybody could build a frontend (Web application, desktop application...).
-The backend uses bittorrent protocol, so users could use their favorite bittorrent client to download/play the video after having its torrent URI.
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.
projects / github / Chocobozzz / PeerTube.git / blobdiff