Skip to content

operations.md

Latest commit

 

History

History
88 lines (66 loc) · 2.77 KB

operations.md

File metadata and controls

88 lines (66 loc) · 2.77 KB
Raw

Operations

Listener liveness

The WebSocket listener serves GET /_healthz only to IPv4 or IPv6 loopback clients. A successful request returns 204 No Content and proves that the listener's Tornado IOLoop can accept and dispatch work without creating an unauthenticated WebSocket session. Successful probes are excluded from access logs. Use an in-container request rather than exposing this endpoint through a public load balancer.

TLS setup

Auto-generated self-signed cert (development / internal use)

Set ssl: true in config. On the first start, the plugin generates <cert_dir>/hivemind.crt and <cert_dir>/hivemind.key automatically. Clients that connect with wss:// need to trust the self-signed CA (or disable verification in test scenarios).

Default cert location: ~/.local/share/hivemind/hivemind.crt

Production certificate (Let's Encrypt or your CA)

Place your cert and key at the configured cert_dir / cert_name paths before starting hivemind-core. The plugin uses whatever files exist; it does not regenerate if the files are already present.

# Example: copy certbot output
cp /etc/letsencrypt/live/myserver.example.com/fullchain.pem \
   ~/.local/share/hivemind/hivemind.crt
cp /etc/letsencrypt/live/myserver.example.com/privkey.pem \
   ~/.local/share/hivemind/hivemind.key

To rotate: replace the files and restart hivemind-core. The plugin reads them once on startup.

nginx reverse proxy

map $http_upgrade $connection_upgrade {
    default upgrade;
    ''      close;
}

server {
    listen 443 ssl;
    server_name myserver.example.com;

    ssl_certificate     /etc/letsencrypt/live/myserver.example.com/fullchain.pem;
    ssl_certificate_key /etc/letsencrypt/live/myserver.example.com/privkey.pem;

    location / {
        proxy_pass http://127.0.0.1:5678;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection $connection_upgrade;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_set_header Host $host;
        proxy_read_timeout 86400;
    }
}

Set trusted_proxy_cidrs: ["127.0.0.1/32"] in hivemind-core config so the plugin reads the real client IP from X-Forwarded-For.

Firewall

The plugin binds to 0.0.0.0:5678 by default. Restrict access to the port at the firewall level if you don't want arbitrary hosts to attempt connections:

# Allow only LAN
ufw allow from 192.168.0.0/16 to any port 5678

Authoring a transport plugin

See architecture.md for the NetworkProtocol ABC and pyproject.toml entry-point registration pattern. The HTTP and MQTT transports are concrete examples of alternative transport implementations.

← Development · Home