Installation

The only supported installation method for Revenant's Brooch is via Docker, specifically, a Docker Compose file.

Using Docker Compose

1. Create and open a new directory for your project:

   # mkdir /dock/brooch
   # cd /dock/brooch 

2. In the Discord channel you want to receive messages in, create a new webhook:

   

3. Create a docker-compose.yml file with the following contents, personalized with your data:

   version: "3.9"
   
   services:
     brooch:
       image: "ghcr.io/ryghub/revenants-brooch:latest"
       restart: always
       environment:
         # Enter your STRATZ API JWT here
         # Obtain one at https://stratz.com/api
         STRATZ_JWT: "__REDACTED__"
         # Enter the webhook URL you previously copied
         # Optionally append ?thread_id=CHANNELID to send all messages in a specific thread
         DISCORD_WEBHOOK_URL: "https://discord.com/api/webhooks/__REDACTED__?thread_id=__REDACTED__"
         # The ID of the Guild to track matches of
         # Find your guild on STRATZ, then extract the numeric part
         # https://stratz.com/guilds/9257
         FOLLOWED_GUILD_ID: "9257"
         # Logging configuration of the env_logging crate
         # Leave it as it is, or read https://docs.rs/env_logger/latest/env_logger/ for more information
         RUST_LOG: "revenants_brooch"

4. Bring up the container using Docker Compose:

   # docker compose up -d && docker compose logs -f

5. If everything seems ok, quit the logs with ^C. You're done!