Compare commits

..
6 changed files with 25 additions and 13 deletions

No files matched your search

+8 -1
View File
@@ -16,6 +16,13 @@ repository root. The application is the Python source at the top level (`app.py`
- **There is no CI.** The packaging guide assumes GitHub Actions workflows. This repository is on
Gitea, so there are no `.github/workflows/` and there must not be any. Build the `.s9pk` locally
with `make`.
- **Development happens on the self-hosted Gitea instance; GitHub is the public mirror.**
`origin` is `https://gitea.sondreolav.com/ai-bot/vardkey`, and `github` is
`https://github.com/sondreolav/vardkey`. The two repository URLs in
`startos/manifest/index.ts` (`packageRepo` and `upstreamRepo`) and the links in `README.md` and
`instructions.md` deliberately point at **GitHub**, because those are the ones a user of the
package sees, and the mirror is the copy that is meant to take that traffic. **Do not change them
back to Gitea.** Only a stable `main` is pushed to the mirror; work in progress stays on Gitea.
- **The image is built by `Dockerfile`**, referenced as `dockerBuild: {}` in
`startos/manifest/index.ts`, which makes the build context the repository root. Anything the
`Dockerfile` does not `COPY` is not in the image. The `COPY *.py ./` line is what keeps a new
@@ -28,7 +35,7 @@ repository root. The application is the Python source at the top level (`app.py`
application migrates its own schema. `UPDATING.md` carries the rule, including the trap that
ExVer normalizes numeric leading zeros, so a single-digit month or day is written without one
(`2026.1.5`, not `2026.01.05`). The git tag is the version with `:` replaced by `_` and a leading
`v` (`v2026.10.28_0`), pushed individually.
`v` (`v2026.10.28_0`), pushed individually — to both remotes.
- **The admin account is touched outside the HTTP API only by `maintenance.py`.** The two StartOS
actions, `delete-all-data` and `set-admin-password`, run it in a `withTemp` subcontainer, and the
generated password never travels from the host into the container, as an argument or on stdin:
+1 -1
View File
@@ -12,7 +12,7 @@
VardKey records the annual health check of a Bitcoin multisig setup, 2-of-3 by default: the keys,
the yearly checklist, the follow-up alerts, and the full history, in a local SQLite database. It
does not sign transactions, perform wallet operations, or store wallet secrets. The application
source is this repository: <https://gitea.sondreolav.com/ai-bot/vardkey>.
source is this repository: <https://github.com/sondreolav/vardkey>.
The application reference — the HTTP API and the rules it enforces — is in
[`docs/application.md`](docs/application.md). This file documents the StartOS package around it.
+4 -2
View File
@@ -175,8 +175,10 @@ at `/data`. No Postgres, no Redis, no external backend, no extra container.
- **Documentation layout.** `README.md` is the StartOS package README, with the guide's fixed heading
set. `docs/spec.md` is the specification, `docs/application.md` the application and API reference,
`instructions.md` the user quick start, and `AGENTS.md` the repo-specific agent context
(`CLAUDE.md` is the one-line `@AGENTS.md` import). The repository is
`https://gitea.sondreolav.com/ai-bot/vardkey`.
(`CLAUDE.md` is the one-line `@AGENTS.md` import). Development happens on
`https://gitea.sondreolav.com/ai-bot/vardkey` (the `origin` remote), and
`https://github.com/sondreolav/vardkey` is its public mirror; `AGENTS.md` says which links point
where and why. **Do not point the manifest or the README links back at Gitea.**
## Traps that already cost time — do not repeat
+1 -1
View File
@@ -2,7 +2,7 @@
## Documentation
- [VardKey repository](https://gitea.sondreolav.com/ai-bot/vardkey) — the application source, its HTTP API reference, and the development notes.
- [VardKey repository](https://github.com/sondreolav/vardkey) — the application source, its HTTP API reference, and the development notes.
## What you get on StartOS
+5 -2
View File
@@ -5,8 +5,11 @@ export const manifest = setupManifest({
id: 'vardkey',
title: 'VardKey',
license: 'GPL-3.0-only',
packageRepo: 'https://gitea.sondreolav.com/ai-bot/vardkey',
upstreamRepo: 'https://gitea.sondreolav.com/ai-bot/vardkey',
// Both point at the public GitHub mirror, not at the self-hosted Gitea
// instance that development happens on: these two links are shown in the
// StartOS UI, and the mirror is the copy that is meant to take that traffic.
packageRepo: 'https://github.com/sondreolav/vardkey',
upstreamRepo: 'https://github.com/sondreolav/vardkey',
marketingUrl: 'https://sondreolav.com/vardkey',
donationUrl: 'https://sondreolav.com/donations',
description: { short, long },
+6 -6
View File
@@ -1,18 +1,18 @@
import { IMPOSSIBLE, VersionInfo } from '@start9labs/start-sdk'
export const current = VersionInfo.of({
version: '2026.10.28:0',
version: '2026.10.28:1',
releaseNotes: {
en_US:
'First release of VardKey for StartOS. One service with the web interface and its own SQLite database on the persistent "main" volume: the multisig key setup, the annual health check, the follow-up alerts, the history, and the CSV export. On a fresh install, set the admin password first and then configure the keys. No wallet secret is ever asked for or stored.',
'The links a user sees now point at the public GitHub mirror. The package repository and the upstream repository in the manifest, and the repository links in the README and the instructions, point at https://github.com/sondreolav/vardkey instead of the self-hosted instance development happens on. No application change: the same code, the same schema, the same database, and nothing to do after updating.',
es_ES:
'Primera versión de VardKey para StartOS. Un servicio con la interfaz web y su propia base de datos SQLite en el volumen persistente "main": la configuración de claves multifirma, la revisión anual, los avisos de seguimiento, el historial y la exportación en CSV. En una instalación nueva, establece primero la contraseña de administrador y después configura las claves. Nunca se pide ni se guarda un secreto de monedero.',
'Los enlaces que ve el usuario ahora apuntan al espejo público de GitHub. El repositorio del paquete y el repositorio de origen en el manifiesto, y los enlaces al repositorio en el README y en las instrucciones, apuntan a https://github.com/sondreolav/vardkey en lugar de la instancia autoalojada donde se desarrolla. Sin cambios en la aplicación: el mismo código, el mismo esquema, la misma base de datos, y nada que hacer tras actualizar.',
de_DE:
'Erste Version von VardKey für StartOS. Ein Dienst mit der Weboberfläche und einer eigenen SQLite-Datenbank auf dem persistenten Volume "main": die Multisig-Schlüsselkonfiguration, die jährliche Prüfung, die Folgehinweise, der Verlauf und der CSV-Export. Bei einer Neuinstallation zuerst das Admin-Passwort festlegen und danach die Schlüssel einrichten. Ein Wallet-Geheimnis wird niemals abgefragt oder gespeichert.',
'Die Links, die der Benutzer sieht, zeigen jetzt auf den öffentlichen GitHub-Spiegel. Das Paket-Repository und das Upstream-Repository im Manifest sowie die Repository-Links in der README und in der Anleitung zeigen auf https://github.com/sondreolav/vardkey statt auf die selbst gehostete Instanz, auf der entwickelt wird. Keine Änderung an der Anwendung: derselbe Code, dasselbe Schema, dieselbe Datenbank, und nach dem Update ist nichts zu tun.',
pl_PL:
'Pierwsze wydanie VardKey dla StartOS. Jedna usługa z interfejsem webowym i własną bazą SQLite na trwałym wolumenie "main": konfiguracja kluczy multisig, coroczny przegląd, alerty do dalszych działań, historia i eksport do CSV. W nowej instalacji najpierw ustaw hasło administratora, a następnie skonfiguruj klucze. Sekret portfela nigdy nie jest pytany ani przechowywany.',
'Widoczne dla użytkownika odnośniki wskazują teraz na publiczny mirro GitHub. Repozytorium pakietu i repozytorium źródłowe w manifeście oraz odnośniki do repozytorium w README i w instrukcji wskazują na https://github.com/sondreolav/vardkey zamiast na samodzielnie hostowaną instancję, na której trwa rozwój. Bez zmian w aplikacji: ten sam kod, ten sam schemat, ta sama baza danych i nic do zrobienia po aktualizacji.',
fr_FR:
'Première version de VardKey pour StartOS. Un seul service avec l’interface web et sa propre base SQLite sur le volume persistant « main » : la configuration des clés multisig, le contrôle annuel, les alertes de suivi, l’historique et l’export CSV. Sur une nouvelle installation, définissez d’abord le mot de passe administrateur, puis configurez les clés. Aucun secret de portefeuille n’est jamais demandé ni stocké.',
'Les liens visibles par l’utilisateur pointent désormais vers le miroir public GitHub. Le dépôt du paquet et le dépôt amont dans le manifeste, ainsi que les liens vers le dépôt dans le README et dans les instructions, pointent vers https://github.com/sondreolav/vardkey au lieu de l’instance auto-hébergée où le développement a lieu. Aucun changement dans l’application : le même code, le même schéma, la même base de données, et rien à faire après la mise à jour.',
},
migrations: {
up: async ({ effects }) => {},