X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=975ec169543e2b681139b54b70914a275c024b34;hb=32e574750a7b06699073ac8e98aeebaf2fa8a82d;hp=e2ffef0a13eb3105bb6d69469b9e101f8f074dca;hpb=1ca81df4d8e9b4769345690e43154aeb7b6dd335;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index e2ffef0a1..975ec1695 100644 --- a/README.md +++ b/README.md @@ -41,14 +41,18 @@ Prototype of a decentralized video streaming platform using P2P (bittorrent) dir Code climate -
- - - js-standard-style + + JavaScript Style Guide

-![screenshot](https://lutim.cpy.re/vC2loRww) +
+ +

+ + screenshot + +

## Demonstration @@ -91,10 +95,12 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t - [ ] Validate the prototype (test PeerTube in a real world with many pods and videos) - [ ] Manage 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) +- [ ] User playlists +- [ ] User subscriptions (by tags, author...) ## Installation @@ -107,6 +113,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t ### Dependencies * **NodeJS >= 4.2** + * **npm >= 3.0** * OpenSSL (cli) * MongoDB * ffmpeg xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron) @@ -119,7 +126,8 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t # 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 + # npm install -g npm@3 + # npm install -g electron #### Other distribution... (PR welcome) @@ -135,14 +143,14 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t ### Development - $ npm start + $ npm run dev ### Test with 3 fresh nodes $ npm run clean:server:test $ npm run play -Then you will can access to the three nodes at `http://localhost:900{1,2,3}`. If you call "make friends" on `http://localhost:9002`, the pod 2 and 3 will become friends. Then if you call "make friends" on `http://localhost:9001` it will become friend with the pod 2 and 3 (check the configuration files). Then the pod will communicate with each others. If you add a video on the pod 3 you'll can see it on the pod 1 and 2 :) +Then you will can access to the three nodes at `http://localhost:900{1,2,3}` with the `root` as username and `test{1,2,3}` for the password. If you call "make friends" on `http://localhost:9002`, the pod 2 and 3 will become friends. Then if you call "make friends" on `http://localhost:9001` it will become friend with the pod 2 and 3 (check the configuration files). Then the pod will communicate with each others. If you add a video on the pod 3 you'll can see it on the pod 1 and 2 :) ### Production @@ -156,6 +164,10 @@ 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 + +**Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd + ### Other commands To print all available command run: @@ -166,6 +178,13 @@ To print all available command run: You can test it inside Docker with the [PeerTube-Docker repository](https://github.com/Chocobozzz/PeerTube-Docker). Moreover it can help you to check how to create an environment with the required dependencies for PeerTube on a GNU/Linux distribution. +## Contributing + +See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/.github/CONTRIBUTING.md). + +See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md). + + ## Architecture See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITECTURE.md) for a more detailed explication. @@ -178,7 +197,7 @@ See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITE * Each server of a network has a list of all other servers of this network * When a new installed server wants to join a network, it just has to get the servers list through a server that is already in the network and tell "Hi I'm new in the network, communicate with me and share me your servers list please". Then the server will "make friend" with each server of this list * Each server has its own users who query it (search videos, where the torrent URI of this specific video is...) - * If an user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network + * If a user upload a video, the server seeds it and sends the video informations (name, short description, torrent URI...) to each server of the network * Each server has a RSA key to encrypt and sign communications with other servers * A server is a tracker responsible for all the videos uploaded in it * Even if nobody watches a video, it is seeded by the server where the video was uploaded