Skip to content

Commit

Permalink
installment doc page (#39)
Browse files Browse the repository at this point in the history
main focus is to be software (not library),
so we had to tinker with the architecture

sorry for the inconvenience

Signed-off-by: Avelino <t@avelino.xxx>
  • Loading branch information
avelino committed Aug 21, 2020
1 parent 7d1b5c1 commit 317a45e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
12 changes: 6 additions & 6 deletions content/getting-started/already-have-db.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ weight: 4

Even though there were four ways to install pREST there's mostly two ways to run it.

1. [With the binary or homebrew or go get](/getting-started/running/#with-the-binary-or-homebrew-or-go-get)
1. [With the binary or homebrew or go install](/getting-started/running/#with-the-binary-or-homebrew-or-go-install)
1. [With Docker or Docker Compose](/getting-started/running/#with-docker)


### With the binary or homebrew or go get
### With the binary or homebrew or go install

If you install pREST by downloading the binary or using Homebrew or using go get, you must pass the necessary variables binary as follows:
If you install pREST by downloading the binary or using Homebrew or using go install, you must pass the necessary variables binary as follows:

```sh
PREST_PG_USER=postgres \
PREST_PG_DATABASE=prest \
PREST_PG_PORT=5432 \
PREST_HTTP_PORT=3010 \
prest # Binary installed
prestd # Binary installed
```

### With docker
Expand All @@ -36,11 +36,11 @@ docker run -e PREST_HTTP_PORT=3000 \
-e PREST_PG_USER=postgres \
-e PREST_PG_PASS=pass \
-e PREST_PG_DATABASE=prest \
prest/prest
prest/prest:v1
```
if you want to connect to a database running on the host machine you can add `--network host` param.

or if use Docker Compose (there's an [example in the repository](https://github.com/prest/prest/blob/master/docker-compose.yml))
or if use Docker Compose (there's an [example in the repository](https://github.com/prest/prest/blob/master/docker-compose-prod.yml))

```sh
docker-compose up
Expand Down
8 changes: 4 additions & 4 deletions content/getting-started/installation.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Here are all the ways you can install pREST, choose one that best fits your need

1. [Downloading the binary](/getting-started/installation/#downloading-the-binary)
1. [With Docker](/getting-started/installation/#with-docker)
1. [Using go get](/getting-started/installation/#using-go-get)
1. [Using go install](/getting-started/installation/#using-go-install)
1. [With Homebrew](/getting-started/installation/#with-homebrew)

### Downloading the binary
Expand All @@ -26,13 +26,13 @@ For any OS you can download the latest version [here](https://github.com/prest/p
We only will need to download the pREST image from Docker Hub with:

```sh
docker pull prest/prest
docker pull prest/prest:v1
```

### Using go get
### Using go install

```sh
go get -u github.com/prest/prest
go install github.com/prest/prest/cmd/prestd
```

### With Homebrew
Expand Down

0 comments on commit 317a45e

Please sign in to comment.