Requirements
Choosing a deployment environment
Section titled “Choosing a deployment environment”EchoLore runs on Docker Compose, so it can be installed on any Linux (amd64) host with Docker. Choose an environment according to your security and operational requirements.
| Environment | Best suited for | Characteristics |
|---|---|---|
| On-premises (own servers / data center) | Cases where data sovereignty and confidentiality are the top priority | Data never leaves your managed network. Existing monitoring and backup infrastructure can be reused |
| VPS (WebArena Indigo, etc.) | Small to mid-sized teams | Cost-efficient and quick to set up. WebArena Indigo (NTTPC Communications) is a verified environment. Japanese data centers offer low latency |
| Public cloud (Amazon EC2, etc.) | When scaling or integration with an existing cloud environment is required | Integrates with existing VPCs, IAM, and snapshot-based backups. Consider cloud-specific settings such as Instance Metadata Service |
Guidelines:
- Prohibit sending data to external networks → on-premises
- Start easily / reduce operational overhead → VPS (WebArena Indigo, verified)
- Integrate with other systems on AWS / anticipate future scaling → EC2
The rest of this documentation (installation, updates, backups) applies to all of these environments.
Protection with Cloudflare proxy (optional)
Section titled “Protection with Cloudflare proxy (optional)”Placing Cloudflare’s DNS proxy (orange cloud) in front of HTTP/HTTPS significantly improves attack resistance even on a small VPS. It pairs well with deployments where you want to publish on a VPS while reducing the attack surface.
Benefits:
| Benefit | Description |
|---|---|
| DDoS / WAF | Attacks are absorbed at the edge (L3-L7 filtering) |
| Origin IP concealment (web) | Attacks and scans against https://your-domain hit Cloudflare instead |
| Access control | WAF rules can add IP or country restrictions on /admin |
| Bot mitigation | Reduces credential stuffing against login pages |
EchoLore-specific caveats:
- TLS mode must be Full (strict) — with Flexible, traffic between Cloudflare and the origin is plaintext. Traefik’s ACME certificate works as-is
- WebRTC (UDP) is not proxied — LiveKit media (50000-50020/udp) and TURN (3478/udp, 5349/tcp) cannot pass through Cloudflare. Set RTC subdomains to DNS only (grey cloud). The origin IP remains discoverable this way, so this is not full IP concealment
- WebSockets — Yjs collaboration and LiveKit signaling use WebSockets through Cloudflare. EchoLore’s keepalives handle the ~100 second idle timeout, but verify the behavior in your environment
- Upload limits — the Free plan caps request bodies at 100 MB. Watch out for large Wiki attachments
- ACME renewals — HTTP-01 challenges work through the proxy; TLS-ALPN-01 does not
Defense of the UDP ports must continue at the origin (firewall + LiveKit-only ingress). Cloudflare hardens the HTTP surface; it does not replace UDP-side countermeasures.
Server Requirements
Section titled “Server Requirements”| Item | Minimum | Recommended |
|---|---|---|
| OS | Debian 12 / Ubuntu 22.04+ (Linux) | — |
| Memory | 4 GB | 8 GB (when using recording / AI features) |
| Storage | 20 GB | Depends on usage |
| CPU | 2 cores | 4 cores |
Software Requirements
Section titled “Software Requirements”Network (ports to open)
Section titled “Network (ports to open)”| Port | Purpose |
|---|---|
| 80/tcp | HTTP (TLS redirect) |
| 443/tcp | HTTPS |
| 3478/udp | TURN (WebRTC) |
| 5349/tcp | TURN over TLS |
| 50000-50020/udp | LiveKit RTC media |
Example with ufw:
sudo ufw allow 80/tcpsudo ufw allow 443/tcpsudo ufw allow 3478/udpsudo ufw allow 5349/tcpsudo ufw allow 50000:50020/udpsudo ufw reloadDomain
Section titled “Domain”Point a DNS A record at your server’s IP address. TLS certificates are obtained automatically by Traefik via Let’s Encrypt (ACME).
Optional external services
Section titled “Optional external services”All of these can be configured from the admin console after deployment:
- Google Cloud project — for Google SSO / Gemini / Vertex AI / GCS
- LLM provider — Gemini / Vertex AI / Z.ai / OpenAI-compatible
- Email provider — SMTP / Resend (for email verification and invitations)
- Storage provider — S3-compatible / GCS (for cloud file storage)