summaryrefslogtreecommitdiff
path: root/modules/bookwyrm.nix
blob: a55d1151ea52edd24212cd14d7e392e173b8ceb4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
{ config, lib, pkgs, ... }:

let
  cfg = config.services.bookwyrm;
in
{
  options.services.bookwyrm = with lib; {
    enable = mkEnableOption "bookwyrm";

    settings = mkOption {
      default = {};
      type = types.attrsOf (types.oneOf [ types.bool types.str types.int ]);
      description = mdDoc ''
        Settings passed to bookwyrm via environment variables. See bookwyrm's
        [.env.example](https://github.com/bookwyrm-social/bookwyrm/blob/v0.7.2/.env.example)
        file for what is permissible here.
      '';
    };

    package = mkOption {
      default = pkgs.bookwyrm.override { inherit (cfg) settings; };
      type = types.package;
      description = mdDoc ''
        The bookwyrm package to use. Note that this includes the settings .env file;
        if you set this directly, settings set via {option}`services.bookwyrm.settings`
        will be ignored.
      '';
    };

    stateDir = mkOption {
      default = "/var/lib/bookwyrm";
      type = types.path;
      description = mdDoc ''
        Where bookwyrm keeps dynamic data (in practice, exclusively book covers?) when
        not configured to use an S3-compatible storage. This should be persistent storage,
        otherwise you will have missing book covers and no obvious way to re-download them
        from a catalogue.
      '';
    };

    bindAddress = mkOption {
      default = "0.0.0.0";
      type = types.str;
      description = mdDoc ''
        Address bookwyrm should bind to.
      '';
    };

    port = mkOption {
      default = 8000;
      type = types.port;
      description = mdDoc ''
        Port bookwyrm should listen on.
      '';
    };

    threads = mkOption {
      default = 8;
      type = types.int;
      description = mdDoc ''
        Number of threads that gunicorn should spawn.
      '';
    };

    setupNginx = mkOption {
      default = false;
      type = types.bool;
      description = mdDoc ''
        Whether to set up a simple nginx config to server bookwyrm's `static/` and `image`
        directories.
      '';
    };

    nginxVirtualHost = mkOption {
      default = "default";
      type = types.str;
      description = mdDoc ''
        The name of the nginx virtual host to set up.
      '';
    };
  };


  config = with lib; mkIf cfg.enable {
    systemd.packages = [ cfg.package ];

    systemd.services = {
      bookwyrm = {
        enable = true;
        wantedBy = [ "multi-user.target" ];
        serviceConfig = mkMerge [
          {
            BindPaths = [
              cfg.package.passthru.gunicorn
              cfg.package.passthru.celery
              cfg.stateDir
            ];
          }
          (mkIf (cfg.bindAddress != "0.0.0.0" || cfg.port != 8000 || cfg.threads != 8) {
            ExecStart = "${lib.getExe cfg.package.passthru.gunicorn} bookwyrm.wsgi:application --threads=${toString cfg.threads} --bind ${cfg.bindAddress}:${toString cfg.port}";

          })
        ];

        environment.PYTHONPATH = cfg.package.passthru.pythonPath;
      };

      bookwyrm-worker = {
        enable = true;
        wantedBy = [ "multi-user.target" ];
        environment.PYTHONPATH = cfg.package.passthru.pythonPath;
        serviceConfig.BindPaths = [
          cfg.stateDir
        ];
      };
      bookwyrm-scheduler = {
        enable = true;
        wantedBy = [ "multi-user.target" ];
        environment.PYTHONPATH = cfg.package.passthru.pythonPath;
      };
    };

    systemd.tmpfiles.rules = [
      "d ${cfg.stateDir}/images 0750 bookwyrm bookwyrm - -"
    ];

    services.nginx = mkIf cfg.setupNginx {
      enable = true;
      virtualHosts.${cfg.nginxVirtualHost} = {
        locations."/static".root = config.services.bookwyrm.package;
        locations."/images".root = cfg.stateDir;
        locations."/".proxyPass = "http://${cfg.bindAddress}:${toString cfg.port}";
      };
    };

    users.users = mkMerge [
      {
        bookwyrm = {
          isSystemUser = true;
          group = "bookwyrm";
        };
      }
      (mkIf cfg.setupNginx {
        nginx.extraGroups = [ "bookwyrm" ];
      })
    ];

    users.groups.bookwyrm = {};
  };

}