summaryrefslogtreecommitdiffstats
path: root/nixos/modules/services/web-apps/silverbullet.nix
diff options
context:
space:
mode:
Diffstat (limited to 'nixos/modules/services/web-apps/silverbullet.nix')
-rw-r--r--nixos/modules/services/web-apps/silverbullet.nix123
1 files changed, 123 insertions, 0 deletions
diff --git a/nixos/modules/services/web-apps/silverbullet.nix b/nixos/modules/services/web-apps/silverbullet.nix
new file mode 100644
index 000000000000..a0c6ee34d262
--- /dev/null
+++ b/nixos/modules/services/web-apps/silverbullet.nix
@@ -0,0 +1,123 @@
+{ config
+, pkgs
+, lib
+, ...
+}:
+let
+ cfg = config.services.silverbullet;
+ defaultUser = "silverbullet";
+ defaultGroup = defaultUser;
+ defaultSpaceDir = "/var/lib/silverbullet";
+in
+{
+ options = {
+ services.silverbullet = {
+ enable = lib.mkEnableOption (lib.mdDoc "Silverbullet, an open-source, self-hosted, offline-capable Personal Knowledge Management (PKM) web application.");
+
+ package = lib.mkPackageOptionMD pkgs "silverbullet" { };
+
+ openFirewall = lib.mkOption {
+ type = lib.types.bool;
+ default = false;
+ description = lib.mdDoc "Open port in the firewall.";
+ };
+
+ listenPort = lib.mkOption {
+ type = lib.types.int;
+ default = 3000;
+ description = lib.mdDoc "Port to listen on.";
+ };
+
+ listenAddress = lib.mkOption {
+ type = lib.types.str;
+ default = "127.0.0.1";
+ description = lib.mdDoc "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 = lib.mdDoc ''
+ 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 = lib.mdDoc ''
+ 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 = lib.mdDoc ''
+ 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 = lib.mdDoc ''
+ 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 = lib.mdDoc "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 ];
+}