SOLECTRUS

SOLECTRUS is your smart solar dashboard, giving you real‑time insights into energy generation and consumption. It automatically calculates costs and savings, so you can maximize the performance of your PV system.

Live Demo

Try it out at https://demo.solectrus.de

Installation

SOLECTRUS is a self‑hosted solution — just bring your own server (a Raspberry Pi works great, but any Linux box will do).

The recommended way to install SOLECTRUS is HELIOS, the companion app that manages your installation. HELIOS sets up the Docker containers, keeps the configuration in one place, and installs updates with one click. It also creates a support package with anonymized logs and configuration if you need help.

Development

To contribute, set up a local development environment (this guide assumes macOS with Homebrew):

1. Clone the repository:

git clone [email protected]:solectrus/solectrus.git
cd solectrus

1. Install PostgreSQL, Redis, and Caddy (if not already present). On a Mac with HomeBrew, run this to install from the Brewfile:

brew bundle

Ensure that PostgreSQL is running:

brew services start postgresql@18

1. Setup the application to install gems and NPM packages and create the database:

bin/setup

1. Start the application locally:

bin/dev

This starts the app and opens https://solectrus.localhost in your default browser.

On the first run, Caddy will ask for your password to install its local CA certificate.

Documentation

• conventions.md — frontend and testing conventions (ViewComponent, forms, Tailwind in Slim, RSpec)
• sensor-overview.md — sensor architecture and core concepts
• sensor-reference.md — the sensor DSL and technical details
• sensor-sql-queries.md — the SQL behind daily and longer timeframes

Testing

After preparing development environment (see above):

bin/influxdb-restart.sh
bin/rspec
open coverage/index.html

RuboCop:

bin/rubocop

ESLint:

bun run lint

TypeScript:

bun run tsc

There is a shortcut to run all test and linting tools:

bin/ci

AI access (Model Context Protocol)

SOLECTRUS can expose its data to AI clients (such as Claude) through a Model Context Protocol server, so you can ask natural-language questions about your PV system. This is a sponsor-only, read-only feature that is disabled by default. See docs/MCP.md for the available tools and how to connect a client.

Performance Monitoring

The Live Demo is hosted at Hetzner Cloud. For performance monitoring, it uses RorVsWild, which is free for OpenSource projects. You can see internal metrics like CPU, memory, and disk usage, as well as request times and errors here: https://www.rorvswild.com/applications/136101/requests

License

© 2020–2026 Georg Ledermann. Released under AGPL-3.0.

The source code is open source under AGPL-3.0. The SOLECTRUS name and logo are trademarks of Georg Ledermann and are not covered by that license: forking and contributing is welcome, but if you distribute a modified version or run it as a service for others, it must use a different name. See TRADEMARK.md for details.

Third-party licenses

The icons are from Font Awesome Free by Fonticons, Inc. They are licensed under CC BY 4.0 and are used unchanged. SOLECTRUS keeps their path data in config/icons.generated.yml and draws each icon on the server. See the full license.