https://github.com/splattael/bigbrother

Server overseer.
https://github.com/splattael/bigbrother

bigbrother crystal notifier telegram watch

Last synced: 17 days ago
JSON representation

Server overseer.

• Host: GitHub
• URL: https://github.com/splattael/bigbrother
• Owner: splattael
• License: mit
• Created: 2017-07-15T09:10:06.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-02-11T11:05:50.000Z (9 months ago)
• Last Synced: 2024-05-09T11:10:33.903Z (6 months ago)
• Topics: bigbrother, crystal, notifier, telegram, watch
• Language: Crystal
• Size: 179 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bigbrother

Server overseer.

`bigbrother` runs predefined checks (e.g. HTTP, TCP) every `n` seconds and notifies (via e.g. Telegram) you if any of these checks fail.

See `config.yml.sample` for some example checks.

## Screenshots

![console](https://github.com/splattael/bigbrother/blob/master/assets/bigbrother.console.png)

![telegram](https://github.com/splattael/bigbrother/blob/master/assets/bigbrother.telegram.png)

## Checks

Currently, the following checks are implemented:

* [http](https://github.com/splattael/bigbrother/blob/master/src/bigbrother/check/http.cr) - Check a URL for specific for its HTTP status code or content.

* [host_ip](https://github.com/splattael/bigbrother/blob/master/src/bigbrother/check/host_ip.cr) - Check a host and ip via TCP.

## Notifiers

A list of available notifiers:

* [telegram](https://github.com/splattael/bigbrother/blob/master/src/bigbrother/notifier/telegram.cr) - Notify via Telegram's bot.

* [console](https://github.com/splattael/bigbrother/blob/master/src/bigbrother/notifier/console.cr) - Print all checks on your terminal.

## Installation

    make build-release

    bin/bigbrother

## Usage

    bin/bigbrother -h

    bin/bigbrother -c config.yml

### Example config

See `config.yml.sample`.

## Development

    make build

    bin/bigbrother

## Contributing

1. Fork it ( https://github.com/splattael/bigbrother/fork )

2. Create your feature branch (git checkout -b my-new-feature)

3. Commit your changes (git commit -am 'Add some feature')

4. Push to the branch (git push origin my-new-feature)

5. Create a new Pull Request

## Contributors

- [splattael](https://github.com/splattael) Peter Leitzen - creator, maintainer