The smallest watchdog on earth. Tiny, monitoring-plugins compatible monitoring with a status page. https://cloud.docker.com/repository/docker/momar/chihuahua/general
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Moritz Marquardt 3e4100bce3 Use a better image 3 years ago
cmd Simplify command-line argument logic 3 years ago
types Show unknown status if the first check didn't run yet 3 years ago
web Improve design, update README for easier instructions 3 years ago
.dockerignore Make docker build faster, disable strict host checking for SSH, adjust Dockerfile for new CLI 3 years ago
.gitignore Publish first working public version (1.0) 3 years ago
Dockerfile Fix SSH connection from Docker 3 years ago
LICENSE Publish first working public version (1.0) 3 years ago
README.md Use a better image 3 years ago
api.go Improve design, update README for easier instructions 3 years ago
check.go Publish first working public version (1.0) 3 years ago
chihuahua.example.yml Publish first working public version (1.0) 3 years ago
notify.go Reorder imports 3 years ago
print.go Publish first working public version (1.0) 3 years ago

README.md

chihuahua

The smallest watchdog on earth. Tiny, monitoring-plugins compatible monitoring with a status page, built with Go, Air, Vue.js and Bulma.

Screenshot

Getting Started

mkdir -p ./data/.ssh
ssh-keygen -b 2048 -f ./data/.ssh/id_rsa -P "" -C "Chihuahua Monitoring"
nano ./data/chihuahua.yml
docker run -d -p 8080:80 -v "$PWD/data:/data" momar/chihuahua
xdg-open http://127.0.0.1:8080

Example chihuahua.yml

notifications:
- provider: gotify # Send notifications via https://gotify.net/
  server: https://gotify.example.org
  token: QwErTyUiOpAsDfG
- provider: email # Send notifications via E-Mail
  host: smtp.example.org
  port: 25
  username: example
  password: QwErTyUiOpAsDfG
  from: noreply@example.org
  to: postmaster@example.org

servers:
  example:
    ssh: monitoring@example.org -p 2222 # SSH connection parameters for the server. Leave away to run checks locally.
    checks:
      disk-space: check_disk -w 15% -c 5% # monitoring-plugins compatible check command

API

GET /checks
GET /checks/:server
GET /checks/:server/:check

Development

Requires Go

go get codeberg.org/momar/chihuahua/...
cd $GOPATH/src/codeberg.org/momar/chihuahua
cp chihuahua.example.yml chihuahua.yml && nano chihuahua.yml
go generate && DEBUG=1 go run ./cmd -c chihuahua.yml --once

Roadmap

  • Add custom messages to checks
  • More notification providers (mainly Clockwork SMS)
  • Gitea integration