Architecture overview
What is this about?
In short: Illumentis consists of a web app in the browser, an interface on the server, a database, a search and background jobs. The wiki is a separate system. We describe the building blocks in simplified form and deliberately name no versions and no server layout.
Protection goal
You should understand what Illumentis is made of and where which data is processed, without us handing attackers a map.
How it works
The path of an input: you write in the browser, the app saves locally and sends the text over an encrypted connection to the interface. The interface checks permissions, processes the request and stores texts encrypted in the database.
| Building block | Task | Technology |
|---|---|---|
| Interface | The app in the browser: pages, state, editor | Vue 3, Pinia, Tailwind CSS, TipTap |
| Offline part | Installability, local saving, syncing | Service worker, IndexedDB (Dexie) |
| API | Permission checks, business rules, REST interface (JSON) | Symfony, API Platform |
| Database | Storage, separated by project | PostgreSQL |
| Search | Full-text search in your content | TNTSearch |
| Background jobs | Exports, check runs and other longer tasks | Symfony Messenger |
| Documents | Export as a Word document and e-book | PHPWord, EPUB 3 |
| Wiki and website | These pages, separate from the app | Sulu |
Measures
- We keep the parts separate: the architecture rules define which parts may depend on each other and are checked on every change.
- Background jobs run through the database as a queue and need no additional service.
- Spelling and grammar checking runs on an instance of our own. For this, the text leaves the browser only towards our own infrastructure.
- The wiki is separate from the app and has no access to your project data.
What we do not promise
- The description is simplified and not exhaustive. It shows the large building blocks, not every detail.
- We deliberately do not name versions, the server layout or hosting details.
- A technology named here is in use. That does not mean we will keep it for all time.
How we check this
Deptrac checks the architecture rules on every change, and static analysis is done by PHPStan. More under “How we test”. This article relies on our project documentation and not on a test of its own.
Change history
- : First version.