commit 02b15d0f5bc6bd821718d808e8dcdbc441449f72 · pyrox.dev/nixpkgs

+28 -25

nixos/modules/services/web-apps/plausible.nix

···

       5
       5
        
       let

     

       6
       6
        
         cfg = config.services.plausible;

     

       7
       7
        
       

     

       8
       8
       +
         # FIXME consider using LoadCredential as soon as it actually works.

     

       8
       9
        
         envSecrets = ''

     

       9
       10
        
           export ADMIN_USER_PWD="$(<${cfg.adminUser.passwordFile})"

     

       10
       11
        
           export SECRET_KEY_BASE="$(<${cfg.server.secretKeybaseFile})"

     

       11
       11
       -
           export RELEASE_TMP=/var/lib/plausible/tmp

     

       12
       12
        
           ${optionalString (cfg.mail.smtp.passwordFile != null) ''

     

       13
       13
        
             export SMTP_USER_PWD="$(<${cfg.mail.smtp.passwordFile})"

     

       14
       14
        
           ''}

     
···

       51
       51
        
                 default = "http://localhost:8123/default";

     

       52
       52
        
                 type = types.str;

     

       53
       53
        
                 description = ''

     

       54
       54
       -
                   The URL to be used to connect to <package>postgres</package>. The format

     

       55
       55
       -
                   is described in <link xlink:href="https://hexdocs.pm/ecto/Ecto.Repo.html#module-urls">

     

       56
       56
       -
                   the elixir docs</link>.

     

       54
       54
       +
                   The URL to be used to connect to <package>clickhouse</package>.

     

       57
       55
        
                 '';

     

       58
       56
        
               };

     

       59
       57
        
             };

     
···

       110
       108
        
       

     

       111
       109
        
           mail = {

     

       112
       110
        
             email = mkOption {

     

       113
       113
       -
               default = "	hello@plausible.local";

     

       111
       111
       +
               default = "hello@plausible.local";

     

       114
       112
        
               type = types.str;

     

       115
       113
        
               description = ''

     

       116
       114
        
                 The email id to use for as <emphasis>from</emphasis> address of all communications

     
···

       146
       144
        
                   The path to the file with the password in case SMTP auth is enabled.

     

       147
       145
        
                 '';

     

       148
       146
        
               };

     

       149
       149
       -
               enableSSL = mkEnableOption "";

     

       147
       147
       +
               enableSSL = mkEnableOption "SSL when connecting to the SMTP server";

     

       150
       148
        
               retries = mkOption {

     

       151
       149
        
                 type = types.ints.unsigned;

     

       152
       150
        
                 default = 2;

     
···

       162
       160
        
           assertions = [

     

       163
       161
        
             { assertion = cfg.adminUser.activate -> cfg.database.postgres.setup;

     

       164
       162
        
               message = ''

     

       165
       165
       -
                 Unable to automatically activate the admin-user if no local DB-managed for

     

       163
       163
       +
                 Unable to automatically activate the admin-user if no locally DB-managed for

     

       166
       164
        
                 postgres (`services.plausible.database.postgres.setup') is enabled!

     

       167
       165
        
               '';

     

       168
       166
        
             }

     
···

       181
       179
        
               plausible = {

     

       182
       180
        
                 inherit (pkgs.plausible.meta) description;

     

       183
       181
        
                 documentation = [ "https://plausible.io/docs/self-hosting" ];

     

       184
       184
       -
                 wantedBy = [ "multi-user.target" ]

     

       185
       185
       -
                   ++ optional cfg.database.clickhouse.setup "clickhouse.service"

     

       186
       186
       -
                   ++ optional cfg.database.postgres.setup "postgresql.service";

     

       182
       182
       +
                 wantedBy = [ "multi-user.target" ];

     

       187
       183
        
                 after = optional cfg.database.postgres.setup "plausible-postgres.service";

     

       184
       184
       +
                 requires = optional cfg.database.clickhouse.setup "clickhouse.service"

     

       185
       185
       +
                   ++ optionals cfg.database.postgres.setup [

     

       186
       186
       +
                     "postgresql.service"

     

       187
       187
       +
                     "plausible-postgres.service"

     

       188
       188
       +
                   ];

     

       188
       189
        
       

     

       189
       190
        
                 environment = {

     

       190
       191
        
                   # NixOS specific option to avoid that it's trying to write into its store-path.

     
···

       196
       197
        
                   PORT = toString cfg.server.port;

     

       197
       198
        
                   DISABLE_REGISTRATION = boolToString cfg.server.disableRegistration;

     

       198
       199
        
       

     

       200
       200
       +
                   RELEASE_TMP = "/var/lib/plausible/tmp";

     

       201
       201
       +
       

     

       199
       202
        
                   ADMIN_USER_NAME = cfg.adminUser.name;

     

       200
       203
        
                   ADMIN_USER_EMAIL = cfg.adminUser.email;

     

       201
       204
        
       

     
···

       210
       213
        
                   SMTP_HOST_PORT = toString cfg.mail.smtp.hostPort;

     

       211
       214
        
                   SMTP_RETRIES = toString cfg.mail.smtp.retries;

     

       212
       215
        
                   SMTP_HOST_SSL_ENABLED = boolToString cfg.mail.smtp.enableSSL;

     

       213
       213
       -
                   ${if cfg.mail.smtp.user != null then "SMTP_USER_NAME" else null} = cfg.mail.smtp.user;

     

       214
       214
       -
                 };

     

       216
       216
       +
       

     

       217
       217
       +
                   SELFHOST = "true";

     

       218
       218
       +
                 } // (optionalAttrs (cfg.mail.smtp.user != null) {

     

       219
       219
       +
                   SMTP_USER_NAME = cfg.mail.smtp.user;

     

       220
       220
       +
                 });

     

       215
       221
        
       

     

       216
       222
        
                 path = [ pkgs.plausible ]

     

       217
       223
        
                   ++ optional cfg.database.postgres.setup config.services.postgresql.package;

     
···

       239
       245
        
               };

     

       240
       246
        
             }

     

       241
       247
        
             (mkIf cfg.database.postgres.setup {

     

       242
       242
       -
               # Unfortunately `plausible' requires super-user permissions in postgresql, so this

     

       243
       243
       -
               # has to be done imperatively here.

     

       248
       248
       +
               # `plausible' requires the `citext'-extension.

     

       244
       249
        
               plausible-postgres = {

     

       245
       250
        
                 after = [ "postgresql.service" ];

     

       246
       251
        
                 bindsTo = [ "postgresql.service" ];

     

       247
       252
        
                 requiredBy = [ "plausible.service" ];

     

       248
       253
        
                 partOf = [ "plausible.service" ];

     

       249
       254
        
                 serviceConfig.Type = "oneshot";

     

       255
       255
       +
                 unitConfig.ConditionPathExists = "!/var/lib/plausible/.db-setup";

     

       250
       256
        
                 script = ''

     

       251
       251
       -
                   if [ ! -e /var/lib/plausible/.db-setup ]; then

     

       252
       252
       -
                     mkdir -p /var/lib/plausible/

     

       253
       253
       -
                     PSQL() {

     

       254
       254
       -
                       /run/wrappers/bin/sudo -Hu postgres ${config.services.postgresql.package}/bin/psql --port=5432 "$@"

     

       255
       255
       -
                     }

     

       256
       256
       -
                     PSQL -tAc "CREATE EXTENSION IF NOT EXISTS citext;"

     

       257
       257
       -
                     PSQL -tAc "CREATE ROLE plausible WITH LOGIN;"

     

       258
       258
       -
                     PSQL -tAc "CREATE DATABASE plausible WITH OWNER plausible;"

     

       259
       259
       -
                     PSQL -tAc "ALTER USER plausible WITH SUPERUSER;"

     

       260
       260
       -
                     touch /var/lib/plausible/.db-setup

     

       261
       261
       -
                   fi

     

       257
       257
       +
                   mkdir -p /var/lib/plausible/

     

       258
       258
       +
                   PSQL() {

     

       259
       259
       +
                     /run/wrappers/bin/sudo -Hu postgres ${config.services.postgresql.package}/bin/psql --port=5432 "$@"

     

       260
       260
       +
                   }

     

       261
       261
       +
                   PSQL -tAc "CREATE ROLE plausible WITH LOGIN;"

     

       262
       262
       +
                   PSQL -tAc "CREATE DATABASE plausible WITH OWNER plausible;"

     

       263
       263
       +
                   PSQL -d plausible -tAc "CREATE EXTENSION IF NOT EXISTS citext;"

     

       264
       264
       +
                   touch /var/lib/plausible/.db-setup

     

       262
       265
        
                 '';

     

       263
       266
        
               };

     

       264
       267
        
             })

+1 -1

nixos/modules/services/web-apps/plausible.xml

···

       12
       12
        
         <title>Basic Usage</title>

     

       13
       13
        
         <para>

     

       14
       14
        
          At first, a secret key is needed to be generated. This can be done with e.g.

     

       15
       15
       -
          <prompt>$ openssl rand -base64 64</prompt>

     

       15
       15
       +
          <screen><prompt>$ </prompt>openssl rand -base64 64</screen>

     

       16
       16
        
         </para>

     

       17
       17
        
         <para>

     

       18
       18
        
          After that, <package>plausible</package> can be deployed like this:

+11 -5

pkgs/servers/web-apps/plausible/default.nix

···

       14
       14
        
           sha256 = "03lm1f29gwwixnhgjish5bhi3m73qyp71ns2sczdnwnbhrw61zps";

     

       15
       15
        
         };

     

       16
       16
        
       

     

       17
       17
       -
         mixDeps = beamPackages.fetchMixDeps {

     

       17
       17
       +
         # TODO consider using `mix2nix` as soon as it supports git dependencies.

     

       18
       18
       +
         mixFodDeps = beamPackages.fetchMixDeps {

     

       18
       19
        
           pname = "${pname}-deps";

     

       19
       20
        
           inherit src version;

     

       20
       20
       -
           sha256 = "sha256-66zSdYmis3UnbdLkPi649RbPbMPI5gVeFlaMekOy5CQ=";

     

       21
       21
       +
           sha256 = "sha256-pv/zXcku+ZgxV1804kIfDZN0jave2qG3rgZwm4yGA6I=";

     

       22
       22
       +
           patches = [ ./ecto_sql-fix.patch ];

     

       21
       23
        
         };

     

       22
       24
        
       

     

       23
       25
        
         yarnDeps = mkYarnModules {

     
···

       28
       30
        
           yarnLock = ./yarn.lock;

     

       29
       31
        
           preBuild = ''

     

       30
       32
        
             mkdir -p tmp/deps

     

       31
       31
       -
             cp -r ${mixDeps}/phoenix tmp/deps/phoenix

     

       32
       32
       -
             cp -r ${mixDeps}/phoenix_html tmp/deps/phoenix_html

     

       33
       33
       +
             cp -r ${mixFodDeps}/phoenix tmp/deps/phoenix

     

       34
       34
       +
             cp -r ${mixFodDeps}/phoenix_html tmp/deps/phoenix_html

     

       33
       35
        
           '';

     

       34
       36
        
           postBuild = ''

     

       35
       37
        
             echo 'module.exports = {}' > $out/node_modules/flatpickr/dist/postcss.config.js

     

       36
       38
        
           '';

     

       37
       39
        
         };

     

       38
       40
        
       in beamPackages.mixRelease {

     

       39
       39
       -
         inherit pname version src mixDeps;

     

       41
       41
       +
         inherit pname version src mixFodDeps;

     

       40
       42
        
       

     

       41
       43
        
         nativeBuildInputs = [ nodejs ];

     

       42
       44
        
       

     
···

       47
       49
        
             url = "https://github.com/Ma27/analytics/commit/f2ee5892a6c3e1a861d69ed30cac43e05e9cd36f.patch";

     

       48
       50
        
             sha256 = "sha256-JvJ7xlGw+tHtWje+jiQChVC4KTyqqdq2q+MIcOv/k1o=";

     

       49
       51
        
           })

     

       52
       52
       +
       

     

       53
       53
       +
           # CREATE EXTENSION requires super-user privileges. To avoid that, we just skip

     

       54
       54
       +
           # the responsible SQL statement here and take care of it in the module.

     

       55
       55
       +
           ./skip-create-ext.patch

     

       50
       56
        
         ];

     

       51
       57
        
       

     

       52
       58
        
         passthru = {

+13

pkgs/servers/web-apps/plausible/ecto_sql-fix.patch

···

       1
       1
       +
       diff --git a/mix.exs b/mix.exs

     

       2
       2
       +
       index f6e3b9a..67687d1 100644

     

       3
       3
       +
       --- a/mix.exs

     

       4
       4
       +
       +++ b/mix.exs

     

       5
       5
       +
       @@ -52,7 +52,7 @@ defmodule Plausible.MixProject do

     

       6
       6
       +
            [

     

       7
       7
       +
              {:bcrypt_elixir, "~> 2.0"},

     

       8
       8
       +
              {:cors_plug, "~> 1.5"},

     

       9
       9
       +
       -      {:ecto_sql, "~> 3.0"},

     

       10
       10
       +
       +      {:ecto_sql, "~> 3.6"},

     

       11
       11
       +
              {:elixir_uuid, "~> 1.2"},

     

       12
       12
       +
              {:gettext, "~> 0.11"},

     

       13
       13
       +
              {:jason, "~> 1.0"},

+16

pkgs/servers/web-apps/plausible/skip-create-ext.patch

···

       1
       1
       +
       diff --git a/priv/repo/migrations/20190430140411_use_citext_for_email.exs b/priv/repo/migrations/20190430140411_use_citext_for_email.exs

     

       2
       2
       +
       index ecb6f80..f3bf12f 100644

     

       3
       3
       +
       --- a/priv/repo/migrations/20190430140411_use_citext_for_email.exs

     

       4
       4
       +
       +++ b/priv/repo/migrations/20190430140411_use_citext_for_email.exs

     

       5
       5
       +
       @@ -2,10 +2,6 @@ defmodule Plausible.Repo.Migrations.UseCitextForEmail do

     

       6
       6
       +
          use Ecto.Migration

     

       7
       7
       +
        

     

       8
       8
       +
          def change do

     

       9
       9
       +
       -    execute "CREATE EXTENSION IF NOT EXISTS citext;"

     

       10
       10
       +
       -

     

       11
       11
       +
       -    alter table(:users) do

     

       12
       12
       +
       -      modify :email, :citext, null: false

     

       13
       13
       +
       -    end

     

       14
       14
       +
       +    execute "ALTER TABLE users ALTER COLUMN email TYPE citext;"

     

       15
       15
       +
          end

     

       16
       16
       +
        end

+4 -4

pkgs/servers/web-apps/plausible/update.sh

···

       45
       45
        
       sed -i "$dir/default.nix" \

     

       46
       46
        
         -e 's,version = ".*",version = "'"$nix_version"'",' \

     

       47
       47
        
         -e '/^  src = fetchFromGitHub/,+4{;s/sha256 = "\(.*\)"/sha256 = "'"$tarball_hash"'"/}' \

     

       48
       48
       -
         -e '/^  mixDeps =/,+3{;s/sha256 = "\(.*\)"/sha256 = "'"$fake_hash"'"/}'

     

       48
       48
       +
         -e '/^  mixFodDeps =/,+3{;s/sha256 = "\(.*\)"/sha256 = "'"$fake_hash"'"/}'

     

       49
       49
        
       

     

       50
       50
       -
       mix_hash="$(nix-build -A plausible.mixDeps 2>&1 | tail -n3 | grep 'got:' | cut -d: -f2- | xargs echo)"

     

       50
       50
       +
       mix_hash="$(nix-build -A plausible.mixFodDeps 2>&1 | tail -n3 | grep 'got:' | cut -d: -f2- | xargs echo)"

     

       51
       51
        
       

     

       52
       52
       -
       sed -i "$dir/default.nix" -e '/^  mixDeps =/,+3{;s/sha256 = "\(.*\)"/sha256 = "'"$mix_hash"'"/}'

     

       52
       52
       +
       sed -i "$dir/default.nix" -e '/^  mixFodDeps =/,+3{;s/sha256 = "\(.*\)"/sha256 = "'"$mix_hash"'"/}'

     

       53
       53
        
       

     

       54
       54
        
       tmp_setup_dir="$(mktemp -d)"

     

       55
       55
        
       trap "rm -rf $tmp_setup_dir" EXIT

     

       56
       56
        
       

     

       57
       57
        
       cp -r $tarball_path/* $tmp_setup_dir/

     

       58
       58
       -
       cp -r "$(nix-build -A plausible.mixDeps)" "$tmp_setup_dir/deps"

     

       58
       58
       +
       cp -r "$(nix-build -A plausible.mixFodDeps)" "$tmp_setup_dir/deps"

     

       59
       59
        
       chmod -R a+rwx "$tmp_setup_dir"

     

       60
       60
        
       

     

       61
       61
        
       pushd $tmp_setup_dir/assets