Compare commits
No commits in common. "00fc3ceed36861f62778997564102f36950f49a6" and "3172104d2928865d21b3676b5a254389a2b98e8e" have entirely different histories.
00fc3ceed3
...
3172104d29
8 changed files with 0 additions and 281 deletions
|
|
@ -1,64 +0,0 @@
|
||||||
name: Build & Push Images
|
|
||||||
|
|
||||||
# Builds the frontend + backend Docker images and pushes them to the Forgejo
|
|
||||||
# container registry (registry.snsnetlabs.com/sam/...). Runs on every push to
|
|
||||||
# main, and on-demand via the "Run workflow" button (workflow_dispatch).
|
|
||||||
#
|
|
||||||
# NOTE: registry.snsnetlabs.com is the unproxied (DNS-only) registry host so
|
|
||||||
# large layers bypass Cloudflare's body cap. The web UI / packages list stays
|
|
||||||
# on forgejo.snsnetlabs.com (Cloudflare Access SSO).
|
|
||||||
#
|
|
||||||
# Requirements (see deploy/README.md):
|
|
||||||
# - Forgejo Actions secret FORGEJO_REGISTRY_TOKEN: a package-scoped token for
|
|
||||||
# user `sam`.
|
|
||||||
# - The runner must allow Docker builds: container.docker_host = "automount"
|
|
||||||
# in the forgejo-runner config (mounts /var/run/docker.sock into the job).
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [main]
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
env:
|
|
||||||
REGISTRY: registry.snsnetlabs.com
|
|
||||||
OWNER: sam
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: docker
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Install Docker CLI
|
|
||||||
run: |
|
|
||||||
apt-get update
|
|
||||||
apt-get install -y --no-install-recommends docker.io
|
|
||||||
docker version
|
|
||||||
|
|
||||||
- name: Log in to Forgejo registry
|
|
||||||
run: |
|
|
||||||
echo "${{ secrets.FORGEJO_REGISTRY_TOKEN }}" \
|
|
||||||
| docker login "$REGISTRY" -u "$OWNER" --password-stdin
|
|
||||||
|
|
||||||
- name: Build & push frontend image
|
|
||||||
run: |
|
|
||||||
docker build \
|
|
||||||
-t "$REGISTRY/$OWNER/archnest:${{ github.sha }}" \
|
|
||||||
-t "$REGISTRY/$OWNER/archnest:latest" \
|
|
||||||
-f Dockerfile .
|
|
||||||
docker push "$REGISTRY/$OWNER/archnest:${{ github.sha }}"
|
|
||||||
docker push "$REGISTRY/$OWNER/archnest:latest"
|
|
||||||
|
|
||||||
- name: Build & push backend image
|
|
||||||
run: |
|
|
||||||
docker build \
|
|
||||||
-t "$REGISTRY/$OWNER/archnest-backend:${{ github.sha }}" \
|
|
||||||
-t "$REGISTRY/$OWNER/archnest-backend:latest" \
|
|
||||||
-f backend/Dockerfile backend
|
|
||||||
docker push "$REGISTRY/$OWNER/archnest-backend:${{ github.sha }}"
|
|
||||||
docker push "$REGISTRY/$OWNER/archnest-backend:latest"
|
|
||||||
|
|
||||||
- name: Log out
|
|
||||||
if: always()
|
|
||||||
run: docker logout "$REGISTRY"
|
|
||||||
|
|
@ -1,50 +0,0 @@
|
||||||
name: Deploy to racknerd2
|
|
||||||
|
|
||||||
# Manual-only. Pulls the pre-built images from the registry onto racknerd2
|
|
||||||
# (validation host) over the NetBird mesh and restarts the stack. Build the
|
|
||||||
# images first with the "Build & Push Images" workflow.
|
|
||||||
#
|
|
||||||
# Requirements (see deploy/README.md):
|
|
||||||
# - Forgejo Actions secret RACKNERD2_SSH_KEY: private key authorized for
|
|
||||||
# root@racknerd2 (mesh IP 100.96.217.250).
|
|
||||||
# - racknerd2 already prepared: Docker installed, logged in to the registry,
|
|
||||||
# and /opt/archnest/{docker-compose.yml,.env} in place.
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
tag:
|
|
||||||
description: "Image tag to deploy (commit SHA or 'latest')"
|
|
||||||
required: true
|
|
||||||
default: latest
|
|
||||||
|
|
||||||
env:
|
|
||||||
DEPLOY_HOST: 100.96.217.250
|
|
||||||
DEPLOY_DIR: /opt/archnest
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
deploy:
|
|
||||||
runs-on: docker
|
|
||||||
steps:
|
|
||||||
- name: Install SSH client
|
|
||||||
run: |
|
|
||||||
apt-get update
|
|
||||||
apt-get install -y --no-install-recommends openssh-client
|
|
||||||
|
|
||||||
- name: Write deploy key
|
|
||||||
run: |
|
|
||||||
install -m 700 -d ~/.ssh
|
|
||||||
printf '%s\n' "${{ secrets.RACKNERD2_SSH_KEY }}" > ~/.ssh/id_deploy
|
|
||||||
chmod 600 ~/.ssh/id_deploy
|
|
||||||
|
|
||||||
- name: Pull images and restart stack
|
|
||||||
run: |
|
|
||||||
ssh -i ~/.ssh/id_deploy -o StrictHostKeyChecking=accept-new \
|
|
||||||
root@"$DEPLOY_HOST" \
|
|
||||||
"cd $DEPLOY_DIR && ARCHNEST_TAG='${{ inputs.tag }}' docker compose pull && ARCHNEST_TAG='${{ inputs.tag }}' docker compose up -d --remove-orphans"
|
|
||||||
|
|
||||||
- name: Health check (backend /api/health via mesh)
|
|
||||||
run: |
|
|
||||||
ssh -i ~/.ssh/id_deploy -o StrictHostKeyChecking=accept-new \
|
|
||||||
root@"$DEPLOY_HOST" \
|
|
||||||
"for i in \$(seq 1 30); do curl -fsS http://$DEPLOY_HOST:8080/api/health && echo OK && exit 0; sleep 2; done; echo 'health check failed'; cd $DEPLOY_DIR && docker compose logs --tail=50; exit 1"
|
|
||||||
3
.gitignore
vendored
3
.gitignore
vendored
|
|
@ -15,9 +15,6 @@ dist-ssr
|
||||||
# Backend data/secrets
|
# Backend data/secrets
|
||||||
backend/data
|
backend/data
|
||||||
backend/.env
|
backend/.env
|
||||||
# Env files (real secrets) — keep only the .example variants
|
|
||||||
.env
|
|
||||||
deploy/.env
|
|
||||||
*.db
|
*.db
|
||||||
*.db-journal
|
*.db-journal
|
||||||
*.db-wal
|
*.db-wal
|
||||||
|
|
|
||||||
|
|
@ -70,10 +70,6 @@ bookmarks. Deployed at `archnest.snsnetlabs.com` via Docker Compose on
|
||||||
|
|
||||||
## Policies
|
## Policies
|
||||||
|
|
||||||
- **Versioning**: development happens on **even** major versions; **odd** majors
|
|
||||||
are released/stable lines. We are currently developing **v2** (the prior
|
|
||||||
released line is v1, see the `v1.0` git tag). Image/version tags should
|
|
||||||
reflect this — dev builds carry the even (v2) version.
|
|
||||||
- **Zero mock data** — every number comes from a live API/SSH/DB call
|
- **Zero mock data** — every number comes from a live API/SSH/DB call
|
||||||
- **Design-first for big features** — write a `docs/<feature>.md` before coding
|
- **Design-first for big features** — write a `docs/<feature>.md` before coding
|
||||||
- **No footer** on any page
|
- **No footer** on any page
|
||||||
|
|
|
||||||
|
|
@ -26,8 +26,6 @@ No new feature is queued. Pick up from here:
|
||||||
|
|
||||||
## Standing rules (read before doing anything)
|
## Standing rules (read before doing anything)
|
||||||
|
|
||||||
- **Versioning convention**: development happens on **even** major versions, releases on **odd**. We are currently developing **v2** (prior released line is v1 — see the `v1.0` git tag). Dev image/version tags carry the even (v2) number. `package.json` (root + backend) still reads `0.0.0` and the Settings → About panel is hardcoded `v1.0.0`; neither has been bumped to v2 yet.
|
|
||||||
|
|
||||||
- **Branch**: never commit on `main`. Create a fresh feature branch off `main` (recent convention: `kiro/<short-feature>`). Confirm with `git branch --show-current` before starting.
|
- **Branch**: never commit on `main`. Create a fresh feature branch off `main` (recent convention: `kiro/<short-feature>`). Confirm with `git branch --show-current` before starting.
|
||||||
- **Workflow per change**: type-check (`npx tsc --noEmit -p .` in repo root AND in `backend/`) — and for frontend changes prefer a full `npm run build` (which runs `tsc -b && vite build`; the stricter `tsc -b` has caught errors a plain `tsc --noEmit` missed via stale incremental cache) → commit → `git fetch origin main && git rebase origin/main` → `git push -u origin <branch>` → open a PR with `gh pr create` → squash-merge (`gh pr merge <n> --squash --delete-branch`) → poll the resulting run (`gh run list --branch main`, then `gh run watch <id> --exit-status`) until `validate` and `deploy` both succeed (deploy's last step is "Health check (backend /api/health)").
|
- **Workflow per change**: type-check (`npx tsc --noEmit -p .` in repo root AND in `backend/`) — and for frontend changes prefer a full `npm run build` (which runs `tsc -b && vite build`; the stricter `tsc -b` has caught errors a plain `tsc --noEmit` missed via stale incremental cache) → commit → `git fetch origin main && git rebase origin/main` → `git push -u origin <branch>` → open a PR with `gh pr create` → squash-merge (`gh pr merge <n> --squash --delete-branch`) → poll the resulting run (`gh run list --branch main`, then `gh run watch <id> --exit-status`) until `validate` and `deploy` both succeed (deploy's last step is "Health check (backend /api/health)").
|
||||||
- **`git add -A` caution**: this has twice swept up unrelated untracked files (e.g. a bookmark-import JSON the user asked to be generated, not committed) into unrelated PRs. Prefer `git add <specific files>` and always check `git diff --cached --stat` before committing.
|
- **`git add -A` caution**: this has twice swept up unrelated untracked files (e.g. a bookmark-import JSON the user asked to be generated, not committed) into unrelated PRs. Prefer `git add <specific files>` and always check `git diff --cached --stat` before committing.
|
||||||
|
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
# Copy to `.env` next to deploy/docker-compose.yml ON racknerd2 (never commit the real .env).
|
|
||||||
# Compose loads it automatically.
|
|
||||||
|
|
||||||
# Image tag to deploy. The build workflow pushes both :latest and the commit
|
|
||||||
# SHA; use :latest for rolling validation or pin a SHA for a specific build.
|
|
||||||
ARCHNEST_TAG=latest
|
|
||||||
|
|
||||||
# Interface the app is published on. Mesh IP only — do NOT bind 0.0.0.0.
|
|
||||||
ARCHNEST_BIND_IP=100.96.217.250
|
|
||||||
|
|
||||||
# Origin the frontend is served from (used for CORS). Mesh URL for validation.
|
|
||||||
ARCHNEST_CORS_ORIGIN=http://100.96.217.250:8080
|
|
||||||
|
|
||||||
# 32-byte hex. Signs auth JWTs. Generate: openssl rand -hex 32
|
|
||||||
ARCHNEST_JWT_SECRET=
|
|
||||||
|
|
||||||
# 32-byte hex. Encrypts integration secrets at rest (AES-256-GCM).
|
|
||||||
# Changing this after data exists makes existing secrets undecryptable.
|
|
||||||
# Generate: openssl rand -hex 32
|
|
||||||
ARCHNEST_SECRET_KEY=
|
|
||||||
|
|
||||||
# Exactly 32 ASCII chars (used literally as an AES-256-CBC key for Guacamole).
|
|
||||||
# Generate: openssl rand -base64 24 | cut -c1-32
|
|
||||||
ARCHNEST_GUAC_CRYPT_KEY=
|
|
||||||
|
|
@ -1,80 +0,0 @@
|
||||||
# ArchNest — Build & Deploy (Forgejo Actions → registry → racknerd2)
|
|
||||||
|
|
||||||
This pipeline builds the Docker images in Forgejo Actions, pushes them to the
|
|
||||||
Forgejo container registry, and deploys them to **racknerd2** (validation host)
|
|
||||||
over the NetBird mesh. racknerd2 only pulls and runs — it never builds (1.9 GiB
|
|
||||||
RAM).
|
|
||||||
|
|
||||||
```
|
|
||||||
push to main / manual ─► [build.yml] build + push images ─► registry.snsnetlabs.com/sam/{archnest,archnest-backend}
|
|
||||||
│
|
|
||||||
manual dispatch ─► [deploy.yml] ssh racknerd2 ─► docker compose pull && up -d
|
|
||||||
```
|
|
||||||
|
|
||||||
## Images
|
|
||||||
|
|
||||||
| Image | From | Tags |
|
|
||||||
|-------|------|------|
|
|
||||||
| `registry.snsnetlabs.com/sam/archnest` | root `Dockerfile` (React build → nginx) | `latest`, `<commit-sha>` |
|
|
||||||
| `registry.snsnetlabs.com/sam/archnest-backend` | `backend/Dockerfile` (Fastify) | `latest`, `<commit-sha>` |
|
|
||||||
|
|
||||||
`registry.snsnetlabs.com` is the **unproxied (DNS-only)** registry host, so large
|
|
||||||
layers bypass Cloudflare's ~100 MB request-body cap. Pushed images appear at
|
|
||||||
`https://forgejo.snsnetlabs.com/sam/-/packages` (web UI, Cloudflare Access SSO).
|
|
||||||
|
|
||||||
## One-time setup
|
|
||||||
|
|
||||||
### 1. Forgejo Actions secrets (repo or org settings → Actions → Secrets)
|
|
||||||
- `FORGEJO_REGISTRY_TOKEN` — Forgejo personal access token for `sam` with
|
|
||||||
**package** scope (NOT the account password). Used by `build.yml` to log in
|
|
||||||
and push.
|
|
||||||
- `RACKNERD2_SSH_KEY` — private SSH key authorized for `root@racknerd2`
|
|
||||||
(mesh IP `100.96.217.250`). Used by `deploy.yml`.
|
|
||||||
|
|
||||||
### 2. Runner (forgejo-runner host) — allow Docker builds
|
|
||||||
The runner runs jobs inside containers and by default has **no Docker access**.
|
|
||||||
Enable socket auto-mounting so the `build` job can build images. Create
|
|
||||||
`/opt/config.yaml` (or edit the existing runner config) with at least:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
container:
|
|
||||||
docker_host: "automount" # mounts /var/run/docker.sock into job containers
|
|
||||||
```
|
|
||||||
|
|
||||||
Generate a full example with `forgejo-runner generate-config > /opt/config.yaml`,
|
|
||||||
set `docker_host: "automount"`, point the service at it
|
|
||||||
(`ExecStart=/usr/local/bin/forgejo-runner daemon -c /opt/config.yaml`), then
|
|
||||||
`systemctl daemon-reload && systemctl restart forgejo-runner`.
|
|
||||||
|
|
||||||
### 3. racknerd2 — prepare the deploy host
|
|
||||||
Docker Engine + compose plugin are already installed. Then:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
mkdir -p /opt/archnest
|
|
||||||
# copy deploy/docker-compose.yml from this repo to /opt/archnest/docker-compose.yml
|
|
||||||
# create /opt/archnest/.env from deploy/.env.example and fill in the secrets:
|
|
||||||
# ARCHNEST_JWT_SECRET = openssl rand -hex 32
|
|
||||||
# ARCHNEST_SECRET_KEY = openssl rand -hex 32
|
|
||||||
# ARCHNEST_GUAC_CRYPT_KEY = openssl rand -base64 24 | cut -c1-32
|
|
||||||
docker login registry.snsnetlabs.com # user: sam, password: the package token
|
|
||||||
```
|
|
||||||
|
|
||||||
Ports are bound to the **mesh IP only** (`100.96.217.250`) — Docker bypasses
|
|
||||||
ufw, so this is what keeps the app off the public interface. Validate at
|
|
||||||
`http://100.96.217.250:8080`.
|
|
||||||
|
|
||||||
## Running it
|
|
||||||
|
|
||||||
1. **Build**: push to `main`, or run **Build & Push Images** manually
|
|
||||||
(Actions tab → Run workflow).
|
|
||||||
2. **Deploy**: run **Deploy to racknerd2** manually, entering the tag
|
|
||||||
(`latest` or a specific commit SHA). It pulls, restarts, and health-checks
|
|
||||||
`/api/health`.
|
|
||||||
|
|
||||||
## Notes / ceilings
|
|
||||||
|
|
||||||
- `ponytail:` deploy is manual (workflow_dispatch), not auto-on-merge — this is
|
|
||||||
a validation host, so deploys are deliberate. Wire `build.yml` → `deploy.yml`
|
|
||||||
with `needs:` later if auto-deploy-to-validation is wanted.
|
|
||||||
- Single-arch (amd64) only — both the runner host and racknerd2 are amd64, so
|
|
||||||
no buildx/multi-platform is needed.
|
|
||||||
|
|
@ -1,54 +0,0 @@
|
||||||
# Deploy compose for racknerd2 (validation host).
|
|
||||||
#
|
|
||||||
# Unlike the root docker-compose.yml (which BUILDS images locally), this file
|
|
||||||
# PULLS pre-built images from the Forgejo container registry
|
|
||||||
# (registry.snsnetlabs.com/sam/...) that the Forgejo Actions `build` workflow
|
|
||||||
# pushes. racknerd2 only has ~1.9 GiB RAM, so we never build here.
|
|
||||||
#
|
|
||||||
# Usage on racknerd2 (in this file's directory, with a sibling .env):
|
|
||||||
# docker login registry.snsnetlabs.com # once, as user `sam`
|
|
||||||
# docker compose pull && docker compose up -d
|
|
||||||
#
|
|
||||||
# IMPORTANT: published ports are bound to the NetBird mesh IP only. Docker
|
|
||||||
# manipulates iptables directly and BYPASSES ufw, so a plain "8080:8080" would
|
|
||||||
# expose the port on the host's public interface regardless of the firewall.
|
|
||||||
# Binding to ${ARCHNEST_BIND_IP} keeps the app reachable only over the mesh.
|
|
||||||
|
|
||||||
services:
|
|
||||||
archnest:
|
|
||||||
image: registry.snsnetlabs.com/sam/archnest:${ARCHNEST_TAG:-latest}
|
|
||||||
container_name: archnest
|
|
||||||
restart: unless-stopped
|
|
||||||
ports:
|
|
||||||
- "${ARCHNEST_BIND_IP:-100.96.217.250}:8080:8080"
|
|
||||||
depends_on:
|
|
||||||
- archnest-backend
|
|
||||||
|
|
||||||
archnest-backend:
|
|
||||||
image: registry.snsnetlabs.com/sam/archnest-backend:${ARCHNEST_TAG:-latest}
|
|
||||||
container_name: archnest-backend
|
|
||||||
restart: unless-stopped
|
|
||||||
environment:
|
|
||||||
- PORT=4000
|
|
||||||
- ARCHNEST_DB_PATH=/data/archnest.db
|
|
||||||
- ARCHNEST_JWT_SECRET=${ARCHNEST_JWT_SECRET}
|
|
||||||
- ARCHNEST_SECRET_KEY=${ARCHNEST_SECRET_KEY}
|
|
||||||
- ARCHNEST_CORS_ORIGIN=${ARCHNEST_CORS_ORIGIN:-http://100.96.217.250:8080}
|
|
||||||
- ARCHNEST_GUAC_CRYPT_KEY=${ARCHNEST_GUAC_CRYPT_KEY}
|
|
||||||
- ARCHNEST_GUACD_HOST=guacd
|
|
||||||
- ARCHNEST_GUACD_PORT=4822
|
|
||||||
volumes:
|
|
||||||
- archnest-data:/data
|
|
||||||
# No host port published: the frontend container reaches the backend over
|
|
||||||
# the compose network as "archnest-backend:4000" (nginx proxies /api).
|
|
||||||
depends_on:
|
|
||||||
- guacd
|
|
||||||
|
|
||||||
guacd:
|
|
||||||
image: guacamole/guacd:1.5.5
|
|
||||||
container_name: archnest-guacd
|
|
||||||
restart: unless-stopped
|
|
||||||
# Internal only; reachable as "guacd:4822" on the compose network.
|
|
||||||
|
|
||||||
volumes:
|
|
||||||
archnest-data:
|
|
||||||
Loading…
Add table
Reference in a new issue