Evolu Relay als tweede app in de store, plus het bouwrecept
De gebruiker koos ervoor het pakket meteen te maken en een installatie te proberen, met de image lokaal gebouwd en het recept in de repo. Dit is dat pakket. Er is nog niets gebouwd en niets geinstalleerd; "gebouwd" is hier nadrukkelijk niet "werkend". De zwaarste ontwerpvraag is met een precedent beslecht en niet met een gok. Trezor Suite is geen browser met een sessiecookie en kan dus niet achter de inlog van umbrelOS; het was onduidelijk of PROXY_AUTH_ADD "false" dan verantwoord is of een omweg. De eigen nostr-relay-app van Umbrel doet exact hetzelfde, om precies dezelfde reden, en heeft ook geen eigen ports:. De prijs staat in de compose en in het plan: wie die poort bereikt, bereikt de relay. Wat de schade beperkt is dat de relay elke eigenaar zonder limietenrij weigert. Daarom gaat de quota-manager mee, en dat is geen restje van Trezor's betaalde hosting: hij is wat die rijen aanmaakt. Relay en quota-manager komen uit dezelfde image met een ander command, want bovenstrooms is het een codebase met meerdere startscripts. Het command staat expliciet en leunt niet op de CMD van de Dockerfile, waar yarn start staat met bovenstrooms zelf een twijfel erbij. Het bouwrecept staat in tools/ en niet in de app-map. Dat is geen netheid: een Dockerfile staat niet in de update-whitelist, dus bouwen-in-de-app zou elke nieuwe versie een deinstallatie plus herinstallatie kosten. Onder tools/ en niet onder build/, want dat laatste staat in .gitignore als bouwselmap en het recept zou stilzwijgend buiten de repo zijn gebleven. Dat kwam pas bij git status aan het licht. De poort is 3851 en niet 4000. 4000 is de eigen poort van de relay maar ook een veelgebruikte poort, en een botsing op de host merk je pas als de app niet start. Die les komt van 50002 tegen Fulcrum. Nieuw testbestand test_appstore_vorm.py, en het gaat over de store en niet over een app: id gelijk aan mapnaam, store-voorvoegsel, veldvolgorde, app_proxy die naar een bestaande service wijst, en elke gemounte map die in de repo bestaat. Het vindt zijn apps zelf, dus een derde app valt er automatisch onder. Digests toetst het expres niet: geen van de twee apps haalt die regel vandaag en een suite die altijd rood staat wordt niet gelezen. Mutatie-getest met drie ingrepen: het app-id laten afwijken van de mapnaam, APP_HOST naar een niet-bestaande service laten wijzen, en de .gitkeep weghalen. Alle drie vielen om bij de juiste toets, en git diff was daarna leeg. Umbrelapp is gepromoveerd naar Actief als 008, tussen Proefopstelling en Appstore, en het masterplan is naar het archief. Wat er in de plannen als open blijft staan is niet klein: of Trezor Suite dit adres accepteert, of het databaseschema zichzelf aanmaakt, en hoe je een eigenaar registreert. Tests: 32 goed 0 fout, 39 goed 0 fout en 54 goed 0 fout, niets overgeslagen. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Harmen
@@ -0,0 +1,117 @@
|
||||
# ═══════════════════════════════════════════════════════════════════════════════
|
||||
# Evolu Relay - de sync-server van Trezor Suite op je eigen Umbrel.
|
||||
#
|
||||
# Drie containers, twee images. De relay en de quota-manager komen uit dezélfde
|
||||
# image met een ander `command`: bovenstrooms is het één codebase met meerdere
|
||||
# startscripts. Dat is nagetrokken in de Dockerfile en de README van Trezor; zie
|
||||
# Docs/Referenties/Upstream-evolu-relay.md §2.
|
||||
# ═══════════════════════════════════════════════════════════════════════════════
|
||||
|
||||
services:
|
||||
app_proxy:
|
||||
environment:
|
||||
APP_HOST: whatsnext-evolu-relay_relay_1
|
||||
APP_PORT: 4000
|
||||
# Trezor Suite is geen browser met een sessiecookie. Achter de inlog van
|
||||
# umbrelOS zou het een inlogpagina krijgen in plaats van de relay, en dat
|
||||
# is niet op te lossen aan onze kant.
|
||||
#
|
||||
# Dit is geen omweg: het is het patroon dat de eigen nostr-relay-app van
|
||||
# Umbrel gebruikt, om precies dezelfde reden. Ook Gitea en Budibase in de
|
||||
# officiele store doen het zo.
|
||||
#
|
||||
# De prijs staat er wel bij: wie deze poort kan bereiken, bereikt de relay
|
||||
# zonder aanmelding. Wat de schade beperkt is dat de relay zelf elke
|
||||
# eigenaar weigert die geen limietenrij in de database heeft. Zet deze app
|
||||
# dus niet zonder meer open naar het internet; zie het masterplan
|
||||
# Bereikbaarheid.
|
||||
PROXY_AUTH_ADD: "false"
|
||||
|
||||
relay:
|
||||
# TODO pinnen. Deze tag komt uit tools/evolu-relay/build.sh en bestaat
|
||||
# voorlopig alleen in de lokale Docker-opslag van de machine waar gebouwd is.
|
||||
# Daarom staat er geen @sha256: er is nog geen register. Compose haalt niets
|
||||
# op zolang de image lokaal bestaat; zodra de tag naar een register wijst,
|
||||
# hoort de digest erbij. Zie Docs/Referenties/Images-pinnen.md.
|
||||
image: whatsnext/evolu-relay:c03a204
|
||||
restart: on-failure
|
||||
depends_on:
|
||||
db:
|
||||
condition: service_healthy
|
||||
# Bovenstrooms staat `CMD ["yarn", "start"]` in de Dockerfile, met daarbij een
|
||||
# eigen commentaar dat het misschien een van de twee specifieke scripts had
|
||||
# moeten zijn. Daarom hier expliciet, en niet vertrouwen op de standaard.
|
||||
command: ["yarn", "start-evolu-relay"]
|
||||
environment:
|
||||
RELAY_PORT: "4000"
|
||||
HEALTH_PORT: "4002"
|
||||
# dev of prod. Volgens .env.sample zet prod authenticatie aan; in de code
|
||||
# bepaalt die vlag alleen het logniveau en staan de autorisatiecontroles
|
||||
# onvoorwaardelijk aan. Een van de twee is achterhaald en dat is nog niet
|
||||
# uitgezocht. Hier staat prod, want dat is de veilige kant van die
|
||||
# onduidelijkheid: als het iets aanzet, willen we dat het aanstaat.
|
||||
SERVER_ENV: prod
|
||||
POSTGRES_GATE_HOST: whatsnext-evolu-relay_db_1
|
||||
POSTGRES_GATE_PORT: "5432"
|
||||
POSTGRES_GATE_USER: suite-sync
|
||||
POSTGRES_GATE_DB: suite-sync-gate
|
||||
# Door umbrelOS per installatie afgeleid. Nooit een letterlijke waarde:
|
||||
# deze repo is publiek.
|
||||
POSTGRES_GATE_PASSWORD: ${APP_PASSWORD}
|
||||
POSTGRES_GATE_SSL: "false"
|
||||
|
||||
quota-manager:
|
||||
image: whatsnext/evolu-relay:c03a204
|
||||
restart: on-failure
|
||||
depends_on:
|
||||
db:
|
||||
condition: service_healthy
|
||||
command: ["yarn", "start-quota-manager"]
|
||||
# Waarom deze container er is, terwijl hij bij Trezor bij hun betaalde
|
||||
# hosting hoort: de relay weigert elke eigenaar zonder rij in de
|
||||
# limietentabel, en dit is wat die rijen aanmaakt. Er is geen HTTP-koppeling
|
||||
# tussen de twee; ze delen alleen de database. Zie Upstream-evolu-relay.md §3.
|
||||
environment:
|
||||
QUOTA_MANAGER_PORT: "4001"
|
||||
HEALTH_PORT: "4012"
|
||||
SERVER_ENV: prod
|
||||
POSTGRES_GATE_HOST: whatsnext-evolu-relay_db_1
|
||||
POSTGRES_GATE_PORT: "5432"
|
||||
POSTGRES_GATE_USER: suite-sync
|
||||
POSTGRES_GATE_DB: suite-sync-gate
|
||||
POSTGRES_GATE_PASSWORD: ${APP_PASSWORD}
|
||||
POSTGRES_GATE_SSL: "false"
|
||||
|
||||
db:
|
||||
# TODO pinnen op de multi-arch index-digest, met
|
||||
# `docker buildx imagetools inspect postgres:17-alpine`. Kan alleen op een
|
||||
# machine met Docker; staat als taak in het plan Umbrelapp.
|
||||
#
|
||||
# Niet `postgres` kaal zoals de compose van Trezor doet: dat is `latest` en
|
||||
# dus niet reproduceerbaar, en een grote-versiesprong van Postgres migreert
|
||||
# zijn datamap niet vanzelf. Dan start de database niet meer en is de data
|
||||
# alleen met handwerk terug te halen.
|
||||
image: postgres:17-alpine
|
||||
restart: on-failure
|
||||
environment:
|
||||
POSTGRES_USER: suite-sync
|
||||
POSTGRES_DB: suite-sync-gate
|
||||
POSTGRES_PASSWORD: ${APP_PASSWORD}
|
||||
# Een submap en niet de wortel van de mount. Postgres weigert een datamap
|
||||
# die al iets anders bevat, en een mount heeft op sommige bestandssystemen
|
||||
# een lost+found.
|
||||
PGDATA: /var/lib/postgresql/data/pgdata
|
||||
volumes:
|
||||
# Onder data/ en niet in een naamloos Docker-volume: dit is wat umbrelOS
|
||||
# bewaart en meeneemt in de back-up. In een volume zou de database een
|
||||
# herinstallatie van de app niet overleven.
|
||||
- ${APP_DATA_DIR}/data/postgres:/var/lib/postgresql/data
|
||||
healthcheck:
|
||||
# Op de eigen database en gebruiker, niet op `-d postgres` zoals
|
||||
# bovenstrooms: die database bestaat hier niet en dan is de controle groen
|
||||
# terwijl het verkeerde antwoord gegeven wordt.
|
||||
test: ["CMD-SHELL", "pg_isready -U suite-sync -d suite-sync-gate"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 10
|
||||
start_period: 30s
|
||||
@@ -0,0 +1,81 @@
|
||||
# De veldvolgorde hieronder is niet vrij: de packaging-documentatie van de
|
||||
# officiele appstore schrijft hem voor. Zie de tabel in
|
||||
# Docs/Referenties/Umbrel-appstore-spec.md.
|
||||
#
|
||||
# Wat de spec niet noemt staat onderaan dit bestand en niet ertussen. Dan is de
|
||||
# voorgeschreven kop letterlijk goed en hoeft er bij inlevering alleen iets weg.
|
||||
#
|
||||
# `dependencies` is weggelaten en niet leeg gezet: deze app hangt van geen enkele
|
||||
# andere app af. Een leeg veld zou suggereren dat er iets te kiezen valt.
|
||||
manifestVersion: 1
|
||||
id: whatsnext-evolu-relay
|
||||
category: bitcoin
|
||||
name: Evolu Relay
|
||||
version: "0.0.1"
|
||||
tagline: Sync your Trezor Suite labels through your own machine
|
||||
description: >-
|
||||
Trezor Suite can sync the labels and account names you give your addresses across your
|
||||
devices. By default that runs through a server operated by Trezor. This app runs that
|
||||
server on your Umbrel instead, so the sync goes through a machine you own.
|
||||
|
||||
|
||||
The data is end to end encrypted on your device before it leaves, so Trezor cannot read
|
||||
your labels either way. What self-hosting changes is who holds the encrypted copy and who
|
||||
can see that you are syncing at all.
|
||||
|
||||
|
||||
This is Trezor's own relay, not a reimplementation: it is built from the source they publish
|
||||
as trezor/trezor-suite-sync, pinned to a specific commit.
|
||||
|
||||
|
||||
Point Trezor Suite at this Umbrel to use it. Away from home you will need a way in, such as
|
||||
Tailscale or a reverse proxy with your own domain.
|
||||
|
||||
|
||||
Two things to know before you install. The relay has no web interface, so the tile opens the
|
||||
relay itself rather than a page for you to read. And it only serves an owner that has a
|
||||
storage limit registered in its database, which is what the included quota manager is for;
|
||||
if syncing is refused, that registration is the place to look.
|
||||
releaseNotes: >-
|
||||
First release. Packages Trezor's Evolu Relay, the quota manager it needs, and a PostgreSQL
|
||||
database, all on your own machine.
|
||||
|
||||
|
||||
Built from source pinned to commit c03a204 of trezor/trezor-suite-sync. There is no image
|
||||
published by Trezor, so the image is built from their Dockerfile; see tools/evolu-relay in
|
||||
the app store repository.
|
||||
|
||||
|
||||
Not verified yet: whether Trezor Suite accepts this address, and what has to happen before
|
||||
an owner is allowed to sync.
|
||||
developer: "WhatsNext?"
|
||||
website: https://sc.kamenier-hamer.nl/sysop/UmbrelApps
|
||||
repo: https://sc.kamenier-hamer.nl/sysop/UmbrelApps
|
||||
support: https://sc.kamenier-hamer.nl/sysop/UmbrelApps/issues
|
||||
# De poort waarop umbrelOS deze app aanbiedt, en tegelijk de poort waar Trezor
|
||||
# Suite naartoe wijst: de app-proxy staat met PROXY_AUTH_ADD op "false", dus wat
|
||||
# hier binnenkomt gaat rechtstreeks naar de relay. Zie docker-compose.yml.
|
||||
#
|
||||
# Niet 4000, de eigen poort van de relay: die is een veelgebruikte poort en een
|
||||
# botsing op de host merk je pas als de app niet start. Dat heeft bij Electrum
|
||||
# Gate een keer een dag gekost, met 50002 tegen Fulcrum. 3851 sluit aan op de 3850
|
||||
# van die app.
|
||||
port: 3851
|
||||
# Leeg laten bij een nieuw pakket; de plaatjes doet het store-team zelf.
|
||||
gallery: []
|
||||
path: ""
|
||||
submitter: "WhatsNext?"
|
||||
submission: https://sc.kamenier-hamer.nl/sysop/UmbrelApps
|
||||
|
||||
# ── Hieronder staat wat de voorgeschreven volgorde niet noemt ────────────────
|
||||
#
|
||||
# Er is geen `icon` en dat is zichtbaar: de tegel blijft naamloos in de store.
|
||||
# Bewust nog niet gevuld, want een verkeerd of geleend icoon is erger dan geen,
|
||||
# en er is nog geen eigen ontwerp. Staat als taak in het plan Umbrelapp.
|
||||
|
||||
# Wat niet in de back-up hoeft. Paden zijn relatief aan de app-datamap.
|
||||
#
|
||||
# Voor deze app is dat vrijwel niets, en dat is expres: de database ís de waarde
|
||||
# van de app. Electrum Gate gebruikt dit veld wel, maar daar gaat het om een log
|
||||
# en een statusbestand. Neem die keuze hier niet uit gewoonte over.
|
||||
backupIgnore: []
|
||||
Reference in New Issue
Block a user