Skip to content

Prerequisites ​

Before installing GitWire, make sure you have the following.

Server Requirements ​

RequirementMinimumRecommended
OSAny Linux with DockerUbuntu 24.04 LTS
CPU2 cores4 cores
RAM2 GB4 GB
Disk16 GB32 GB
Docker24.0+29.x
Docker Composev2.0+v2.30+

Account Requirements ​

RequirementWhy
GitHub accountTo create the GitHub App and install it on repos
Anthropic API keyGitWire uses Claude for AI triage, CI healing, and code fixes
Domain nameFor the webhook callback URL (via Cloudflare Tunnel)
Cloudflare accountTo create the tunnel (free tier works)

Network Requirements ​

GitWire uses Cloudflare Tunnel for inbound connectivity. This means:

  • No inbound ports need to be opened
  • No static IP required
  • Works behind NAT, firewalls, and home networks
  • Only outbound HTTPS connections to Cloudflare

Deployment Topology ​

GitWire is deployed as an unprivileged LXC container on Proxmox VE:

LayerTechnologyDetails
HypervisorProxmox VE 8.4pve host, kernel 6.8.12-13-pve
ContainerLXC (CT 115)Ubuntu, nesting=1 for Docker-in-LXC
RuntimeDocker 29.x9 containers via Compose
TunnelCloudflare TunnelOutbound-only, no inbound ports

Container 115 — gitwire ​

ResourceAllocatedNotes
CPU2 coresSufficient for current workload
RAM2 GBRecommended: increase to 4 GB for v0.20+ validator
Disk16 GB (LVM)Monitor — Docker images grow over time
Swap512 MB58% utilized under load
Bootonboot: 1Starts automatically with PVE host
Network192.168.3.151/24Bridge vmbr0, gateway 192.168.3.1

Management ​

bash
# SSH into the GitWire container via PVE host
ssh [email protected]        # Proxmox host
pct exec 115 -- bash         # Enter CT 115

# Or with the SSH config alias
ssh gitwire

# Proxmox web UI
# https://192.168.3.5:8006

v0.20 Memory Consideration ​

The pass-capable Docker executor (v0.20.0) runs isolated validation containers inside the LXC host. This requires additional memory headroom beyond the existing 9 containers. Increase CT 115 memory from 2 GB to 4 GB before enabling production pass-capable execution.

Software Stack ​

GitWire runs as Docker containers — no host-level software needed beyond Docker:

ComponentVersionPurpose
Node.js20 LTSAPI server + workers (inside container)
PostgreSQL16Database (36 tables)
Redis7Job queues (9 workers via BullMQ)
CloudflaredlatestTunnel to Cloudflare

Next Step ​

→ Docker Compose Deployment

Released under the MIT License.