Files
keeporg/packaging/windows/README.txt
T
root 0e83acb9b1 Add Android client, packaging, Makefile entrypoint and handover docs
Why: the set has to be installable and publishable, not just buildable, and
the next person needs the reasoning, not only the code.

What:
- android/: Kotlin client with no third-party dependencies. A
  DocumentsProvider publishes the mirrored databases to every file picker, so
  KeePassDX opens them as ordinary documents; closing a file it wrote
  triggers a sync. A foreground service holds the event stream open.
  Mirror.decide transcribes the Go merge table, so both platforms resolve a
  conflict identically.
- Makefile as the single entrypoint, with file targets so only what changed
  is rebuilt: host and cross builds, both .deb packages, the macOS DMG with
  its /Applications symlink, the Windows zip, the APK under its F-Droid
  publishing name, and manual-only android-publish.
- versions.mk holds one version per platform plus the Android versionCode;
  `make bump` and `make changelog` move them. Debian changelog is tracked.
- systemd units (hardened system unit for the server, user unit for the
  agent), macOS bundle and launch agent, Windows Task Scheduler job.
- docs/HANDOVER.md on architecture and every decision that shaped it,
  docs/PROTOCOL.md for the API, README for the quick start.

Proved: make check and make test-race both pass; built both .deb packages and
inspected their contents, built the Windows zip, cross-compiled all five
desktop targets, and exercised make bump. The Android module is written but
not compiled: no JDK or Android SDK in this environment, which HANDOVER.md
states plainly.
2026-10-29 16:26:33 +01:00

31 lines
1016 B
Plaintext

KeepOrg for Windows
===================
keeporg.exe is the synchronization agent and the administration command.
First run
---------
keeporg.exe login -server https://keeporg.example.com -user you
keeporg.exe run
`login` stores its configuration in
%AppData%\keeporg\config.json and mirrors your databases into
%UserProfile%\KeepOrg by default. Pass -dir to choose another directory.
Open the .kdbx files in that directory with KeePass, KeePassXC or any
compatible application. Every save is pushed to the server, and changes made
by other people are applied to the files.
Keeping it running
------------------
Import keeporg-task.xml into Task Scheduler to start the agent at logon:
schtasks /create /tn KeepOrg /xml keeporg-task.xml
Conflicts
---------
If someone else saved first, your save is kept beside the file as
<name>.conflict-<timestamp>.kdbx and the server copy is restored. Open both
in KeePass and merge them, or ask a group administrator to switch the
database to another merge strategy.