77 lines
3.2 KiB
Markdown
77 lines
3.2 KiB
Markdown
# LumaOps
|
|
|
|
LumaOps brengt al je ondersteunde RGB-hardware samen in één lokale webinterface.
|
|
Vanuit je browser beheer je apparaten, ruimtes, groepen, scènes, planningen, back-ups
|
|
en diagnostiek. Er is geen cloudaccount nodig: de toepassing, database en
|
|
hardware-engine draaien samen op je eigen Linux- of Unraid-server.
|
|
|
|
> **Release status:** 0.1.0 is een release candidate. Begin met één apparaat en een
|
|
> statische kleur op lage helderheid. RGB-protocollen zijn vaak reverse-engineered;
|
|
> directe hardwarebesturing houdt altijd een beperkt risico in.
|
|
|
|
## Wat je krijgt
|
|
|
|
- één responsieve interface voor inventaris, bediening, scènes en automatiseringen;
|
|
- lokale opslag in SQLite met controleerbare back-up en restore;
|
|
- audit- en diagnostiekfuncties zonder ruwe secrets in exports;
|
|
- OpenRGB 1.0rc3 als ingebedde hardware-engine;
|
|
- een afgeschermde interne OpenRGB SDK-verbinding op `127.0.0.1:6742`;
|
|
- expliciete USB-, HID- en I²C-device mappings in plaats van een privileged container.
|
|
|
|
Native WLED- en Home Assistant-connectors zijn nog niet inbegrepen in 0.1.0.
|
|
|
|
## Snel starten
|
|
|
|
Vereisten: Docker Compose v2, Linux/Unraid x86_64 en toegang tot de benodigde
|
|
hardware-device nodes.
|
|
|
|
```sh
|
|
cp .env.example .env
|
|
# Vervang LUMAOPS_ADMIN_TOKEN in .env door een unieke waarde:
|
|
openssl rand -base64 32
|
|
docker compose build
|
|
docker compose up -d
|
|
```
|
|
|
|
Open vervolgens `http://SERVER-IP:1223`, meld je aan met de ingestelde beheertoken
|
|
en doorloop de setupwizard. De token is standaard verplicht omdat de webinterface
|
|
op het LAN luistert. Gebruik `SECURE_COOKIES=true` zodra je LumaOps achter HTTPS
|
|
plaatst; laat dit op `false` voor rechtstreekse HTTP-toegang op een vertrouwd LAN.
|
|
|
|
Map alleen de hardware die je werkelijk nodig hebt. Voor netwerkapparaten die
|
|
broadcast, multicast of mDNS vereisen, staat een gedocumenteerde host-network
|
|
override klaar:
|
|
|
|
```sh
|
|
docker compose -f docker-compose.yml -f docker/compose.host-network.yml up -d
|
|
```
|
|
|
|
Publiceer poort `6742` nooit. Het OpenRGB SDK-protocol heeft zelf geen
|
|
authenticatie of transportbeveiliging.
|
|
|
|
## Documentatie
|
|
|
|
- [Unraid-installatie](docs/UNRAID_DEPLOYMENT.md)
|
|
- [Hardwaretoegang](docs/HARDWARE_ACCESS.md)
|
|
- [Back-up en herstel](docs/BACKUP_AND_RESTORE.md)
|
|
- [Veiligheidsmodel](docs/SECURITY.md)
|
|
- [Probleemoplossing](docs/TROUBLESHOOTING.md)
|
|
- [Testen en verificatie](docs/TESTING.md)
|
|
- [OpenRGB upstream synchroniseren](docs/OPENRGB_UPSTREAM_SYNC.md)
|
|
- [Gedocumenteerde OpenRGB-corepatches](docs/CORE_PATCHES.md)
|
|
- [Publieke releasegrens](docs/PUBLIC_RELEASE.md)
|
|
|
|
De broncode is bewust als OpenRGB-fork opgebouwd. LumaOps staat onder `lumaops/`,
|
|
de containerlaag onder `docker/` en projectdocumentatie onder `docs/`.
|
|
|
|
## OpenRGB en licentie
|
|
|
|
LumaOps bouwt op [OpenRGB](https://openrgb.org), ontwikkeld door de OpenRGB-
|
|
community. De geïmporteerde 1.0rc3-bron, oorspronkelijke copyrightvermeldingen en
|
|
licentieteksten blijven behouden. LumaOps en de gecombineerde distributie vallen
|
|
onder **GPL-2.0-or-later**. Wie images of binaries verspreidt, moet de bijbehorende
|
|
broncode en wijzigingen onder die licentie beschikbaar maken.
|
|
|
|
Zie [LICENSE](LICENSE) voor de volledige licentietekst en [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
voor de upstream bijdragevoorwaarden.
|