Repository files navigation

Deskflow is a free and open source keyboard and mouse sharing app.Use the keyboard, mouse, or trackpad of one computer to control nearby computers,and work seamlessly between them.It's like a software KVM (but without the video).TLS encryption is enabled by default. Wayland is supported. Clipboard sharing is supported.

To use Deskflow you can use one of ourpackages, installdeskflow (if available in your package repository), orbuild it yourself from source.

• Motivated by the community interests (not business-driven)
• Privacy by default (e.g. update check is off by default)
• Leading edge releases (we don't focus on supporting older systems)
• Decisions are discussed and documented publicly with majority rule
• Have fun; we don't need to worry about impressing anyone

Here are a few ways to join in with the project and get involved:

• Build the latestmaster version (see below) andreport a bug
• Submit a PR (pull request) with a bug fix or improvement
• Let us know if you have an idea for an improvement

For instructions on building Deskflow, use the wiki page:Building

We support all major operating systems, including Windows, macOS, Linux, and Unix-like BSD-derived.

Windows 10 or higher is required.

macOS 12 or higher is required.

Linux requires libei 1.3+ and libportal 0.8+ for the server/client. Additionally, Qt 6.7+ is required for the GUI.Linux users with systems not meeting these requirements should use flatpak in place of a native package.

We officially support FreeBSD, and would also like to support: OpenBSD, NetBSD, DragonFly, Solaris.

Repology monitors a huge number of package repositories and other sources comparing packageversions across them and gathering other information.

Note: We are working with package maintainers to have our new package name adopted.

When you install Deskflow on macOS, you need to allow accessibility access (Privacy & Security) to both theDeskflow app and thedeskflow process.

If using Sequoia, you may also need to allowDeskflow under Local Network‍ settings (Privacy & Security).When prompted by the OS, go to the settings and enable the access.

If you are upgrading and you already haveDeskflow ordeskflowon the allowed list you will need to manually remove them before accessibility access can be granted to the new version.

macOS users who download directly from releases may need to runxattr -c /Applications/Deskflow.app after copying the app to theApplications dir.

It is recommend to install Deskflow usingHomebrew from ourhomebrew-tap

To add our tap, run:

brew tap deskflow/homebrew-tap

Then install either:

• Stable:brew install deskflow
• Continuous:brew install deskflow-dev

In the open source developer community, similar projects collaborate for the improvement of allmouse and keyboard sharing tools. We aim for idea sharing and interoperability.

• Lan Mouse -Rust implementation with the goal of having native front-ends and interoperability withDeskflow/Synergy.
• Input Leap -Deskflow/Synergy-derivative with the goal of continuing what Barrier started, after Barrierbecame a dead fork.
• Synergy -Downstream commercial fork and Deskflow sponsor, geared toward adapting to customerneeds, offering business and enterprise licensing.

Synergy sponsors the Deskflow project by contributing code and providing financial support while maintaining its customer-oriented code downstream.

Learn more:Relationship with Synergy

Yes, Deskflow has network compatibility with all forks:

• Requires Deskflow >= v1.17.0.96
• Deskflow willjust work with Input Leap and Barrier (server or client).
• Connecting a Deskflow client to a Synergy 1 server will alsojust work.
• To connect a Synergy 1 client, you need to select the Synergy protocol in the Deskflow server settings.

Note: Only Synergy 1 is compatible with Deskflow (Synergy 3 is not yet compatible).

We would love to see compatibility with Lan Mouse. This may be quite an effort as currently the way they handle the generated input is very different.

We welcome PRs (pull requests) from the community. If you'd like to make a change, please feelfree tostart a discussion oropen a PR.

Absolutely. The clipboard-sharing feature is a cornerstone feature of the product and we arecommitted to maintaining and improving that feature.

Yes! Wayland (the Linux display server protocol aimed to become the successor of the X WindowSystem) is an important platform for us.Thelibei andlibportal libraries enableWayland support for Deskflow. We would like to give special thanks to Peter Hutterer,who is the author oflibei, a major contributor tolibportal, and the author of the Waylandimplementation in Deskflow. Others such as Olivier Fourdan and Povilas Kanapickas helped with theWayland implementation.

Some featuresmay be unavailable or broken on Wayland. Please see theknown Wayland issues.

Deskflow was first created as Synergy in 2001 by Chris Schoeneman.Read about thehistory of the project on ourwiki.

Deskflow is made by possible by these contributors.

This project is licensed underGPL-2.0 with anOpenSSL exception.