X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=8248e3a7c8179083b86dc0e801287b1097591f36;hb=a265f7f30fe5f25e742c99c6d43e79dfd46bf2a9;hp=248057f25a18f85279f378942c507b34523a37cb;hpb=d3b5237869d0dce6d339fef14dd0817e32b38f84;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 248057f25..8248e3a7c 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@
@@ -15,7 +15,7 @@ Prototype of a decentralized video streaming platform using P2P (bittorrent) dir - +
@@ -26,36 +26,41 @@ Prototype of a decentralized video streaming platform using P2P (bittorrent) dir+ + + +
## Demonstration Want to see 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 + * [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. ## Why @@ -69,8 +74,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t ## Features - [X] Frontend - - [X] ~~Simple frontend (All elements are generated by jQuery)~~ - - [X] Angular 2 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 @@ -88,17 +92,28 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t - [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 +- [X] Validate the prototype (test PeerTube in a real world) +- [ ] Manage inter pod 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) +- [X] Admin panel + - [X] Stats + - [X] Friends list + - [X] Manage users (create/remove) +- [X] OpenGraph tags +- [X] Update video +- [X] Videos view count +- [X] Videos likes/dislikes +- [ ] Videos comments? +- [X] User registration +- [ ] User playlists +- [ ] User subscriptions (by tags, author...) +- [X] Signaling a video to the admin origin pod ## Installation +See [wiki](https://github.com/Chocobozzz/PeerTube/wiki) for complete installation commands. + ### Front compatibility * Chromium @@ -106,55 +121,92 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t ### Dependencies - * **NodeJS >= 4.2** + * **NodeJS >= 6.x** + * **npm >= 3.x** + * yarn * OpenSSL (cli) - * MongoDB - * ffmpeg xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron) + * PostgreSQL + * FFmpeg #### Debian - * 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) + * Install NodeJS 6.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) + * Install yarn: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install) * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/ * Run: # 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 + # apt-get install ffmpeg postgresql-9.4 openssl #### Other distribution... (PR welcome) ### Sources - $ git clone https://github.com/Chocobozzz/PeerTube + $ git clone -b master https://github.com/Chocobozzz/PeerTube $ cd PeerTube - $ npm install + $ 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- + - + - + - + -
### 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. +There already is a frontend (Angular) but the backend is a REST API so anybody can 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 with its torrent URI.