← Terug naar nieuws

OptimCE installeren: snelstartgids

· door Eric van OptimCE

OptimCE-app Gids

Er zijn twee manieren om met OptimCE te starten, en welke de juiste is hangt vooral af van wie u bent.

Beheert u een energiegemeenschap en wilt u gewoon het gereedschap, dan is OptimCE Cloud de gehoste versie: geen installatie, geen onderhoud, en tijdens de alpha momenteel gratis. Ga meteen naar de gebruikersgids.

Bent u een technisch team dat het platform zelf wil draaien, de volledige controle over de data wil houden of aan de code wil bijdragen, dan is deze gids voor u. Hij beschrijft de lokale uitrol van de volledige stack.

Wat u gaat uitrollen

OptimCE is geen monolithische applicatie maar een ecosysteem van microservices, georkestreerd vanuit één centrale repository: de monorepo. Bij het opstarten komen omhoog:

  • zeven applicaties — CRM-frontend en -backend, generatie van verdeelsleutels, sleutelsimulatie, facturatie, documentgeneratie en het nieuwsbord;
  • zes PostgreSQL-databanken, één per functioneel domein;
  • de platformdiensten: Keycloak voor authenticatie, KrakenD als API-gateway, Nginx als reverse proxy, MinIO voor objectopslag, NATS voor messaging en Jaeger voor tracing.

Die architectuur verklaart de gereedschapskeuze in de volgende sectie: u installeert de componenten niet één voor één, u laat Docker Compose het werk doen.

Vereisten

Drie tools, en verder niets:

  • Docker
  • Docker Compose
  • Git

Node.js, Python of PostgreSQL hoeft u niet op uw machine te installeren: elke dienst brengt zijn eigen runtime mee in zijn container.

1. De repository klonen

De monorepo bundelt de diensten als Git-submodules. --recurse-submodules is dus niet optioneel:

git clone --recurse-submodules https://github.com/OptimCE/monorepo.git
cd monorepo

Hebt u al zonder submodules gekloond, dan hebt u de orkestratieconfiguratie maar geen applicatiecode. Herstel met:

git submodule update --init --recursive

2. De omgevingsvariabelen instellen

Stel vóór de eerste start de wachtwoorden in het bestand .env.dev in:

DB_PASSWORD=changeme_db_password
KEYCLOAK_DB_PASSWORD=changeme_keycloak_db_password
KEYCLOAK_ADMIN_PASSWORD=changeme_keycloak_admin_password

Wijzig deze waarden, ook lokaal. Een demowachtwoord dat blijft staan is de meest banale manier om een instantie bloot te leggen die privé had moeten blijven.

De CRM-databank initialiseert zich bij de eerste start automatisch via het script crm-backend/database_script/init.sql.

3. De stack starten

De aanbevolen weg loopt via het meegeleverde script:

chmod +x ./docker-stack.sh
./docker-stack.sh start

Wie Docker Compose liever rechtstreeks aanstuurt:

docker compose --env-file .env.dev -f docker-compose.dev.yml --profile dev up -d

En om de images eerst te herbouwen:

docker compose --env-file .env.dev -f docker-compose.dev.yml --profile dev up --build

Let op — de gegevens zijn niet persistent. In de ontwikkelconfiguratie worden de databanken bij het herstarten van de containers gewist. Dat is een bewuste keuze die bij elke test een schone omgeving waarborgt. Een blijvende uitrol vereist persistente volumes en een back-upstrategie.

4. Uw eerste gemeenschap aanmaken

Zodra de stack draait, meldt u zich aan op de beheerinterface. De authenticatie verloopt via Keycloak: gebruik het beheerdersaccount waarvan u in stap 2 het wachtwoord hebt ingesteld.

De volgorde van ingebruikname is daarna dezelfde als op de gehoste versie:

  1. de gemeenschap aanmaken en haar juridische gegevens invullen;
  2. de leden toevoegen en hun leveringspunten (EAN) koppelen;
  3. de verdeelsleutel van de deelactie vastleggen;
  4. de berekening over een testperiode nakijken voordat ze naar de netbeheerder gaat.

De functionele details van elke stap staan in de gebruikersgids, die de actuele referentie blijft voor het gebruik van de applicatie.

Verder lezen

Is het onderwerp nieuw voor u in plaats van het gereedschap, begin dan bij het kader:

Energiegemeenschappen in België: CER, CEC, CEL

De drie statuten, energiedelen, en de rol van de regulator en de netbeheerder.

Verdeelsleutel automatisch genereren

Hoe de generatiemodule op basis van uw echte data een sleutel voorstelt.

FAQ

Moet ik OptimCE installeren om het te gebruiken?

Nee. OptimCE Cloud is de gehoste en beheerde versie: u maakt een account aan en gaat van start, zonder installatie en zonder onderhoud. De lokale installatie is bedoeld voor teams die het platform op hun eigen infrastructuur willen draaien, de volledige controle over hun data willen houden of aan de code willen bijdragen. Beide bieden dezelfde functionaliteit.

Wat heb ik nodig om OptimCE lokaal te installeren?

Slechts drie dingen: Docker, Docker Compose en Git. De volledige stack — applicaties, PostgreSQL-databanken, Keycloak, API-gateway, objectopslag en messaging — wordt via Docker Compose vanuit de monorepo georkestreerd. U hoeft Node.js, Python of PostgreSQL niet apart op uw machine te installeren.

Waarom moet ik klonen met --recurse-submodules?

Omdat de OptimCE-monorepo de afzonderlijke diensten bundelt als Git-submodules: CRM-frontend en -backend, generatie en simulatie van verdeelsleutels, facturatie, documentgeneratie en het nieuwsbord. Zonder --recurse-submodules krijgt u de orkestratieconfiguratie maar geen applicatiecode. Hebt u al zonder gekloond, dan lost git submodule update --init --recursive het op.

Blijven de gegevens van de ontwikkelstack bewaard?

Nee. In de ontwikkelconfiguratie zijn de databanken niet persistent: bij het herstarten van de containers worden de gegevens gewist. Dat is bewust zo — het garandeert een schone omgeving bij elke test. Een uitrol die moet blijven draaien vereist persistente volumes en een back-upstrategie.

Onder welke licentie staat OptimCE?

Onder de Apache 2.0-licentie. U mag het platform gratis en zonder beperking op uw eigen infrastructuur uitrollen, ook in een professionele context. Als tegenprestatie voor die vrijheid betekent zelf hosten dat u zelf instaat voor hosting, updates en beschikbaarheid: op dat pad wordt geen dienstgarantie geboden.

Liever niet installeren? Gebruik OptimCE Cloud

De gehoste versie is gratis tijdens de alpha: geen installatie, geen onderhoud, dezelfde functionaliteit. Maakt u gemeenschap aan in enkele minuten of doorblader de open deelacties.

Open de OptimCE-app Bekijk de monorepo op GitHub

Bronnen