Introduction
The Verdantix Energy Dashboard provides real-time monitoring, predictive analytics, and automated optimization for renewable energy installations. This guide covers everything from initial setup to advanced API integration.
Prerequisites: Ensure you have a valid Verdantix API key and admin access to your facility's energy management system (EMS) before proceeding.
Installation & Setup
Deploy the dashboard agent on your local gateway or cloud instance. We support Docker, Kubernetes, and direct binary installation.
Docker Deployment
Run the following command to pull and start the latest stable image:
bash
docker run -d \
--name verdantix-agent \
-e API_KEY="your_api_key_here" \
-v /var/log/verdantix:/app/logs \
-p 8080:8080 \
verdantix/energy-agent:latestSystem Configuration
After installation, configure your `verdantix.yaml` file with your facility parameters:
yaml
facility:
name: "Main Campus Solar Array"
timezone: "America/New_York"
reporting_interval: "5m"
carbon:
offset_tracking: true
baseline_year: 2023
scope: [1, 2, 3]
alerts:
email: true
slack_webhook: "https://hooks.slack.com/..."| Parameter | Type | Description | Default |
|---|---|---|---|
reporting_interval | string | Frequency of data sync | 10m |
carbon.offset_tracking | boolean | Enable automatic offset calculation | false |
max_retries | integer | API connection retry attempts | 3 |
Warning: Do not expose port 8080 to the public internet without a reverse proxy. Always use TLS certificates for production deployments.
First Run & Validation
Once configured, start the service and verify connectivity. The dashboard will automatically begin polling your inverters and meters.
- Run
verdantix-cli verifyto check configuration syntax - Monitor logs at
docker logs -f verdantix-agent - Wait 3-5 minutes for initial data sync
- Access the web dashboard at
http://localhost:8080
Success: If you see "Connected to Verdantix Cloud (v2.4.1)" in your logs, your installation is complete.