https://github.com/yamnikov-oleg/avamon-bot

Small telegram bot monitoring web sites availability
https://github.com/yamnikov-oleg/avamon-bot

Last synced: about 5 hours ago
JSON representation

Small telegram bot monitoring web sites availability

• Host: GitHub
• URL: https://github.com/yamnikov-oleg/avamon-bot
• Owner: yamnikov-oleg
• License: mit
• Created: 2017-06-25T16:37:58.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-23T09:54:20.000Z (about 7 years ago)
• Last Synced: 2024-06-20T12:46:12.341Z (5 months ago)
• Language: Go
• Size: 12.8 MB
• Stars: 18
• Watchers: 5
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# avamon-bot

Small telegram bot monitoring websites' availability.

## Usage

This bot is not currently hosted for public use, unfortunately. You will have to

host it yourself.

It is suitable for adding to groups. All the group members will be able to add,

list and delete targets.

### Adding a target

![Adding a target](assets/adding.png)

### List all targets

![List all targets](assets/listing.png)

### Notifications

![Notification DOWN](assets/down_notif.png)

![Notification UP](assets/up_notif.png)

### Deleting a target

![Deleting a target](assets/deleting.png)

## Building and running

### With Docker

You must have Docker installed.

1. Clone the repo.

2. Run `build.sh`, it will build the docker image for you and will tag it `avamon-bot`.

3. Copy the default config from `./frontend/telegrambot/bin/avamon-bot/config.default.toml` and

  edit it however you like. Don't forget to specify the bot token. Set redis host to `redis`.

4. Create `docker-compose.yml` with these contents:

  ```

  version: '3'

  services:

    bot:

      image: avamon-bot

      links:

      - redis

      volumes:

      - ./config.toml:/var/avamon-bot/config.toml:ro

    redis:

      image: redis

  ```

5. Run with `docker-compose up`.

If you want to persist the sqlite3 database, edit the path of the db file in

the config (`database.name` key), then mount it as docker volume.

### With Go compiler.

1. Build and install it: `go get github.com/yamnikov-oleg/avamon-bot/frontend/bin/avamon-bot`

2. Copy and edit the config file at `./frontend/avamon-bot/config.default.toml`.

  Don't forget to specify the bot token. Make sure you have Redis running on localhost.

3. Run it like so: `avamon-bot -config ./path/to/config.toml`