Skip to content

DeFiChain collateral ratio tracker

Notifications You must be signed in to change notification settings

defichain-api/dobby

Repository files navigation

DeFiChain DOBBY

Dobby is your personal house elf. He's always busy and watches your vaults on the DeFiChain.

You can setup as much vaults as you want, each with a custom amount of trigger points for notifications.

Dobby can inform you via mail, telegram message or a webhook. More notification gateways will be released in future.

Setup own Dobby instance

These are the requirements for Dobby:

  • MariaDB/MySQL
  • Redis
  • PHP 8.1
  • Mailserver, if you want to receive notifications by mail
  • Telegram Bot, if you want to receive notifications on telegram. Add the bot secret in the .env after the instance setup. To receive the secret, be kind to the BotFather.

Follow these steps to setup your own instance of Dobby on an own server:

  1. checkout the repo
  2. install php dependencies with composer install
  3. create copy of the environment file cp .env.example .env, then add your redis/database credentials
  4. create an app secret with php artisan key:generate
  5. migrate the database with php artisan migrate

Telegram bot commands

  • vault_state - get the current states of your vault/s
  • user_key - let Dobby find your user key
  • disable_telegram - unlink your telegram from Dobby
  • remove_snooze - Delete all current set snooze / cooldown notifications

Webhooks

Take a look at the webhook readme for further details.

Health Checks

Take a look at the health check readme for further details.

Donations for Dobby

If you want to honor the hard work that Dobby does 24/7 feel free to buy him a coffee or new socks.

df1qw0522d3tc8t3p5656a0u69mfauwg99xkdst50w

About

DeFiChain collateral ratio tracker

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •