Plume/docs/INSTALL.md

# How to install Plume on a Debian stretch:

## Basic setup:

```bash
apt update
apt install gettext postgresql postgresql-contrib libpq-dev
adduser plume
su - plume
cd /home/plume
git clone https://github.com/Plume-org/Plume.git
curl https://sh.rustup.rs -sSf | sh 
cd Plume
rustup toolchain install nightly
rustup toolchain default nightly
rustup update
cargo install diesel_cli --no-default-features --features postgres --version '=1.2.0' # we dont need to compile anything else than pgsql
```

## Now, if you want to run postgresql on the same server:

```bash
service postgresql start
cargo run # this will configure and launch Plume on the server.
```

## If you want to run Plume with a remote DB this time ( Postgresql is not installed on the same server/container):

* On the DB server:

```bash
service postgresql start
su - postgres
createuser -d -P plume
createdb -O plume plume
```

* On the Plume server:

```bash
cd /home/plume/Plume
diesel migration run --database-url postgres://plume:PASSWORD@DBSERVERIP:DBPORT/plume
DB_URL=postgres://plume:PASSWORD@DBSERVERIP:DBPORT/plume cargo run # the first launch will ask questions to configure the instance. A second launch will not need the DB_URL.
```

## Plume is now accessible as seen on your console. You can have fun now, or configure an nginx proxy with the following excerpt:

    location / {
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $http_host;

        proxy_pass http://localhost:8000;

        client_max_body_size 16m;
    }

# Caveats:

* Pgbouncer is not yet supported ( named transactions are used ).

* Rust nightly is a moving target, dependancies can break and sometimes you need to check a few versions to find the one working.

```bash
cd /home/plume/Plume
rustup override set nightly-2018-05-15 # this could be needed for compilation. If errors, try 2018-05-31.
# rustup override unset # remove the override for this directory.
```

* Rust nightly 2018-06-28 is known to be failing to compile diesel 1.3.2