Try to improve documentations/readme

4 files changed, 257 insertions, 21 deletions

diff --git a/support/doc/dependencies.md b/support/doc/dependencies.md
new file mode 100644
index 000000000..d77724b5a
--- /dev/null
+++ b/support/doc/dependencies.md
@@ -0,0 +1,29 @@
+# Installation
+
+## Dependencies
+
+### Debian / Ubuntu
+
+  1. Install NodeJS 8.x (current 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)
+  2. Install yarn:
+     [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
+  4. Run:
+
+```bash
+$ apt-get update
+$ apt-get install nginx ffmpeg postgresql openssl g++ make
+```
+
+### Arch Linux
+
+  1. Run:
+
+```bash
+$ pacman -S nodejs yarn ffmpeg postgresql openssl
+```
+
+### Other distributions
+
+Feel free to update this file in a pull request!
+
diff --git a/support/doc/development/client/code.md b/support/doc/development/client/code.md
index ddd277e54..749783c29 100644
--- a/support/doc/development/client/code.md
+++ b/support/doc/development/client/code.md
@@ -53,12 +53,7 @@ Details of the Angular application file structure. It tries to follow [the offic
 
 Uses [TSLint](https://palantir.github.io/tslint/) for TypeScript linting and [Angular styleguide](https://angular.io/docs/ts/latest/guide/style-guide.html).
 
-## Developing
-
-  * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies)
-  * Run `yarn install --pure-lockfile` at the root directory to install all the dependencies
-  * Run PostgreSQL and create the database `peertube_dev`.
-  * Run `npm run dev:client` to compile the client, run the server, watch client files modifications and reload modules on the fly (you don't need to refresh manually the web browser). The API listen on `localhost:9000` and the client on `localhost:3000`.
+## Concepts
 
 In a Angular application, we create components that we put together. Each component is defined by an HTML structure, a TypeScript file and optionally a SASS file.
 If you are not familiar with Angular I recommend you to read the [quickstart guide](https://angular.io/docs/ts/latest/quickstart.html).
diff --git a/support/doc/development/server/code.md b/support/doc/development/server/code.md
index d909b0c3d..ddb93119b 100644
--- a/support/doc/development/server/code.md
+++ b/support/doc/development/server/code.md
@@ -36,21 +36,6 @@ All other server files are in the [server](https://github.com/Chocobozzz/PeerTub
 
 Uses [JavaScript Standard Style](http://standardjs.com/).
 
-
-## Developing
-
-  * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies)
-  * Run `yarn install` at the root directory to install all the dependencies
-  * Run PostgreSQL and create the database `peertube_dev`.
-  * Run `npm run dev:server` to run the server, watch server files modifications and restart it automatically. The server (API + client) listen on `localhost:9000`.
-
-The `NODE_ENV=test` is set to speed up communications between instances (see [constants.ts](https://github.com/Chocobozzz/PeerTube/blob/master/server/initializers/constants.ts)).
-
-`npm run help` gives you all available commands.
-
-If you want to test the decentralization feature, you can easily run 3 instances by running `npm run play`. The instances password are `test1`, `test2` and `test3`.
-
-
 ## Architecture
 
 The server is composed by:
diff --git a/support/doc/production.md b/support/doc/production.md
new file mode 100644
index 000000000..4d7c14f2b
--- /dev/null
+++ b/support/doc/production.md
@@ -0,0 +1,227 @@
+# Production guide
+
+## Installation
+
+### Dependencies
+
+Follow the steps of the [dependencies guide](dependencies.md).
+
+### PeerTube user
+
+Create a `peertube` user with `/home/peertube` home:
+
+```bash
+sudo useradd -m -d /home/peertube -s /bin/bash -p peertube peertube
+sudo passwd peertube
+```
+
+### Database
+
+Create production database and peertube user:
+
+```bash
+sudo -u postgres createuser -P peertube
+sudo -u postgres createdb -O peertube peertube_prod
+```
+
+### Sources
+
+Clone, install node dependencies and build application:
+
+```bash
+$ cd /home/peertube
+$ sudo -u peertube git clone -b master https://github.com/Chocobozzz/PeerTube
+$ cd PeerTube
+$ sudo -u peertube yarn install --pure-lockfile
+$ sudo -u peertube npm run build
+```
+
+### PeerTube configuration
+
+Copy example configuration:
+
+```bash
+$ sudo -u peertube 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`.
+
+### Webserver
+
+Copy the nginx configuration template:
+
+```bash
+$ sudo cp /home/peertube/PeerTube/support/nginx/peertube-https /etc/nginx/sites-available/peertube
+```
+
+Then modify the webserver configuration file. Please pay attention to the `alias` key of `/static/webseed` location. 
+It should correspond to the path of your videos directory (set in the configuration file as `storage->videos` key).
+
+```bash
+$ sudo vim /etc/nginx/sites-available/peertube
+```
+
+If you want to set https with Let's Encrypt please follow the steps of [this guide](https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-16-04).
+
+An example of the nginx configuration could be:
+
+```
+server {
+  listen 80;
+  listen [::]:80;
+  server_name peertube.example.com;
+
+  access_log /var/log/nginx/peertube.example.com.access.log;
+  error_log /var/log/nginx/peertube.example.com.error.log;
+
+  rewrite ^ https://$server_name$request_uri? permanent;
+}
+
+server {
+  listen 443 ssl http2;
+  listen [::]:443 ssl http2;
+  server_name peertube.example.com;
+
+  # For example with Let's Encrypt
+  ssl_certificate      /etc/letsencrypt/live/peertube.example.com/fullchain.pem;
+  ssl_certificate_key  /etc/letsencrypt/live/peertube.example.com/privkey.pem;
+  ssl_trusted_certificate /etc/letsencrypt/live/peertube.example.com/chain.pem;
+
+  access_log /var/log/nginx/peertube.example.com.access.log;
+  error_log /var/log/nginx/peertube.example.com.error.log;
+
+  location ^~ '/.well-known/acme-challenge' {
+    default_type "text/plain";
+    root /var/www/certbot;
+  }
+
+  location / {
+    proxy_pass http://localhost:9000;
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header Host $host;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+
+    # For the video upload
+    client_max_body_size 8G;
+    proxy_connect_timeout       600;
+    proxy_send_timeout          600;
+    proxy_read_timeout          600;
+    send_timeout                600;
+  }
+
+  # Bypass PeerTube webseed route for better performances
+  location /static/webseed {
+    if ($request_method = 'OPTIONS') {
+      add_header 'Access-Control-Allow-Origin' '*';
+      add_header 'Access-Control-Allow-Methods' 'GET, OPTIONS';
+      add_header 'Access-Control-Allow-Headers' 'Range,DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type';
+      add_header 'Access-Control-Max-Age' 1728000;
+      add_header 'Content-Type' 'text/plain charset=UTF-8';
+      add_header 'Content-Length' 0;
+      return 204;
+    }
+
+    if ($request_method = 'GET') {
+      add_header 'Access-Control-Allow-Origin' '*';
+      add_header 'Access-Control-Allow-Methods' 'GET, OPTIONS';
+      add_header 'Access-Control-Allow-Headers' 'Range,DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type';
+    }
+
+    alias /var/www/PeerTube/videos;
+  }
+
+  # Websocket tracker
+  location /tracker/socket {
+    # Peers send a message to the tracker every 15 minutes
+    # Don't close the websocket before this time
+    proxy_read_timeout 1200s;
+    proxy_set_header Upgrade $http_upgrade;
+    proxy_set_header Connection "upgrade";
+    proxy_http_version 1.1;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $host;
+    proxy_pass http://localhost:9000;
+  }
+}
+```
+
+
+Activate the configuration file:
+
+```bash
+$ sudo ln -s /etc/nginx/sites-available/peertube /etc/nginx/sites-enabled/peertube
+$ sudo systemctl reload nginx
+```
+
+### Systemd
+
+Copy the nginx configuration template:
+
+```bash
+sudo cp /home/peertube/PeerTube/support/systemd/peertube.service /etc/systemd/system/
+```
+
+Update the service file:
+
+```bash
+sudo vim /etc/systemd/system/peertube.service
+```
+
+It should look like this:
+
+```
+[Unit]
+Description=PeerTube daemon
+After=network.target
+
+[Service]
+Type=simple
+Environment=NODE_ENV=production
+User=peertube
+Group=peertube
+ExecStart=/usr/bin/npm start
+WorkingDirectory=/home/peertube/PeerTube
+StandardOutput=syslog
+StandardError=syslog
+SyslogIdentifier=peertube
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
+```
+
+
+Tell systemd to reload its config:
+
+```bash
+sudo systemctl daemon-reload
+```
+
+### Run
+
+```bash
+sudo systemctl start peertube
+sudo journalctl -feu peertube
+```
+
+### Administrator
+
+The administrator password is automatically generated and can be found in the
+logs. You can set another password with:
+
+```bash
+$ NODE_ENV=production npm run reset-password -- -u root
+```
+
+## Upgrade
+
+The following commands will upgrade the source (according to your current
+branch), upgrade node modules and rebuild client application:
+
+```bash
+# systemctl stop peertube
+$ npm run upgrade-peertube
+# systemctl start peertube
+```