alexandr 0.0.1 → 0.1.1

package/templates/docker-compose.yml

@@ -0,0 +1,51 @@
+# alexandr runtime — managed by the `alexandr` CLI.
+# Do not edit by hand; use `alexandr config …` or re-run `alexandr up`.
+# Pulls the published kernel image (no source build). Update with `alexandr update`.
+#
+# Host ports + image are templated so the CLI can override them via the .env it
+# writes next to this file (ALEXANDR_KERNEL_PORT / ALEXANDR_HTTP_PORT / …).
+
+services:
+  kernel:
+    image: ${ALEXANDR_IMAGE:-ghcr.io/alexandrco/alexandr-kernel:latest}
+    environment:
+      # The installer's placement stamp: a self-hosted box is an engine behind the
+      # desktop app — browsers at its root get the "open in the Alexandr app" page,
+      # never the web shell (that's the managed placement's surface).
+      ALEXANDR_PLACEMENT: self-hosted
+      # The HOST side of the port map below — inside the container the kernel only
+      # knows its internal port, and must not advertise that as its reachable URL.
+      ALEXANDR_ADVERTISED_PORT: ${ALEXANDR_KERNEL_PORT:-3030}
+    env_file:
+      - path: ./.env
+        required: false            # every var is optional; the CLI writes this file
+    volumes:
+      - data:/data                 # instance state: OS db, installed apps, blobs
+    ports:
+      - "127.0.0.1:${ALEXANDR_KERNEL_PORT:-3030}:3030"   # loopback only
+    restart: unless-stopped
+
+  # Public front door. Only started under the "public" profile — i.e. when a
+  # domain is configured (`alexandr up --domain …`). Pure-local runs skip it, so
+  # no root is needed for :80/:443 and there's no TLS machinery to babysit.
+  caddy:
+    image: caddy:2-alpine
+    profiles: ["public"]
+    depends_on:
+      - kernel
+    env_file:
+      - path: ./.env
+        required: false            # reads ALEXANDR_DOMAIN
+    ports:
+      - "${ALEXANDR_HTTP_PORT:-80}:80"
+      - "${ALEXANDR_HTTPS_PORT:-443}:443"
+    volumes:
+      - ./Caddyfile:/etc/caddy/Caddyfile:ro
+      - caddy_data:/data
+      - caddy_config:/config
+    restart: unless-stopped
+
+volumes:
+  data:
+  caddy_data:
+  caddy_config:

package/templates/env.example

@@ -0,0 +1,49 @@
+# alexandr runtime configuration — managed by the `alexandr` CLI.
+# Prefer `alexandr config set <KEY> <VALUE>` over editing by hand. Every var is
+# optional; an empty value is NOT the same as unset (keep unused lines commented).
+
+# ---- ports (host side; the CLI sets these from --port) ----------------------
+# ALEXANDR_KERNEL_PORT=3030     # loopback kernel port (http://127.0.0.1:<port>)
+# ALEXANDR_HTTP_PORT=80         # Caddy HTTP  (only with a domain)
+# ALEXANDR_HTTPS_PORT=443       # Caddy HTTPS (only with a domain)
+
+# ---- image (the CLI pins this for `update --to <tag>` / `--rollback`) -------
+# ALEXANDR_IMAGE=ghcr.io/alexandrco/alexandr-kernel:latest
+
+# ---- account link (REQUIRED — the runtime refuses to serve unlinked) --------
+# Every runtime must be linked to an alexandr account before it serves anyone
+# (.decode/docs/plans/account-required-runtimes.md). `alexandr up` signs you in as
+# step one and writes these three; you never fill them by hand. The control plane is
+# the identity authority, the runtime a pure verifier (no static tokens, no local
+# login). Self-hosted workspaces open in the Alexandr DESKTOP app — a browser at the
+# box gets an "open in the app" page, not a web workspace.
+# ALEXANDR_CP_URL=https://api.alexandr.so
+# ALEXANDR_INSTANCE_ID=
+# ALEXANDR_RUNTIME_SECRET=
+# ALEXANDR_WORKSPACE_ID=        # account-side record id (used by `destroy --unlink`)
+
+# Public domain for Caddy auto-HTTPS. Setting this starts the "public" profile — the
+# supported way to reach the runtime from another machine. Without a domain the
+# kernel binds loopback only (this machine). Access on an exposed box is the desktop
+# app's account sign-in — no separate token exists.
+# ALEXANDR_DOMAIN=alexandr.example.com
+
+# Advertised URL the connect link points at, when you've made the runtime
+# reachable some other way (your own reverse proxy, a tunnel, a LAN bind). Must
+# point at where clients can ACTUALLY reach it — it doesn't change how the kernel
+# binds. Overrides the domain/loopback default in the printed connect link.
+# ALEXANDR_PUBLIC_URL=https://alexandr.example.com
+
+# ---- AI provider (optional) -------------------------------------------------
+# xrouter is the sole AI gateway, and it owns credentials + spend — the runtime
+# stores no AI key. This only picks WHICH xrouter (defaults to the public one) and
+# the default model.
+# ALEXANDR_AI_BASE_URL=https://api.xrouter.so/v1
+# ALEXANDR_COPILOT_MODEL=
+
+# ---- app marketplace (optional) ---------------------------------------------
+# ALEXANDR_CATALOG_URL=
+
+# ---- updates ----------------------------------------------------------------
+# Defaults to the public release feed. Set to empty to turn update checks OFF.
+# ALEXANDR_RELEASES_URL=