Commit Graph

15 Commits

Author SHA1 Message Date
E. Kaparulin
4a4ab9d781 Remove a false key-storage claim; fix a broken CLI example and a stale artifact table
Three defects in the README, all found while cross-checking it against the
source and the published releases.

## 1. The key-storage claim was false, not merely wrong about platforms

"Private keys are stored in the OS secure enclave on every platform (iOS
Keychain, macOS Keychain, Android Keystore). They are never written to disk
in plaintext."

There is no OS-keychain integration in Konduit at all. Nothing in the Rust
workspace or the Flutter GUI references a keyring or secure-storage crate --
the GUI's only persistence dependency is shared_preferences. And
core/src/config.rs writes the client identity key straight into the config
file the docs tell you to pass with --config:

    client.toml:  identity_key = "<hex>"

so "never written to disk in plaintext" was false by construction, for the
one thing the claim was about. It also named two platforms that do not ship.

Replaced with what actually happens, and the consequence: the key is
generated locally, never sent to K-Ops, and the config file is itself the
secret -- so restrict its permissions, do not commit it, do not paste it
into a bug report. Deliberately not reworded into another claim I could not
verify.

## 2. The CLI example does not run

    ./konduit connect --config client.toml

--config is a top-level flag on Args (cli/src/main.rs:15), not on the
Connect subcommand, and it is not marked global, so clap rejects it:

    error: unexpected argument '--config' found

Fixed to `./konduit --config client.toml`, which is the form
docs/client-quickstart.md uses and the binary accepts. Documented the
`connect` subcommand's actual flags --server/--peer-id/--identity/
--server-pub -- checked against `konduit connect --help`.

## 3. The artifact table lists assets that are not in the current release

Checked against the Gitea releases API rather than the Makefile. v0.1.0-beta.11
ships five assets: the AppImage, the three Linux binaries, and
konduit-gui-...-windows-x86_64-portable.zip. It has no Windows CLI zip and
no Android AAB; beta.9 and beta.10 had both, and the Windows GUI zip was
only named -portable.zip in beta.11.

So the Windows GUI row is now the published name, and the two rows that
appear in some releases but not others are marked as such with the
variation spelled out. The Releases page is called authoritative, since
which assets ship is a per-release decision.

No claim here is reworded from assumption -- each one was checked against
the code or the published release first.
2026-09-30 11:38:48 +03:00
E. Kaparulin
3b212bbed9 docs(www): align support/vulnerability disclosure with koridor pattern 2026-07-31 12:42:51 +03:00
E. Kaparulin
56201f6b72 docs(public): fix README support section to match actual channels (contact form, no in-app reporting/issues) 2026-07-17 10:34:10 +03:00
E. Kaparulin
99a2993ace docs(public): remove stealth-mode content, add SOCKS5 modes and connection tuning docs 2026-07-10 06:46:44 +03:00
57249605fb Update README.md 2026-06-19 07:44:03 +00:00
E. Kaparulin
7be38783b5 chore: add GUI quickstart docs and update README for 0.1.0-beta.0 2026-06-17 12:00:52 +03:00
E. Kaparulin
10def914ab Update examples 2026-06-09 08:30:41 +03:00
E. Kaparulin
1e08ba34f0 Documentation update 2026-06-09 08:18:12 +03:00
Eugen Kaparulin
5cd882f74b Public website overhaul 2026-06-09 07:17:24 +03:00
Eugen Kaparulin
68b3a7fc26 docs: add server quickstart, stealth setup guide, and download table 2026-06-08 11:48:46 +03:00
Eugen Kaparulin
b3302d2072 chore: sync konduit-platform 2026-06-08 10:46:10 +03:00
Eugen Kaparulin
035fd50452 docs: remove brand section from README 2026-06-08 09:15:32 +03:00
Eugen Kaparulin
278bc0d274 docs: link konduit-platform from README 2026-06-08 09:12:39 +03:00
Eugen Kaparulin
ee7898cfac feat(brand): add logo SVG files and brand guidelines 2026-06-07 22:32:27 +03:00
Eugen Kaparulin
852b6a0cd8 init: initial public repo with README and LICENSE 2026-06-06 16:32:50 +03:00