Update INSTALL.md

Better formatting.
This commit is contained in:
Tristan Mahé 2018-06-29 10:13:58 -07:00 committed by GitHub
parent 6b1c68b89e
commit 6b44597b0f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,6 +1,8 @@
# How to install Plume on a Debian stretch: # How to install Plume on a Debian stretch:
## Basic setup: ## Basic setup:
```bash
apt update apt update
apt install gettext postgresql postgresql-contrib libpq-dev apt install gettext postgresql postgresql-contrib libpq-dev
adduser plume adduser plume
@ -12,21 +14,32 @@ cd Plume
rustup toolchain install nightly rustup toolchain install nightly
rustup override set nightly-2018-05-15 # this seems to be needed for compilation rustup override set nightly-2018-05-15 # this seems to be needed for compilation
cargo install diesel_cli --no-default-features --features postgres # we dont need to compile anything else than pgsql cargo install diesel_cli --no-default-features --features postgres # we dont need to compile anything else than pgsql
```
## Now, if you want to run postgresql on the same server: ## Now, if you want to run postgresql on the same server:
```bash
cargo run # this will configure and launch Plume on the server. 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): ## 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: * On the DB server:
```bash
service postgresql start service postgresql start
su - postgres su - postgres
createuser -d -P plume createuser -d -P plume
createdb -O plume plume createdb -O plume plume
```
* On the Plume server: * On the Plume server:
```bash
cd /home/plume/Plume cd /home/plume/Plume
diesel migration run --database-url postgres://plume:PASSWORD@DBSERVERIP:DBPORT/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. 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: ## Plume is now accessible as seen on your console. You can have fun now, or configure an nginx proxy with the following excerpt:
@ -42,4 +55,5 @@ DB_URL=postgres://plume:PASSWORD@DBSERVERIP:DBPORT/plume cargo run # the first l
} }
# Caveats: # Caveats:
* Pgbouncer is not yet supported ( named transactions are used ). * Pgbouncer is not yet supported ( named transactions are used ).