Documentation
How Veytrix works
An overview of the system for server owners and for anyone integrating the bot. Setup instructions for developers are in the repository README.
Architecture
Veytrix is three separate systems. They never call each other directly; they meet only in the database.
- Dashboard. This website. It signs administrators in, displays what the bot has reported, and saves configuration. It never connects to the Discord gateway and cannot perform a security action itself.
- Database. Stores configuration, security events, incidents, backups, and a queue of requested actions. Row Level Security limits every dashboard query to servers the signed-in user manages.
- Bot. A separate process on its own server. It connects to Discord, detects threats, enforces protection, and writes results back. It keeps working if the dashboard is offline.
Sign-in and access
You sign in with Discord. The dashboard requests your identity and your server list, and does not request your email address.
After sign-in, our server asks Discord which servers you belong to and what permissions you hold in each. You can manage a server if you are its owner or hold the Administrator or Manage Server permission. That result is stored on the server and is the only thing that grants access; nothing sent by your browser is trusted for this decision.
Verified access lasts 6 hours. After that you are asked to re-verify with Discord, so someone who loses their role in Discord does not keep dashboard access indefinitely.
Bot status
The bot reports a heartbeat for each server it is in. The dashboard shows it as online if the last heartbeat arrived within 120 seconds, and offline otherwise. A server where the bot has never reported is shown as not installed.
Protection is shown as active only when the bot is online, protection is switched on, and the bot reports that it has the permissions it needs. Saved settings alone are never presented as active protection.
Requesting bot actions
Sensitive actions such as a lockdown or a backup restore are not performed by the dashboard. The dashboard records a request, the bot picks it up, performs it, and records what actually happened. The dashboard then shows that recorded outcome.
- pending
- Requested from the dashboard and waiting for the bot.
- claimed
- Picked up by the bot and in progress.
- succeeded
- The bot performed the action and recorded the result.
- failed
- The bot tried and could not complete it. The error is recorded.
- rejected
- The bot refused, for example because of missing permissions.
- expired
- Not picked up within 10 minutes, so it will never run.
Requests expire after 10 minutes. If the bot was offline when you asked for a lockdown, it will not suddenly apply one hours later when it reconnects.
Bot permissions
The bot asks for these permissions when invited. Discord also only lets a bot act on roles below its own, so place the bot's role near the top of your role list.
- View Audit Log
- Identify which account performed a destructive action.
- Timeout Members
- Temporarily restrict an account while staff review it.
- View Channels
- See the channels it is protecting.
- Send Messages
- Post alerts to your staff channel.
Demonstration data
A demonstration workspace with sample data is available in development so the interface can be reviewed without a connected bot. It is labeled as demonstration data on every screen, is never stored in the database, and is disabled in production unless explicitly switched on.
Real servers never show sample figures. If the bot has reported nothing, the dashboard shows empty states rather than invented numbers.