Skip to content

Requirements

An operational quick reference before deployment. For concept explanations, see Core concepts.

ItemRequirement
OSLinux (x86_64 / arm64), Debian 12 / Ubuntu 22.04+ recommended
CPU / RAM2 cores / 2 GB minimum; 4 cores / 4 GB+ recommended with many nodes
Disk20 GB+ (including data and logs)
NetworkReachable by the operator’s browser; each node’s FF1 Core can reach Master outbound
StorageEmbedded SQLite, bundled with FF1 Master—no separate database install needed

Master listens on 80 by default; it can be changed to 443 with TLS, or reverse-proxied by Nginx / Caddy.

ItemRequirement
OSLinux x86_64 / arm64
Privilegesroot, or sudo with systemd and write access to /usr/local/bin
NetworkCan reach Master outbound; exposes forwarding business ports externally

FF1 Core can be installed non-interactively via Master’s one-click SSH installation, or installed manually. A node needs no public IP as long as it can actively connect to Master (SSH installation additionally requires Master to reach the node’s management port).

DirectionDescription
Operator → MasterConsole HTTP/HTTPS
Node → MasterFF1 Core persistent connection with config sync, install-package download
Master → NodeOne-click SSH installation (22 or a custom port)
Business trafficDetermined by each forwarding rule’s entry port, independent of Master’s management port

At minimum, the firewall must allow: nodes to reach Master outbound; if using SSH installation, Master must be able to SSH inbound to nodes.

  • Obtain a License Key by claiming the Community edition or purchasing (see Purchase & payment)
  • Write the License Key during Master installation as prompted by the wizard
  • The quota constrains node count, forward rule count, and validity period; see Plans

When unactivated or expired, the console shows a prompt; already-deployed nodes are not deleted, but some management capabilities may be limited.

Q: Do I need to install a separate database? A: No. FF1 Master embeds SQLite; data lives in the data directory—just back that directory up regularly.

Q: Can a node have no public IP? A: Yes, as long as the node can actively connect to Master. SSH installation still requires Master to reach the node’s management port.

Q: Are Windows nodes supported? A: Currently Linux only.