You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-8Lines changed: 7 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -25,11 +25,11 @@ share, but you can't sell it. See [LICENSE.md](https://github.com/grafolean/graf
25
25
26
26
If in doubt, please [open an issue](https://github.com/grafolean/grafolean-snmp-bot/issues) to get further clarification.
27
27
28
-
# Install (docker / docker-compose)
28
+
# Install
29
29
30
-
Docker is the easiest and currently the only officially supported way. Note that while instructions might (with possibly some modifications) work on other operating systems, Linux is assumed.
30
+
Requirements: `docker`and `docker-compose`.
31
31
32
-
1) log in to Grafolean service (either https://grafolean.com/ or self-hosted), select an appropriate `Account` and create a new `Bot`. Make sure that selected protocol is `SNMP`. Copy the bot token.
32
+
1) log in to Grafolean service (either self-hosted or https://grafolean.com/) and create a new `Bot`. Make sure that selected protocol is `SNMP`. Copy the bot token.
33
33
34
34
2) save [docker-compose.yml](https://github.com/grafolean/grafolean-snmp-bot/raw/master/docker-compose.yml) to a local file:
35
35
```
@@ -42,6 +42,7 @@ Docker is the easiest and currently the only officially supported way. Note that
42
42
- mandatory: `BACKEND_URL` (set to the URL of Grafolean backend, for example `https://grafolean.com/api`),
43
43
- mandatory: `BOT_TOKEN` (set to the bot token from step 1),
44
44
- optional: `JOBS_REFRESH_INTERVAL` (interval in seconds at which the jobs definitions will be updated)
45
+
45
46
Alternatively, you can also copy `.env.example` to `.env` and change settings there (leaving `docker-compose.yml` in original state).
46
47
47
48
4) run: `docker-compose up -d`
@@ -52,8 +53,6 @@ In case of error make sure that the user is allowed to run `docker` (that is, th
0 commit comments