Server: add video abuse support

[github/Chocobozzz/PeerTube.git] / README.md

diff --git a/README.md b/README.md
index efacfc7410b981336d718d01448502474728ca77..68c2f907b2a04283b112a0cda1db6da9ecb3b438 100644 (file)
--- a/README.md
+++ b/README.md
@@ -117,7 +117,7 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
   * **NodeJS >= 4.x**
   * **npm >= 3.x**
   * OpenSSL (cli)
-  * MongoDB
+  * PostgreSQL
   * ffmpeg
 
 #### Debian
@@ -127,7 +127,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)
@@ -142,24 +142,13 @@ Thanks to [WebTorrent](https://github.com/feross/webtorrent), we can make P2P (t
 
 ## 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.
 
@@ -181,6 +170,19 @@ 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
+
+### 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 +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
 
@@ -230,7 +234,7 @@ Here are some simple schemes:
 
 <img src="https://lutim.cpy.re/MyeS4q1g" alt="Join a network" />
 
-<img src="https://lutim.cpy.re/PqpTTzdP" alt="Many networks"
+<img src="https://lutim.cpy.re/PqpTTzdP" alt="Many networks" />
 
 </p>