commit 46666bba62ba062c8e17aa56a4de67c3fe491d37 · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2505.section.md

···

       142
        
       

     

       143
        
       - [victorialogs][https://docs.victoriametrics.com/victorialogs/], log database from VictoriaMetrics. Available as [services.victorialogs](#opt-services.victorialogs.enable)

     

       144
        
       

     

       0
        
       
     

       0
        
       
     

       145
        
       - [nostr-rs-relay](https://git.sr.ht/~gheartsfield/nostr-rs-relay/), This is a nostr relay, written in Rust. Available as [services.nostr-rs-relay](options.html#opt-services.nostr-rs-relay.enable).

     

       146
        
       

     

       147
        
       - [Prometheus Node Cert Exporter](https://github.com/amimof/node-cert-exporter), a prometheus exporter to check for SSL cert expiry. Available under [services.prometheus.exporters.node-cert](#opt-services.prometheus.exporters.node-cert.enable).

···

       142
        
       

     

       143
        
       - [victorialogs][https://docs.victoriametrics.com/victorialogs/], log database from VictoriaMetrics. Available as [services.victorialogs](#opt-services.victorialogs.enable)

     

       144
        
       

     

       145
       +
       - [gokapi](https://github.com/Forceu/Gokapi), Lightweight selfhosted Firefox Send alternative without public upload. AWS S3 supported. Available with [services.gokapi](options.html#opt-services.gokapi.enable)

     

       146
       +
       

     

       147
        
       - [nostr-rs-relay](https://git.sr.ht/~gheartsfield/nostr-rs-relay/), This is a nostr relay, written in Rust. Available as [services.nostr-rs-relay](options.html#opt-services.nostr-rs-relay.enable).

     

       148
        
       

     

       149
        
       - [Prometheus Node Cert Exporter](https://github.com/amimof/node-cert-exporter), a prometheus exporter to check for SSL cert expiry. Available under [services.prometheus.exporters.node-cert](#opt-services.prometheus.exporters.node-cert.enable).

nixos/modules/module-list.nix

···

       1116
        
         ./services/networking/go-neb.nix

     

       1117
        
         ./services/networking/go-shadowsocks2.nix

     

       1118
        
         ./services/networking/gobgpd.nix

     

       0
        
       
     

       1119
        
         ./services/networking/gvpe.nix

     

       1120
        
         ./services/networking/hans.nix

     

       1121
        
         ./services/networking/harmonia.nix

···

       1116
        
         ./services/networking/go-neb.nix

     

       1117
        
         ./services/networking/go-shadowsocks2.nix

     

       1118
        
         ./services/networking/gobgpd.nix

     

       1119
       +
         ./services/networking/gokapi.nix

     

       1120
        
         ./services/networking/gvpe.nix

     

       1121
        
         ./services/networking/hans.nix

     

       1122
        
         ./services/networking/harmonia.nix

+143

nixos/modules/services/networking/gokapi.nix

···

       1
       +
       {

     

       2
       +
         config,

     

       3
       +
         lib,

     

       4
       +
         pkgs,

     

       5
       +
         ...

     

       6
       +
       }:

     

       7
       +
       

     

       8
       +
       let

     

       9
       +
         cfg = config.services.gokapi;

     

       10
       +
         settingsFormat = pkgs.formats.json { };

     

       11
       +
         userSettingsFile = settingsFormat.generate "generated-config.json" cfg.settings;

     

       12
       +
       in

     

       13
       +
       {

     

       14
       +
         options.services.gokapi = {

     

       15
       +
           enable = lib.mkEnableOption "Lightweight selfhosted Firefox Send alternative without public upload";

     

       16
       +
       

     

       17
       +
           mutableSettings = lib.mkOption {

     

       18
       +
             type = lib.types.bool;

     

       19
       +
             default = true;

     

       20
       +
             description = ''

     

       21
       +
               Allow changes to the program config made by the program to persist between restarts.

     

       22
       +
               If disabled all required values must be set using nix, and all changes to config format over application updates must be resolved by user.

     

       23
       +
             '';

     

       24
       +
           };

     

       25
       +
       

     

       26
       +
           package = lib.mkPackageOption pkgs "gokapi" { };

     

       27
       +
       

     

       28
       +
           environment = lib.mkOption {

     

       29
       +
             type = lib.types.submodule {

     

       30
       +
               freeformType = lib.types.attrsOf (lib.types.either lib.types.str lib.types.int);

     

       31
       +
               options = {

     

       32
       +
                 GOKAPI_CONFIG_DIR = lib.mkOption {

     

       33
       +
                   type = lib.types.str;

     

       34
       +
                   default = "%S/gokapi/config";

     

       35
       +
                   description = "Sets the directory for the config file.";

     

       36
       +
                 };

     

       37
       +
                 GOKAPI_CONFIG_FILE = lib.mkOption {

     

       38
       +
                   type = lib.types.str;

     

       39
       +
                   default = "config.json";

     

       40
       +
                   description = "Sets the filename for the config file.";

     

       41
       +
                 };

     

       42
       +
                 GOKAPI_DATA_DIR = lib.mkOption {

     

       43
       +
                   type = lib.types.str;

     

       44
       +
                   default = "%S/gokapi/data";

     

       45
       +
                   description = "Sets the directory for the data.";

     

       46
       +
                 };

     

       47
       +
                 GOKAPI_PORT = lib.mkOption {

     

       48
       +
                   type = lib.types.port;

     

       49
       +
                   default = 53842;

     

       50
       +
                   description = "Sets the port of the service.";

     

       51
       +
                 };

     

       52
       +
               };

     

       53
       +
             };

     

       54
       +
             default = { };

     

       55
       +
             description = ''

     

       56
       +
               Environment variables to be set for the gokapi service. Can use systemd specifiers.

     

       57
       +
               For full list see <https://gokapi.readthedocs.io/en/latest/advanced.html#environment-variables>.

     

       58
       +
             '';

     

       59
       +
           };

     

       60
       +
           settings = lib.mkOption {

     

       61
       +
             type = lib.types.submodule {

     

       62
       +
               freeformType = settingsFormat.type;

     

       63
       +
               options = { };

     

       64
       +
             };

     

       65
       +
             default = { };

     

       66
       +
             description = ''

     

       67
       +
               Configuration settings for the generated config json file.

     

       68
       +
               See <https://gokapi.readthedocs.io/en/latest/advanced.html#config-json> for more information

     

       69
       +
             '';

     

       70
       +
           };

     

       71
       +
           settingsFile = lib.mkOption {

     

       72
       +
             type = lib.types.nullOr lib.types.str;

     

       73
       +
             default = null;

     

       74
       +
             description = ''

     

       75
       +
               Path to config file to parse and append to settings.

     

       76
       +
               Largely useful for loading secrets from a file not in the nix store. Can use systemd specifiers.

     

       77
       +
               See <https://gokapi.readthedocs.io/en/latest/advanced.html#config-json> for more information

     

       78
       +
             '';

     

       79
       +
           };

     

       80
       +
       

     

       81
       +
         };

     

       82
       +
       

     

       83
       +
         config = lib.mkIf cfg.enable {

     

       84
       +
           systemd.services.gokapi = {

     

       85
       +
             wantedBy = [ "default.target" ];

     

       86
       +
             wants = [ "network-online.target" ];

     

       87
       +
             after = [ "network-online.target" ];

     

       88
       +
             environment = lib.mapAttrs (_: value: toString value) cfg.environment;

     

       89
       +
             unitConfig = {

     

       90
       +
               Description = "gokapi service";

     

       91
       +
             };

     

       92
       +
             serviceConfig = {

     

       93
       +
               ExecStartPre =

     

       94
       +
                 let

     

       95
       +
                   updateScript = lib.getExe (

     

       96
       +
                     pkgs.writeShellApplication {

     

       97
       +
                       name = "merge-config";

     

       98
       +
                       runtimeInputs = with pkgs; [ jq ];

     

       99
       +
                       text = ''

     

       100
       +
                         echo "Running merge-config"

     

       101
       +
                         mutableSettings="$1"

     

       102
       +
                         statefulSettingsFile="$2"

     

       103
       +
                         settingsFile="$3"

     

       104
       +
                         if [[ "$mutableSettings" == true ]]; then

     

       105
       +
                           if [[ -f "$statefulSettingsFile" ]]; then

     

       106
       +
                             echo "Updating stateful config file"

     

       107
       +
                             merged="$(jq -s '.[0] * .[1]' "$statefulSettingsFile" ${userSettingsFile})"

     

       108
       +
                             echo "$merged" > "$statefulSettingsFile"

     

       109
       +
                           fi

     

       110
       +
                         else

     

       111
       +
                           echo "Overwriting stateful config file"

     

       112
       +
                           mkdir -p "$(dirname "$statefulSettingsFile")"

     

       113
       +
                           cat ${userSettingsFile} > "$statefulSettingsFile"

     

       114
       +
                         fi

     

       115
       +
                         if [ "$settingsFile" != "null" ]; then

     

       116
       +
                           echo "Merging settings file into current stateful settings file"

     

       117
       +
                           merged="$(jq -s '.[0] * .[1]' "$statefulSettingsFile" "$settingsFile")"

     

       118
       +
                           echo "$merged" > "$statefulSettingsFile"

     

       119
       +
                         fi

     

       120
       +
                       '';

     

       121
       +
                     }

     

       122
       +
                   );

     

       123
       +
                 in

     

       124
       +
                 lib.strings.concatStringsSep " " [

     

       125
       +
                   updateScript

     

       126
       +
                   (lib.boolToString cfg.mutableSettings)

     

       127
       +
                   "${cfg.environment.GOKAPI_CONFIG_DIR}/${cfg.environment.GOKAPI_CONFIG_FILE}"

     

       128
       +
                   (if (cfg.settingsFile == null) then "null" else cfg.settingsFile)

     

       129
       +
                 ];

     

       130
       +
               ExecStart = lib.getExe cfg.package;

     

       131
       +
               RestartSec = 30;

     

       132
       +
               DynamicUser = true;

     

       133
       +
               PrivateTmp = true;

     

       134
       +
               StateDirectory = "gokapi";

     

       135
       +
               CacheDirectory = "gokapi";

     

       136
       +
               Restart = "on-failure";

     

       137
       +
             };

     

       138
       +
           };

     

       139
       +
         };

     

       140
       +
         meta.maintainers = with lib.maintainers; [

     

       141
       +
           delliott

     

       142
       +
         ];

     

       143
       +
       }

nixos/tests/all-tests.nix

···

       479
        
         gobgpd = handleTest ./gobgpd.nix {};

     

       480
        
         gocd-agent = handleTest ./gocd-agent.nix {};

     

       481
        
         gocd-server = handleTest ./gocd-server.nix {};

     

       0
        
       
     

       482
        
         gollum = handleTest ./gollum.nix {};

     

       483
        
         gonic = handleTest ./gonic.nix {};

     

       484
        
         google-oslogin = handleTest ./google-oslogin {};

···

       479
        
         gobgpd = handleTest ./gobgpd.nix {};

     

       480
        
         gocd-agent = handleTest ./gocd-agent.nix {};

     

       481
        
         gocd-server = handleTest ./gocd-server.nix {};

     

       482
       +
         gokapi = runTest ./gokapi.nix;

     

       483
        
         gollum = handleTest ./gollum.nix {};

     

       484
        
         gonic = handleTest ./gonic.nix {};

     

       485
        
         google-oslogin = handleTest ./google-oslogin {};

+22

nixos/tests/gokapi.nix

···

       1
       +
       { lib, ... }:

     

       2
       +
       let

     

       3
       +
         port = 6000;

     

       4
       +
       in

     

       5
       +
       {

     

       6
       +
         name = "gokapi";

     

       7
       +
       

     

       8
       +
         meta.maintainers = with lib.maintainers; [ delliott ];

     

       9
       +
       

     

       10
       +
         nodes.machine = {

     

       11
       +
           services.gokapi = {

     

       12
       +
             enable = true;

     

       13
       +
             environment.GOKAPI_PORT = port;

     

       14
       +
           };

     

       15
       +
         };

     

       16
       +
       

     

       17
       +
         testScript = ''

     

       18
       +
           machine.wait_for_unit("gokapi.service")

     

       19
       +
           machine.wait_for_open_port(${toString port})

     

       20
       +
           machine.succeed("curl --fail http://localhost:${toString port}/")

     

       21
       +
         '';

     

       22
       +
       }

+7 -13

pkgs/by-name/go/gokapi/package.nix

···

       20
        
       

     

       21
        
         vendorHash = "sha256-9GRAlgng+yq7q0VQz374jIOCjeDIIDD631BglM/FsQQ=";

     

       22
        
       

     

       0
        
       
     

       23
        
         preBuild = ''

     

       24
       -
           # This is the go generate is ran in the upstream builder, but we have to run the components seperately for things to work.

     

       25
       -
           # go generate ./...

     

       26
       -
           # Hopefully at some point this is no longer necessary

     

       27
       -
       

     

       28
       -
           # Enter package dir, to match behaviour of go:generate

     

       29
        
           cd ./cmd/gokapi/

     

       30
       -
           go run "../../build/go-generate/updateVersionNumbers.go"

     

       31
       -
           # Ran by go-generate, but breaks build in nix

     

       32
       -
           # As it tries to download "golang.org/x/exp/slices"

     

       33
       -
           # go run "../../build/go-generate/updateProtectedUrls.go"

     

       34
       -
           go run "../../build/go-generate/buildWasm.go"

     

       35
       -
           # Must specify go root to import wasm_exec.js

     

       36
        
           GOROOT="$(go env GOROOT)" go run "../../build/go-generate/copyStaticFiles.go"

     

       37
       -
           # Return to toplevel before build

     

       38
        
           cd ../..

     

       39
        
         '';

     

       40
        
       

     
···

       59
        
         };

     

       60
        
       

     

       61
        
         meta = {

     

       62
       -
           description = "Lightweight selfhosted Firefox Send alternative without public upload. AWS S3 supported";

     

       63
        
           homepage = "https://github.com/Forceu/Gokapi";

     

       64
        
           changelog = "https://github.com/Forceu/Gokapi/releases/tag/v${version}";

     

       65
        
           license = lib.licenses.agpl3Only;

···

       20
        
       

     

       21
        
         vendorHash = "sha256-9GRAlgng+yq7q0VQz374jIOCjeDIIDD631BglM/FsQQ=";

     

       22
        
       

     

       23
       +
         # This is the go generate is ran in the upstream builder, but we have to run the components separately for things to work.

     

       24
        
         preBuild = ''

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       25
        
           cd ./cmd/gokapi/

     

       26
       +
           go run ../../build/go-generate/updateVersionNumbers.go

     

       27
       +
           # Tries to download "golang.org/x/exp/slices"

     

       28
       +
           # go run ../../build/go-generate/updateProtectedUrls.go

     

       29
       +
           go run ../../build/go-generate/buildWasm.go

     

       30
       +
           # Must be specify go root to import wasm_exec.js

     

       0
        
       
     

       31
        
           GOROOT="$(go env GOROOT)" go run "../../build/go-generate/copyStaticFiles.go"

     

       0
        
       
     

       32
        
           cd ../..

     

       33
        
         '';

     

       34
        
       

     
···

       53
        
         };

     

       54
        
       

     

       55
        
         meta = {

     

       56
       +
           description = "Lightweight selfhosted Firefox Send alternative without public upload";

     

       57
        
           homepage = "https://github.com/Forceu/Gokapi";

     

       58
        
           changelog = "https://github.com/Forceu/Gokapi/releases/tag/v${version}";

     

       59
        
           license = lib.licenses.agpl3Only;