2e751c0772
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
104 lines
2.9 KiB
Nix
104 lines
2.9 KiB
Nix
{ config, pkgs, lib, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.cage;
|
|
in {
|
|
options.services.cage.enable = mkEnableOption "cage kiosk service";
|
|
|
|
options.services.cage.user = mkOption {
|
|
type = types.str;
|
|
default = "demo";
|
|
description = lib.mdDoc ''
|
|
User to log-in as.
|
|
'';
|
|
};
|
|
|
|
options.services.cage.extraArguments = mkOption {
|
|
type = types.listOf types.str;
|
|
default = [];
|
|
defaultText = literalExpression "[]";
|
|
description = lib.mdDoc "Additional command line arguments to pass to Cage.";
|
|
example = ["-d"];
|
|
};
|
|
|
|
options.services.cage.program = mkOption {
|
|
type = types.path;
|
|
default = "${pkgs.xterm}/bin/xterm";
|
|
defaultText = literalExpression ''"''${pkgs.xterm}/bin/xterm"'';
|
|
description = lib.mdDoc ''
|
|
Program to run in cage.
|
|
'';
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
# The service is partially based off of the one provided in the
|
|
# cage wiki at
|
|
# https://github.com/Hjdskes/cage/wiki/Starting-Cage-on-boot-with-systemd.
|
|
systemd.services."cage-tty1" = {
|
|
enable = true;
|
|
after = [
|
|
"systemd-user-sessions.service"
|
|
"plymouth-start.service"
|
|
"plymouth-quit.service"
|
|
"systemd-logind.service"
|
|
"getty@tty1.service"
|
|
];
|
|
before = [ "graphical.target" ];
|
|
wants = [ "dbus.socket" "systemd-logind.service" "plymouth-quit.service"];
|
|
wantedBy = [ "graphical.target" ];
|
|
conflicts = [ "getty@tty1.service" ];
|
|
|
|
restartIfChanged = false;
|
|
unitConfig.ConditionPathExists = "/dev/tty1";
|
|
serviceConfig = {
|
|
ExecStart = ''
|
|
${pkgs.cage}/bin/cage \
|
|
${escapeShellArgs cfg.extraArguments} \
|
|
-- ${cfg.program}
|
|
'';
|
|
User = cfg.user;
|
|
|
|
IgnoreSIGPIPE = "no";
|
|
|
|
# Log this user with utmp, letting it show up with commands 'w' and
|
|
# 'who'. This is needed since we replace (a)getty.
|
|
UtmpIdentifier = "%n";
|
|
UtmpMode = "user";
|
|
# A virtual terminal is needed.
|
|
TTYPath = "/dev/tty1";
|
|
TTYReset = "yes";
|
|
TTYVHangup = "yes";
|
|
TTYVTDisallocate = "yes";
|
|
# Fail to start if not controlling the virtual terminal.
|
|
StandardInput = "tty-fail";
|
|
StandardOutput = "journal";
|
|
StandardError = "journal";
|
|
# Set up a full (custom) user session for the user, required by Cage.
|
|
PAMName = "cage";
|
|
};
|
|
};
|
|
|
|
security.polkit.enable = true;
|
|
|
|
security.pam.services.cage.text = ''
|
|
auth required pam_unix.so nullok
|
|
account required pam_unix.so
|
|
session required pam_unix.so
|
|
session required pam_env.so conffile=/etc/pam/environment readenv=0
|
|
session required ${config.systemd.package}/lib/security/pam_systemd.so
|
|
'';
|
|
|
|
hardware.opengl.enable = mkDefault true;
|
|
|
|
systemd.targets.graphical.wants = [ "cage-tty1.service" ];
|
|
|
|
systemd.defaultUnit = "graphical.target";
|
|
};
|
|
|
|
meta.maintainers = with lib.maintainers; [ matthewbauer ];
|
|
|
|
}
|