Files
archie/deployments/systemd-user-service.md
T
sam 0346bfef77 fix(configuration): require containers.image instead of a private-registry default (#2054)
applyContainerDefaults no longer fills containers.image with a hard-coded
private-registry reference. An unset image now fails configuration
validation with 'containers.image is required for autonomous workflow
workers', so a fresh instance is told at startup (and via the readiness
probe at runtime) instead of at the first failed container pull.

Configs that relied on the default now set it explicitly: dev.toml (the
local task image:agent build, which e2e also overlays), plus commented
[containers] blocks in config.example.toml and standalone.toml. The
deploy docs no longer describe a code-level default.
2026-11-21 01:16:41 +11:00

9.5 KiB

Managing archied with Systemd User Services

This runbook describes how to manage archied as a background user service on Linux servers.


1. Unit Files (written by install.sh)

install.sh writes all five units -- archied.service, archie-state-store.service, archie-gateway.service, archie-ui.service and archie-messaging.service -- with the contents it ships. This page describes what runs and why; the installer owns the contents, so inspect a unit with systemctl --user cat <unit> rather than copying it from here, where it would drift from what is written.

The Gateway unit is archie-gateway.service, written by install.sh beside archied.service.

The State Store unit is archie-state-store.service. It owns the task data in PostgreSQL and serves the StateStore gRPC contract. BOTH archied and archie-gateway dial it via [services.state].target (see the archied config below) and never open the task tables themselves. A host-only agent uses the loopback bind below; a container-mode agent needs the Docker bridge gateway address, and a non-loopback bind needs [tls] (see config.example.toml):

install.sh writes archie-state-store.service with that loopback bind.


Messaging Service Unit (~/.config/systemd/user/archie-messaging.service)

The Telegram, email and webhook channels are served by archie-messaging, not by archied, since the v1.30.0 extraction. archied starts no gateway for them and logs nothing when one is absent, so a host that updates across v1.30.0 without this unit runs on with dead channels and a daemon that looks perfectly healthy. install.sh writes this unit on a fresh install; archied update install refuses an update when a host is missing a unit and names what is missing, which now fires for a host that drifted or predates this release rather than the normal path.

It dials the Gateway for the chat contract and the State Store for the stored channel settings, and reads the same config.toml, including [tls].

install.sh writes archie-messaging.service. Its After= and Wants= lines only tidy the start sequence: nothing depends on that order, because each service waits for the peers it needs.

2. UI Service Unit (~/.config/systemd/user/archie-ui.service)

The dashboard is served by the standalone UI Service, not by archied. It reads the same config.toml, dials the Gateway and State Store targets already in it, and binds [web].listen. Open the dashboard to configure the organisation, workspace and first administrator account. Complete setup before exposing it publicly; remote access requires an HTTPS reverse proxy.

Auth note: archie-ui authenticates to the Gateway, State Store and daemon with its [tls] certificate (archie-ui.pem) from config.toml.

For supervision, GET /healthz on [web].listen is the process's liveness probe (token-free by design); the authenticated readiness surface lives at the dashboard's health endpoint behind account authentication. A watchdog can curl /healthz without credentials.

install.sh writes archie-ui.service. Browser accounts are configured through the dashboard.

After= orders the start, it does not wait for the store to bind. The UI process closes that gap itself: its event pump retries priming with backoff until the State Store answers, so the activity feed goes live once the store is up rather than staying history-only until the next restart.

For remote access, configure a TLS reverse proxy and the instance public URL in Access → Authentication. Enrol passkeys from Your account on HTTPS or localhost.


3. Enabling User Linger (loginctl)

By default, systemd terminates user services when you log out of SSH. Enabling linger allows your archied service to run continuously 24/7 across reboots and logouts:

loginctl enable-linger "$USER"

Verify linger status:

loginctl show-user "$USER" | grep Linger
# Output: Linger=yes

4. Service Commands

Reload systemd daemon files:

systemctl --user daemon-reload

Enable and start the service immediately:

systemctl --user enable --now archie-state-store archie-gateway archie-messaging archie-ui archied

Check service status:

systemctl --user status archied

Tail live daemon logs:

journalctl --user -u archied -f

Restart or stop the service:

systemctl --user restart archied
systemctl --user stop archied

5. Default: Native Daemon, Embedded NATS, Managed Containers

Embedded NATS is the default. The systemd service runs archied natively, so interactive chat keeps the host access the operator configured, while every autonomous repository workflow runs in a task-scoped Docker container. No Compose service or host archie-agent binary is required.

Docker must be installed and reachable by the service user. containers.image has no default: with it unset the daemon refuses to start and names the key, so a fresh install learns about it at startup, not at the first failed pull. single-forge-github.toml and docker-nats-stack.toml set a pinned reference; standalone.toml and dev.toml leave it for the operator to set -- see Pinning the archie-agent image below. An explicit reference, pinned the same way, is:

[nats]
mode = "embedded"

[containers]
image = "git.catlow.cloud/sam/archie-agent@sha256:<digest>"
pull_policy = "missing"

At startup Archie resolves the Docker bridge used by its task containers, binds the authenticated embedded broker only to that bridge's host gateway, and passes the resulting endpoint to each worker. There is no port to publish and no broker URL to maintain.

The State Store is a separate process and, with a container-mode agent, must be reachable from the container, so bind it to the same bridge gateway with a token and point [services.state].target at it (start archie-state-store with -listen <bridge>:9090 -token <token>); without a token a non-loopback bind fails closed. For a host-only agent, 127.0.0.1:9090 with no token is correct.

If Docker or the image is unavailable, archied still serves chat and the dashboard. Autonomous tasks park with an explicit capability error; they never fall back to a host model loop.


6. Pinning the archie-agent Image

The release pipeline publishes git.catlow.cloud/sam/archie-agent as :v<version> and :sha-<commit> when the commit carries a release tag; an ordinary push to main publishes nothing for the agent image, and :latest moves only when a release is promoted. A distribution zip pins the image its own release published, by digest, in release.json, and archied update install pulls exactly that.

To pin by hand, prefer the version tag for readability, or a digest where you need byte-for-byte reproducibility (a tag can be overwritten, a digest cannot):

[containers]
image = "git.catlow.cloud/sam/archie-agent:v<version>"
# or
image = "git.catlow.cloud/sam/archie-agent@sha256:<digest>"

A reference on a registry that needs a login needs the credential in [containers].registry_auth -- the release's own git.catlow.cloud/sam/archie-agent digest is one, since an anonymous pull cannot reach it:

[containers]
registry_auth = {engine = "env", key = "ARCHIE_REGISTRY_AUTH"}

The secret resolves to a Docker AuthConfig JSON document: the object docker login stores under auths, without the surrounding map, and with a personal access token that can read the package as the password -- {"username":"<user>","password":"<token>"}. Put it in ~/.config/archie/env as ARCHIE_REGISTRY_AUTH so it stays out of config.toml. The field is file-owned and settled at boot, so a change takes effect on restart; a value that cannot be read logs a warning and pulls anonymously, which is the failure the task reports as a capability error.

The bundled update adapter snapshots the configured [containers].image before rebuilding it and restores that image if the restarted daemon fails its health check. A custom image reference is therefore supported directly in config.toml; ARCHIE_AGENT_IMAGE is only an override for deployments that cannot make that configuration file available to the update command.

7. Optional: External Compose NATS

External NATS changes only broker deployment. It does not change the worker executor. Start the optional service and configure the pinned Compose gateway:

docker compose up -d nats
[nats]
mode = "external"
url = "nats://172.19.0.1:4222"
token_env = "NATS_TOKEN"
callout_issuer_seed_env = "NATS_CALLOUT_SEED"

[containers]
network = "archie-core_default"

The broker defers every login to archied (NATS auth callout), so a worker logs in with its run credential and reaches only its own task's subjects. Generate an account nkey (nk -gen account -pubout), export its seed as NATS_CALLOUT_SEED for archied and its public key as NATS_CALLOUT_ISSUER for Compose, and set NATS_TOKEN to the same value in both.

The daemon hands workers the URL its own client connected to. The Compose service name is not resolvable from the native host, and localhost inside a worker is the worker itself; the pinned network gateway is reachable from both.

pull_policy = "always" cannot authenticate to a private registry because the daemon sends no registry credentials to the Docker API. Refresh a private image with the operator's Docker credentials and retain pull_policy = "missing":

docker compose pull agent

state_dir and other paths are native host paths. Point state_dir at the intended state directory (embedded NATS store, task logs).