150 lines
8.6 KiB
Markdown
150 lines
8.6 KiB
Markdown
|
|
|
|
> [!NOTE]
|
|
> 🚀 **Deskflow** is now the upstream project for Synergy.
|
|
>
|
|
> 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)
|
|
|
|
**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)
|
|
|
|
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)
|
|
|
|
[](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)
|
|
[](https://sonarcloud.io/summary/new_code?id=deskflow_deskflow)
|
|
|
|
[](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)
|
|
[](https://github.com/deskflow/deskflow/actions/workflows/build-containers.yml)
|
|
|
|
## Project Values
|
|
|
|
- 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
|
|
|
|
## Ways to get involved
|
|
|
|
> [!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.
|
|
>
|
|
Here are a few ways to join in with the project and get involved:
|
|
* 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
|
|
|
|
## Build Quick Start
|
|
|
|
For instructions on building Deskflow, use the wiki page: [Building](https://github.com/deskflow/deskflow/wiki/Building)
|
|
|
|
## 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.
|
|
|
|
## 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.
|
|
|
|
## Collaborative Projects
|
|
|
|
In the open source developer community, similar projects collaborate for the improvement of all
|
|
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.
|
|
* [**Synergy**](https://github.com/deskflow/deskflow/wiki/Relationship-with-Synergy) -
|
|
Downstream commercial fork and Deskflow sponsor, geared toward adapting to customer
|
|
needs, offering business and enterprise licensing.
|
|
|
|
## FAQ
|
|
|
|
### 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?
|
|
|
|
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.
|
|
|
|
### If I want to solve issues in Deskflow do I need to contribute to a fork?
|
|
|
|
We welcome PRs (pull requests) from the community. If you'd like to make a change, please feel
|
|
free to [start a discussion](https://github.com/deskflow/deskflow/discussions) or
|
|
[open a PR](https://github.com/deskflow/deskflow/wiki/Contributing).
|
|
|
|
### Is clipboard sharing supported?
|
|
|
|
Absolutely. The clipboard-sharing feature is a cornerstone feature of the product and we are
|
|
committed to maintaining and improving that feature.
|
|
|
|
### Is Wayland for Linux supported?
|
|
|
|
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
|
|
Wayland support for Deskflow. We would like to give special thanks to Peter Hutterer,
|
|
who is the author of `libei`, a major contributor to `libportal`, and the author of the Wayland
|
|
implementation in Deskflow. Others such as Olivier Fourdan and Povilas Kanapickas helped with the
|
|
Wayland implementation.
|
|
|
|
### Where did it all start?
|
|
|
|
Deskflow was first created as Synergy in 2001 by Chris Schoeneman.
|
|
Read about the [history of the project](https://github.com/deskflow/deskflow/wiki/History) on our
|
|
wiki.
|
|
|
|
## Meow'Dib (our mascot)
|
|
|
|
|
|
|
|
## License
|
|
|
|
This project is licensed under [GPL-2.0](LICENSE) with an [OpenSSL exception](LICENSE_EXCEPTION).
|