From f60f4273580ebee4d10f90029d79a037cd844643 Mon Sep 17 00:00:00 2001 From: Bat Date: Sat, 6 Oct 2018 16:39:33 +0100 Subject: [PATCH] Document --features --- docs/INSTALL.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/INSTALL.md b/docs/INSTALL.md index a3a5e4c1..fcdd57d4 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -125,6 +125,12 @@ Plume needs to be compiled from source. To download the code, run: ```bash git clone https://github.com/Plume-org/Plume.git cd Plume + +# If you want PostgreSQL +export FEATURES=postgres + +# If you want SQlite +export FEATURES=sqlite ``` ## Running migrations @@ -132,7 +138,7 @@ cd Plume Migrations are scripts used to update the database. They are run by a tool called Diesel, which can be installed with: ```bash -cargo install diesel_cli --no-default-features --features postgres --version '=1.3.0' +cargo install diesel_cli --no-default-features --features $FEATURES --version '=1.3.0' ``` To run the migrations, you can do: @@ -153,7 +159,8 @@ When in doubt, run them. Then, you'll need to install Plume and the CLI tools to manage your instance. ``` -cargo install && cargo install --path plume-cli +cargo install --no-default-features --features $FEATURES +cargo install --no-default-features --features $FEATURES --path plume-cli ``` Before starting Plume, you'll need to create a configuration file, called `.env`. Here is a sample of what you should put inside.