nixpkgs/nixos/modules/services/web-apps/silverbullet.nix
Silvan Mosberger 4f0dadbf38 treewide: format all inactive Nix files
After final improvements to the official formatter implementation,
this commit now performs the first treewide reformat of Nix files using it.
This is part of the implementation of RFC 166.

Only "inactive" files are reformatted, meaning only files that
aren't being touched by any PR with activity in the past 2 months.
This is to avoid conflicts for PRs that might soon be merged.
Later we can do a full treewide reformat to get the rest,
which should not cause as many conflicts.

A CI check has already been running for some time to ensure that new and
already-formatted files are formatted, so the files being reformatted here
should also stay formatted.

This commit was automatically created and can be verified using

    nix-build a08b3a4d19.tar.gz \
      --argstr baseRev b32a094368
    result/bin/apply-formatting $NIXPKGS_PATH
2024-12-10 20:26:33 +01:00

128 lines
3.7 KiB
Nix

{
config,
pkgs,
lib,
...
}:
let
cfg = config.services.silverbullet;
defaultUser = "silverbullet";
defaultGroup = defaultUser;
defaultSpaceDir = "/var/lib/silverbullet";
in
{
options = {
services.silverbullet = {
enable = lib.mkEnableOption "Silverbullet, an open-source, self-hosted, offline-capable Personal Knowledge Management (PKM) web application";
package = lib.mkPackageOption pkgs "silverbullet" { };
openFirewall = lib.mkOption {
type = lib.types.bool;
default = false;
description = "Open port in the firewall.";
};
listenPort = lib.mkOption {
type = lib.types.int;
default = 3000;
description = "Port to listen on.";
};
listenAddress = lib.mkOption {
type = lib.types.str;
default = "127.0.0.1";
description = "Address or hostname to listen on. Defaults to 127.0.0.1.";
};
spaceDir = lib.mkOption {
type = lib.types.path;
default = defaultSpaceDir;
example = "/home/yourUser/silverbullet";
description = ''
Folder to store Silverbullet's space/workspace.
By default it is located at `${defaultSpaceDir}`.
'';
};
user = lib.mkOption {
type = lib.types.str;
default = defaultUser;
example = "yourUser";
description = ''
The user to run Silverbullet as.
By default, a user named `${defaultUser}` will be created whose space
directory is [spaceDir](#opt-services.silverbullet.spaceDir).
'';
};
group = lib.mkOption {
type = lib.types.str;
default = defaultGroup;
example = "yourGroup";
description = ''
The group to run Silverbullet under.
By default, a group named `${defaultGroup}` will be created.
'';
};
envFile = lib.mkOption {
type = lib.types.nullOr lib.types.path;
default = null;
example = "/etc/silverbullet.env";
description = ''
File containing extra environment variables. For example:
```
SB_USER=user:password
SB_AUTH_TOKEN=abcdefg12345
```
'';
};
extraArgs = lib.mkOption {
type = lib.types.listOf lib.types.str;
default = [ ];
example = [ "--db /path/to/silverbullet.db" ];
description = "Extra arguments passed to silverbullet.";
};
};
};
config = lib.mkIf cfg.enable {
systemd.services.silverbullet = {
description = "Silverbullet service";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
preStart = lib.mkIf (!lib.hasPrefix "/var/lib/" cfg.spaceDir) "mkdir -p '${cfg.spaceDir}'";
serviceConfig = {
Type = "simple";
User = "${cfg.user}";
Group = "${cfg.group}";
EnvironmentFile = lib.mkIf (cfg.envFile != null) "${cfg.envFile}";
StateDirectory = lib.mkIf (lib.hasPrefix "/var/lib/" cfg.spaceDir) (
lib.last (lib.splitString "/" cfg.spaceDir)
);
ExecStart =
"${lib.getExe cfg.package} --port ${toString cfg.listenPort} --hostname '${cfg.listenAddress}' '${cfg.spaceDir}' "
+ lib.concatStringsSep " " cfg.extraArgs;
Restart = "on-failure";
};
};
networking.firewall = lib.mkIf cfg.openFirewall {
allowedTCPPorts = [ cfg.listenPort ];
};
users.users.${defaultUser} = lib.mkIf (cfg.user == defaultUser) {
isSystemUser = true;
group = cfg.group;
description = "Silverbullet daemon user";
};
users.groups.${defaultGroup} = lib.mkIf (cfg.group == defaultGroup) { };
};
meta.maintainers = with lib.maintainers; [ aorith ];
}