2024-09-21 22:31:53 +00:00
2019-04-26 16:02:45 +00:00
2024-10-20 05:03:46 +00:00
> [!NOTE]
> 🚀 **Deskflow** is now the upstream project for Synergy.
2024-10-02 13:22:36 +00:00
>
2024-10-20 05:03:46 +00:00
> The Deskflow project was established to cultivate community-driven development where everyone can collaborate.
>
> Synergy sponsors the Deskflow project by contributing code and providing financial support while maintaining its customer-oriented code downstream.
>
> More info: [Relationship with Synergy](https://github.com/deskflow/deskflow/wiki/Relationship-with-Synergy)
2024-09-13 11:03:17 +00:00
2024-10-20 05:03:46 +00:00
**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.
[](https://github.com/deskflow/deskflow/releases/tag/v1.17.0) [](https://github.com/deskflow/deskflow/releases)
2024-09-20 14:03:59 +00:00
2024-10-20 05:03:46 +00:00
To use Deskflow you can use one of our [packages ](https://github.com/deskflow/deskflow/releases ), install `deskflow` (if available in your package repository), or [build it ](#build-quick-start ) yourself from source.
[](https://github.com/deskflow/deskflow/commits/master/)
[](https://github.com/deskflow/deskflow/commits/master/)
[](LICENSE)
2024-10-02 09:03:37 +00:00
2024-09-17 19:00:25 +00:00
[](https://sonarcloud.io/summary/new_code?id=deskflow_deskflow)
2024-10-02 09:03:37 +00:00
[](https://sonarcloud.io/summary/new_code?id=deskflow_deskflow)
[](https://sonarcloud.io/summary/new_code?id=deskflow_deskflow)
[](https://sonarcloud.io/summary/new_code?id=deskflow_deskflow)
2024-09-10 11:05:43 +00:00
2024-09-16 20:33:07 +00:00
[](https://github.com/deskflow/deskflow/actions/workflows/ci.yml)
[](https://github.com/deskflow/deskflow/actions/workflows/codeql-analysis.yml)
[](https://github.com/deskflow/deskflow/actions/workflows/sonarcloud-analysis.yml)
2024-06-26 16:42:02 +00:00
2024-10-02 09:03:37 +00:00
## Project Values
2019-04-26 16:02:45 +00:00
2024-09-17 19:00:25 +00:00
- Motivated by the community interests (not business-driven)
2024-10-02 09:03:37 +00:00
- Privacy by default (e.g. update check is off by default)
2024-10-14 10:17:31 +00:00
- Leading edge releases (we don't focus on supporting older systems)
2024-10-11 06:48:12 +00:00
- Decisions are discussed and documented publicly with majority rule
2024-09-17 19:00:25 +00:00
- Have fun; we don't need to worry about impressing anyone
2024-09-05 09:10:26 +00:00
## Ways to get involved
2024-10-20 05:03:46 +00:00
> [!TIP]
> Join us! Real-time discussion on Matrix: [`#deskflow:matrix.org`](https://matrix.to/#/#deskflow:matrix.org)
>
> Alternatively, we have [other ways](https://github.com/deskflow/deskflow/wiki/Chat-with-us) to communicate.
>
2024-09-05 09:10:26 +00:00
Here are a few ways to join in with the project and get involved:
2024-09-16 20:33:07 +00:00
* Build the latest `master` version (see below) and [report a bug ](https://github.com/deskflow/deskflow/issues )
* [Submit a PR ](https://github.com/deskflow/deskflow/wiki/Contributing ) (pull request) with a bug fix or improvement
* [Let us know ](https://github.com/deskflow/deskflow/issues ) if you have an idea for an improvement
2024-09-05 09:10:26 +00:00
2024-09-10 09:39:12 +00:00
## Build Quick Start
2019-04-26 16:02:45 +00:00
2024-10-20 05:03:46 +00:00
For instructions on building Deskflow, use the wiki page: [Building ](https://github.com/deskflow/deskflow/wiki/Building )
2024-09-13 11:03:17 +00:00
## Operating Systems
We support all major operating systems, including Windows, macOS, Linux, and Unix-like BSD-derived.
All Linux distributions are supported, primarily focusing on:
Debian, Ubuntu, Linux Mint, Fedora, RHEL, AlmaLinux, Rocky Linux, Arch Linux, openSUSE, Gentoo.
We officially support FreeBSD, and would also like to support: OpenBSD, NetBSD, DragonFly, Solaris.
2024-09-06 09:52:21 +00:00
2024-10-20 05:03:46 +00:00
## Repology
Repology monitors a huge number of package repositories and other sources comparing package
versions across them and gathering other information.
[](https://repology.org/project/deskflow/versions)
**Note:** We are working with package maintainers to have our new package name adopted.
2024-09-19 20:52:14 +00:00
## Collaborative Projects
2024-10-20 05:03:46 +00:00
In the open source developer community, similar projects collaborate for the improvement of all
2024-09-19 20:52:14 +00:00
mouse and keyboard sharing tools. We aim for idea sharing and interoperability.
* [**Lan Mouse** ](https://github.com/feschber/lan-mouse ) -
Rust implementation with the goal of having native front-ends and interoperability with
Deskflow/Synergy.
* [**Input Leap** ](https://github.com/input-leap/input-leap ) -
Deskflow/Synergy-derivative with the goal of continuing what Barrier started, after Barrier
became a dead fork.
2024-09-20 14:03:59 +00:00
* [**Synergy** ](https://github.com/deskflow/deskflow/wiki/Relationship-with-Synergy ) -
2024-10-02 09:03:37 +00:00
Downstream commercial fork and Deskflow sponsor, geared toward adapting to customer
2024-09-19 20:52:14 +00:00
needs, offering business and enterprise licensing.
2024-09-10 20:16:29 +00:00
2024-09-05 09:10:26 +00:00
## FAQ
2024-10-20 05:03:46 +00:00
### What is the relationship with Synergy?
[](https://github.com/deskflow/deskflow/wiki/Relationship-with-Synergy)
Synergy sponsors the Deskflow project by contributing code and providing financial support while maintaining its customer-oriented code downstream.
Learn more: [Relationship with Synergy ](https://github.com/deskflow/deskflow/wiki/Relationship-with-Synergy )
### Is Deskflow compatible with Synergy, Input Leap, or Barrier?
Yes, Deskflow has network compatibility with all forks:
- Requires Deskflow >= v1.17.0.96
- Deskflow will *just work* with Input Leap and Barrier (server or client).
- Connecting a Deskflow client to a Synergy server will also *just work* .
- To connect a Synergy client, you need to select the Synergy protocol in the Deskflow server settings.
### Is Deskflow compatible with Lan Mouse?
2024-09-13 11:03:17 +00:00
2024-10-20 05:03:46 +00:00
We would love to see compatibility with Lan Mouse. This maybe quite an effort as currently they way they handle the generated input is very different.
2024-09-13 11:03:17 +00:00
2024-09-17 19:00:25 +00:00
### If I want to solve issues in Deskflow do I need to contribute to a fork?
2024-09-05 09:10:26 +00:00
2024-09-06 09:52:21 +00:00
We welcome PRs (pull requests) from the community. If you'd like to make a change, please feel
2024-09-16 20:33:07 +00:00
free to [start a discussion ](https://github.com/deskflow/deskflow/discussions ) or
[open a PR ](https://github.com/deskflow/deskflow/wiki/Contributing ).
2024-09-05 09:10:26 +00:00
### Is clipboard sharing supported?
2024-09-06 09:52:21 +00:00
Absolutely. The clipboard-sharing feature is a cornerstone feature of the product and we are
committed to maintaining and improving that feature.
2024-09-05 09:10:26 +00:00
### Is Wayland for Linux supported?
2024-09-06 09:52:21 +00:00
Yes! Wayland (the Linux display server protocol aimed to become the successor of the X Window
System) is an important platform for us.
The [`libei` ](https://gitlab.freedesktop.org/libinput/libei ) and
[`libportal` ](https://github.com/flatpak/libportal ) libraries enable
2024-09-17 19:00:25 +00:00
Wayland support for Deskflow. We would like to give special thanks to Peter Hutterer,
2024-09-06 09:52:21 +00:00
who is the author of `libei` , a major contributor to `libportal` , and the author of the Wayland
2024-09-17 19:00:25 +00:00
implementation in Deskflow. Others such as Olivier Fourdan and Povilas Kanapickas helped with the
Wayland implementation.
2024-09-05 09:10:26 +00:00
### Where did it all start?
2024-09-17 19:00:25 +00:00
Deskflow was first created as Synergy in 2001 by Chris Schoeneman.
2024-09-16 20:33:07 +00:00
Read about the [history of the project ](https://github.com/deskflow/deskflow/wiki/History ) on our
2024-09-06 09:52:21 +00:00
wiki.
2024-09-05 09:10:26 +00:00
2024-10-02 09:03:37 +00:00
## Meow'Dib (our mascot)
2024-09-10 10:35:54 +00:00
## License
2024-09-10 11:02:15 +00:00
This project is licensed under [GPL-2.0 ](LICENSE ) with an [OpenSSL exception ](LICENSE_EXCEPTION ).
