Projects/muscl
12
5
Fork 0
Code Issues 78 Pull Requests Actions Packages Releases 2 Activity

docs: split SUID/SGID installation section into its own document
Build and test / test (push) Has been cancelled
Details
Build and test / docs (push) Has been cancelled
Details
Build and test / build (push) Has been cancelled
Details
Build and test / check (push) Has been cancelled
Details
Build and test / check-license (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Oystein Kristoffer Tveit
2025-12-15 09:00:38 +09:00
parent 6e914dec34
commit 8811a41980
3 changed files with 22 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/installation.md
+4 -7
View File
@@ -1,5 +1,9 @@
# Installation and configuration
This document contains instructions for the recommended way of installing and configuring muscl.
Note that there are separate instructions for [installing on NixOS](nixos.md) and [installing with SUID/SGID mode](suid-sgid-mode.md).
## Installing with deb on Debian
You can install muscl by adding the [PVV apt repository][pvv-apt-repository] and installing the package:
@@ -68,13 +72,6 @@ If you are running systemd older than version 254 (see `systemctl --version`), y
LoadCredentialEncrypted=muscl_mysql_password:/etc/credstore.encrypted/muscl_mysql_password
```
## SUID/SGID mode
For backwards compatibility reasons, it is possible to run the program without a daemon by utilizing SUID/SGID.
In order to do this, you should set either the SUID/SGID bit and preferably make the executable owned by a non-privileged user.
If the database is running on the same machine, the user/group will need access to write and read from the database socket.
Otherwise, the only requirement is that the user/group is able to read the config file (typically `/etc/muscl/config.toml`).
## A note on minimum version requirements
The muscl server will work with older versions of systemd, but the recommended version is 254 or newer.