commit d69cbe23e19b65c34f17c3a3dcd3e9564bab4780 · pyrox.dev/nixpkgs

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

···

       34
       34
        
       

     

       35
       35
        
       - [tlsrpt-reporter], an application suite to generate and deliver TLSRPT reports. Available as [services.tlsrpt](#opt-services.tlsrpt.enable).

     

       36
       36
        
       

     

       37
       37
       +
       - [Chhoto URL](https://github.com/SinTan1729/chhoto-url), a simple, blazingly fast, selfhosted URL shortener with no unnecessary features, written in Rust. Available as [services.chhoto-url](#opt-services.chhoto-url.enable).

     

       38
       38
       +
       

     

       37
       39
        
       - [Broadcast Box](https://github.com/Glimesh/broadcast-box), a WebRTC broadcast server. Available as [services.broadcast-box](options.html#opt-services.broadcast-box.enable).

     

       38
       40
        
       

     

       39
       41
        
       - Docker now defaults to 28.x, because version 27.x stopped receiving security updates and bug fixes after [May 2, 2025](https://github.com/moby/moby/pull/49910).

nixos/modules/module-list.nix

···

       1531
       1531
        
         ./services/web-apps/castopod.nix

     

       1532
       1532
        
         ./services/web-apps/changedetection-io.nix

     

       1533
       1533
        
         ./services/web-apps/chatgpt-retrieval-plugin.nix

     

       1534
       1534
       +
         ./services/web-apps/chhoto-url.nix

     

       1534
       1535
        
         ./services/web-apps/cloudlog.nix

     

       1535
       1536
        
         ./services/web-apps/code-server.nix

     

       1536
       1537
        
         ./services/web-apps/coder.nix

+212

nixos/modules/services/web-apps/chhoto-url.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       

     

       8
       8
       +
       let

     

       9
       9
       +
         cfg = config.services.chhoto-url;

     

       10
       10
       +
       

     

       11
       11
       +
         environment = lib.mapAttrs (

     

       12
       12
       +
           _: value:

     

       13
       13
       +
           if value == true then

     

       14
       14
       +
             "True"

     

       15
       15
       +
           else if value == false then

     

       16
       16
       +
             "False"

     

       17
       17
       +
           else

     

       18
       18
       +
             toString value

     

       19
       19
       +
         ) cfg.settings;

     

       20
       20
       +
       in

     

       21
       21
       +
       

     

       22
       22
       +
       {

     

       23
       23
       +
         meta.maintainers = with lib.maintainers; [ defelo ];

     

       24
       24
       +
       

     

       25
       25
       +
         options.services.chhoto-url = {

     

       26
       26
       +
           enable = lib.mkEnableOption "Chhoto URL";

     

       27
       27
       +
       

     

       28
       28
       +
           package = lib.mkPackageOption pkgs "chhoto-url" { };

     

       29
       29
       +
       

     

       30
       30
       +
           settings = lib.mkOption {

     

       31
       31
       +
             description = ''

     

       32
       32
       +
               Configuration of Chhoto URL.

     

       33
       33
       +
               See <https://github.com/SinTan1729/chhoto-url/blob/main/compose.yaml> for a list of options.

     

       34
       34
       +
             '';

     

       35
       35
       +
             example = {

     

       36
       36
       +
               port = 4567;

     

       37
       37
       +
             };

     

       38
       38
       +
       

     

       39
       39
       +
             type = lib.types.submodule {

     

       40
       40
       +
               freeformType =

     

       41
       41
       +
                 with lib.types;

     

       42
       42
       +
                 attrsOf (oneOf [

     

       43
       43
       +
                   str

     

       44
       44
       +
                   int

     

       45
       45
       +
                   bool

     

       46
       46
       +
                 ]);

     

       47
       47
       +
       

     

       48
       48
       +
               options = {

     

       49
       49
       +
                 db_url = lib.mkOption {

     

       50
       50
       +
                   type = lib.types.path;

     

       51
       51
       +
                   description = "The path of the sqlite database.";

     

       52
       52
       +
                   default = "/var/lib/chhoto-url/urls.sqlite";

     

       53
       53
       +
                 };

     

       54
       54
       +
       

     

       55
       55
       +
                 port = lib.mkOption {

     

       56
       56
       +
                   type = lib.types.port;

     

       57
       57
       +
                   description = "The port to listen on.";

     

       58
       58
       +
                   example = 4567;

     

       59
       59
       +
                 };

     

       60
       60
       +
       

     

       61
       61
       +
                 cache_control_header = lib.mkOption {

     

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

     

       63
       63
       +
                   description = "The Cache-Control header to send.";

     

       64
       64
       +
                   default = null;

     

       65
       65
       +
                   example = "no-cache, private";

     

       66
       66
       +
                 };

     

       67
       67
       +
       

     

       68
       68
       +
                 disable_frontend = lib.mkOption {

     

       69
       69
       +
                   type = lib.types.bool;

     

       70
       70
       +
                   description = "Whether to disable the frontend.";

     

       71
       71
       +
                   default = false;

     

       72
       72
       +
                 };

     

       73
       73
       +
       

     

       74
       74
       +
                 public_mode = lib.mkOption {

     

       75
       75
       +
                   type = lib.types.bool;

     

       76
       76
       +
                   description = "Whether to enable public mode.";

     

       77
       77
       +
                   default = false;

     

       78
       78
       +
                   apply = x: if x then "Enable" else "Disable";

     

       79
       79
       +
                 };

     

       80
       80
       +
       

     

       81
       81
       +
                 public_mode_expiry_delay = lib.mkOption {

     

       82
       82
       +
                   type = lib.types.nullOr lib.types.ints.unsigned;

     

       83
       83
       +
                   description = "The maximum expiry delay in seconds to force in public mode.";

     

       84
       84
       +
                   default = null;

     

       85
       85
       +
                   example = 3600;

     

       86
       86
       +
                 };

     

       87
       87
       +
       

     

       88
       88
       +
                 redirect_method = lib.mkOption {

     

       89
       89
       +
                   type = lib.types.enum [

     

       90
       90
       +
                     "TEMPORARY"

     

       91
       91
       +
                     "PERMANENT"

     

       92
       92
       +
                   ];

     

       93
       93
       +
                   description = "The redirect method to use.";

     

       94
       94
       +
                   default = "PERMANENT";

     

       95
       95
       +
                 };

     

       96
       96
       +
       

     

       97
       97
       +
                 hash_algorithm = lib.mkOption {

     

       98
       98
       +
                   type = lib.types.nullOr (lib.types.enum [ "Argon2" ]);

     

       99
       99
       +
                   description = ''

     

       100
       100
       +
                     The hash algorithm to use for passwords and API keys.

     

       101
       101
       +
                     Set to `null` if you want to provide these secrets as plaintext.

     

       102
       102
       +
                   '';

     

       103
       103
       +
                   default = null;

     

       104
       104
       +
                 };

     

       105
       105
       +
       

     

       106
       106
       +
                 site_url = lib.mkOption {

     

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

     

       108
       108
       +
                   description = "The URL under which Chhoto URL is externally reachable.";

     

       109
       109
       +
                   default = null;

     

       110
       110
       +
                 };

     

       111
       111
       +
       

     

       112
       112
       +
                 slug_style = lib.mkOption {

     

       113
       113
       +
                   type = lib.types.enum [

     

       114
       114
       +
                     "Pair"

     

       115
       115
       +
                     "UID"

     

       116
       116
       +
                   ];

     

       117
       117
       +
                   description = "The slug style to use for auto-generated URLs.";

     

       118
       118
       +
                   default = "Pair";

     

       119
       119
       +
                 };

     

       120
       120
       +
       

     

       121
       121
       +
                 slug_length = lib.mkOption {

     

       122
       122
       +
                   type = lib.types.addCheck lib.types.int (x: x >= 4);

     

       123
       123
       +
                   description = "The length of auto-generated slugs.";

     

       124
       124
       +
                   default = 8;

     

       125
       125
       +
                 };

     

       126
       126
       +
       

     

       127
       127
       +
                 try_longer_slugs = lib.mkOption {

     

       128
       128
       +
                   type = lib.types.bool;

     

       129
       129
       +
                   description = "Whether to try a longer UID upon collision.";

     

       130
       130
       +
                   default = false;

     

       131
       131
       +
                 };

     

       132
       132
       +
       

     

       133
       133
       +
                 allow_capital_letters = lib.mkOption {

     

       134
       134
       +
                   type = lib.types.bool;

     

       135
       135
       +
                   description = "Whether to allow capital letters in slugs.";

     

       136
       136
       +
                   default = false;

     

       137
       137
       +
                 };

     

       138
       138
       +
       

     

       139
       139
       +
                 custom_landing_directory = lib.mkOption {

     

       140
       140
       +
                   type = lib.types.nullOr lib.types.path;

     

       141
       141
       +
                   description = "The path of a directory which contains a custom landing page.";

     

       142
       142
       +
                   default = null;

     

       143
       143
       +
                 };

     

       144
       144
       +
               };

     

       145
       145
       +
             };

     

       146
       146
       +
           };

     

       147
       147
       +
       

     

       148
       148
       +
           environmentFiles = lib.mkOption {

     

       149
       149
       +
             type = lib.types.listOf lib.types.path;

     

       150
       150
       +
             default = [ ];

     

       151
       151
       +
             example = [ "/run/secrets/chhoto-url.env" ];

     

       152
       152
       +
             description = ''

     

       153
       153
       +
               Files to load environment variables from in addition to [](#opt-services.chhoto-url.settings).

     

       154
       154
       +
               This is useful to avoid putting secrets into the nix store.

     

       155
       155
       +
               See <https://github.com/SinTan1729/chhoto-url/blob/main/compose.yaml> for a list of options.

     

       156
       156
       +
             '';

     

       157
       157
       +
           };

     

       158
       158
       +
         };

     

       159
       159
       +
       

     

       160
       160
       +
         config = lib.mkIf cfg.enable {

     

       161
       161
       +
           systemd.services.chhoto-url = {

     

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

     

       163
       163
       +
       

     

       164
       164
       +
             inherit environment;

     

       165
       165
       +
       

     

       166
       166
       +
             serviceConfig = {

     

       167
       167
       +
               User = "chhoto-url";

     

       168
       168
       +
               Group = "chhoto-url";

     

       169
       169
       +
               DynamicUser = true;

     

       170
       170
       +
               StateDirectory = "chhoto-url";

     

       171
       171
       +
               EnvironmentFile = cfg.environmentFiles;

     

       172
       172
       +
       

     

       173
       173
       +
               ExecStart = lib.getExe cfg.package;

     

       174
       174
       +
       

     

       175
       175
       +
               # hardening

     

       176
       176
       +
               AmbientCapabilities = "";

     

       177
       177
       +
               CapabilityBoundingSet = [ "" ];

     

       178
       178
       +
               DevicePolicy = "closed";

     

       179
       179
       +
               LockPersonality = true;

     

       180
       180
       +
               MemoryDenyWriteExecute = true;

     

       181
       181
       +
               NoNewPrivileges = true;

     

       182
       182
       +
               PrivateDevices = true;

     

       183
       183
       +
               PrivateTmp = true;

     

       184
       184
       +
               PrivateUsers = true;

     

       185
       185
       +
               ProcSubset = "pid";

     

       186
       186
       +
               ProtectClock = true;

     

       187
       187
       +
               ProtectControlGroups = true;

     

       188
       188
       +
               ProtectHome = true;

     

       189
       189
       +
               ProtectHostname = true;

     

       190
       190
       +
               ProtectKernelLogs = true;

     

       191
       191
       +
               ProtectKernelModules = true;

     

       192
       192
       +
               ProtectKernelTunables = true;

     

       193
       193
       +
               ProtectProc = "invisible";

     

       194
       194
       +
               ProtectSystem = "strict";

     

       195
       195
       +
               RemoveIPC = true;

     

       196
       196
       +
               RestrictAddressFamilies = [ "AF_INET AF_INET6" ];

     

       197
       197
       +
               RestrictNamespaces = true;

     

       198
       198
       +
               RestrictRealtime = true;

     

       199
       199
       +
               RestrictSUIDSGID = true;

     

       200
       200
       +
               SocketBindAllow = "tcp:${toString cfg.settings.port}";

     

       201
       201
       +
               SocketBindDeny = "any";

     

       202
       202
       +
               SystemCallArchitectures = "native";

     

       203
       203
       +
               SystemCallFilter = [

     

       204
       204
       +
                 "@system-service"

     

       205
       205
       +
                 "~@privileged"

     

       206
       206
       +
                 "~@resources"

     

       207
       207
       +
               ];

     

       208
       208
       +
               UMask = "0077";

     

       209
       209
       +
             };

     

       210
       210
       +
           };

     

       211
       211
       +
         };

     

       212
       212
       +
       }

nixos/tests/all-tests.nix

···

       311
       311
        
         cfssl = runTestOn [ "aarch64-linux" "x86_64-linux" ] ./cfssl.nix;

     

       312
       312
        
         cgit = runTest ./cgit.nix;

     

       313
       313
        
         charliecloud = runTest ./charliecloud.nix;

     

       314
       314
       +
         chhoto-url = runTest ./chhoto-url.nix;

     

       314
       315
        
         chromadb = runTest ./chromadb.nix;

     

       315
       316
        
         chromium = (handleTestOn [ "aarch64-linux" "x86_64-linux" ] ./chromium.nix { }).stable or { };

     

       316
       317
        
         chrony = runTestOn [ "aarch64-linux" "x86_64-linux" ] ./chrony.nix;

+60

nixos/tests/chhoto-url.nix

···

       1
       1
       +
       { config, lib, ... }:

     

       2
       2
       +
       

     

       3
       3
       +
       {

     

       4
       4
       +
         name = "chhoto-url";

     

       5
       5
       +
         meta.maintainers = with lib.maintainers; [ defelo ];

     

       6
       6
       +
       

     

       7
       7
       +
         nodes.machine = {

     

       8
       8
       +
           services.chhoto-url = {

     

       9
       9
       +
             enable = true;

     

       10
       10
       +
             settings.port = 8000;

     

       11
       11
       +
             environmentFiles = [

     

       12
       12
       +
               (builtins.toFile "chhoto-url.env" ''

     

       13
       13
       +
                 api_key=api_key

     

       14
       14
       +
                 password=password

     

       15
       15
       +
               '')

     

       16
       16
       +
             ];

     

       17
       17
       +
           };

     

       18
       18
       +
         };

     

       19
       19
       +
       

     

       20
       20
       +
         interactive.nodes.machine = {

     

       21
       21
       +
           services.glitchtip.listenAddress = "0.0.0.0";

     

       22
       22
       +
           networking.firewall.allowedTCPPorts = [ 8000 ];

     

       23
       23
       +
           virtualisation.forwardPorts = [

     

       24
       24
       +
             {

     

       25
       25
       +
               from = "host";

     

       26
       26
       +
               host.port = 8000;

     

       27
       27
       +
               guest.port = 8000;

     

       28
       28
       +
             }

     

       29
       29
       +
           ];

     

       30
       30
       +
         };

     

       31
       31
       +
       

     

       32
       32
       +
         testScript = ''

     

       33
       33
       +
           import json

     

       34
       34
       +
           import re

     

       35
       35
       +
       

     

       36
       36
       +
           machine.wait_for_unit("chhoto-url.service")

     

       37
       37
       +
           machine.wait_for_open_port(8000)

     

       38
       38
       +
       

     

       39
       39
       +
           resp = json.loads(machine.succeed("curl localhost:8000/api/getconfig"))

     

       40
       40
       +
           assert resp["success"] is False

     

       41
       41
       +
           assert resp["reason"] == "No valid authentication was found"

     

       42
       42
       +
       

     

       43
       43
       +
           resp = json.loads(machine.succeed("curl -H 'X-API-Key: api_key' localhost:8000/api/getconfig"))

     

       44
       44
       +
           expected_version = "${config.nodes.machine.services.chhoto-url.package.version}"

     

       45
       45
       +
           assert resp["version"] == expected_version

     

       46
       46
       +
       

     

       47
       47
       +
           resp = json.loads(machine.succeed("curl -H 'X-API-Key: api_key' localhost:8000/api/new -d '{\"longlink\": \"https://nixos.org/\"}'"))

     

       48
       48
       +
           assert resp["success"] is True

     

       49
       49
       +
           assert (match := re.match(r"^http://localhost:8000/(.+)$", resp["shorturl"]))

     

       50
       50
       +
           slug = match[1]

     

       51
       51
       +
       

     

       52
       52
       +
           resp = machine.succeed(f"curl -i {resp["shorturl"]}")

     

       53
       53
       +
           assert (match := re.search(r"(?m)^location: (.+?)\r?$", resp))

     

       54
       54
       +
           assert match[1] == "https://nixos.org/"

     

       55
       55
       +
       

     

       56
       56
       +
           resp = json.loads(machine.succeed(f"curl -H 'X-API-Key: api_key' localhost:8000/api/expand -d '{slug}'"))

     

       57
       57
       +
           assert resp["success"] is True

     

       58
       58
       +
           assert resp["hits"] == 1

     

       59
       59
       +
         '';

     

       60
       60
       +
       }

+47

pkgs/by-name/ch/chhoto-url/package.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         rustPlatform,

     

       4
       4
       +
         fetchFromGitHub,

     

       5
       5
       +
         nixosTests,

     

       6
       6
       +
         nix-update-script,

     

       7
       7
       +
       }:

     

       8
       8
       +
       

     

       9
       9
       +
       rustPlatform.buildRustPackage (finalAttrs: {

     

       10
       10
       +
         pname = "chhoto-url";

     

       11
       11
       +
         version = "6.2.8";

     

       12
       12
       +
       

     

       13
       13
       +
         src = fetchFromGitHub {

     

       14
       14
       +
           owner = "SinTan1729";

     

       15
       15
       +
           repo = "chhoto-url";

     

       16
       16
       +
           tag = finalAttrs.version;

     

       17
       17
       +
           hash = "sha256-aWiLfhNbtjsM7fEqoNIKsU12/3b8ORTpZ/4jyqSLmdM=";

     

       18
       18
       +
         };

     

       19
       19
       +
       

     

       20
       20
       +
         sourceRoot = "${finalAttrs.src.name}/actix";

     

       21
       21
       +
       

     

       22
       22
       +
         postPatch = ''

     

       23
       23
       +
           substituteInPlace src/{main.rs,services.rs} \

     

       24
       24
       +
             --replace-fail "./resources/" "${placeholder "out"}/share/chhoto-url/resources/"

     

       25
       25
       +
         '';

     

       26
       26
       +
       

     

       27
       27
       +
         cargoHash = "sha256-rKNGUl1TI21SOBwTuv/TGl46S8FVjCWunJwP5PLdx6g=";

     

       28
       28
       +
       

     

       29
       29
       +
         postInstall = ''

     

       30
       30
       +
           mkdir -p $out/share/chhoto-url

     

       31
       31
       +
           cp -r ${finalAttrs.src}/resources $out/share/chhoto-url/resources

     

       32
       32
       +
         '';

     

       33
       33
       +
       

     

       34
       34
       +
         passthru = {

     

       35
       35
       +
           tests = { inherit (nixosTests) chhoto-url; };

     

       36
       36
       +
           updateScript = nix-update-script { };

     

       37
       37
       +
         };

     

       38
       38
       +
       

     

       39
       39
       +
         meta = {

     

       40
       40
       +
           description = "Simple, blazingly fast, selfhosted URL shortener with no unnecessary features";

     

       41
       41
       +
           homepage = "https://github.com/SinTan1729/chhoto-url";

     

       42
       42
       +
           changelog = "https://github.com/SinTan1729/chhoto-url/releases/tag/${finalAttrs.version}";

     

       43
       43
       +
           license = lib.licenses.mit;

     

       44
       44
       +
           maintainers = with lib.maintainers; [ defelo ];

     

       45
       45
       +
           mainProgram = "chhoto-url";

     

       46
       46
       +
         };

     

       47
       47
       +
       })