X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=956403552a77f947621667aea0a51ab765585ee6;hb=ce487e1e3b9ae46b4bea2297e13d6f8c5b3f8aeb;hp=a6f6cfab85dc82d3c676f525515da9bee6b68287;hpb=6f045b57915d0eac8e590c503b362d2df5e16b85;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index a6f6cfab8..956403552 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,14 @@
Client @@ -17,7 +21,7 @@ Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly - +
@@ -35,7 +39,7 @@ Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly - + @@ -58,25 +62,31 @@ Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly ## 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](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 ## 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. +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 (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. +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. ## Features -- [X] Frontend - - [X] Angular frontend +- [X] Angular frontend - [X] Join the fediverse - [X] Follow other instances - [X] Unfollow an instance @@ -91,8 +101,8 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t - [X] OpenGraph tags - [X] OEmbed - [X] Update video -- [X] Videos view counter -- [X] Videos likes/dislikes +- [X] Federated videos view counter +- [X] Federated videos likes/dislikes - [X] Transcoding to different definitions - [X] Download file/torrent - [X] User video bytes quota @@ -103,144 +113,65 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t - [X] User registration - [X] Video privacy settings (public, unlisted or private) - [X] Signaling a video to the admin origin PeerTube instance -- [ ] Videos comments +- [X] Federated videos comments +- [ ] Video imports (URL, Torrent, YouTube...) +- [ ] Advanced search +- [ ] Subtitles - [ ] User playlist - [ ] User subscriptions (by tags, author...) - [ ] Add "DDOS" security -## Installation +## Front compatibility -See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installation commands. + * Firefox + * Chrome/Chromium -### Front compatibility - - * Chromium - * Firefox (>= 42 for MediaSource support) - -### Dependencies +## 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: - - $ 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: - - $ 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 - -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`. - -Finally, run the server with the `production` `NODE_ENV` variable set. - - $ NODE_ENV=production npm start - -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