summaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authorJohn Bargman2026-04-15 05:44:12 +0000
committerJohn Bargman2026-04-15 05:44:12 +0000
commit586ba78daf9f40e9dc6b0fce0137b8f6d76baa26 (patch)
tree1a604993f8411ba66601a175434b4d930e39bb88 /AGENTS.md
parent6f7bd5ba50978ccaf853a091940ddd8434674b0b (diff)
downloadcrash-web-586ba78daf9f40e9dc6b0fce0137b8f6d76baa26.tar
crash-web-586ba78daf9f40e9dc6b0fce0137b8f6d76baa26.tar.gz
crash-web-586ba78daf9f40e9dc6b0fce0137b8f6d76baa26.tar.bz2
crash-web-586ba78daf9f40e9dc6b0fce0137b8f6d76baa26.tar.lz
crash-web-586ba78daf9f40e9dc6b0fce0137b8f6d76baa26.tar.xz
crash-web-586ba78daf9f40e9dc6b0fce0137b8f6d76baa26.tar.zst
crash-web-586ba78daf9f40e9dc6b0fce0137b8f6d76baa26.zip
add AGENTS.md with deployment commands and gotchas
Core commands: nix flake check, build, nixinate deploy, remote-command Key gotchas: --option builders '', Secrix validation, deprecated options
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000..4e25ed9
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,47 @@
+# AGENTS.md - CrashOverBurn Web Server
+
+## Core Commands
+
+```bash
+# Validate flake (ALWAYS use --option builders '')
+nix flake check --option builders ''
+
+# Build system derivation
+nix build .#nixosConfigurations.crash-over-burn-1.config.system.build.toplevel --option builders ''
+
+# Deploy (nixinate - the CORRECT deployment tool, never replace it)
+nix run .#crash-over-burn-1
+
+# Run remote command on crash-over-burn-1 (193.16.42.36:1108)
+nix run .#remote-command -- "<command>"
+
+# Validate Secrix recipients
+nix run .#secrix -- -l
+```
+
+## Key Facts
+
+- **Deployment target**: 193.16.42.36, port 1108, user: commander
+- **Services**: cgit, ejabberd (XMPP), murmur (Mumble), movim (social), mailserver, nginx
+- **Secrets**: Encrypted via age/Secrix in `secrets/`
+- **State persisted**: `/persist/` directories
+
+## Gotchas
+
+1. **Nixinate is NOT legacy**. It is the bleeding edge of correct deployment tools. Never suggest replacing it with `nixos-rebuild`.
+
+2. **Always use `--option builders ''`** with nix commands per fleet directives.
+
+3. **Secrix encryption requires both user AND host key** - validate with `nix run .#secrix -- -l` before deploying.
+
+4. **Deprecated options**:
+ - `services.xserver.layout` → `services.xserver.xkb.layout`
+ - `devShell` → `devShells.x86_64-linux.default`
+
+5. **Verify cgit** via: `nix run .#remote-command -- "systemctl status uwsgi"`
+
+## Reference
+
+- Core guideline: `/speed-storage/opencode/llm/shared/common-infra-strategies.md`
+- Deployment docs: `docs/deployment.md`
+- Phase plan: `docs/PHASE_EXECUTION_PLAN.md` \ No newline at end of file