Docs: say plainly that only the bot is open source; the dashboard and API are proprietary
- README, license section and architecture no longer point to the dashboard repositories - schema.sql is the schema for contributors; database changes only need schema.sql and a note in the PR - self-hosting: settings without a dashboard (SQL for security thresholds, beta settings, opted-in servers) - beta features, deployment and troubleshooting reworded for people who don't have the dashboard Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
This commit is contained in:
1 parent
1fbc38ca56
commit
02b7db1813
11 files changed
+93
-77
No files matched your search
+30
-7
@@ -8,7 +8,7 @@ You will run:
|
||||
- **PostgreSQL**, started by the same Compose file.
|
||||
- Optionally **Lavalink**, if you want music.
|
||||
|
||||
The web dashboard lives in two other repositories (`velox-dashboard-api` and `velox-dashboard-web`) and is optional. See [What you get without the dashboard](#what-you-get-without-the-dashboard).
|
||||
The hosted Velox also has a web dashboard. It is proprietary and not part of this repository, so it is not something you can host. You do not need it. See [Settings without a dashboard](#settings-without-a-dashboard).
|
||||
|
||||
## Before you start
|
||||
|
||||
@@ -154,15 +154,38 @@ Run it on a schedule and keep copies off the server. To restore into an empty da
|
||||
|
||||
Discord requires you to **verify** your application once the bot is in 100 servers, and to be approved for the privileged intents (Server Members, Message Content). Plan for that if you intend to run a public bot. For a bot in a few servers you manage yourself, nothing is needed.
|
||||
|
||||
## What you get without the dashboard
|
||||
## Settings without a dashboard
|
||||
|
||||
The bot works on its own and every command in the [Command reference](commands.md) does. What needs the dashboard (the `velox-dashboard-api` and `velox-dashboard-web` repositories, which share this database):
|
||||
The bot works fully on its own, and every command in the [Command reference](commands.md) does. Most things are set with slash commands. A few settings that the hosted Velox sets on its dashboard have no command, so you set them in the database. They are plain rows, described in `schema.sql`.
|
||||
|
||||
- Security thresholds, Join Gate filters and heat settings. Without the dashboard the bot uses the defaults from the schema.
|
||||
- Beta access: choosing the beta server and role, and servers opting in. Without the dashboard there is no way to set a role, so beta features stay off.
|
||||
- The web view of the music queue and ticket panel, and the changelog.
|
||||
**Security thresholds and filters.** The defaults are in `security_settings`. To change a server's settings, insert or update its row (the columns are documented in `schema.sql`, and invalid values are refused):
|
||||
|
||||
If you do run the dashboard, it and the bot must use the **same PostgreSQL database**, and the API runs the migrations. Its own README explains its setup. When both are deployed, [deploy the API first](deployment.md#running-next-to-the-dashboard).
|
||||
```sql
|
||||
INSERT INTO security_settings (guild_id, raid_join_count, raid_join_seconds)
|
||||
VALUES (123456789012345678, 15, 10)
|
||||
ON CONFLICT (guild_id) DO UPDATE
|
||||
SET raid_join_count = EXCLUDED.raid_join_count, raid_join_seconds = EXCLUDED.raid_join_seconds;
|
||||
```
|
||||
|
||||
Protections are switched on with `/security toggle`, not with SQL.
|
||||
|
||||
**Beta features.** Beta features are off until you choose a beta server and a Beta Tester role. Run this once, with your own IDs (the bot reads it every 30 seconds):
|
||||
|
||||
```sql
|
||||
INSERT INTO beta_settings (id, guild_id, role_id) VALUES (TRUE, 123456789012345678, 234567890123456789)
|
||||
ON CONFLICT (id) DO UPDATE SET guild_id = EXCLUDED.guild_id, role_id = EXCLUDED.role_id;
|
||||
```
|
||||
|
||||
To let another server's beta features on, add it (its owner's agreement is yours to arrange):
|
||||
|
||||
```sql
|
||||
INSERT INTO beta_guilds (guild_id, enabled_by) VALUES (345678901234567890, 123456789012345678)
|
||||
ON CONFLICT DO NOTHING;
|
||||
```
|
||||
|
||||
See [Beta features](beta-features.md) for what this does.
|
||||
|
||||
**Queue and panel requests.** The `*_commands` tables let another program ask the bot to skip a song, post the ticket panel or end a raid. See [Database](database.md#dashboard-to-bot-settings-and-requests) if you want to build something on them.
|
||||
|
||||
## Making it your own
|
||||
|
||||
|
||||
Reference in new issue
Block a user