Docs

Dashboard Manual Deployment

This guide explains how to manually deploy the Oakestra Dashboard for custom setups.

Automatic Deployment

The dashboard is automatically deployed when you start Oakestra using the standard installation scripts. Manual deployment is only necessary for custom configurations or when using override files to exclude the dashboard.

Prerequisites

Requirements

  • You have a running Root Orchestrator
  • You can access the APIs at <IP_OF_ROOT_ORCHESTRATOR>:10000

Manual Deployment Steps

1. Clone the Dashboard Repository

git clone https://github.com/oakestra/dashboard.git && cd dashboard

2. Configure Environment Variables

Create a file containing the environment variables:

echo "API_ADDRESS=<IP_OF_ROOT_ORCHESTRATOR>:10000" > .env

Replace <IP_OF_ROOT_ORCHESTRATOR> with the actual IP address of your root orchestrator.

3. Run the Dashboard

Start the dashboard using Docker Compose:

sudo docker compose up

Verification

Once deployed, the dashboard should be accessible at:

http://<IP_OF_ROOT_ORCHESTRATOR>

If the Oakestra components (System Manager and MongoDB) are not running or configured correctly, you can reach the login screen but will not be able to log in.

Default Credentials

Upon launching the system for the first time, an administrative user is automatically created:

  • Username: Admin
  • Password: Admin

Security Warning

After setting up the root, immediately change the password of the admin user!

Troubleshooting

If you experience issues accessing the dashboard:

  1. Verify that the Root Orchestrator and all required components are running
  2. Check that the API_ADDRESS in the .env file is correct
  3. Ensure that port 80 (or your configured port) is not blocked by a firewall
  4. Check the dashboard logs: docker compose logs

For more information on dashboard features, see the other pages in this section.

Prev
MQTT Authentication
Next
Organizations