X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=778762ebf2ab5fcf5edf271fc307007d1aecc1a3;hb=2fec520605bc8919cc71ab6565bf55d8a79925ca;hp=efacfc7410b981336d718d01448502474728ca77;hpb=900f0d2b3cc5035568ffa0853101a12c6abcffdc;p=github%2FChocobozzz%2FPeerTube.git
diff --git a/README.md b/README.md
index efacfc741..778762ebf 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.
+Prototype of a 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
-
+
@@ -37,13 +37,13 @@ Prototype of a decentralized video streaming platform using P2P (bittorrent) dir
-
-
-
-
+
+
+
+
@@ -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
@@ -103,7 +102,7 @@ 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
## Installation
@@ -117,8 +116,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 +126,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,36 +134,29 @@ 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
## 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.
$ 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
@@ -181,6 +173,21 @@ The following commands will upgrade the source (according to your current branch
$ 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
+
+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
+ $ 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:
@@ -197,6 +204,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
@@ -230,7 +239,7 @@ Here are some simple schemes:
-