X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=88eac088a1471f5c91a11acab7eafd3692cd5b4d;hb=e1a540b5fa14b0fafa63f99e344927b10fdbee00;hp=8c43cb965f42f28b7a7a87255ef6bc05e23f4e7e;hpb=023553a2bde74c5765b5ea679fc04128c27f18a0;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 8c43cb965..88eac088a 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,15 @@
Client
@@ -15,9 +21,13 @@ Decentralized video streaming platform using P2P (BitTorrent) directly in the we
-
+
+
+
+
+
@@ -33,7 +43,7 @@ Decentralized video streaming platform using P2P (BitTorrent) directly in the we
-
+
@@ -49,207 +59,129 @@ Decentralized video streaming platform using P2P (BitTorrent) directly in the we
+ Website | + Instances list + +
+ ## Demonstration -Want to see in action? +Want to see it in action? - * 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 - * 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](http://peertube.cpy.re) + * [peertube2.cpy.re](http://peertube2.cpy.re) + * [peertube3.cpy.re](http://peertube3.cpy.re) + * [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 enought money to pay bandwith 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 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. - -## Features - -- [X] Frontend - - [X] Angular 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) -- [X] Validate the prototype (test PeerTube in a real world) -- [ ] Manage API breaks -- [ ] Add "DDOS" security (check if a pod don't send too many requests for example) -- [X] Admin panel - - [X] Stats - - [X] Friends list - - [X] Manage users (create/remove) -- [X] OpenGraph tags -- [ ] User playlists -- [ ] User subscriptions (by tags, author...) -- [X] Signaling a video to the admin origin pod -- [X] Videos view count -- [X] Videos likes/dislikes -- [ ] Videos comments? - -## Installation - -### Front compatibility - - * Chromium - * Firefox (>= 42 for MediaSource support) - -### Dependencies - - * **NodeJS >= 4.x** - * **npm >= 3.x** - * OpenSSL (cli) - * PostgreSQL - * FFmpeg - -#### Debian - - * Install NodeJS 4.x (actual 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) - * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/ - * Run: - - # apt-get update - # apt-get install ffmpeg postgresql-9.4 openssl - # npm install -g npm@3 - -#### Other distribution... (PR welcome) - - -### Sources - - $ git clone -b master https://github.com/Chocobozzz/PeerTube - $ cd PeerTube - $ npm install # Or npm install --unsafe-perm for root user - $ npm run build - -## Usage - -### Production - -If you want to run PeerTube for production (bad idea for now :) ): - - $ 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`. +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. -Finally, run the server with the `production` `NODE_ENV` variable set. +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. - $ NODE_ENV=production npm start +## Dependencies -The administrator password is automatically generated and can be found in the logs. You can set another password with: - - $ NODE_ENV=production npm run reset-password -- -u root - -**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx - -**Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd - -You can check the application (CORS headers, tracker websocket...) by running: - - $ NODE_ENV=production npm run check - -See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installation commands. - -### Upgrade - -The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application: - - # systemctl stop peertube - $ npm run upgrade - # systemctl start peertube - -### Development - -In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds and the client files are automatically compiled when we modify them: - - $ npm run dev + * nginx + * PostgreSQL + * Redis + * **NodeJS >= 8.x** + * yarn + * OpenSSL (cli) + * **FFmpeg >= 3.x** -**Username**: *root*
-
+
+
+
-
+
-
+