Getting startedInstallation
Configure for production
The defaults are good for a laptop. A server needs a base domain, HTTPS and a service manager.
With the defaults, your apps are at <name>.localhost:8080.
1 / 2
The options that you use most
Most flags also have an environment variable.
| Flag | Environment variable | Default | Purpose |
|---|---|---|---|
--data-dir | FERRY_DATA_DIR | ./ferry-data | The state of the server |
--base-domain | FERRY_BASE_DOMAIN | localhost | The base domain: your apps are at <name>.<base-domain>. You can connect more domains while the server runs. |
--proxy-addr | FERRY_PROXY_ADDR | 0.0.0.0:8080 | The public HTTP address, for example 0.0.0.0:80 |
--https-addr | FERRY_HTTPS_ADDR | none | The public HTTPS address, for example 0.0.0.0:443 |
--acme-email | FERRY_ACME_EMAIL | none | Turns on Let’s Encrypt certificates |
--github-webhook-secret | FERRY_GITHUB_WEBHOOK_SECRET | none | Turns on GitHub auto-deploys |
Example
ferryd run \
--data-dir /var/lib/ferry \
--base-domain apps.example.com \
--proxy-addr 0.0.0.0:80 \
--https-addr 0.0.0.0:443 \
--acme-email you@example.comA service manager such as systemd runs this command for you. The Production setup guide shows the full setup.
Server options lists each flag. If the server does not start, see Troubleshooting.