Skip to content

Commit d3d22fa

Browse files
author
Anze
committed
Improve installation instructions
1 parent 91508bc commit d3d22fa

File tree

3 files changed

+9
-6
lines changed

3 files changed

+9
-6
lines changed

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
BACKEND_URL=https://grafolean.com/api
22
BOT_TOKEN=
3-
JOBS_REFRESH_INTERVAL=60
3+
JOBS_REFRESH_INTERVAL=60

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,17 @@ Docker is the easiest and currently the only officially supported way. Note that
3030
$ wget https://gitlab.com/grafolean/grafolean-collector-ping/raw/master/docker-compose.yml
3131
```
3232
33-
3) edit `docker-compose.yml` and change:
33+
3) These settings must be set:
34+
3435
- mandatory: `BACKEND_URL` (set to the URL of Grafolean backend, for example `https://grafolean.com/api`),
3536
- mandatory: `BOT_TOKEN` (set to the bot token from step 1),
3637
- optional: `JOBS_REFRESH_INTERVAL` (interval in seconds at which the jobs definitions will be updated)
37-
Alternatively, you can also copy `.env.example` to `.env` and change settings there (leaving `docker-compose.yml` in original state).
38+
39+
The easiest way to set them is to download example `.env` and edit it:
40+
```
41+
$ wget https://gitlab.com/grafolean/grafolean-collector-ping/raw/master/.env.example -O .env
42+
$ nano .env
43+
```
3844
3945
4) run: `docker-compose up -d`
4046

docker-compose.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ services:
1010
# image: grafolean/grafolean-collector-ping:v1.0.0
1111
image: grafolean/grafolean-collector-ping
1212
container_name: grafolean-collector-ping
13-
build:
14-
context: .
15-
dockerfile: Dockerfile
1613
environment:
1714
# Backend url must be set to the address of the Grafolean backend, for example this uses Grafolean hosted service:
1815
# - BACKEND_URL=https://grafolean.com/api

0 commit comments

Comments
 (0)