Skip to content

Commit bf2bb84

Browse files
author
Anze
committed
Readme improvements
1 parent c3ac21f commit bf2bb84

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ share, but you can't sell it. See [LICENSE.md](https://github.com/grafolean/graf
2525

2626
If in doubt, please [open an issue](https://github.com/grafolean/grafolean-snmp-bot/issues) to get further clarification.
2727

28-
# Install (docker / docker-compose)
28+
# Install
2929

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`.
3131

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.
3333

3434
2) save [docker-compose.yml](https://github.com/grafolean/grafolean-snmp-bot/raw/master/docker-compose.yml) to a local file:
3535
```
@@ -42,6 +42,7 @@ Docker is the easiest and currently the only officially supported way. Note that
4242
- mandatory: `BACKEND_URL` (set to the URL of Grafolean backend, for example `https://grafolean.com/api`),
4343
- mandatory: `BOT_TOKEN` (set to the bot token from step 1),
4444
- optional: `JOBS_REFRESH_INTERVAL` (interval in seconds at which the jobs definitions will be updated)
45+
4546
Alternatively, you can also copy `.env.example` to `.env` and change settings there (leaving `docker-compose.yml` in original state).
4647
4748
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
5253
5354
## Upgrade
5455
55-
Upgrading should be easy:
56-
5756
1) `$ docker-compose pull`
5857
2) `$ docker-compose down`
5958
3) `$ docker-compose up -d`
@@ -67,18 +66,18 @@ $ docker logs --since 5m -f grafolean-snmp-bot
6766
6867
## Building locally
6968
70-
If you wish to build the Docker image locally (for debugging or for development purposes), you can specify a custom docker-compose YAML file:
69+
If you wish to build the Docker image locally (for debugging or for development purposes), you can use a custom docker-compose YAML file:
7170
```
7271
docker-compose -f docker-compose.dev.yml build
7372
```
7473
75-
In this case `.env.example` can be copied to `.env` and all settings can be altered there, which helps us avoid commiting settings to the repository.
74+
In this case `.env.example` can be copied to `.env` and all settings can be altered there.
7675
7776
# Development
7877
7978
## Contributing
8079
81-
To contribute to this repository, CLA needs to be signed. Please open an issue about the problem you are facing before submitting a pull request.
80+
CLA needs to be signed to contribute to this repository. Please open an issue about the problem you are facing before submitting a pull request.
8281
8382
## Issues
8483

0 commit comments

Comments
 (0)