X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=68c2f907b2a04283b112a0cda1db6da9ecb3b438;hb=55fa55a9be566cca2ba95322f2ae23b434aed62a;hp=975ec169543e2b681139b54b70914a275c024b34;hpb=35165e1669f0525fbd1f6b41cf5dd076b326057b;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 975ec1695..68c2f907b 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,7 @@ 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 + * 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 @@ -99,9 +100,10 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t - [X] Stats - [X] Friends list - [X] Manage users (create/remove) +- [X] OpenGraph tags - [ ] User playlists - [ ] User subscriptions (by tags, author...) - +- [ ] Signaling a video to the admin pod ## Installation @@ -112,22 +114,21 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t ### Dependencies - * **NodeJS >= 4.2** - * **npm >= 3.0** + * **NodeJS >= 4.x** + * **npm >= 3.x** * 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 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) * 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 + # apt-get install ffmpeg postgresql-9.4 openssl # npm install -g npm@3 - # npm install -g electron #### Other distribution... (PR welcome) @@ -136,29 +137,18 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t $ git clone https://github.com/Chocobozzz/PeerTube $ cd PeerTube - $ npm install + $ npm install # Or npm install --unsafe-perm for root user $ npm run build ## Usage -### Development - - $ 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}` 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 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. @@ -168,6 +158,31 @@ Finally, run the server with the `production` `NODE_ENV` variable set. **Systemd template**: https://github.com/Chocobozzz/PeerTube/tree/master/support/systemd +You can check the application (CORS headers, tracker websocket...) by running: + + $ NODE_ENV=production npm run check + +### Upgrade + +The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application: + + # systemctl stop peertube + $ npm run upgrade + # systemctl start peertube + +### 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 + +### 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}` 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 :) + ### Other commands To print all available command run: @@ -184,6 +199,8 @@ See the [contributing guide](https://github.com/Chocobozzz/PeerTube/blob/master/ See the [server code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md). +See the [client code documentation](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md). + ## Architecture @@ -200,9 +217,8 @@ See [ARCHITECTURE.md](https://github.com/Chocobozzz/PeerTube/blob/master/ARCHITE * 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 + * Even if nobody watches a video, it is seeded by the server (throught [WebSeed protocol](http://www.bittorrent.org/beps/bep_0019.html)) where the video was uploaded * A network can live and evolve by expelling bad pod (with too many downtimes for example) - * A server **would** run webtorrent-hybrid to be a bridge with webrtc/standard bittorrent protocol See the ARCHITECTURE.md for more informations. Do not hesitate to give your opinion :) @@ -210,19 +226,19 @@ Here are some simple schemes:

-Decentralized +Decentralized -Watch a video +Watch a video -Watch a P2P video +Watch a P2P video -Join a network +Join a network -Many networks

### Frontend There already is a frontend (Angular 2) 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. +The backend uses BitTorrent protocol, so users could use their favorite BitTorrent client to download/play the video with its torrent URI.