Skip to content

docs: V4 sync-federation bundle discovery #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lukisch merged 1 commit into from
Jul 29, 2026
Merged

docs: V4 sync-federation bundle discovery #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,23 @@ org overview: [ellmos-ai](https://github.com/ellmos-ai). Companion module for li
SQLite state (role `sync.database`): [sqlite-transit-sync](https://github.com/dev-bricks/sqlite-transit-sync) — see
[Companion tools](#companion-tools) above.

## Bundles and partners

`system-gap-master` remains a standalone, serverless sync tool. In the V4
composition it is the required federation and receipt coordinator of the
`ellmos-sync-federation-bundle`. Its direct partners are the recommended
`sqlite-transit-sync` snapshot adapter and read-only system-map export and
receipt-validation components.

Federation is optional for a local system: if this module is absent or not
healthy, the local core may still produce its local manifest and gap output;
foreign-map import, fleet analysis and direct trusted-peer transfer are then
unavailable rather than silently simulated.

The authoritative bundle manifest defines membership, versions, profiles and
private composition recipes. This public section describes only safe,
standalone discovery relationships.

## Security & privacy notes

- The yard travels through your sync provider: treat it as **semi-trusted**.
Expand Down
18 changes: 18 additions & 0 deletions README_de.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,24 @@ Details:
[`schemas/`](schemas/) und
[`examples/trusted-peer-paths.local-config.example.json`](examples/trusted-peer-paths.local-config.example.json).

## Bundles und Partner

`system-gap-master` bleibt ein eigenständig nutzbares, serverloses
Sync-Werkzeug. In der V4-Komposition ist es der erforderliche Föderations- und
Receipt-Koordinator des `ellmos-sync-federation-bundle`. Direkte Partner sind
der empfohlene Snapshot-Adapter `sqlite-transit-sync` sowie schreibgeschützte
Systemkarten-Export- und Receipt-Validierungskomponenten.

Föderation ist für ein lokales System optional: Fehlt dieses Modul oder ist es
nicht gesund, kann der lokale Kern weiterhin sein lokales Manifest und seine
Gap-Ausgabe erzeugen. Import fremder Karten, Fleet-Analyse und direkter
Trusted-Peer-Transfer sind dann nicht verfügbar und werden nicht still
simuliert.

Das verbindliche Bundle-Manifest definiert Mitgliedschaft, Versionen, Profile
und private Zusammensetzungsrezepte. Dieser öffentliche Abschnitt beschreibt
nur sichere, eigenständig nutzbare Discovery-Beziehungen.

## Lizenz

MIT License — Copyright (c) dev-bricks / Lukas Geiger
Loading