FerryDocs
Getting startedSet up the CLI

Reach a remote server

ferryd listens only on 127.0.0.1. An SSH tunnel gives your laptop a way to its API.

Edit on GitHub
Your serverYour laptopferrySSH tunnelport 7878ferryd127.0.0.1:7878

By default, ferryd listens only on 127.0.0.1. Your laptop cannot reach it.

1 / 3

Do it

Open the tunnel

Terminal
ssh -N -L 7878:127.0.0.1:7878 you@your-server &

The stays open in the background.

Log in to the local address

Terminal
ferry login --server http://127.0.0.1:7878

The approval page opens through the same tunnel. Its address in your browser is http://127.0.0.1:7878.

With HTTPS and no tunnel

It is possible to put the dashboard on the proxy with (--dashboard-host). Then you can log in to that URL, for example https://ferry.apps.example.com.

See Production setup.

Log in with a token

With a token, ferry login needs no approval. Use it for CI, scripts and machines without a browser.

Choose a server

ferry gets the server URL and the token from four places, and uses the first value that it finds.

On this page

Do itOpen the tunnelLog in to the local addressWith HTTPS and no tunnel