Requirements

Supported Platforms

FiveNet is available on:

• Windows (only the latest version of Windows Server and Windows 11 are supported)
  • amd64 - Your typical Windows server will run on this architecture.
• Linux
  • amd64 - Your typical Linux server will run on this architecture.
  • arm64 - The newer 64-bit ARM architecture commonly found in Raspberry Pi 4 and other ARM-based servers.

Required Services

Database

• Use MySQL 8.4+ or MariaDB 11.4+.
• Fulltext search must be available.
• Older versions may still work, but they are not officially supported.

Message Queue

• Run NATS server in single-server or clustered mode.
• Required version: NATS 2.11.3+
• JetStream must be enabled.
• JetStream memory storage should have at least 10-20 MB available.

Storage

• Use either a local directory or S3-compatible bucket storage.
• Storage is used for avatars, faction/job logos, and uploaded files.
• For S3, the bucket needs at least read and write access. See this example AWS S3 policy.

Network Requirements

Public URL and HTTPS

• Use a publicly reachable domain or subdomain such as https://fivenet.example.com.
• Point that domain to the server or reverse proxy that fronts your FiveNet instance.
• Use a valid HTTPS certificate.
• If you use Cloudflare Tunnel, Cloudflare can terminate HTTPS for you.
• If you manage HTTPS yourself, Let's Encrypt is a good free option.

Reverse Proxy

• Your reverse proxy must support HTTP/2 and WebSockets.
• DBSync is required.
• Your reverse proxy only needs to support gRPC if DBSync or FiveNet plugin traffic passes through it.
• HTTPS should be terminated at the reverse proxy before traffic is forwarded to FiveNet.
• Known working options:
  • NGINX
  • Traefik

For NGINX, make sure http2 is enabled in the listen directive and follow the official WebSocket proxying guide.

Optional Requirements

• Tracing: OpenTelemetry-based tracing is available for the FiveNet server and worker components. It is useful for troubleshooting and performance monitoring.