Memo is AppThrust's Markdown publishing application: write drafts, publish articles,
follow authors, and like articles. A Go server serves the React SPA, the authenticated
/api/memo/v1 API, the shared app launcher, and /healthz, /readyz, and /releasez.
PostgreSQL stores application data. Directory optionally enriches author profiles.
The app is built and released independently of the platform.
Imported from appthrust/platform commit
27347914ee15817f27a42055160b42506edc73e6:
cmd/memo-server/→cmd/server/, including API, domain, storage, SQL migrations, OpenAPI document, and tests. Internal imports usegithub.com/appthrust/memo.dashboard/packages/memo/→web/, including the SPA, development mock, and tests.- Neither source directory contained a README at the imported revision.
The public Go SDK is github.com/appthrust/appserver-go v0.2.0; no platform checkout,
module replacement, or private Go credential is required. The launcher and i18n
packages use the published ^0.1.0 GitHub Packages versions rather than workspace
packages. Tailwind scans the installed launcher package for its classes.
Use Go 1.26 or newer and Bun 1.4.1 (the CI and image version).
go build ./... && go test ./...
go vet ./...
cd web
# GitHub Packages requires a token with read:packages access.
export NODE_AUTH_TOKEN="$(gh auth token)"
bun install --frozen-lockfile
bun run typecheck
bun run build:imageFor local UI development, run bun run mock and bun run dev in separate terminals
in web/. The mock defaults to port 5236 and Vite to port 5238. To use a real server,
set MEMO_API_UPSTREAM plus MEMO_DEV_BEARER or MEMO_DEV_COOKIE_FILE as described in
web/vite.config.ts.
Run the server with go run ./cmd/server --static-dir web/dist. Configure:
PLATFORM_API_URL,PLATFORM_PROJECT_ID, and the platform OIDC identity settings.MEMO_DATABASE_URL(orDATABASE_URL) for PostgreSQL.MEMO_DEV_SEED=1enables development seed data on an empty database.MEMO_PUBLIC_URLfor the HTTPS browser origin.MEMO_DIRECTORY_URLandMEMO_DIRECTORY_PUBLIC_URLfor optional Directory links.MEMO_STATIC_DIRor--static-dirto override/srv/memo.
The database connection starts asynchronously. While connecting, /readyz is 503
and /healthz remains 200. Missing database configuration leaves the API returning
memo_store_unavailable (503). /api/memo/v1/openapi.json exposes the API document
when the API is available. /releasez uses MEMO_RELEASE_VERSION and
MEMO_ARTIFACT_DIGEST supplied by the catalog.
PostgreSQL integration tests are opt-in: they skip when both
BUILTIN_APPSERVER_TEST_DATABASE_URL and BUILDER_CONSOLE_TEST_DATABASE_URL are unset.
An explicitly configured test database must permit isolated schema creation.
Publisher renderer and mocked catalog API tests need no live services:
bun test hack/Build the production image locally:
NODE_AUTH_TOKEN="$(gh auth token)" docker build --platform linux/amd64 \
--secret id=NODE_AUTH_TOKEN,env=NODE_AUTH_TOKEN -t memo-local .The image builds the SPA natively, cross-compiles the Go binary, and uses a
non-root distroless final stage. The executable is /memo-server, static files are
in /srv/memo, and port 8080 is exposed. Npm credentials enter the build only through
a required BuildKit secret, never through build arguments or committed files.
catalog/entry.yaml preserves the complete spec read from
ApplicationStackDefinition/memo in appthrust-ink-pmc001 on 2026-11-06, excluding
cluster-owned metadata. The served compatibility floor is 0.1.0, stream 0.1,
with its original immutable ghcr.io/appthrust/platform/memo image. The next release
is 0.2.0, stream 0.2. No speculative new-version image is committed.
After the release prerequisites are available, push a SemVer tag such as v0.2.0.
The tag workflow:
- Performs one multi-platform build on
ubuntu-24.04for Linux amd64 and arm64, pushingghcr.io/appthrust/memo:<version>. - Resolves and signs the image index digest with Cosign keyless signing.
- Reads Cloud's persisted entry, merges its history with the committed floor,
and appends the new version using
ghcr.io/appthrust/memo@sha256:<index-digest>. The new version alone is default; earlier versions remain served. Reusing a version with different immutable images is rejected. - PUTs
/api/v1/catalog/entries/memo, then POSTs/api/v1/catalog/publish. HTTP 202 with statequeuedmeans Cloud dispatched publication; HTTP 200 with statesnapshotrequires the workflow to dispatch the Cloud repository event using a short-lived GitHub App installation token. - Waits up to ten minutes for the signed catalog artifact to contain the exact Memo version and image digest. Dispatch alone is not publication success.
Publication commands used by the workflow:
bun hack/publish-entry.ts submit --version 0.2.0 --digest sha256:<image-index-digest>
bun hack/publish-entry.ts await --version 0.2.0 --digest sha256:<image-index-digest>Writers are serialized by memo-catalog-publish; the workflow is guarded to
appthrust/memo. Required settings are repository secret CLOUD_CATALOG_ADMIN_TOKEN,
optional variable CLOUD_API_URL (default https://api.appthrust.com), and organization
secrets APPTHRUST_GITHUB_ACTIONS_APP_ID and APPTHRUST_GITHUB_ACTIONS_APP_PRIVATE_KEY.
The App must be installed on appthrust/cloud with Contents write permission.
GitHub Packages must grant this repository's GITHUB_TOKEN read access to
@appthrust/app-launcher and @appthrust/platform-dashboard-i18n. Make the GHCR image
public after its first publication.
await uses ORAS to verify the catalog index digest and Cosign to verify its signer:
https://github.com/appthrust/cloud/.github/workflows/catalog-publish.yml@refs/heads/main,
issued by https://token.actions.githubusercontent.com. It does not require the Cloud
admin token.
An existing installation moving from ghcr.io/appthrust/platform/memo requires an
explicit version update with replaceRepository: true. Subsequent follow updates
track the selected stream; pinned installations require explicit updates.
Migration authority: First-party app repositories.
cmd/authz-probe is a dependency-free app that exercises platform app roles
and bindings (platform ADR-0082) on appthrust.ink. It is not part of Memo and
is never published to the shared catalog.
- API:
GET /api/probe/whoamireturns the caller's resolved permissions and whether the installation's access model is declared and accepted;GET /api/probe/read,POST /api/probe/writeandPOST /api/probe/adminanswer 403 withoutprobe:read,probe:writeandprobe:admin. - Roles:
viewer,editor,admin(catalog/authz-probe.yaml). Project managers getadminand every signed-in user getsviewerby default. - Publication: the manual workflow
authz-probe.yml(main only) pushes the image asghcr.io/appthrust/memo:authz-probe-<version>and a signed one-entry catalog asghcr.io/appthrust/memo:authz-test-catalog. Updates are pinned only, because Memo's version tags share the repository. - An estate reads it only through the task-owned
AppCatalogSourceinhack/authz-test/appcatalogsource.yaml, which trusts that workflow alone. It requires platform main791a7f4d4cor later.