Skip to content

Ferry 1.0.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 14 Sep 11:27
v1.0.0
84c355b

Ferry 1.0.0 is the first versioned release of the Ferry Server and Web app: a self-hosted timeline for moving text, links and files between your devices on a private network.

Which file do I need?

  • To run Ferry, download ferry-1.0.0-docker-compose.tar.gz. It is not the program itself but the three files Docker Compose needs: compose.yaml, .env.example and the backup script. Compose then pulls the program, the public image ghcr.io/max1874/ferry:1.0.0, for linux/amd64 or linux/arm64.
  • Source code (zip / tar.gz) is added by GitHub for developers. You do not need it to run Ferry.
  • Phones and other computers need only a browser. The native iOS and Android apps are not published in this release.

What's new

  • Install without cloning. The public image runs on 64-bit x86 and ARM servers, and the Compose download holds everything else.
  • Connect another device. An empty timeline explains what to do next. Devices now shows the server address with a copy button and a QR code generated in your browser. The code carries only the address, never a device token or password.
  • Clearer startup log. Ferry prints the address it listens on and, separately, the address to open in a browser, including a warning when that address works on this computer only.

Install

curl -fLO https://github.com/max1874/ferry/releases/download/v1.0.0/ferry-1.0.0-docker-compose.tar.gz
tar -xzf ferry-1.0.0-docker-compose.tar.gz
cd ferry
cp .env.example .env    # set FERRY_HOST_IP to this server's LAN IP
docker compose up -d
docker compose logs ferry

The README covers every step, other deployment paths and troubleshooting.

Upgrade an existing source deployment

In the directory you already deploy from:

scripts/ferry-data.sh backup ../ferry-backup-before-1.0.0.tar.gz
git pull --ff-only
docker compose pull
docker compose up -d

If your .env sets COMPOSE_FILE to build the source, remove compose.build.yaml from it first, keeping any override file, or Compose keeps building instead of using the image. The service, volume, data directory and user stay the same, so messages, files, device identities and the password carry over. Later upgrades change only the version in FERRY_IMAGE.

Limits

  • Ferry serves plain HTTP for a trusted private network. Keep it off the public Internet; a TLS reverse proxy of your own inside the private network is supported.

简体中文：https://github.com/max1874/ferry/blob/main/docs/releases/1.0.0.zh-Hans.md

Image digest sha256:3eba51a1d91902543afd91c8f2c3eed85deb450d291a20d6b5599402e41a5bce · commit 84c355b · CI run

Assets 3
Loading