Cyno: The bot that makes your Discord server more fun!

Developing Cyno | Setting up Cyno (Single Shard) | Setting up Cyno at scale

---

Cyno is self-hostable. There is no managed instance, so you run your own copy of the bot and dashboard. See Setting up Cyno (Single Shard) or Setting up Cyno at scale.

This repository contains the source tree for Cyno. There are 4 main parts to the Cyno source tree:

• bot: The source code for the bot. The bot uses react-djs to manage interactions.
• site: This contains the Next app router based site that powers the dashboard for your instance of the bot. It can be self-hosted alongside the bot or deployed to Vercel.
• database: This package contains the database logic that is shared between both of these.
• scripts: Scripts and anything the scripts require for deployment and management of the bots monolith.

Husky is used to ensure code consistency on commit and run the lints within the web application. The bot is built using some custom logic built on top of ESBuild. In some situations, when you add dependencies, you may need to update bot/build.cjs to stop it being bundled. The bot will hot reload in development mode.

Developing Cyno

To develop Cyno, you will need the following:

• A Discord bot user.
• A uploadthing project.
• Node.js 24 or higher (the exact LTS version used is in .nvmrc).

Once you have these, you can run npm ci to go ahead and install all the dependencies for all of your packages and then run npm run dev. The first time you run this, you will get a CLI setup wizard to walk you through setting up your devlopment environment. After that (or instantly if you have walked through the setup before), foreman will then start all the required processes. You can then go to localhost:5100 to see the dashboard or interact with the bot in Discord.

Some useful commands for development (all of these are ran in the root folder):

• npm run lint:fix: Automatically tries to fix lint errors. Run this if the linting commit hook fails.
• npm run db:generate-migrations: Generate database migrations. This should be ran when you change the schema.
• npm run db:migrate: Pushes the migrations to the database. This is ran initially when you setup your development environment, but may be useful if you make any changes to the schema.
• npm run commands:migrate: Runs migrations for commands on your Discord account. This is ran initially when you setup your development environment, but may be useful if you add a command.
• npm run bump-node: Bumps the Node version in nvmrc and all of the Dockerfile's to the latest LTS release of Node.js.

Setting up Cyno (Single Shard)

This is the approach you probably want to take if you just need a single Discord shard. You will need the following:

• A Linux server to run Cyno on with Docker, Docker Compose, and Bun installed.
• A Discord bot user.
• A uploadthing project.

From here, run the following commands and follow the setup wizard to setup your server:

git clone https://github.com/Infrawrench/cyno.git /opt/cyno
cd /opt/cyno
bun scripts/serverSetup.ts

To perform updates after this, run cd /opt/cyno && bun scripts/serverSetup.ts.

Setting up Cyno at scale

So you want to run Cyno at scale? You should have some experience with scaling services and do the following:

1. Use Turso for the database and Vercel for hosting the web side. Deploying a web app or database at scale is a lot harder than the bot portion, so this reduces the burden on yourself.
2. Build the bot container with Dockerfile.bot and push it to a registry you control.
3. Run one bot container per shard. Set SHARD_COUNT to the total number of shards, and give each container its shard number with SHARD_ID. If you are using a Kubernetes StatefulSet, you can leave SHARD_ID unset and the shard number is taken from the end of POD_NAME.
4. Set the following environment variables on the site and the bot containers:

DATABASE_AUTH_TOKEN=<your turso auth token>
DATABASE_URL=<your turso database url>
DISCORD_CLIENT_ID=<your discord client id>
DISCORD_CLIENT_SECRET=<your discord client secret>
DISCORD_REDIRECT_URI=<your discord redirect URI, https://<your domain>/api/auth/callback>
TOKEN=<your discord token>
UPLOADTHING_TOKEN=<your uploadthing v7 token>
COOKIE_PRIVATE_KEY=<32 bytes for the cookie key>

5. Run npm run db:migrate and npm run commands:migrate with those environment variables set to set up the database and register the bot commands. Run them again after updating if the schema or commands changed.