X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=6e54e5bdb6313d938d1295c233d607dfcfaf443f;hb=85ec3eb7f37d71be99566c6c5c43f0f8a80b9b09;hp=1a9b032015c98a655eedfcc1dc7482fe67a23419;hpb=fcc5f77b95d330bfcb439c172b7fcc58f3162e4d;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 1a9b03201..6e54e5bdb 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@

-Prototype of a decentralized video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent. +Decentralized video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent.

@@ -15,7 +15,7 @@ Prototype of a decentralized video streaming platform using P2P (BitTorrent) dir Dependency Status - + devDependency Status

@@ -26,25 +26,21 @@ Prototype of a decentralized video streaming platform using P2P (BitTorrent) dir
- Build Status + Build Status Dependencies Status - + devDependency Status - - Code climate - - JavaScript Style Guide - + PeerTube Freenode IRC @@ -78,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 @@ -97,20 +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) - [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...) -- [ ] Signaling a video to the admin pod +- [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 @@ -118,28 +121,27 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t ### Dependencies - * **NodeJS >= 4.x** + * **NodeJS >= 6.x** * **npm >= 3.x** * OpenSSL (cli) - * MongoDB - * ffmpeg + * 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) + * 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) * Add jessie backports to your *source.list*: http://backports.debian.org/Instructions/ * Run: # apt-get update - # apt-get install ffmpeg mongodb openssl - # npm install -g npm@3 + # 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 # Or npm install --unsafe-perm for root user $ npm run build @@ -158,8 +160,11 @@ Finally, run the server with the `production` `NODE_ENV` variable set. $ NODE_ENV=production npm start -**Nginx template** (reverse proxy): https://github.com/Chocobozzz/PeerTube/tree/master/support/nginx +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: @@ -180,6 +185,9 @@ In this mode, the server will run requests between pods more quickly, the videos $ npm run dev +**Username**: *root*
+**Password**: *test* + ### Test with 3 fresh nodes $ npm run clean:server:test @@ -238,7 +246,7 @@ Here are some simple schemes: Join a network -Many networks