Deployment

VYREX is designed for Vercel but runs anywhere Node.js serverless functions are supported.

Vercel (recommended)

The root vercel.json handles all routing. Static files are served from the root directory; API functions live in api/.

{
  "rewrites": [
    { "source": "/dashboard", "destination": "/dashboard.html" },
    { "source": "/api/discord-token", "destination": "/api/oauth?__op=discord-token" },
    { "source": "/api/bot-config", "destination": "/api/bot-config" }
  ]
}

Self-hosted / other providers

Run npm install then serve static files with any web server and set up serverless functions using the provider's Node.js runtime. Ensure all /api/* paths route to the corresponding api/*.js files.

Environment variables

All configuration is done through environment variables. Never commit secrets to your repository.

Discord (required)

Access control

Storage

Bot setup

Configure your Discord application and bot token for full dashboard integration.

Creating your Discord application

1. Go to discord.com/developers/applications and click New Application.
2. Under Bot, click Add Bot. Copy the token and add it as DISCORD_BOT_TOKEN on Vercel.
3. Under OAuth2 → General, copy the Client ID and Client Secret. Add them as DISCORD_CLIENT_ID and DISCORD_CLIENT_SECRET.
4. Under OAuth2 → Redirects, add your deployment URL: https://your-domain.vercel.app/oauth-callback.
5. Enable Presence Intent, Server Members Intent, and Message Content Intent under Bot → Privileged Gateway Intents.

Inviting the bot

Use the Add to Discord button on the homepage, or generate the invite URL manually:

https://discord.com/api/oauth2/authorize
  ?client_id=YOUR_CLIENT_ID
  &permissions=8
  &scope=bot%20applications.commands

Bot branding

Customise your bot's avatar, status, activity, and per-server nicknames from the dashboard.

Global settings

Navigate to Dashboard → Bot Branding. Changes are saved to /api/bot-config (Redis-backed) and your local cache. The bot picks them up on its next poll, within five minutes, or straight away with >branding-sync.

Per-server nicknames

In the Per-server Nicknames card, add rows for each server where you want a custom nickname. These are stored separately at /api/bot-config?guildId=SERVER_ID and can be read individually by your bot worker per guild.

Commands

VYREX supports both slash commands (/command) and the text prefix (>command). The full, generated list is on the command reference.

Core commands

Every command runs with the text prefix (> by default, changeable per server). The hundred most used are also registered as slash commands and appear in Discord's / picker; everything else is prefix-only. Names and descriptions below are the bot's own.

Vanity roles

Give a role to members who put your link in their custom status. They hold it while the text is there and lose it when they take it out.

Welcome & goodbye

One command configures both messages. >welcome test posts exactly what a new member will see, built by the same code the join event runs.

Subcommands

Variables

Any of these work in the message, title and footer, on both the welcome and the goodbye side:

Moderation

Bans, kicks, mutes, warnings and temporary bans record a moderation case and post to the mod log when one is set (/modlog-set). Member actions respect role hierarchy: the bot never acts on someone above the moderator or above itself. Descriptions are the bot's own. Names shown with / are in the slash picker; the rest run with the prefix.

Members

Warnings, cases and records

Channels

Server security

Automod

Eight filters, each its own switch, with thresholds you set per server. Everything is off until you turn it on, and channels or roles you exempt are never scanned. Names and limits below are the bot's own.

Filters

Thresholds and escalation

Commands

Tickets

Private channels per request, a panel with a button for members, and an archive that survives the channel. Set a category and a support role with >ticket, then post a panel. Tickets use channel topics and permission overwrites; no dashboard is needed for the core flow.

Applications and staff trials

An applicant opens a ticket, fills it in, and a reviewer decides. Accepting can grant the role outright, or put them on a probation period first.

Economy & levels

Gold, XP and reputation per member, with a shop and leaderboards. Members earn XP by chatting and by voice time; the commands below are the ones in the slash picker.

Voice assistant

VYREX can sit in a voice channel, hear a wake word, answer out loud, and optionally run moderation commands it was asked for by voice. Because it listens to people, the rules about who is told and who can refuse come first.

Who is told, and how to refuse

• Joining announces itself. >vc join replies in the channel with what the bot is listening for and how to opt out.
• So does arriving later. Anyone who walks into the voice channel while a session is live is named once, in the same channel, with the same instruction. A group arriving is announced together rather than one line each.
• Opting out is global and permanent. >vc optout means the bot never transcribes that person, in any server, until they run >vc optin. The check runs before the audio stream is subscribed to, not after.
• Opting out is not announced. Someone who has already opted out is not named on arrival, because they are not being transcribed and the choice is theirs to share.

Commands

Settings (Manage Server)

Authentication

VYREX signs in with PKCE-based Discord OAuth only. Sessions are server-backed via Upstash Redis.

Discord OAuth (PKCE)

1. User clicks Continue with Discord. The browser generates a 48-byte random code verifier.
2. The SHA-256 hash of the verifier (code challenge) is sent to Discord's authorize URL.
3. Discord redirects to /oauth-callback with an auth code.
4. The callback calls POST /api/discord-token, sending the code + verifier. The server exchanges these for an access token without the client_secret ever touching the browser.
5. The access token is used to call GET /users/@me on Discord's API to get the user's ID and email.

Sessions and accounts

Accounts are stored in Upstash Redis under vyrex:acc:<id>. Sessions are 32-byte random tokens stored under vyrex:sess:<token> with a 30-day TTL. Password sign-in is disabled by default; see Auth endpoints.

Tier system

All role checks happen server-side in api/_lib/serverAccountTier.js:

Embed builder

Build rich Discord embeds visually and export the JSON to use in any bot.

Using the embed builder

Navigate to Dashboard → Embed Builder. The live preview updates as you type. When done, click Copy JSON to get the payload.

JSON output format

{
  "embeds": [{
    "color": 5046271,
    "author": { "name": "VYREX", "url": "https://vyrex.lastlydevelopments.com" },
    "title": "Embed Title",
    "description": "Your **markdown** text here.",
    "fields": [
      { "name": "Field 1", "value": "Value 1", "inline": true },
      { "name": "Field 2", "value": "Value 2", "inline": true }
    ],
    "footer": { "text": "VYREX Bot" },
    "timestamp": "2025-01-01T00:00:00.000Z"
  }]
}

Quick presets

8 built-in presets: Welcome, Announcement, Warning, Success, Error, Info, Rules, Event. Click any to load it into the builder.

Team & roles

Manage your platform team using Discord ID allowlists on Vercel environment variables.

Adding team members

1. Get the team member's Discord user ID (right-click their name in Discord → Copy User ID, with Developer Mode on).
2. Add the ID to VYREX_COOWNER_DISCORD_IDS (Owner) or VYREX_STAFF_DISCORD_IDS (Staff) on Vercel — comma-separated for multiple IDs.
3. Redeploy the project. The team member can now sign in with Discord and access their tier-appropriate sections.

API overview

All VYREX API routes are serverless Node.js functions deployed alongside the static site.

Base URL

https://your-domain.vercel.app/api/

Authentication

API routes accept two auth methods:

• API key: x-vyrex-api-key: YOUR_DASH_API_KEY header — full access
• Discord OAuth: Authorization: Bearer DISCORD_ACCESS_TOKEN — access scoped by Discord ID tier

Available routes

Auth endpoints

The /api/auth-accounts endpoint handles sessions and admin operations. Sign-in itself goes through Discord OAuth — see Authentication.

POST /api/auth-accounts — Register / Login

Both actions are disabled. VYREX signs in with Discord only, so these return:

403 { "error": "password_auth_disabled" }

Set VYREX_ALLOW_PASSWORD_AUTH=1 on the deployment to re-enable email/password sign-in. It is off by default and should stay off unless you have a specific reason.

POST /api/auth-accounts — Logout

{ "action": "logout" }

Returns: { "ok": true }

GET /api/auth-accounts?me=1

Requires Authorization: Bearer SESSION_TOKEN. Returns the current account and computed tier.

Bot config API

Store and retrieve bot customisation settings per-guild or globally.

GET /api/bot-config

Returns global config. Append ?guildId=SERVER_ID for per-guild config.

POST /api/bot-config — Global

{
  "activityType": "watching",
  "activityText": "your server",
  "onlineStatus": "online",
  "brandColor": "#7c3aed",
  "globalNick": "VYREX",
  "avatarUrl": "https://cdn.example.com/avatar.png"
}

Requires Founder or Owner auth (API key or elevated Discord ID).

POST /api/bot-config — Per-guild

{ "guildId": "1234567890", "nickname": "MyBot", "prefix": "!", "embedColor": "#34d399" }

Requires any valid auth (Discord OAuth or API key).

FAQ

Common questions about VYREX setup and configuration.

Why does /api/bot-snapshot show 0 servers?

The bot snapshot requires DISCORD_BOT_TOKEN set on Vercel and a valid Discord or API key auth header. Sign in with Discord in the dashboard and click Sync from Discord.

My session expires — how do I extend it?

Sessions last 30 days (Redis TTL). The dashboard auto-refreshes the server session if you're active. Re-signing in creates a fresh session.

Can I run multiple bots from one dashboard?

Currently one bot token per deployment. To manage multiple bots, deploy separate instances of VYREX with different environment variables.

How do I enable Stripe billing?

Add STRIPE_SECRET_KEY, STRIPE_WEBHOOK_SECRET, STRIPE_PRICE_PRO, and STRIPE_PRICE_PREMIUM to Vercel. The /api/stripe-session handler is ready.

Troubleshooting

Common issues and how to fix them.

"Failed to fetch" on Discord sign-in

The /api/discord-token route is not reachable. Check: (1) the site is deployed on Vercel (not opened as a file), (2) DISCORD_CLIENT_SECRET is set, (3) the redirect URI in Discord Portal matches exactly.

Sessions not persisting across devices

Configure Upstash Redis. Without it, sessions are in-memory and lost on function cold starts.

Bot branding not applying to Discord

The dashboard saves config to /api/bot-config. The bot reads it every five minutes when DASHBOARD_PUBLIC_URL and VYREX_BOT_SHARED_SECRET are set in its .env; npm run doctor in the bot repo tells you whether that sync is on.

Owner/Staff access not working

Make sure you signed in with Discord OAuth. The tier check compares your Discord user ID against the env var allowlists. After adding IDs, redeploy Vercel.