Skip to content

Commit 33a6e59

Browse files
authored
[+] mention Apt installation option in docs. (#1043)
* Mention `PostgreSQL apt` as a new installation method. * Remove `go install ...` it will be automatically done by go. * Use `go generate ...` instead of the protoc command. * Move protoc installation to a separate step.
1 parent 2214bad commit 33a6e59

File tree

1 file changed

+24
-13
lines changed

1 file changed

+24
-13
lines changed

docs/tutorial/custom_installation.md

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ visualize the gathered metrics.
1616
is required but the latest major version is recommended.
1717
1. Bootstrap the configuration database.
1818
1. Bootstrap the metrics measurements storage database aka sink (PostgreSQL here).
19-
1. Install pgwatch - either from pre-built packages or by compiling
20-
the Go code.
19+
1. Install pgwatch
2120
1. [Prepare](preparing_databases.md) the "to-be-monitored" databases for monitoring by creating
2221
a dedicated login role name as a minimum.
2322
1. Add some databases to the monitoring configuration via the Web UI, REST API or
@@ -54,16 +53,21 @@ syntax differences.
5453
/ RedHat based systems
5554
- <https://www.postgresql.org/download/windows/> - for Windows
5655

57-
1. **Install pgwatch** either from pre-built packages or by
58-
compiling the Go code
56+
1. **Install pgwatch**
57+
58+
- For Debian/Ubuntu, add the official [PostgreSQL Apt Repository](https://wiki.postgresql.org/wiki/Apt#Quickstart) then:
59+
60+
```bash
61+
sudo apt update && sudo apt install pgwatch
62+
```
5963

6064
- Using pre-built packages which are available on the
6165
[GitHub releases](https://github.com/cybertec-postgresql/pgwatch/releases)
6266
page:
6367

6468
```terminal
65-
# find out the latest package link and replace below, using v3.0 here
66-
wget https://github.com/cybertec-postgresql/pgwatch/releases/download/3.0.0/pgwatch_Linux_x86_64.deb
69+
# find out the latest package link and replace below, using v4.0 here
70+
wget https://github.com/cybertec-postgresql/pgwatch/releases/download/v4.0.0/pgwatch_Linux_x86_64.deb
6771
sudo dpkg -i pgwatch_Linux_x86_64.deb
6872
```
6973

@@ -72,17 +76,25 @@ syntax differences.
7276
This method of course is not needed unless dealing with maximum
7377
security environments or some slight code changes are required.
7478

75-
1. Install Go by following the [official
76-
instructions](https://golang.org/doc/install)
79+
1. Install Go by following the [official instructions](https://golang.org/doc/install)
80+
81+
2. Install Protoc and protoc plugins for Go by following the [official instructions](https://grpc.io/docs/languages/go/quickstart/)
7782

78-
2. Get the pgwatch project's code and compile the gatherer
83+
3. Get the pgwatch project's code and compile the gatherer
7984
daemon
8085
81-
```terminal
86+
```bash
87+
# Clone the Repo
8288
git clone https://github.com/cybertec-postgresql/pgwatch.git
89+
90+
# Build the webui
8391
cd pgwatch/internal/webui
8492
yarn install --network-timeout 100000 && yarn build
85-
cd ../..
93+
94+
# generate the Go code from protobuf files
95+
cd ../../ && go generate ./api/pb
96+
97+
# Compile pgwatch
8698
go build ./cmd/pgwatch/
8799
```
88100
@@ -303,8 +315,7 @@ paragraph.
303315
is required but the latest major version is recommended.
304316
1. Edit the YAML file to include the sources to be monitored.
305317
1. Bootstrap the metrics measurements storage database aka sink (PostgreSQL here).
306-
1. Install pgwatch - either from pre-built packages or by compiling
307-
the Go code.
318+
1. Install pgwatch
308319
1. [Prepare](preparing_databases.md) the "to-be-monitored" databases for monitoring by creating
309320
a dedicated login role name as a minimum.
310321
1. Add some databases to the monitoring configuration via the Web UI, REST API or

0 commit comments

Comments
 (0)