Getting startedInstallation
Ports and URLs
ferryd listens on two addresses. One is for you, and one is for the users of your apps.
You control Ferry on port 7878. Only your machine can connect to it.
1 / 2
| What | Default address | Flag |
|---|---|---|
| API and dashboard | http://127.0.0.1:7878 | --api-addr |
| Public HTTP proxy, where your apps are | 0.0.0.0:8080 | --proxy-addr |
| Public HTTPS proxy | off | --https-addr with --acme-email |
The URLs with the defaults
| What | URL |
|---|---|
| Dashboard | http://127.0.0.1:7878, or http://ferry.localhost:8080 through the proxy |
| Your apps | http://<name>.localhost:8080 |
| Swagger UI of your server | http://127.0.0.1:7878/api/docs |
| OpenAPI document (3.1) | /api/openapi.json |
| Liveness probe | /healthz answers ok |
Browsers send each *.localhost name to 127.0.0.1. Thus you set up no DNS on your machine.
Reach the API from another machine
ssh -L 7878:127.0.0.1:7878 your-serverUse this SSH tunnel. Do not open the API to the public. See Production setup.
Swagger UI, the OpenAPI document and /healthz answer without a token. In Swagger UI, the Authorize button takes an API token.