Skip to content

Commit 04efb28

Browse files
chore: update README (#2)
1 parent d07faf3 commit 04efb28

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,31 +23,43 @@ This allows you to monitor the health, duration, and success rates of pipelines
2323
docker run ghcr.io/aleksanderwww/prometheus-gitlabci-exporter:0.1.0
2424
```
2525

26+
### From GitHub releases
27+
28+
```shell
29+
wget https://github.com/alwojnarowicz/prometheus-gitlabci-exporter/releases/download/1.0.0/prometheus_gitlabci_exporter-1.0.0.tar.gz
30+
31+
tar -xzf prometheus_gitlabci_exporter-1.0.0.tar.gz
32+
33+
chmod +x prometheus_gitlabci_exporter
34+
35+
./prometheus_gitlabci_exporter
36+
```
37+
2638
### From source
2739

28-
### 1. Clone the repository
40+
#### 1. Clone the repository
2941
```bash
3042
git clone https://github.com/AleksanderWWW/prometheus-gitlabci-exporter.git
3143
cd prometheus-gitlabci-exporter
3244
```
3345

34-
### 2. Build the binary
46+
#### 2. Build the binary
3547
```bash
36-
go build -o gitlabci-exporter
48+
go build -o prometheus_gitlabci_exporter
3749
```
3850

39-
### 3. Run it
51+
#### 3. Run it
4052
You can provide your GitLab API token either via flag or environment variable.
4153

42-
#### Option A: Using environment variable
43-
```bash
54+
```shell
4455
export GITLAB_API_TOKEN="glpat-yourtoken"
45-
./gitlabci-exporter
56+
./prometheus_gitlabci_exporter
4657
```
4758

48-
#### Option B: Using CLI flag
59+
or
60+
4961
```bash
50-
./gitlabci-exporter --api.token="glpat-yourtoken"
62+
./prometheus_gitlabci_exporter --api.token="glpat-yourtoken"
5163
```
5264

5365
---

0 commit comments

Comments
 (0)