Giter VIP home page Giter VIP logo

ethanc / moniker Goto Github PK

View Code? Open in Web Editor NEW
2.0 2.0 0.0 470 KB

Monitor usernames across various services and report availability via Discord.

Home Page: https://hub.docker.com/r/ethanchrisp/moniker

License: MIT License

Dockerfile 1.47% Python 98.53%
discord docker docker-compose notifier notify portainer script twitter username watcher webhook monitor notifications available availability python github snapchat mastodon youtube

moniker's Introduction

Moniker

GitHub Workflow Status Docker Pulls Docker Image Size (tag)

Moniker monitors usernames across the following platforms and reports availability via Discord.

Setup

Although not required, a Discord Webhook is recommended for notifications.

Regardless of your chosen setup method, Moniker is intended for use with a task scheduler, such as cron.

Environment Variables:

  • LOG_LEVEL: Loguru severity level to write to the console.
  • LOG_DISCORD_WEBHOOK_URL: Discord Webhook URL to receive log events.
  • LOG_DISCORD_WEBHOOK_LEVEL: Minimum Loguru severity level to forward to Discord.
  • CASHAPP_USERNAMES: Comma-separated list of Cash App $Cashtags to monitor.
  • GITHUB_USERNAMES: Comma-separated list of GitHub usernames to monitor.
  • MASTODON_USERNAMES: Comma-separated list of Mastodon usernames to monitor.
  • SNAPCHAT_USERNAMES: Comma-separated list of Snapchat usernames to monitor.
  • VENMO_USERNAMES: Comma-separated list of Venmo usernames to monitor.
  • X_USERNAMES: Comma-separated list of X usernames to monitor.
  • GITHUB_USERNAMES: Comma-separated list of Venmo usernames to monitor.
  • YOUTUBE_USERNAMES: Comma-separated list of YouTube usernames to monitor.
  • DISCORD_WEBHOOK_URL: Discord Webhook URL to receive available username notifications.

Docker (Recommended)

Modify the following docker-compose.yml example file, then run docker compose up.

services:
  moniker:
    container_name: moniker
    image: ethanchrisp/moniker:latest
    environment:
      LOG_LEVEL: INFO
      LOG_DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/YYYYYYYY/YYYYYYYY
      LOG_DISCORD_WEBHOOK_LEVEL: WARNING
      CASHAPP_USERNAMES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ
      GITHUB_USERNAMES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ
      MASTODON_USERNAMES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ
      SNAPCHAT_USERNAMES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ
      VENMO_USERNAMES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ
      X_USERNAMES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ
      YOUTUBE_USERNAMES: XXXXXXXX,YYYYYYYY,ZZZZZZZZ
      DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/XXXXXXXX/XXXXXXXX

Standalone

Moniker is built for Python 3.12 or greater.

  1. Install required dependencies using Poetry: poetry install --no-root
  2. Rename .env.example to .env, then provide the environment variables.
  3. Start Moniker: python moniker.py

moniker's People

Contributors

ethanc avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.