Skip to content

Repository files navigation

Moniker

GitHub Workflow Status Docker Pulls Docker Image Size (tag)

Moniker monitors usernames across various services 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 compose.yaml 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 uv: uv sync
  2. Rename .env.example to .env, then provide the environment variables.
  3. Start Moniker: python moniker.py

Sponsor this project

Used by

Contributors

Languages