~yerinalexey/gobin

3c6d85ab5b59a4432d8eb5449920e40cc33c549d — Alexey Yerin 10 months ago a71ab36
docs: reword
1 files changed, 12 insertions(+), 5 deletions(-)

M README.md
M README.md => README.md +12 -5
@@ 2,13 2,20 @@
Simple self-hosted service for sharing text snippets

# Installation
Two basic requirements are Go compiler (unless you grab built binaries) and
PostgreSQL database running.

## Database
Two basic requirements are Go compiler and PostgreSQL running. As soon as
PostgreSQL is running, set `DATABASE_URI` to `postgresql://`-URI:
Set `DATABASE_URI` environment variable to `postgresql://`-URI:

```sh
export DATABASE_URI=posgtresql://user:password@localhost/db
export DATABASE_URI=posgtresql://USER:PASSWORD@localhost/DB
```

Replace `USER` with your username (`postrges` is default),
`PASSWORD` with your strong and complicated password and
`DB` with database name (make sure to run `create database`).

## Configuration
If you want to change port on which application is running, set `PORT`
environment variable (4000 is default).


@@ 19,7 26,7 @@ environment variable to `http://` or `https://` + your domain

```sh
export BASE_URL=https://somesite.dev
export PORT=80
export PORT=80 # Note: you might need to run gobin as root
```

## Building


@@ 43,5 50,5 @@ files in subdirectories of `./migrations`.
./gobin
```

It's a good idea to run `gobin` binary as a system service. Make sure to
It's also a good idea to run `gobin` binary as a system service. Make sure to
provide all environment variables.