X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=22ee2270169fa2c596c1bdea2fad9e73f5225852;hb=6b684b616e5d3e068428c39cbf6203cb506a6dc3;hp=e2a5a7251fc734e9c69328d99b45859e8e59dc9b;hpb=9a989f8164fec08b01ea4166b6f938bd85de0a6b;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index e2a5a7251..22ee22701 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,14 @@ PeerTube -

-Decentralized video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent. -

+

+Federated (ActivityPub) video streaming platform using P2P (BitTorrent) +directly in the web browser with WebTorrent. +

-**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/).** +

+We are running a crowdfunding campaign to pave the road to version 1.0 of PeerTube! +

Client @@ -17,9 +20,13 @@ Decentralized video streaming platform using P2P (BitTorrent) directly in the we Dependency Status - + devDependency Status + + + +

@@ -35,7 +42,7 @@ Decentralized video streaming platform using P2P (BitTorrent) directly in the we Dependencies Status - + devDependency Status @@ -56,192 +63,103 @@ Decentralized video streaming platform using P2P (BitTorrent) directly in the we

+## Getting Started + + * **[Website](https://joinpeertube.org)** + * **[Instances list](https://instances.joinpeertube.org)** + ## Demonstration -Want to see in action? +Want to see it in action? - * [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. + * 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 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 -We 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. - -So we need to have a decentralized network (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 right now. - -## 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 +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. + +## Dependencies + * nginx + * PostgreSQL + * Redis * **NodeJS >= 8.x** * yarn * OpenSSL (cli) - * PostgreSQL - * FFmpeg - -#### Debian - - 1. Install NodeJS 6.x (previous 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) - 3. Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/ - 4. Run: - - $ apt-get update - $ apt-get install ffmpeg postgresql-9.4 openssl - -#### Ubuntu 16.04 - - 1. Install NodeJS 8.x (current LTS): (same as Debian) - 2. Install yarn: (same as Debian) - 3. Run: - - $ apt-get update - $ apt-get install ffmpeg postgresql openssl - -#### Other distribution... (PR welcome) - - -### Sources - - $ git clone -b master https://github.com/Chocobozzz/PeerTube - $ cd PeerTube - $ yarn install - $ npm run build - -## Usage - -### Production + * **FFmpeg >= 3.x** -If you want to run PeerTube for production (bad idea for now :) ): +## Run using Docker - $ cp config/production.yaml.example config/production.yaml +See the [docker guide](/support/doc/docker.md) -Then edit the `config/production.yaml` file according to your webserver configuration. Keys set in this file will override those of `config/default.yml`. +## Run on YunoHost +[![Install Peertube with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=peertube) -Finally, run the server with the `production` `NODE_ENV` variable set. +Peertube app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/peertube_ynh) - $ NODE_ENV=production npm start +## Production -The administrator password is automatically generated and can be found in the logs. You can set another password with: +See the [production guide](/support/doc/production.md). - $ NODE_ENV=production npm run reset-password -- -u root +## Contribute/Translate/Test -**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx
-**Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd +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! -You can check the application (CORS headers, tracker websocket...) by running: +## API REST documentation - $ NODE_ENV=production npm run check +Quick Start: [/support/doc/api/quickstart.md](/support/doc/api/quickstart.md) -### Upgrade +Endpoints documentation: -The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application: + * 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) - # systemctl stop peertube - $ npm run upgrade-peertube - # systemctl start peertube +## Tools -### Development + * [Import videos (YouTube, Dailymotion, Vimeo...)](/support/doc/tools.md) + * [Upload videos from the CLI](/support/doc/tools.md) -In this mode, the server will run requests between instances more quickly, the video durations are limited to a few seconds. - -To develop on the server-side (server files are automatically compiled when we modify them and the server restarts automatically too): - - $ npm run dev:server - -The server (with the client) will listen on `localhost:9000`. - - -To develop on the client side (client files are automatically compiled when we modify them): - - $ npm run dev:client - -The 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). - -**Username**: *root*
-**Password**: *test* - -### Test with 3 fresh nodes - - $ npm run clean:server:test - $ npm run play - -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. - -### Other commands - -To print all available command run: - - $ npm run help - -## Contributing - -See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md). - -See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md). - -See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md). +## FAQ +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 explication. +See [ARCHITECTURE.md](/ARCHITECTURE.md) for a more detailed explanation. ### 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, where the torrent URI of this specific video is...) - * If a user upload a video, the server seeds it and sends the video information (name, short description, torrent URI...) its followers - * 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 + * 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. Here are some simple schemes: @@ -254,3 +172,20 @@ Here are some simple schemes: Watch a P2P video

+ +## 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 .