Skip to main content

​
Quickstart

This guide will get you from zero to a running Acusight platform in about 5 minutes.

​
Prerequisites

Before you begin, ensure you have:
  • Git - for cloning the repository
  • Docker with Compose v2 - for running the platform
  • A machine with at least 8GB RAM (16GB recommended)

​
Step 1: Clone the Repository

git clone https://github.com/ArcturusNetworks/acusight.git
cd acusight

​
Step 2: Configure Environment

Copy the example environment file: 
cp .env.example .env
Edit .env and set your LAN IP address: 
# .env
SERVER_EXTERNAL_IP="192.168.1.100"   # <-- your machine's LAN IP
Find your LAN IP with:
  • Linux: hostname -I | awk '{print $1}'
  • macOS: ipconfig getifaddr en0

​
Step 3: Start the Platform

docker compose up --build -d
On first boot, the platform will automatically:
  1. Initialize Portainer with an admin account
  2. Configure Zitadel (OIDC identity provider)
  3. Create an OIDC client for authentication
The platform is ready when docker compose logs core shows:
Listening and serving HTTP on :8080
This typically takes 1-2 minutes on first start.

​
Step 4: Access the Dashboard

Open your browser and navigate to: 
https://<SERVER_EXTERNAL_IP>
Certificate Warning ExpectedYour browser will show a certificate warning because Caddy generates a self-signed TLS certificate. This is normal for local development.
  • Chrome: Click “Advanced” → “Proceed to site”
  • Firefox: Click “Advanced” → “Accept the Risk and Continue”
You only need to do this once per browser.

​
Step 5: Log In

Click Sign In on the login page. You’ll be redirected to Zitadel where you enter:
FieldValue
Usernameadmin@zitadel.<SERVER_EXTERNAL_IP>
PasswordAdmin1234!
For example, if your IP is 192.168.1.100: After login, you’ll be redirected to the Acusight dashboard.

​
What’s Running?

Once the platform is up, these services are available:
ServiceURLCredentials
Acusight Dashboardhttps://<IP>OIDC login
Swagger API Docshttps://<IP>/swagger/-
Portainerhttp://<IP>:9000admin / superpassword
Grafanahttp://<IP>:3030admin / admin
MinIO Consolehttp://<IP>:9011minioadmin / minioadmin

​
Next Steps

Add Your First Device

Provision an edge device to start collecting data

Explore the API

Learn how to interact with Acusight programmatically

​
Common Commands

# View logs for a service
docker compose logs -f core

# Rebuild a service after code changes
docker compose up --build -d core

# Stop the platform
docker compose down

# Stop and remove all data (fresh start)
docker compose down -v

​
Troubleshooting

If something isn’t working, check the Troubleshooting Guide for common issues and solutions.