Plume/docs/INSTALL.md

Installing Plume (for development or production)

Prerequisites

In order to be installed and to work correctly, Plume needs:

• Git
• PostgreSQL
• GetText
• Rust and Cargo

All the following instructions will need a terminal.

Here are the commands to install PostgreSQL and GetText on various operating systems. Some of them may need root permissions.

On Debian:

apt update
apt install gettext postgresql postgresql-contrib libpq-dev git

On Fedora, CentOS or RHEL:

dnf install postgresql-server postgresql-contrib mariadb-devel libsq3-devel libpqxx libpqxx-devel
# TODO: GetText + Git install

On Gentoo:

emerge --sync
emerge -av postgresql eselect-postgresql
# TODO: GetText + Git install

On Mac OS X, with Homebrew:

brew update
brew install postgres
# TODO: GetText + Git install

Creating a new user (optional)

This step is recommended if you are in a production environment, but it is not necessary.

adduser plume
su - plume
cd ~

Creating a new user will let you use systemd to manage Plume if you want (see the dedicated section below).

Installing Rust and Cargo

We said that Plume needed Rust and Cargo to work, but we didn't installed them at the same time as PostgreSQL and GetText, because there is an universal installation method called RustUp.

You can install it on GNU/Linux and Mac OS X with:

curl https://sh.rustup.rs -sSf | sh

On Windows, you'll need, if you don't already have them, to download and install the Visual C++ 2015 Build Tools. Then, download the rustup installer and run it.

Getting and compiling the Plume source code

Plume needs to be compiled from source.

git clone https://github.com/Plume-org/Plume.git
cd Plume

# This may take some time as RustUp will download all
# the required Rust components, and Cargo will download
# and compile all dependencies.
cargo build

We may provide precompiled packages and Docker images in the future (if you have experience in these fields and want to help, you're welcome).

Configuring PostgreSQL

You can either run PostgreSQL from the machine that runs Plume, or from another server. We recommend you to use the first setup for development environments, or in production for small instances.

In the first case, just run this command after the PostgreSQL installation, to start it:

service postgresql start

If you want to have two separate machines, run these commands on the database server after you installed the dependencies mentionned above on both servers:

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

Running migrations

Migrations are scripts to update the database. They are run by a tool called Diesel, which can be installed with:

cargo install diesel_cli --no-default-features --features postgres --version '=1.2.0'

Plume should normally run migrations for you when needed, but if you want to run them manually, the command is:

diesel migration run --database-url postgres://USER:PASSWORD@IP:PORT/plume

This command may be useful if you decided to use a separate database server.

Starting Plume

When you launch Plume for the first time, it will ask you a few questions to setup your instance before it actually launches. To start it, run these commands.

# Optional, only do it if the database URL is not
# postgres://plume:plume@localhost/plume
export DB_URL=postgres://plume:PASSWORD@DBSERVERIP:DBPORT/plume

cargo run

Configuring Nginx

Here is a sample Nginx configuration for a Plume instance:

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:7878;

    client_max_body_size 16m;
}

Systemd integration

If you want to manage your Plume instance with systemd, you can use the following unit file (to be saved in /lib/systemd/system/plume.service):

[Unit]
Description=plume

[Service]
Type=simple
User=plume
WorkingDirectory=/home/plume/Plume
ExecStart=/home/plume/.cargo/bin/cargo run
TimeoutSec=30
Restart=always

[Install]
WantedBy=multi-user.target

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 (run rustup override set nightly-2018-05-15 or rustup override set nightly-2018-05-31 in the Plume directory if you have issues during the compilation)
• Rust nightly 2018-06-28 is known to be failing to compile diesel 1.3.2

Acknowledgements

Most of this documentation have been written by gled-rs. The systemd unit file have been written by nonbinaryanargeek. Some parts (especially the instructions to install native dependencies) are from the Aardwolf project.