Getting Started

User Guide

From download to your first synced folder in a few minutes.

Step 1

Install CoveSync

Download the binary for your platform from the releases page. No installer required on Linux — just a single executable.

1 Linux

Download covesync-linux-amd64, make it executable, and move it to your PATH:

chmod +x covesync-linux-amd64
sudo mv covesync-linux-amd64 /usr/local/bin/covesync

2 Windows

Run the CoveSync-Setup.exe installer. CoveSync will be added to your Start menu and configured to run as a Windows Service automatically.

3 macOS

Download the .dmg, open it, and drag CoveSync to Applications. On first launch, macOS may ask you to allow it in System Settings → Privacy & Security.

Step 2

First launch

1 Start the daemon

On Linux, run covesync in a terminal. On Windows and macOS the service starts automatically after installation.

covesync

You'll see a line like:

CoveSync started. Web UI: https://localhost:8485

2 Open the web UI

Open https://localhost:8485 in your browser. You'll see a certificate warning — this is expected. CoveSync uses a self-signed certificate. Click "Advanced" → "Proceed" (Chrome) or "Accept the Risk" (Firefox) to continue. You only need to do this once per browser.

The web UI is only accessible from the same machine. It is not reachable from other devices on your network.

Step 3

Add a peer

Both devices must be on the same network (same WiFi or LAN) and both must be running CoveSync.

1 Go to the Peers tab

Open the web UI on Device A and click Peers. You should see Device B listed as a discovered device within a few seconds.

2 Verify the fingerprint

Click Trust on Device B's entry. A fingerprint is shown — for example 0a5f:ee7b:3c12:…

Go to Device B's web UI → Settings and confirm its fingerprint matches exactly. This step protects against someone else on your network impersonating Device B.

3 Confirm trust on Device B

Device B will show an incoming trust request from Device A. Click Accept. Both devices now trust each other and trust is bi-directional.

Step 4

Share a folder

1 Go to Folders on Device A

Click Folders → Add Folder. Browse to the folder you want to sync, give it a label, and click Add.

2 Share with a peer

In the folder settings, click Share with peer and select Device B from the list. An invitation will appear on Device B.

Step 5

Accept a share

1 Go to Folders on Device B

Click Folders. A pending share invitation from Device A will appear at the top. Click Accept.

2 Choose a local path

Browse to where you want the folder to sync on Device B. You can create a new folder here if needed. Click Confirm.

CoveSync will begin syncing immediately. The first sync downloads all existing files from Device A.

Step 6 (optional)

Android companion app

Note: The Android app requires at least one PC running CoveSync on the same network. Two Android devices cannot sync with each other directly.

1 Install and open the app

Install CoveSync from the Google Play Store. Open the app — it will begin discovering devices on your network automatically.

2 Trust your PC

Your PC should appear in the app's Peers list. Tap it, verify the fingerprint matches your PC's web UI → Settings fingerprint, then tap Trust.

Accept the incoming trust request on your PC's web UI.

3 Share a folder to Android

On your PC's web UI, go to a synced folder → Share with peer → select your Android device. Accept the share invitation in the Android app and choose a local folder.

Step 7 (optional)

Run CoveSync on startup

1 Linux — systemd user service

covesync systemd-install
systemctl --user enable --now covesync

CoveSync will start automatically when you log in, without requiring root.

2 macOS — launchd

covesync launchd-install

This installs a LaunchAgent that starts CoveSync at login.

3 Windows

The Windows installer configures CoveSync as a Windows Service automatically. No extra steps needed.