Repository files navigation

• Windows and macOS:cargo build --release

• Linux:

  • apt install pkg-config libdbus-1-dev libxcb1-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev

  • cargo build --release

1. ClipSync supports 2 type of servers:

   • Setup MQTT broker if you want to use MQTT, or,

   • Includeserver role in one of the devices to use the device as a server, or runclip-sync in the headless mode to start a server on a dedicated machine.

     Refer to the "Linux Headless Server" section.

2. Create config fileconfig.toml at the default config path (~/.config/clip-sync/config.toml on Linux,C:\Users\%USERNAME%\AppData\Roaming\clip-sync\config.toml on Windows,~/Library/Application Support/clip-sync/config.toml on macOS).

   Refer toconfig.toml for the format.

3. Runclip-sync.

To automatically start the program on system startup:

• Windows:

  Create a shortcut toclip-sync.exe in the startup folder at%appdata%\Microsoft\Windows\Start Menu\Programs\Startup.

• macOS:

  Update thecom.0d0a.clipsync.plist with the correct path and copy it to~/Library/LaunchAgents/.

  Then runlaunchctl load ~/Library/LaunchAgents/com.0d0a.clipsync.plist.

• Linux:

  Update theclip-sync.desktop file with the correct path and copy it to~/.config/autostart/.

  Or useclip-sync.service to run it as a systemd service.

• Linux Headless Server (No GUI):

  Build the Docker image by runningdocker build -t clipsync . in the project root.

  Then rundocker run -d --restart unless-stopped --name clipsync -p 3000:3000 clipsync.

  To persist the clipboard history, add-v /path/to/index/storage:/index to thedocker run command.