Skip to content

Commit

Permalink
chore: update readme and and docker-compose
Browse files Browse the repository at this point in the history
  • Loading branch information
albttx committed Nov 14, 2022
1 parent 25fb4cb commit 238bf35
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,41 @@
# Cosmos notifyer

Cosmos notifyer is an alerting and informing tool for cosmos-sdk based chain


# Features

:warning: Alerts

- [x] New :moneybag: & Lost :money_with_wings: delegations
- [x] Missing blocks and recovery
- [ ] RPCs are down

* Cosmos-notifyer can send alert into

- [x] Discord
- [ ] Slack
- [ ] Telegram
- [ ] Phone number
- [ ] Homing pigeon

## Installation

to install docker -> [get.docker.com](https://get.docker.com)

* using [docker](https://docker.com)


```bash
$ cp config.example.yml config.yml

# edit the config
$ vi config.yml

# start the container
$ docker-compose up -d
```

## Misc

This tool is inspired by [blockpane/tenderduty](https://github.com/blockpane/tenderduty)
7 changes: 7 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
version: "3"
services:
cosmosnotifyer:
image: ghcr.io/nysa-network/cosmos-notifyer:latest
restart: unless-stopped
volumes:
- ./config.yml:/config.yml

0 comments on commit 238bf35

Please sign in to comment.