{
	"id": "1621b711-7c57-4c34-bbb6-6225aef8db58",
	"created_at": "2026-06-10T02:02:37.011902Z",
	"updated_at": "2026-11-22T02:28:43.612786Z",
	"deleted_at": null,
	"sha1_hash": "c78309d5b12d373d95d41d63bf82eecca4e1f603",
	"title": "GitHub - vxaboveground/Overlord: Overlord",
	"llm_title": "GitHub - vxaboveground/Overlord: Overlord",
	"authors": "KingKDot",
	"file_creation_date": "0001-01-01T00:00:00Z",
	"file_modification_date": "0001-01-01T00:00:00Z",
	"file_size": 989456,
	"plain_text": "https://github.com/vxaboveground/Overlord\n\nGitHub - vxaboveground/Overlord: Overlord\n\nBy KingKDot\n\nArchived: 2026-06-10 02:01:57 UTC\n\nTELEGRAM SERVER JOIN NOW NO EXCUSES WE GIVE SUPPORT AND\n\nIT'S FUN\n\nHello, I made this project for fun.\n\nThe server is TypeScript on Node/Bun. The client is Go. Operators talk to the server through a web panel or the\n\nElectron desktop app, and agents connect over encrypted WebSockets.\n\nDocker is the easiest way to run it.\n\nQuick Start (Docker)\n\nWindows\n\nLinux\n\nmacOS\n\nNo Docker (.bat / .sh)\n\nProduction Package Scripts\n\nWebRTC Streaming\n\nDocker Notes (TLS, reverse proxy, cache)\n\nQuick Start (Docker)\n\nPick your OS below. Each section is self-contained: install Docker, get the project, start it.\n\nPage 1 of 7\n\nhttps://github.com/vxaboveground/Overlord\n\nWindows and macOS use  docker-compose.windows.yml . Linux uses the default  docker-compose.yml\n\n(host networking).\n\nAfter the first start, open  https://localhost:5173 . Default login is  admin  /  admin  unless you set\n\nOVERLORD_USER  /  OVERLORD_PASS . First startup writes generated secrets to  data/save.json  (inside the\n\ncontainer:  /app/data/save.json ) — keep that file private and back it up.\n\nWindows\n\nStep-by-step: Windows\n\nLinux\n\nStep-by-step: Linux (Debian / Ubuntu / Kali)\n\nmacOS\n\nStep-by-step: macOS\n\nNo Docker (.bat / .sh)\n\nIf you don't want Docker, use the included scripts.\n\nPrerequisites:\n\nBun in PATH\n\nGo 1.21+ in PATH\n\nWindows\n\nDevelopment mode (starts server + client):\n\nstart-dev.bat\n\nProduction mode (build + run server executable):\n\nstart-prod.bat\n\nBuild client binaries (adds client builds to the build queue):\n\nbuild-clients.bat\n\nLinux / macOS\n\nPage 2 of 7\n\nhttps://github.com/vxaboveground/Overlord\n\nMake scripts executable once:\n\nchmod +x start-dev.sh start-dev-server.sh start-dev-client.sh start-prod.sh build-prod-package.sh\n\nDevelopment mode (server in background, client in foreground):\n\n./start-dev.sh\n\nOnly server, or only client:\n\n./start-dev.sh server\n./start-dev.sh client\n\nProduction mode:\n\n./start-prod.sh\n\nProduction Package Scripts\n\nBuild a production-ready package where the server can still build client binaries at runtime.\n\nWindows:\n\nbuild-prod-package.bat\n\nOutput:  release/\n\nLinux / macOS:\n\n./build-prod-package.sh\n\nOutput:  release/prod-package/\n\nWebRTC Streaming\n\nThe remote desktop viewer has a Transport dropdown with three modes:\n\nCanvas (default): H.264 / JPEG / block frames over the existing WebSocket, decoded into a  \u003ccanvas\u003e .\n\nHighest latency, works anywhere the WS does.\n\nWebRTC P2P: browser ↔ agent direct. The server only relays SDP and ICE candidates over the existing\n\nWS — MediaMTX is not involved. Lowest latency. Fails when both sides are behind aggressive symmetric\n\nPage 3 of 7\n\nhttps://github.com/vxaboveground/Overlord\n\nNAT.\n\nWebRTC Relayed: agent publishes to a MediaMTX sidecar via WHIP, browser plays via WHEP. The\n\nserver proxies signaling so the existing JWT auth + per-client RBAC still apply. Lowest-effort fallback\n\nwhen P2P can't punch through.\n\nBuilding agents with WebRTC\n\nWebRTC is opt-in per agent build. In the builder UI, tick the WebRTC checkbox before clicking Build. Without\n\nit, the Pion stack (~6 MB of Go modules) is not compiled in — any WebRTC start attempt from the operator\n\nreturns  webrtc support not compiled in  and the viewer falls back to Canvas. The Canvas path always works\n\nregardless of the build setting.\n\nThe build tag ( overlord_webrtc ) is also available if you build agents outside the UI:\n\ngo build -tags overlord_webrtc ./cmd/agent\n\nMediaMTX sidecar\n\nCompose starts an  overlord-mediamtx  service for Relayed mode. It needs:\n\nPort  8189/udp  and  8189/tcp  reachable from operators (WebRTC ICE traffic). The Windows / macOS\n\ncompose publishes these; Linux uses host networking and shares the host's interfaces directly.\n\nNo auth config — the Overlord server proxies every WHIP/WHEP request through  /api/webrtc/...  and\n\nenforces the existing operator JWT + RBAC there.\n\nIf you only ever want P2P, you can comment out the  mediamtx:  service in your compose file — only Relayed\n\nmode depends on it.\n\nLAN / public access\n\nBy default MediaMTX advertises  127.0.0.1  as an ICE candidate, which is enough for operators running their\n\nbrowser on the same machine as Docker.\n\nFor viewers on a different machine:\n\nLinux (host networking): nothing to configure — MediaMTX sees the host's eth0/wlan0 and gathers those\n\ncandidates automatically.\n\nWindows / macOS (bridge networking): set  OVERLORD_WEBRTC_ADDITIONAL_HOSTS  to a comma-separated\n\nlist including the server's reachable LAN or public IP. Either export it in your shell, or add it to a  .env\n\nfile next to the compose file:\n\nOVERLORD_WEBRTC_ADDITIONAL_HOSTS=127.0.0.1,192.168.1.42\n\nThen  docker compose -f docker-compose.windows.yml up -d mediamtx  to apply.\n\nPage 4 of 7\n\nhttps://github.com/vxaboveground/Overlord\n\nAdvanced MediaMTX customization\n\nThe compose file passes a minimal set of  MTX_*  environment variables to MediaMTX — enough for Overlord to\n\nwork. To change anything else (codecs, paths, ICE servers, etc.), either:\n\nAdd more  MTX_*  variables to the  mediamtx  service's  environment:  block (every option in\n\nMediaMTX's docs is supported as an env var), or\n\nProvide a full  mediamtx.yml  via a bind mount:\n\nmediamtx:\n  # ...existing config...\n  volumes:\n    - ./mediamtx.yml:/mediamtx.yml:ro\n\nMake sure the file exists on the host before the container starts — Docker will otherwise auto-create an\n\nempty directory at that path and fail with \"not a directory\".\n\nDocker Notes (TLS, reverse proxy, cache)\n\nNotes on configs and workarounds.\n\nBuildKit cache for faster rebuilds\n\ndocker-compose.yml  ships with  build.cache_from  and  build.cache_to  pointing at  .docker-cache/buildx .\n\nLocal builds reuse it automatically — no extra setup.\n\nRuntime client build cache\n\nThe compose setup uses a persistent volume for runtime client builds:\n\nVolume:  overlord-client-build-cache\n\nMount:  /app/client-build-cache\n\nEnv:  OVERLORD_CLIENT_BUILD_CACHE_DIR  (default  /app/client-build-cache )\n\nCertbot TLS\n\nTo use Let's Encrypt certificates in production Docker:\n\n1. Set  OVERLORD_TLS_CERTBOT_ENABLED=true\n\n2. Set  OVERLORD_TLS_CERTBOT_DOMAIN=your-domain.com\n\n3. Mount letsencrypt into the container read-only, e.g.  /etc/letsencrypt:/etc/letsencrypt:ro\n\nDefault cert paths:\n\nPage 5 of 7\n\nhttps://github.com/vxaboveground/Overlord\n\ncert: /etc/letsencrypt/live/\u003cdomain\u003e/fullchain.pem\nkey:  /etc/letsencrypt/live/\u003cdomain\u003e/privkey.pem\nca:   /etc/letsencrypt/live/\u003cdomain\u003e/chain.pem\n\nOverride with:\n\nOVERLORD_TLS_CERTBOT_LIVE_PATH\n\nOVERLORD_TLS_CERTBOT_CERT_FILE\n\nOVERLORD_TLS_CERTBOT_KEY_FILE\n\nOVERLORD_TLS_CERTBOT_CA_FILE\n\nReverse proxy TLS offload\n\nIf your platform terminates TLS before traffic reaches Overlord (Render, Caddy, nginx, etc.), set:\n\nOVERLORD_TLS_OFFLOAD=true\nOVERLORD_HEALTHCHECK_URL=http://localhost:5173/health\nOVERLORD_PUBLISH_HOST=127.0.0.1\n\nWhen enabled:\n\nContainer serves internal HTTP on  0.0.0.0:$PORT\n\nExternal URL stays  https://...  through your platform proxy\n\nHealth checks should use  http://localhost:$PORT/health  inside the container\n\nDon't expose the internal container HTTP port directly to the internet\n\nSource IP behind a domain / reverse proxy\n\nIf the dashboard, audit log, or IP bans show all agents as  172.x.x.x  (or some other proxy/bridge IP), something\n\nbetween the agent and Bun is rewriting the source IP. Two independent flags govern this:\n\nOVERLORD_TLS_OFFLOAD  — TLS terminates at the proxy; Overlord runs plain HTTP internally.\n\nOVERLORD_TRUST_PROXY  — honor  X-Forwarded-For  /  X-Real-IP  /  CF-Connecting-IP  so\n\ndashboard/audit/IP-bans see the real client. Auto-enabled when  TLS_OFFLOAD=true .\n\nCommon shapes:\n\nSetup\n\nDomain, no proxy (Linux host networking; certbot inside Overlord;\n\nTLS_OFFLOAD TRUST_PROXY\n\nfalse false\nCloudflare DNS-only)\n\nDomain, proxy does TLS (Render, nginx terminating TLS → http\n\nupstream)\ntrue auto ( true )\n\nPage 6 of 7\n\nhttps://github.com/vxaboveground/Overlord\n\nSetup\n\nDomain, proxy in front but Overlord still does TLS (Cloudflare orange-\n\ncloud Full Strict; nginx with  proxy_pass https:// )\n\nTLS_OFFLOAD TRUST_PROXY\n\nfalse true\n\nOnly enable  OVERLORD_TRUST_PROXY  when a trusted reverse proxy is in front. If Overlord is directly exposed and\n\nyou enable it, agents can spoof their source IP by sending their own  X-Forwarded-For  header, breaking IP bans\n\nand audit accuracy. The upstream proxy also has to be configured to inject the header (Cloudflare does by default;\n\nnginx/Caddy/Traefik need explicit directives).\n\nIf you're using  docker-compose.windows.yml  or  docker-compose.quickstart.yml  (Docker Desktop bridge\n\nnetworking) with no reverse proxy, Docker itself rewrites source IPs to the bridge gateway and there is no header\n\nto recover from —  TRUST_PROXY  cannot help. Either switch to Linux host networking or put a real reverse proxy\n\nin front.\n\nNotes\n\nKeep  HOST=0.0.0.0  inside the container. Limit exposure with  OVERLORD_PUBLISH_HOST , not the bind\n\nhost.\n\nIf your  .env  secret/password contains  $ , escape it as  $$  to avoid Docker Compose variable-expansion\n\nwarnings.\n\nSource: https://github.com/vxaboveground/Overlord\n\nPage 7 of 7",
	"extraction_quality": 1,
	"language": "EN",
	"sources": [
		"Malpedia"
	],
	"origins": [
		"web"
	],
	"references": [
		"https://github.com/vxaboveground/Overlord"
	],
	"report_names": [
		"Overlord"
	],
	"threat_actors": [],
	"ts_created_at": 1781056957,
	"ts_updated_at": 1795314523,
	"ts_creation_date": 0,
	"ts_modification_date": 0,
	"files": {
		"pdf": "https://archive.orkl.eu/c78309d5b12d373d95d41d63bf82eecca4e1f603.pdf",
		"text": "https://archive.orkl.eu/c78309d5b12d373d95d41d63bf82eecca4e1f603.txt",
		"img": "https://archive.orkl.eu/c78309d5b12d373d95d41d63bf82eecca4e1f603.jpg"
	},
	"iocs": [
		{
			"type": "domain",
			"value": "build-prod-package.sh",
			"count": 2,
			"flags": [
				"file_like"
			],
			"some_flags": [
				"file_like"
			]
		},
		{
			"type": "domain",
			"value": "github.com",
			"count": 8,
			"flags": [
				"in_url_host"
			],
			"some_flags": [
				"in_url_host"
			]
		},
		{
			"type": "domain",
			"value": "start-dev-client.sh",
			"count": 1,
			"flags": [
				"file_like"
			],
			"some_flags": [
				"file_like"
			]
		},
		{
			"type": "domain",
			"value": "start-dev-server.sh",
			"count": 1,
			"flags": [
				"file_like"
			],
			"some_flags": [
				"file_like"
			]
		},
		{
			"type": "domain",
			"value": "start-dev.sh",
			"count": 4,
			"flags": [
				"file_like"
			],
			"some_flags": [
				"file_like"
			]
		},
		{
			"type": "domain",
			"value": "start-prod.sh",
			"count": 2,
			"flags": [
				"file_like"
			],
			"some_flags": [
				"file_like"
			]
		},
		{
			"type": "domain",
			"value": "your-domain.com",
			"count": 1,
			"flags": [],
			"some_flags": []
		},
		{
			"type": "ipv4",
			"value": "0.0.0.0",
			"count": 2,
			"flags": [
				"non_global"
			],
			"some_flags": [
				"non_global"
			]
		},
		{
			"type": "ipv4",
			"value": "127.0.0.1",
			"count": 3,
			"flags": [
				"non_global"
			],
			"some_flags": [
				"non_global"
			]
		},
		{
			"type": "ipv4",
			"value": "192.168.1.42",
			"count": 1,
			"flags": [
				"non_global"
			],
			"some_flags": [
				"non_global"
			]
		},
		{
			"type": "url",
			"value": "https://github.com/vxaboveground/Overlord",
			"count": 8,
			"flags": [],
			"some_flags": []
		}
	]
}