8b83fc10d5
This repo is a hard fork of mycellium-ui dedicated to the mycelium-private experimental track upstream. The two apps coexist on the same machine via distinct app identifiers, polkit actions, and binary names. Renames - package + crate: mycellium-ui → mycellium-ui-private - bundle identifier: tech.threefold.mycellium-ui-private - daemon binary: mycelium-private (separate upstream release tarball) - bootstrap wrapper: /usr/bin/mycellium-bootstrap-private - polkit policy file + action id Functional changes - SidecarConfig.network_name field (UTF-8, 2..=64 bytes) - start() refuses to spawn without a network name AND a 32-byte key file at app_data_dir/network_key.bin; surfaces a clear error rather than letting mycelium-private fail mid-startup - network_key_status / generate / import / export / delete commands; uses OS RNG (rand) and writes 0600 - empty default peers list (no Threefold seed for private overlays) - new Settings → Private network panel: name input, key generate / reveal-hex / import / delete, status indicator Adapted bootstrap script kills both `mycelium` and `mycelium-private` orphans (cross-clash on UDP/9650 + TCP/8990). CI workflow + sidebar branding updated. The README explains the divergence model and how to cherry-pick upstream fixes.
85 lines
3.9 KiB
Markdown
85 lines
3.9 KiB
Markdown
# mycellium-ui-private
|
||
|
||
Desktop GUI for joining a **private** [Mycelium](https://github.com/threefoldtech/mycelium) overlay network — a self-contained IPv6 mesh isolated from the public Mycelium network by a shared 32-byte key.
|
||
|
||
This is a fork of [`mycellium-ui`](https://git.open.us.org/syoul/Mycell-UI) (the public-network variant). Code structure is identical; only the bundled daemon (`mycelium-private` instead of `mycelium`), the default config (no public seed peer), and a new "Private network" panel in Settings differ.
|
||
|
||
The two apps are designed to **coexist** on the same machine: distinct app identifier (`tech.threefold.mycellium-ui-private`), distinct binary (`/usr/bin/mycellium-ui-private`), distinct polkit action.
|
||
|
||
## What's a private network?
|
||
|
||
Mycelium 0.6.1 ships an opt-in mode where every packet is wrapped under an additional symmetric key. Two nodes only see each other if:
|
||
|
||
1. They run the `mycelium-private` daemon (not the public `mycelium`).
|
||
2. They were both started with the same `--network-name` (UTF-8, 2–64 bytes — public, e.g. `acme-corp-private`).
|
||
3. They were both started with `--network-key-file` pointing at the same 32-byte secret.
|
||
|
||
Without the right name+key, peers reject each other at the handshake. There's no Threefold-operated bootstrap node for private networks — the operator distributes the key out-of-band and brings up at least one reachable peer (typically a VPS) that other nodes can dial.
|
||
|
||
## Status
|
||
|
||
v0.1, Linux-only. Same UI surface as the public variant. **Marked experimental upstream** (`docs/private_network.md` in the mycelium repo).
|
||
|
||
## Setup (dev)
|
||
|
||
```bash
|
||
sudo apt install -y \
|
||
libwebkit2gtk-4.1-dev libjavascriptcoregtk-4.1-dev \
|
||
libsoup-3.0-dev libayatana-appindicator3-dev librsvg2-dev \
|
||
build-essential curl wget file libssl-dev libgtk-3-dev libxdo-dev \
|
||
pkg-config policykit-1
|
||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
|
||
|
||
pnpm install
|
||
bash scripts/fetch-mycelium.sh # downloads mycelium-private v0.6.1
|
||
pnpm tauri dev
|
||
```
|
||
|
||
On first launch:
|
||
|
||
1. Open **Settings → Private network**.
|
||
2. Type a network name (e.g. `acme-corp-private`).
|
||
3. Click **Generate 32-byte key** (or **Import** a key already shared with you).
|
||
4. Click **Reveal hex** and share the hex string out-of-band with your other nodes.
|
||
5. Save daemon configuration (add at least one bootstrap peer).
|
||
6. Click **Start daemon** in the sidebar.
|
||
|
||
Other nodes paste the same hex into their **Import** field and use the same network name.
|
||
|
||
## Build a `.deb`
|
||
|
||
```bash
|
||
pnpm tauri build --bundles deb
|
||
# → src-tauri/target/release/bundle/deb/Mycellium UI Private_*.deb
|
||
```
|
||
|
||
The `.deb` declares `Depends: pkexec | policykit-1` (Debian 12 + 13 covered) and ships:
|
||
- `/usr/bin/mycellium-ui-private` (GUI)
|
||
- `/usr/bin/mycelium-private` (daemon)
|
||
- `/usr/bin/mycellium-bootstrap-private` (cleanup wrapper for orphan handling)
|
||
- `/usr/share/polkit-1/actions/tech.threefold.mycellium-ui-private.policy`
|
||
|
||
## Diverging from upstream
|
||
|
||
This fork tracks `Mycell-UI` upstream as `origin/upstream` (after running the `git remote add upstream ...` step). To pull bugfixes:
|
||
|
||
```bash
|
||
git fetch upstream
|
||
git cherry-pick <upstream-commit>
|
||
```
|
||
|
||
Most fixes will apply cleanly because the only divergence is in:
|
||
- `src-tauri/src/sidecar.rs` (network_name + key_file args)
|
||
- `src-tauri/src/commands.rs` (network_key_* commands)
|
||
- `src-tauri/packaging/` (different bootstrap script + polkit policy)
|
||
- `src-tauri/tauri.conf.json` (productName, identifier, externalBin)
|
||
- `src/views/Settings.vue` (Private network section)
|
||
- `src/stores/config.ts` (defaults)
|
||
|
||
## Known limitations (v0.1)
|
||
|
||
- Linux only.
|
||
- The `mycelium-private` binary is upstream's experimental track; the API may shift in a future release.
|
||
- Network keys are stored in `$XDG_DATA_HOME/tech.threefold.mycellium-ui-private/network_key.bin` with mode `0600`. Not encrypted at rest — host-level disk encryption is the only layer.
|
||
- No multi-network support — one private overlay at a time.
|