xombi (pronounced "zombie") is an XMTP bot that allows you to interface with your Ombi instance.
This is intended to be ran internally within your network with visibility to your Ombi instance, allowing you to remotely search for and enqueue movies without exposing Ombi to the internet.
This operates based on an allow list of wallet addresses, relying on Ethereum private key authentication to secure your requests. Each allow-listed address must be mapped to a username known to Ombi; this does not allow 'anonymous' requests.
This project requires Node >= 20.0.0.
Within GitHub, click the green "Code" button and select the "Download ZIP" option.
Extract the contents of the ZIP file to a location of your choice.
From there, follow Usage, below, for instructions on how to run it.
Create a .env file that looks like the following:
ALLOW_LIST=<comma-separated list of addresses that can talk to the bot>
XMTP_ENV=production
KEY=<optional private key>
OMBI_API_KEY=<your Ombi instance's API key>
OMBI_API_URL=<the URL at which your Ombi instance resides>
USERNAME_<allowlisted address>=<username to be mapped to allowlisted address>
Optionally, you can add:
DEBUG_OMBI_SEARCH=true
...this will enable debug logging of the responses received from Ombi.
By default, the bot will generate a random private key; if you want the bot to accept messages at a particular address, provide a private key as the KEY environmental variable.
Once that's set up, run:
node index.js
Following that, send help to the bot for instructions on how to interact with it.
You can run the bot with its own Ombi instance using Docker. This will require connecting the local Ombi instance to a Plex server.
This requires manual setup of the Ombi instance first, so run this command first to start Ombi:
docker compose up ombi -d
Once it's running, navigate to http://localhost:9753 to set up Ombi. Once it's set up, obtain the Ombi API key from here. Take note, also, of the user here you want the bot to send your requests as to Ombi.
Once you have the API key, create a .env file like so:
ALLOW_LIST=<your wallet address>
KEY=<the private key to be used by Xombi to sign XMTP messages>
OMBI_API_KEY=<your Ombi API key>
OMBI_API_URL=http://ombi:3579
USERNAME_<your wallet address>=<your username as it appears in Ombi>
Then run:
docker compose up -d
This will start the bot on top of the Ombi instance already running.