X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=8248e3a7c8179083b86dc0e801287b1097591f36;hb=a265f7f30fe5f25e742c99c6d43e79dfd46bf2a9;hp=9dab73d0909d2a20e481429cf06560194a8274d7;hpb=732bd032409c7ccee44654b26ea1394478c63212;p=github%2FChocobozzz%2FPeerTube.git
diff --git a/README.md b/README.md
index 9dab73d09..8248e3a7c 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
-
+
@@ -26,31 +26,31 @@ Prototype of a decentralized video streaming platform using P2P (bittorrent) dir
-
+
-
+
-
-
-
-
+
+
+
+
-
-
+
+
@@ -58,8 +58,9 @@ Prototype of a decentralized video streaming platform using P2P (bittorrent) dir
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
@@ -73,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
@@ -92,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 videos
+- [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
@@ -110,57 +121,92 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
### Dependencies
- * **NodeJS >= 4.2**
- * **npm >= 3.0**
+ * **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 npm@3
- # 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
+**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-peertube
+ # systemctl start peertube
+
### Development
- $ npm run dev
+In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds.
-### Test with 3 fresh nodes
+To develop on the server side (server files are automatically compiled when we modify them and the server restarts automatically too):
- $ npm run clean:server:test
- $ npm run play
+ $ npm run dev:server
-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 :)
+The server (with the client) will listen on `localhost:9000`.
-### Production
-If you want to run PeerTube for production (bad idea for now :) ):
+To develop on the client side (client files are automatically compiled when we modify them):
- $ cp config/production.yaml.example config/production.yaml
+ $ npm run dev:client
-Then edit the `config/production.yaml` file according to your webserver configuration.
+The API will listen on `localhost:9000` and the frontend on `localhost:3000` (with hot module replacement, you don't need to refresh the web browser).
-Finally, run the server with the `production` `NODE_ENV` variable set.
+**Username**: *root*
+**Password**: *test*
- $ NODE_ENV=production npm start
+### 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
@@ -178,6 +224,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
@@ -194,9 +242,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 :)
@@ -204,19 +251,19 @@ Here are some simple schemes:
-
+
-
+
-
+
-
+
-
### 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.
+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.