Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Dashboard Setup

Ready to launch your dashboard? Let's set it up.

This setup guide assumes that the Basic Setup Guide has already been completed!

We've recorded a video that walks you through this part of the documentation. Check it out here!

AthenaBot Web API Setup

The Web API is the bridge between AthenaBot and the Dashboard. If this is wrong, the dashboard cannot load data.

Open /configuration/web_api.json(5) and complete these steps:

1. Set your API port

Pick a free port (example uses 3111):

port: "3111"

2. Set a secure authentication key

Replace the default value of authentication_key with a randomly generated string:

authentication_key: ["your-super-secure-key"]

Leaving the default API key unchanged will prevent the plugin from loading for security reasons.

3. Set base IP / domain

Configure base_ip using one of the following options:

  • IP Address: "<host_ip>:<web_api_port>" Example: 123.123.123.123:3111

  • Domain: "<web_api_subdomain>" Example: api.iynxdev.com

If you are using a domain, point it to your server using an A record (or CNAME) and configure either a reverse proxy (recommended) or Cloudflare Tunnel to forward requests to your dashboard. DNS and web server configuration are outside the scope of this guide.

4. Optional hardening options

  • secure_mode: Restrict most API routes to trusted IP addresses listed in whitelisted_ips

  • whitelisted_ips: Keep the default entries and add any additional trusted IP addresses that should be allowed to access protected API routes

  • rate_limit.enabled: Keep enabled to protect the API against excessive requests

  • rate_limit.proxied: Enable if the dashboard is behind a reverse proxy (e.g. Nginx, Apache, Caddy, or Cloudflare Tunnel)

Dashboard Configuration

Now open /common.json and edit the dashboard section.

1. Enable dashboard

2. Set dashboard port

Pick a free port (example uses 3222):

The dashboard must use a different port than the one configured for the Web API

3. Configure the Dashboard & Web API URLs

Update both URLs to match your deployment.

Dashboard URL (dashboard_base_url):

  • IP setup: http://<server_ip>:<dashboard_port> Example: http://123.123.123.123:3222

  • Domain setup: https://<dashboard_subdomain> Example: https://dashboard.iynxdev.com

Web API URL (web_api_base_url):

  • IP setup: http://<server_ip>:<web_api_port> Example: http://123.123.123.123:3111

  • Domain: equals IP setup

Please leave the web_api_local_url setting empty unless instructed otherwise by our Support team.

4. Whitelist your Discord account

Add your Discord user ID to:

5. Optional Dashboard Configuration

When the dashboard is enabled for the first time, Athena imports the configuration files from the /configuration directory into the database.

From that point onward, the dashboard configuration becomes the source of truth. Changes made to the configuration files are ignored while the dashboard is enabled.

Optional settings:

  • disable_dashboard_configuration: Prevent configuration changes from the dashboard and use the configuration files in /configuration instead.

  • sync_dashboard_configs_to_file: Automatically write configuration changes made in the dashboard back to the files in /configuration.

Enabling sync_dashboard_configs_to_file may overwrite your existing configuration files.

Synchronization only occurs from the dashboard to the configuration files, not the other way around.

If you want to discard the dashboard configuration and reimport your configuration files, run in console while the bot is running:

Discord OAuth Setup

The dashboard login uses Discord OAuth.

1. Add redirect URL

Open your application in the Discord Developer Portal and navigate to OAuth2 → Redirects.

Add one of the following redirect URLs:

  • IP setup: http://<host_ip>:<dashboard_port>/api/auth/callback Example: http://123.123.123.123:3222/api/auth/callback

  • Domain setup: https://<dashboard_subdomain>/api/auth/callback Example: https://dashboard.iynxdev.com/api/auth/callback

2. Configure the Client Secret

In the Discord Developer Portal, navigate to OAuth2, generate or copy your Client Secret, and set it in common.json:

Setup Complete!

Restart the bot and access your dashboard using the URL you configured:

  • IP setup: http://<server_ip>:<dashboard_port> Example: http://123.123.123.123:3222

  • Domain setup: https://<dashboard_subdomain> Example: https://dashboard.iynxdev.com

Last updated