mconnect - KDE Connect protocol implementation in Vala/C
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

55 lines
1.7 KiB

10 years ago
  1. # mconnect
  2. mconnect - KDE Connect protocol implementation in Vala/C
  3. GLib and Gio should be available even on trimmed down systems. Vala is
  4. really needed only at build time. OpenSSL does the packet
  5. encryption/decryption at the protocol level, while Json-glib does
  6. packet parsing. Libnotify is responsible for displaying shell popups.
  7. # Building
  8. Build dependencies (using package names as found in Fedora):
  9. - vala
  10. - vala-devel
  11. - glib2-devel
  12. - json-glib
  13. - openssl-devel
  14. - libnotify-devel
  15. or see `mconnect.spec` in source tree. Once build deps are in place, run:
  16. autoreconf -if
  17. ./configure --prefix=<your favorite prefix>
  18. make
  19. make install
  20. # or make DESTDIR=<somedir> install if you want to inspect what
  21. # gets installed
  22. # Configuration
  23. A sample configuration file is provided in source tree, see
  24. `mconnect.conf`. It will get installed to `${sysconfdir}/mconnect/`
  25. (usually corresponding to `/etc/mconnect/`) by default. Once
  26. `mconnect` starts it will pick the default file and make a copy of it
  27. in user's config directory, specifically `~/.config/mconnect/`.
  28. A device described in it's own group and listed in `main.devices`, has
  29. to match exactly with incoming identity packets. However, since
  30. `deviceId` is not known beforehand, neither shown in KDE Connect
  31. Android application, only `name` and `type` are used for matching.
  32. # Usage
  33. Start it by running:
  34. mconnect -d
  35. # Operation
  36. The daemon starts listening on `0.0.0.0:1714` for incoming UDP
  37. packets. Once an identity packet (a sort of a handshake) is received,
  38. a connection at the sender's address will be made only if the device
  39. is listed as `allowed` in `mconnect.conf` (see the sample config).
  40. Should the device be whitelisted in configuration, pairing will happen
  41. automatically.