https://github.com/jirutka/swaylockd
A dumb launcher to spawn swaylock and ensure it runs no matter what
https://github.com/jirutka/swaylockd
screenlocker swaylock
Last synced: 8 months ago
JSON representation
A dumb launcher to spawn swaylock and ensure it runs no matter what
- Host: GitHub
- URL: https://github.com/jirutka/swaylockd
- Owner: jirutka
- License: mit
- Created: 2021-09-08T21:19:02.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-04-30T20:34:43.000Z (about 4 years ago)
- Last Synced: 2025-06-08T18:48:17.988Z (about 1 year ago)
- Topics: screenlocker, swaylock
- Language: C
- Homepage:
- Size: 13.7 KB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
README
= swaylockd
:proj-name: swaylockd
:version: 0.1.0
:gh-name: jirutka/{proj-name}
:releases-uri: https://github.com/{gh-name}/releases/download/v{version}
ifdef::env-github[]
image:https://github.com/{gh-name}/workflows/CI/badge.svg[Binaries Workflow, link=https://github.com/{gh-name}/actions?query=workflow%3A%22CI%22]
endif::env-github[]
*swaylockd* is a dumb launcher to spawn https://github.com/swaywm/swaylock[swaylock] and ensure it’s running no matter what -- it immediately restarts swaylock if terminated by a signal (e.g. the process crashed) and also blocks all signals (except `SIGKILL` and `SIGSTOP`).
It also ensures that only one instance per user is running.
swaylockd has been developed mainly as a workaround for the swaylock stability issues footnote:[Actually, it’s more a bad design. See article https://www.jwz.org/xscreensaver/toolkits.html[XScreenSaver:
On Toolkit Dialogs] written in 2004 by Jamie Zawinski.] (see e.g. https://github.com/swaywm/swaylock/issues/181[#181]).
swaylock is a critical piece of security software -- as a screen locker, any bug in the program that causes it to crash will cause the screen to unlock.
As soon as swaylock is no longer running, the screen is no longer locked.
Therefore, great care must be taken to ensure that the daemon never crash.
Refer to link:{proj-name}.1.adoc[{proj-name}(1)] for more information.
== Requirements
.*Runtime*:
* https://github.com/swaywm/swaylock[swaylock]
.*Build*:
* C compiler and linker supporting at least C99 (tested with clang and gcc)
* https://www.gnu.org/software/make/[GNU Make]
* http://asciidoctor.org/[Asciidoctor] (for building man pages)
== Installation
=== On Alpine Linux
Install package https://pkgs.alpinelinux.org/packages?name={proj-name}[{proj-name}] on Alpine Linux v3.15 or later:
[source, sh, subs="+attributes"]
apk add {proj-name}
=== Using Pre-Built Binary
{releases-uri}/{proj-name}-{version}-x86_64-unknown-linux.tar.gz[[x86_64]]
{releases-uri}/{proj-name}-{version}-aarch64-unknown-linux.tar.gz[[aarch64]]
{releases-uri}/{proj-name}-{version}-armv7-unknown-linux.tar.gz[[armv7]]
{releases-uri}/{proj-name}-{version}-ppc64le-unknown-linux.tar.gz[[ppc64le]]
{releases-uri}/{proj-name}-{version}-riscv64-unknown-linux.tar.gz[[riscv64]]
. Download and extract release tarball for your CPU architecture (pick the right link from the list above):
+
[source, sh, subs="verbatim, attributes"]
----
wget {releases-uri}/{proj-name}-{version}-x86_64-unknown-linux.tar.gz
tar -xzf {proj-name}-{version}-*.tar.gz
----
. Install `{proj-name}` somewhere on your `PATH`, e.g. `/usr/local/bin`:
+
[source, sh, subs="verbatim, attributes"]
install -m 755 {proj-name}-{version}-*/{proj-name} /usr/local/bin/
All binaries are statically linked with http://www.musl-libc.org/[musl libc], so they work on every Linux system (distro) regardless of used libc.
=== From Source Tarball
[source, sh, subs="+attributes"]
----
wget https://github.com/{gh-name}/archive/v{version}/{proj-name}-{version}.tar.gz
tar -xzf {proj-name}-{version}.tar.gz
cd {proj-name}-{version}
make build
make install DESTDIR=/ prefix=/usr/local
----
== License
This project is licensed under http://opensource.org/licenses/MIT/[MIT License].
For the full text of the license, see the link:LICENSE[LICENSE] file.