Linux

Check DockerCopy Anchor Link

evertap needs Linux on x64 or arm64, with Docker Engine 24 or later.

Your user must be able to use Docker without sudo. Add it to the docker group, then log out and back in:

sudo usermod -aG docker $USER

Being in that group is as good as being root on that machine, so add only users you would trust with root. Docker from Snap and rootless Docker need one more step first (How Docker was installed).

Leave disk space for the images evertap downloads: about 400 MB for each PostgreSQL version and 800 to 900 MB for each MySQL version you use. Each MySQL database also takes about 210 MB before any data, as each runs a server of its own, and each MySQL version keeps one more such copy that new databases start from.

Run the install scriptCopy Anchor Link

Run it as yourself, not with sudo:

curl -fsSL https://evertap.dev/install.sh | sh

When it asks where it runs, answer 1:

Where is this?
  1) The machine that runs evertap (it needs Docker)
  2) A laptop or CI that connects to evertap on another machine

It checks that your user can use Docker, and stops with what to do if not. Then it downloads the build for your system from the latest GitHub release, checks it against the release's SHA256SUMS, and installs it as /usr/local/bin/evertap, asking for sudo if it needs it. evertap keeps its data in your ~/.local/share/evertap, where evertap setup and the other commands you run find it.

Without a terminal, as when a script sets up the machine, set EVERTAP_ROLE=host on the sh side of the pipe. The install script lists its other settings.

Keep evertap runningCopy Anchor Link

Every connection to a database or bucket goes through the evertap serve process. While it is stopped, the databases keep running in Docker but nothing reaches them.

Set up and sign inCopy Anchor Link

With systemd, the install script runs evertap setup for you on a first install. Without a terminal, it says to run evertap setup with flags instead.

On the machine running evertap, as the user that runs it, while it runs:

evertap setup

Until you run it, evertap listens on 127.0.0.1 alone, and no other machine can reach it (What listens where). Setup asks where you will open evertap from (Choose how evertap is reached), asks only what that choice needs, and applies it without a restart. Then it signs in your first browser:

• For This computer only, it opens a signed-in browser on this machine.
• For the others, it prints a one-time sign-in link and a QR code. Open the link in a browser, or scan the code with your phone. It signs in one browser and expires in 10 minutes.

Without a terminal, give the answers as flags, and setup asks nothing:

evertap setup --mode local                                                         # This computer only
evertap setup --mode network --listen 0.0.0.0                                      # Devices on your network
CLOUDFLARE_API_TOKEN=<token> evertap setup --mode cloudflare --zone example.com    # Anywhere, through Cloudflare
evertap setup --mode network --url https://evertap.example.com                     # Behind your own proxy or tunnel

Run evertap setup again to change your answers; it offers to keep the address you gave before. Once you are signed in, Settings in the UI can make the same changes, as long as they keep your browser connected.

Signing in laterCopy Anchor Link

• A new browser shows a code. On a device that is signed in, open /device (Clients → Add a device) and enter it.
• evertap signin-link, on the machine running evertap, prints another one-time link and QR code. Use it when no browser is signed in anymore.
• evertap open, on the machine running evertap, opens a signed-in browser there.

Check itCopy Anchor Link

evertap doctor

The Doctor, also a page in the UI, shows the Docker version and any warnings about it, the state of each service, whether each database and bucket entry answers, and which of your own Docker containers want the same ports.

Next, connect from your laptop. Upgrading and uninstalling are in Limitations.