Git Product home page Git Product logo

clipboard-sync's Introduction

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.

clipboard-sync's People

Contributors

icewind1991 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

liusong1220

clipboard-sync's Issues

Client can't run

  1. run server on linux, ip: 192.168.119.52, port:80;
  2. run client on windows, "client ws://192.168.119.52 session_key",
    output error msg: "
    connecting to ws://192.168.119.52:80 on channel session_key
    ERROR 2018-11-20T18:07:48Z: ws::io: Unable to establish connection to ws://192.1
    68.119.52/: WS Error : Unable to obtain any socket address for ws://19
    2.168.119.52/", how run by correct paramerter ? how to solved the problem ?
    thank you!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.