X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=1db3d9fc90eea1baed6bf93458a49361c89c6493;hb=f6e692f5ee2a0e8e1fcb75df1949b354a014ad50;hp=d3adcb94fd20a764526a11675c0567a5add8828b;hpb=fd8e5e3c6b124408b6bc8b12563d3d9a7101a5fa;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index d3adcb94f..1db3d9fc9 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.

@@ -26,7 +26,7 @@ Prototype of a decentralized video streaming platform using P2P (bittorrent) dir
- Build Status + Build Status @@ -37,13 +37,13 @@ Prototype of a decentralized video streaming platform using P2P (bittorrent) dir devDependency Status - - Code climate - - JavaScript Style Guide + + + PeerTube Freenode IRC +


@@ -74,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 @@ -93,7 +92,7 @@ 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) +- [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 @@ -103,7 +102,10 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t - [X] OpenGraph tags - [ ] User playlists - [ ] User subscriptions (by tags, author...) -- [ ] Signaling a video to the admin pod +- [X] Signaling a video to the admin origin pod +- [X] Videos view count +- [X] Videos likes/dislikes +- [ ] Videos comments? ## Installation @@ -117,8 +119,8 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t * **NodeJS >= 4.x** * **npm >= 3.x** * OpenSSL (cli) - * MongoDB - * ffmpeg + * PostgreSQL + * FFmpeg #### Debian @@ -127,7 +129,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t * Run: # apt-get update - # apt-get install ffmpeg mongodb openssl + # apt-get install ffmpeg postgresql-9.4 openssl # npm install -g npm@3 #### Other distribution... (PR welcome) @@ -135,7 +137,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t ### 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 @@ -148,12 +150,16 @@ 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. +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 **Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd @@ -172,8 +178,12 @@ The following commands will upgrade the source (according to your current branch ### 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 +The administrator password is displayed in the command output and can be found in the logs. + ### Test with 3 fresh nodes $ npm run clean:server:test @@ -232,7 +242,7 @@ Here are some simple schemes: Join a network -Many networks