PeerTube
</h1>
-<h4 align="center">
+<p 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>.
-</h4>
+</p>
-**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/).**
+<p align="center">
+<strong>We have run <a href="https://www.kisskissbankbank.com/en/projects/peertube-a-free-and-federated-video-platform">a crowdfunding campaign</a> to pave the road to version 1.0 of PeerTube. Thanks to everyone who pitched in and shared the news around. You can now check out <a href="https://github.com/Chocobozzz/PeerTube/milestone/1">the corresponding milestone</a> and help its development!</strong>
+</p>
<p align="center">
<strong>Client</strong>
<img src="https://david-dm.org/Chocobozzz/PeerTube.svg?path=client" alt="Dependency Status" />
</a>
- <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client#info=dev">
+ <a href="https://david-dm.org/Chocobozzz/PeerTube?path=client&type=dev">
<img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg?path=client" alt="devDependency Status" />
</a>
+
+ <a href="https://www.browserstack.com/automate/public-build/VXBPc0szNjUvRUNsREJQRFF6RkEvSjJBclZ4VUJBUm1hcS9RZGpUbitRST0tLWFWbjNEdVN6eEZpYTk4dGVpMkVlQWc9PQ==--644e755052bf7fe2346eb6e868be8e706718a17c%">
+ <img src='https://www.browserstack.com/automate/badge.svg?badge_key=VXBPc0szNjUvRUNsREJQRFF6RkEvSjJBclZ4VUJBUm1hcS9RZGpUbitRST0tLWFWbjNEdVN6eEZpYTk4dGVpMkVlQWc9PQ==--644e755052bf7fe2346eb6e868be8e706718a17c%'/>
+ </a>
</p>
<p align="center">
<img src="https://david-dm.org/Chocobozzz/PeerTube.svg" alt="Dependencies Status" />
</a>
- <a href="https://david-dm.org/Chocobozzz/PeerTube#info=dev">
+ <a href="https://david-dm.org/Chocobozzz/PeerTube?type=dev">
<img src="https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg" alt="devDependency Status" />
</a>
<a href="http://standardjs.com/">
<img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="JavaScript Style Guide" />
</a>
-
- <a href="https://kiwiirc.com/client/irc.freenode.net/#peertube">
- <img src="https://img.shields.io/badge/%23peertube-on%20freenode-brightgreen.svg" alt="PeerTube Freenode IRC" />
- </a>
</p>
<br />
</a>
</p>
+## Getting Started
+
+ * **[Website](https://joinpeertube.org)**
+ * **[Instances list](https://instances.joinpeertube.org)**
+ * Chat:
+ * IRC : **[#peertube on chat.freenode.net:6697](https://kiwiirc.com/client/irc.freenode.net/#peertube)**
+ * Matrix (bridged on the IRC channel) : **[#peertube:matrix.org](https://matrix.to/#/#peertube:matrix.org)**
+
## Demonstration
Want to see it in action?
- * [Demo server](http://peertube.cpy.re)
+ * Demonstration servers:
+ * [peertube.cpy.re](https://peertube.cpy.re)
+ * [peertube2.cpy.re](https://peertube2.cpy.re)
+ * [peertube3.cpy.re](https://peertube3.cpy.re)
+ * [Video](https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3) What is PeerTube?
* [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.
+ to see what the "decentralization feature" looks like
+ * [Video](https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701) to see
+ the communication between PeerTube and [Mastodon](https://github.com/tootsuite/mastodon)
## Why
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
+enough because one video could become famous and overload the server. That is
+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.
-
-## Features
-
-- [X] Frontend
- - [X] Angular frontend
-- [X] Join the fediverse
- - [X] Follow other instances
- - [X] Unfollow an instance
- - [X] Get for the followers/following list
-- [X] Upload a video
- - [X] Seed the video
- - [X] Send the meta data with ActivityPub to followers
-- [X] Remove the video
-- [X] List the videos
-- [X] View the video in an HTML5 player with WebTorrent
-- [X] Admin panel
-- [X] OpenGraph tags
-- [X] OEmbed
-- [X] Update video
-- [X] Videos view counter
-- [X] Videos likes/dislikes
-- [X] Transcoding to different definitions
-- [X] Download file/torrent
-- [X] User video bytes quota
-- [X] User video channels
-- [X] NSFW warnings/settings
-- [X] Video description in markdown
-- [X] User roles (administrator, moderator)
-- [X] User registration
-- [X] Video privacy settings (public, unlisted or private)
-- [X] Signaling a video to the admin origin PeerTube instance
-- [ ] Videos comments
-- [ ] User playlist
-- [ ] User subscriptions (by tags, author...)
-- [ ] Add "DDOS" security
-
-
-## Installation
-
-See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete
-installation commands.
-
-### Front compatibility
-
- * Chromium
- * Firefox (>= 42 for MediaSource support)
-
-### Dependencies
+BitTorrent) inside the web browser, as of today.
+## Dependencies
+
+ * nginx
+ * PostgreSQL
+ * Redis
* **NodeJS >= 8.x**
* yarn
* OpenSSL (cli)
- * PostgreSQL
- * FFmpeg
-
-#### 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:
-
-```bash
- $ apt-get update
- $ 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
-```
-
-#### Arch Linux
-
- 1. Run:
-
-```bash
- $ pacman -S nodejs yarn ffmpeg postgresql openssl
-```
+ * **FFmpeg >= 3.x**
-#### Other distributions
+## Run in production
-Feel free to update this README file in a pull request!
+See the [production guide](/support/doc/production.md).
-### Build from the sources
+## Run on YunoHost
+[](https://install-app.yunohost.org/?app=peertube)
-```bash
- $ git clone -b master https://github.com/Chocobozzz/PeerTube
- $ cd PeerTube
- $ yarn install
- $ npm run build
-```
+Peertube app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/peertube_ynh).
-## Usage
+## Run using Docker
-### Production
+See the [docker guide](/support/doc/docker.md).
-If you want to run PeerTube in production (which might be a bad idea for now :) ):
+## Contribute/Translate/Test
-```bash
- $ cp config/production.yaml.example config/production.yaml
-```
-
-Then edit the `config/production.yaml` file according to your webserver
-configuration. Keys set in this file will override those of
-`config/default.yml`.
-
-Finally, run the server with the `NODE_ENV` environment variable set to
-`production`:
-
-```bash
- $ NODE_ENV=production npm start
-```
-
-The administrator password is automatically generated and can be found in the
-logs. You can set another password with:
-
-```bash
- $ NODE_ENV=production npm run reset-password -- -u root
-```
-
-**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
-
-You can check the application (CORS headers, tracker websocket...) by running:
-
-```bash
- $ NODE_ENV=production npm run check
-```
-
-### Upgrade
-
-The following commands will upgrade the source (according to your current
-branch), upgrade node modules and rebuild client application:
-
-```bash
- # systemctl stop peertube
- $ npm run upgrade-peertube
- # systemctl start peertube
-```
+See the [contributing
+guide](/.github/CONTRIBUTING.md)
+to see how to test or contribute to PeerTube (write documentation, translate, develop...). Spoiler alert: you don't need to be a
+coder to help!
-### Test with three fresh nodes
+## API REST documentation
-```bash
- $ npm run clean:server:test
- $ npm run play
-```
+Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md)
-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.
+Endpoints documentation:
-### Other commands
+ * HTML version: [/support/doc/api/html/index.html](https://htmlpreview.github.io/?https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/html/index.html)
+ * Swagger/OpenAPI schema: [/support/doc/api/openapi.yaml](/support/doc/api/openapi.yaml)
-To print all available commands, run:
+## Tools
-```bash
- $ npm run help
-```
+ * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md)
+ * [Upload videos from the CLI](/support/doc/tools.md)
+ * [Admin server tools (create transcoding jobs, prune storage...)](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/tools.md#server-tools)
-## Contributing
+## FAQ
-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!
+If you have a question, please try to find the answer in the [FAQ](/FAQ.md) first.
## Architecture
-See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explanation.
+See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation.
### Backend
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.
+ * A server is a tracker responsible for all the videos uploaded on 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.
<img src="https://lutim.cpy.re/pqKm3Q5S.png" alt="Watch a P2P video" />
</p>
+
+## 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/>.
projects / github / Chocobozzz / PeerTube.git / blobdiff