Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions catalog-overlay/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ the entry on its own, which is how a Desktop-only service would be carried.
| Field | What Desktop does | Why |
| --- | --- | --- |
| `docker.fence_gated` | A deploy is refused unless the earner joins the fenced network (`internal/runtime/lanfence.go`), and the compose export refuses the service. The container gets restart policy `no`, as on the web, and Desktop starts it itself, only right after it has applied the fence: at app start, on every fence check, when isolation is turned on, and from a guard that looks every 30 seconds for a node that is down (`internal/runtime/fence_gated_start.go`). A node whose start Docker refused is left to the five-minute fence check. A stop from the dashboard is recorded and stays a stop until Start or a deploy. A node deployed with `unless-stopped` is switched to `no` in place by the first check; one that is down then with no start error is recorded as stopped. Until that first check has succeeded, the old policy still holds: if the computer restarts before it, or the switch fails, Docker can start the node before the fence is back. A failed switch is shown as the fence's error on the dashboard and is tried again at every check. Turning isolation off stops the node before the fence's drops go, and Start refuses it until isolation is on again. | The web worker starts the node the same way, from its own guard. One difference stays: Desktop is an app, so while neither the window nor its background service runs, nothing starts the node. After a reboot it stays stopped until CashPilot starts, and the dashboard shows it as waiting for the fence. |
| `device_link.id_shape`, `device_link.id_shape_unique` | Read and not used. Desktop masks no device id. | The web app masks a claimable device id in every text shown to anyone but the owner: other roles, the read-only feed, pushed alerts. Desktop has no such reader. Its notices and container logs show only in the owner's own window, and the fleet API and the pairing heartbeat carry slugs and status, not text. |

## Files Desktop reads beside the services

Expand Down
9 changes: 9 additions & 0 deletions internal/catalog/catalog.go
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,15 @@ type DeviceLink struct {
IDEnv string `json:"idEnv" yaml:"id_env"`
URL string `json:"url" yaml:"url"`
Steps string `json:"steps" yaml:"steps"`
// IDShape is the regex of the device id's shape, and IDShapeUnique says the
// shape fits this provider's ids only. An unlinked id claims its earnings for
// whoever adds it first, so the web app masks what matches in every text shown
// to anyone but the owner: other roles, the read-only feed, pushed alerts.
// Desktop has no such reader. Its notices and container logs are shown only in
// the owner's own window, and the fleet API and the pairing heartbeat carry
// slugs and status, not text, so it reads the fields and has nothing to mask.
IDShape string `json:"idShape,omitempty" yaml:"id_shape"`
IDShapeUnique bool `json:"idShapeUnique,omitempty" yaml:"id_shape_unique"`
}

// Disclosure is what a service does with the user's machine, in plain words. An
Expand Down
14 changes: 14 additions & 0 deletions services/_schema.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@
# device by (ProxyRack's UUID). A proxied copy gets its own, derived in the
# same format; a value in a format it cannot derive refuses the copy.
# Required on the key a device_link names.
# identifier: false (optional) the value names this device to the provider
# (a device name or id) without being a secret. CashPilot keeps the values
# of these keys, and of per_device keys, in the owner-only identity list
# after the service is removed, so the owner can see and reuse them.
# Never on a secret key: the loader refuses that.
# port_range: false (optional) the value is "start:end" with
# 1 <= start <= end <= 65535. A pattern checks the shape, not the order.
# ports: ["port:port"]
Expand Down Expand Up @@ -230,6 +235,15 @@
# url: "https://earnapp.com/r/${EARNAPP_UUID}" (optional) where to claim it;
# ${VAR} is filled from the deployed env, URL-encoded
# steps: "Open this link while signed in..." what to do, in plain words
# id_shape: 'sdk-node-[0-9a-f]{32}' regex of the id's shape, matched case-insensitively
# as a whole token. An unlinked id claims its earnings for whoever adds it
# first, so every text shown to anyone but the owner (logs, notices, pushes)
# masks what matches it; ids derived for proxied copies are found this way.
# id_shape_unique: true (optional, default false) the shape fits this provider's
# ids only (EarnApp's sdk-node- prefix), so it is masked in any text, not
# only this service's. Leave it off for a bare shape such as 64 hex, which
# a digest also has.
# A link built from url with the id in it is masked in any text.

# requirements:
# residential_ip: true/false
Expand Down
2 changes: 2 additions & 0 deletions services/bandwidth/bitping.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ short_description: Bandwidth sharing - decentralized network monitoring, works o

referral:
signup_url: "https://app.bitping.com"
# Checked 2026-10-30 at signup and in the node dashboard: no referral programme.
program: false

docker:
image: "bitping/bitpingd@sha256:6f923c4f5e0fe7fa188f621f3dde0cf62e5d3a28848c08f3f84f1a3d8d875dd9"
Expand Down
14 changes: 14 additions & 0 deletions services/bandwidth/earnapp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,24 @@ docker:
command: ""
network_mode: ""
privileged: false
health_signals:
# Seen live (Nov 2026) for four days on one box: the client exited with
# "Error: Handshake timeout" every 100 seconds or so, the container restarted
# it, and Docker's health check stayed healthy throughout.
- pattern: "Error: Handshake timeout"
window_hours: 1
min_matches: 10
means: >-
EarnApp keeps failing to reach its servers and restarting, so it earns
little or nothing. Restart this copy; if it keeps happening, check this
box's internet connection.
state: failing

device_link:
id_env: EARNAPP_UUID
url: "https://earnapp.com/r/${EARNAPP_UUID}"
id_shape: 'sdk-node-[0-9a-f]{32}'
id_shape_unique: true
steps: >-
Open this link while signed in to EarnApp to add the node to your account.
Until you do, the node earns but nothing reaches your balance.
Expand Down
1 change: 1 addition & 0 deletions services/bandwidth/honeygain.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ docker:
secret: true
description: "Your Honeygain account password"
- key: HONEYGAIN_DEVICE_NAME
identifier: true
label: "Device name"
required: false
secret: false
Expand Down
2 changes: 2 additions & 0 deletions services/bandwidth/iproyal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,14 @@ docker:
secret: true
description: "Your IPRoyal Pawns account password (passed as -password flag)"
- key: IPROYALPAWNS_DEVICE_NAME
identifier: true
label: "Device name"
required: false
secret: false
description: "Name shown in your Pawns dashboard (passed as -device-name flag)"
default: "cashpilot-{hostname}"
- key: IPROYALPAWNS_DEVICE_ID
identifier: true
label: "Device ID"
required: false
secret: false
Expand Down
24 changes: 24 additions & 0 deletions services/bandwidth/packetstream.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,30 @@ docker:
command: ""
network_mode: ""
privileged: false
health_signals:
# Seen live (Nov 2026): a copy whose egress IP PacketStream classes as a
# datacenter logged this every few minutes for days, never "PacketStream is
# running", and earned nothing while its container stayed healthy.
- pattern: "Non-residential IPs are currently unsupported"
unless: "PacketStream is running"
window_hours: 2
min_matches: 10
means: >-
PacketStream refuses this copy's IP address as not residential, so it
earns nothing. Run it on a box whose internet connection is a home line,
or remove this copy.
state: failing
# Seen live (Nov 2026) a few times a day on a healthy copy, each time
# followed by "PacketStream is running"; only a copy that never recovers
# inside the window is flagged.
- pattern: "allows packeting from 1 client per IP address"
unless: "PacketStream is running"
window_hours: 2
min_matches: 10
means: >-
PacketStream already has another client on this IP address, and it pays
only one per IP. Remove this copy, or the other one that shares its IP.
state: failing

requirements:
residential_ip: true
Expand Down
17 changes: 17 additions & 0 deletions services/bandwidth/proxybase.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ docker:
secret: true
description: "Log in at <a href=\"https://peer.proxybase.org/dashboard\">peer.proxybase.org/dashboard</a> → copy your Access Token (shown in the Docker command on the setup page)"
- key: NAME
identifier: true
label: "Device Name"
required: true
secret: false
Expand All @@ -44,6 +45,22 @@ docker:
# are filled from the form values at deploy time.
command: "${ID} ${NAME}"
network_mode: ""
health_signals:
# Seen live (Nov 2026) on two boxes for days: the client logged a failed
# relay connection every 15 seconds ("Failed to connect to <ip>:2931,
# retrying in 5 seconds.", split over two lines), so 240 an hour, logged no
# balance, and earned nothing while its container stayed healthy, until the
# hosts rebooted. A working copy logs "Balance: $..." every 30 seconds and
# never this line. 120 lines is half an hour of retries.
- pattern: "retrying in 5 seconds"
unless: "Balance: \\$"
window_hours: 1
min_matches: 120
means: >-
ProxyBase has not reached its relay for at least half an hour, so it
earns nothing. Restart this copy; if that does not help, check that this
box can reach the internet.
state: failing

requirements:
residential_ip: false
Expand Down
2 changes: 2 additions & 0 deletions services/bandwidth/proxyrack.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ docker:
secret: true
description: "Log in at <a href=\"https://peer.proxyrack.com\">peer.proxyrack.com</a> → API Key is shown on the main dashboard page (auto-registers device if provided)"
- key: DEVICE_NAME
identifier: true
label: "Device name"
required: false
secret: false
Expand All @@ -48,6 +49,7 @@ docker:
device_link:
id_env: UUID
url: "https://peer.proxyrack.com"
id_shape: '[0-9a-f]{64}'
steps: >-
Sign in to ProxyRack, open Devices, choose Add device and paste this UUID.
Until the device is on your account it earns for nobody. If you entered an
Expand Down
1 change: 1 addition & 0 deletions services/bandwidth/traffmonetizer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ docker:
secret: true
description: "Log in at <a href=\"https://app.traffmonetizer.io\">app.traffmonetizer.io</a>, press F12 → Application → Local Storage → click <code>https://app.traffmonetizer.io</code> → copy the <code>authToken</code> value (about 54 characters, digits, a <code>|</code>, then letters and digits)"
- key: TRAFFMONETIZER_DEVICE_NAME
identifier: true
label: "Device name"
required: false
secret: false
Expand Down
Loading