Skip to content

Commit

Permalink
docs: add "install from devel" mini-howto
Browse files Browse the repository at this point in the history
  • Loading branch information
lesovsky committed Mar 17, 2019
1 parent 450bc6c commit 30936b4
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion doc/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [General notes](#general-notes)
- [Download](#download)
- [Install devel](#install-from-dev-branch)
- [Run in Docker](#run-in-docker)
- [pgCenter usage](#pgcenter-usage)
---
Expand All @@ -14,6 +15,24 @@
#### Download
Download latest release from [release page](https://github.com/lesovsky/pgcenter/releases) and unpack, after that pgCenter is ready to run.

#### Install from dev branch
- Install fresh version of `golang` into the system. Install it with package manager or download it directly from the [official site](https://golang.org/dl/). In this case after downloading you need to unpack the archive and copy binaries into the $PATH.
- Clone pgcenter's repo, switch to `dev` branch.
```
git clone https://github.com/lesovsky/pgcenter
cd pgcenter
git checkout --track origin/dev
```
- Build `pgcenter` using `Makefile`. It supposes `go` binary is already is in the PATH.
```
make
```
- Optionally you can install `pgcenter` into `/usr/bin` using `Makefile`. Root privileges required.
```
make install
```
Now `pgcenter` is ready for use.

#### Run in Docker
```
docker build -t pgcenter .
Expand Down Expand Up @@ -67,4 +86,4 @@ Full list of available parameters available in a built-in help for particular co
```
pgcenter report --help
```
```

0 comments on commit 30936b4

Please sign in to comment.