robin/clipboard-sync
1
0
Fork 0
mirror of https://github.com/icewind1991/clipboard-sync synced 2026-06-03 10:24:06 +02:00
Code Issues Releases Wiki Activity
Syncronize clipboard between computers
20 commits 1 branch 2 tags 242 KiB
  • Rust 92.3%
  • Dockerfile 4%
  • Shell 3.7%
Find a file
Robin Appelman f4839aa938 fix feature flag
2019-06-15 14:44:48 +02:00
src dont make a clipboard context for every incoming message 2019-06-15 14:37:21 +02:00
.dockerignore use two step dockerfile 2019-06-15 13:53:24 +02:00
.gitignore initial server 2018-07-30 16:52:52 +02:00
.travis.yml fix travis release 2018-07-31 00:55:38 +02:00
appveyor.yml appveyor release fix 2018-07-31 00:32:41 +02:00
build_static.sh add ci setup 2018-07-30 20:15:23 +02:00
Cargo.lock fix feature flag 2019-06-15 14:44:48 +02:00
Cargo.toml fix feature flag 2019-06-15 14:44:48 +02:00
clipboard-sync.iml initial server 2018-07-30 16:52:52 +02:00
Dockerfile use two step dockerfile 2019-06-15 13:53:24 +02:00
README.md update readme 2018-07-31 01:11:38 +02:00

README.md

clipboard-sync

Build Status Build status

Synchronize clipboard between computers

Usage

The project consists of 2 parts, a server that is responsible for passing messages between client and the client which interact with the clipboard on the machine.

Server

Simply run the server executable to start the server, by default the server listens on port 80, this can be changed by setting the PORT environment variable.

A pre-built docker image with the server is available as clipboardsync/server and a static binary is available in the releases page.

The server is currently only tested on linux, but should run on all platforms with proper rust support.

Client

When running the client, you need to specify the websocket address of the server and the session identifier to use, all clients that share a session identifier will have their clipboards synced.

client ws://example.com my_session_key

The client is currently tested on linux(X11) and windows, but should also work fine on OSX and BSD. Prebuild binaries for windows can be found on the releases page.

Building

clipboard-sync is build using rust and can be build using a simple

cargo build --release

which will put the server and client binary in target/release.

Security

If multiple users have access to the machine running the clipboard-sync server it's important to take care about security to prevent other users from snooping the clipboard contents.

  • Put the sync server behind an SSL proxy

    This prevents the clipboard contents from being send over the network unencrypted.
    Note that using ssl on windows is currently broken, the clipboard-sync should thus only be used in secure environments when windows support is required.

  • Use a secure session key

    Everyone that knows the session key and has access to the sync server will be able to read the sync traffic. Picking a secure random key will prevent snooping of clipboard contents.