Home›Download & Install

Download & Install

Two installation methods — pick whichever fits your environment. The script pulls the latest image automatically and finishes deployment with no external dependencies.

Requirements

Linux distribution (Debian / Ubuntu / CentOS / RHEL / Rocky / KylinOS / UnionTech UOS, etc.)
Architecture：amd64 or arm64
Kernel ≥ 4.18 (≥ 5.4 recommended for HTTP/3 / QUIC)
root or an account with sudo privileges
curl, docker ≥ 20.10 and docker compose already installed

Method 1 · One-click install script (recommended)

The script auto-detects Docker and the system environment, downloads and launches the latest release. After install, manage the service via the foxwaf CLI.

curl -fsSL https://server.foxwaf.cn/install.sh | bash

Tip：The default console URL is http://<server-ip>:8088/fox; initial credentials are fox / fox — change the password immediately after first login.

Method 2 · Docker Compose

If you already run Docker, fetch the image and docker-compose.yaml manually:

mkdir -p /data/foxwaf && cd /data/foxwaf
curl -fsSLO https://server.foxwaf.cn/release/latest/docker-compose.yaml
docker compose up -d

Every release directory ships a full docker-compose.yaml, image tarball and checksum files — pick a version on Releases .

Common CLI Commands

Once installed, manage the service with foxwaf:

Command	Description
`foxwaf status`	Show service status, version, CPU/memory and port listeners
`foxwaf logs`	Live-tail runtime logs
`foxwaf restart`	Gracefully restart the service so configuration changes take effect
`foxwaf update`	Check and install a new release in GitCode / GitHub / official mirror priority order
`foxwaf export`	Pack configuration / database / certificates / plugins into the `backup/` directory
`foxwaf import <file>`	Restore from a backup file (when path is omitted, the latest file in `backup/` is used)
`foxwaf reset-auth`	Reset the Web console login user / password without a service restart

Verification & Upgrade

每个Releases目录均提供 waf、source.enc.md5、foxwaf-image.tar.gz.md5.下载后可手动校验：

md5sum -c waf

Online upgrade: the CLI pulls from configured mirrors (GitHub / GitCode) in priority order and falls back to the official direct link if all mirrors fail.

foxwaf update

Next Steps

Quickstart — Configure your first site and upstream
Configuration — Sites, certificates and hot reload
Architecture — 8-layer request processing pipeline
Releases — Full release history