commit 316b4b6fb53f8cd1c2ba016b309c454a07b73fd0 · pyrox.dev/nixpkgs

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

···

       142
       142
        
       

     

       143
       143
        
       - [nvme-rs](https://github.com/liberodark/nvme-rs), NVMe monitoring [services.nvme-rs](#opt-services.nvme-rs.enable).

     

       144
       144
        
       

     

       145
       145
       +
       - [ringboard](https://github.com/SUPERCILEX/clipboard-history), a fast, efficient, and composable clipboard manager for Linux. Available for x11 as [services.ringboard](#opt-services.ringboard.x11.enable) and for wayland as [services.ringboard](#opt-services.ringboard.wayland.enable).

     

       146
       146
       +
       

     

       145
       147
        
       ## Backward Incompatibilities {#sec-release-25.11-incompatibilities}

     

       146
       148
        
       

     

       147
       149
        
       <!-- To avoid merge conflicts, consider adding your item at an arbitrary place in the list instead. -->

nixos/modules/module-list.nix

···

       915
       915
        
         ./services/misc/redlib.nix

     

       916
       916
        
         ./services/misc/redmine.nix

     

       917
       917
        
         ./services/misc/renovate.nix

     

       918
       918
       +
         ./services/misc/ringboard.nix

     

       918
       919
        
         ./services/misc/rkvm.nix

     

       919
       920
        
         ./services/misc/rmfakecloud.nix

     

       920
       921
        
         ./services/misc/rshim.nix

+78

nixos/modules/services/misc/ringboard.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         lib,

     

       4
       4
       +
         pkgs,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         cfg = config.services.ringboard;

     

       9
       9
       +
       in

     

       10
       10
       +
       {

     

       11
       11
       +
         options.services.ringboard = {

     

       12
       12
       +
           x11.enable = lib.mkEnableOption "X11 support for Ringboard";

     

       13
       13
       +
           wayland.enable = lib.mkEnableOption "Wayland support for Ringboard";

     

       14
       14
       +
           x11.package = lib.mkPackageOption pkgs "ringboard" { };

     

       15
       15
       +
           wayland.package = lib.mkPackageOption pkgs "ringboard-wayland" { };

     

       16
       16
       +
         };

     

       17
       17
       +
       

     

       18
       18
       +
         config = lib.mkIf (cfg.x11.enable || cfg.wayland.enable) {

     

       19
       19
       +
           systemd.user.services.ringboard-server = {

     

       20
       20
       +
             description = "Ringboard server";

     

       21
       21
       +
             documentation = [ "https://github.com/SUPERCILEX/clipboard-history" ];

     

       22
       22
       +
             after = [ "multi-user.target" ];

     

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

     

       24
       24
       +
             serviceConfig = {

     

       25
       25
       +
               Type = "notify";

     

       26
       26
       +
               Environment = "RUST_LOG=trace";

     

       27
       27
       +
               ExecStart = "${

     

       28
       28
       +
                 if cfg.x11.enable then cfg.x11.package else cfg.wayland.package

     

       29
       29
       +
               }/bin/ringboard-server";

     

       30
       30
       +
               Restart = "on-failure";

     

       31
       31
       +
               Slice = "session-ringboard.slice";

     

       32
       32
       +
             };

     

       33
       33
       +
           };

     

       34
       34
       +
       

     

       35
       35
       +
           systemd.user.services.ringboard-listener = {

     

       36
       36
       +
             description = "Ringboard clipboard listener";

     

       37
       37
       +
             documentation = [ "https://github.com/SUPERCILEX/clipboard-history" ];

     

       38
       38
       +
             requires = [ "ringboard-server.service" ];

     

       39
       39
       +
             after = [

     

       40
       40
       +
               "ringboard-server.service"

     

       41
       41
       +
               "graphical-session.target"

     

       42
       42
       +
             ];

     

       43
       43
       +
             bindsTo = [ "graphical-session.target" ];

     

       44
       44
       +
             wantedBy = [ "graphical-session.target" ];

     

       45
       45
       +
             script =

     

       46
       46
       +
               if cfg.x11.enable && cfg.wayland.enable then

     

       47
       47
       +
                 ''

     

       48
       48
       +
                   if [ "$XDG_SESSION_TYPE" = "wayland" ]; then

     

       49
       49
       +
                     exec '${cfg.wayland.package}'/bin/ringboard-wayland

     

       50
       50
       +
                   else

     

       51
       51
       +
                     exec '${cfg.x11.package}'/bin/ringboard-x11

     

       52
       52
       +
                   fi

     

       53
       53
       +
                 ''

     

       54
       54
       +
               else if cfg.wayland.enable then

     

       55
       55
       +
                 ''

     

       56
       56
       +
                   exec '${cfg.wayland.package}'/bin/ringboard-wayland

     

       57
       57
       +
                 ''

     

       58
       58
       +
               else

     

       59
       59
       +
                 ''

     

       60
       60
       +
                   exec '${cfg.x11.package}'/bin/ringboard-x11

     

       61
       61
       +
                 '';

     

       62
       62
       +
             serviceConfig = {

     

       63
       63
       +
               Type = "exec";

     

       64
       64
       +
               Restart = "on-failure";

     

       65
       65
       +
               Slice = "session-ringboard.slice";

     

       66
       66
       +
             };

     

       67
       67
       +
             environment.RUST_LOG = "trace";

     

       68
       68
       +
           };

     

       69
       69
       +
       

     

       70
       70
       +
           systemd.user.slices.session-ringboard = {

     

       71
       71
       +
             description = "Ringboard clipboard services";

     

       72
       72
       +
           };

     

       73
       73
       +
       

     

       74
       74
       +
           environment.systemPackages =

     

       75
       75
       +
             lib.optionals cfg.x11.enable [ cfg.x11.package ]

     

       76
       76
       +
             ++ lib.optionals cfg.wayland.enable [ cfg.wayland.package ];

     

       77
       77
       +
         };

     

       78
       78
       +
       }

nixos/tests/all-tests.nix

···

       1300
       1300
        
         restic = runTest ./restic.nix;

     

       1301
       1301
        
         restic-rest-server = runTest ./restic-rest-server.nix;

     

       1302
       1302
        
         retroarch = runTest ./retroarch.nix;

     

       1303
       1303
       +
         ringboard = runTest ./ringboard.nix;

     

       1303
       1304
        
         rke2 = handleTestOn [ "aarch64-linux" "x86_64-linux" ] ./rke2 { };

     

       1304
       1305
        
         rkvm = handleTest ./rkvm { };

     

       1305
       1306
        
         rmfakecloud = runTest ./rmfakecloud.nix;

+49

nixos/tests/ringboard.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         pkgs,

     

       4
       4
       +
         lib,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       {

     

       8
       8
       +
         name = "ringboard";

     

       9
       9
       +
         meta = { inherit (pkgs.ringboard.meta) maintainers; };

     

       10
       10
       +
       

     

       11
       11
       +
         nodes.machine = {

     

       12
       12
       +
           imports = [

     

       13
       13
       +
             ./common/user-account.nix

     

       14
       14
       +
             ./common/x11.nix

     

       15
       15
       +
           ];

     

       16
       16
       +
       

     

       17
       17
       +
           test-support.displayManager.auto.user = "alice";

     

       18
       18
       +
       

     

       19
       19
       +
           services.xserver.displayManager.sessionCommands = ''

     

       20
       20
       +
             '${lib.getExe pkgs.gedit}' &

     

       21
       21
       +
           '';

     

       22
       22
       +
       

     

       23
       23
       +
           services.ringboard.x11.enable = true;

     

       24
       24
       +
         };

     

       25
       25
       +
       

     

       26
       26
       +
         testScript =

     

       27
       27
       +
           { nodes, ... }:

     

       28
       28
       +
           let

     

       29
       29
       +
             inherit (nodes.machine.test-support.displayManager.auto) user;

     

       30
       30
       +
           in

     

       31
       31
       +
           ''

     

       32
       32
       +
             @polling_condition

     

       33
       33
       +
             def gedit_running():

     

       34
       34
       +
               machine.succeed("pgrep gedit")

     

       35
       35
       +
       

     

       36
       36
       +
             with subtest("Wait for service startup"):

     

       37
       37
       +
               machine.wait_for_unit("graphical.target")

     

       38
       38
       +
               machine.wait_for_unit("ringboard-server.service", "${user}")

     

       39
       39
       +
               machine.wait_for_unit("ringboard-listener.service", "${user}")

     

       40
       40
       +
       

     

       41
       41
       +
             with subtest("Ensure clipboard is monitored"):

     

       42
       42
       +
               with gedit_running: # type: ignore[union-attr]

     

       43
       43
       +
                 machine.send_chars("Hello world!")

     

       44
       44
       +
                 machine.send_key("ctrl-a")

     

       45
       45
       +
                 machine.send_key("ctrl-c")

     

       46
       46
       +
                 machine.wait_for_console_text("Small selection transfer complete")

     

       47
       47
       +
                 machine.succeed("su - '${user}' -c 'ringboard search Hello | grep world!'")

     

       48
       48
       +
           '';

     

       49
       49
       +
       }

+109

pkgs/by-name/ri/ringboard/package.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         stdenv,

     

       3
       3
       +
         rustPlatform,

     

       4
       4
       +
         fetchFromGitHub,

     

       5
       5
       +
         lib,

     

       6
       6
       +
         libxkbcommon,

     

       7
       7
       +
         libGL,

     

       8
       8
       +
         wayland,

     

       9
       9
       +
         xorg,

     

       10
       10
       +
         makeWrapper,

     

       11
       11
       +
         displayServer ? "x11",

     

       12
       12
       +
         nixosTests,

     

       13
       13
       +
       }:

     

       14
       14
       +
       

     

       15
       15
       +
       assert lib.assertOneOf "displayServer" displayServer [

     

       16
       16
       +
         "x11"

     

       17
       17
       +
         "wayland"

     

       18
       18
       +
       ];

     

       19
       19
       +
       

     

       20
       20
       +
       rustPlatform.buildRustPackage (finalAttrs: {

     

       21
       21
       +
         pname = "ringboard" + lib.optionalString (displayServer == "wayland") "-wayland";

     

       22
       22
       +
       

     

       23
       23
       +
         # release version needs nightly, so we use a custom tree, see:

     

       24
       24
       +
         # https://github.com/SUPERCILEX/clipboard-history/issues/22#issuecomment-3322075172

     

       25
       25
       +
         version = "0.12.2-unstable-2025-09-23";

     

       26
       26
       +
       

     

       27
       27
       +
         src = fetchFromGitHub {

     

       28
       28
       +
           owner = "SUPERCILEX";

     

       29
       29
       +
           repo = "clipboard-history";

     

       30
       30
       +
           rev = "228a39dd8a9aece0bb06f68ad44906b297270628";

     

       31
       31
       +
           hash = "sha256-qA7wwvWnnZHN9edkmubEo37F+peU0LQGo/Zl8FpywuE=";

     

       32
       32
       +
         };

     

       33
       33
       +
       

     

       34
       34
       +
         cargoHash = "sha256-MFfuUu/hpb6Uaqe21bvXNKRyJazAL5m+Vw/vAeeDYEk=";

     

       35
       35
       +
       

     

       36
       36
       +
         nativeBuildInputs = [

     

       37
       37
       +
           makeWrapper

     

       38
       38
       +
         ];

     

       39
       39
       +
       

     

       40
       40
       +
         buildInputs = [

     

       41
       41
       +
           libxkbcommon

     

       42
       42
       +
           libGL

     

       43
       43
       +
         ]

     

       44
       44
       +
         ++ lib.optionals (displayServer == "x11") [

     

       45
       45
       +
           xorg.libXcursor

     

       46
       46
       +
           xorg.libXrandr

     

       47
       47
       +
           xorg.libXi

     

       48
       48
       +
           xorg.libX11

     

       49
       49
       +
         ]

     

       50
       50
       +
         ++ lib.optionals (displayServer == "wayland") [

     

       51
       51
       +
           wayland

     

       52
       52
       +
         ];

     

       53
       53
       +
       

     

       54
       54
       +
         buildPhase = ''

     

       55
       55
       +
           runHook preBuild

     

       56
       56
       +
       

     

       57
       57
       +
           local flagsArray=("-j $NIX_BUILD_CORES --target ${stdenv.hostPlatform.rust.rustcTarget} --offline --release");

     

       58
       58
       +
           concatTo flagsArray cargoBuildFlags;

     

       59
       59
       +
       

     

       60
       60
       +
           echo "Building package: clipboard-history-server"

     

       61
       61
       +
           cargo build $flagsArray --package clipboard-history-server --no-default-features --features systemd

     

       62
       62
       +
           ${lib.optionalString (displayServer == "x11") ''

     

       63
       63
       +
             echo "Building package: clipboard-history-x11"

     

       64
       64
       +
             cargo build $flagsArray --package clipboard-history-x11 --no-default-features

     

       65
       65
       +
           ''}

     

       66
       66
       +
           ${lib.optionalString (displayServer == "wayland") ''

     

       67
       67
       +
             echo "Building package: clipboard-history-wayland"

     

       68
       68
       +
             cargo build $flagsArray --package clipboard-history-wayland --no-default-features

     

       69
       69
       +
           ''}

     

       70
       70
       +
           echo "Building package: clipboard-history"

     

       71
       71
       +
           cargo build $flagsArray --package clipboard-history

     

       72
       72
       +
           echo "Building package: clipboard-history-tui"

     

       73
       73
       +
           cargo build $flagsArray --package clipboard-history-tui

     

       74
       74
       +
           echo "Building package: clipboard-history-egui"

     

       75
       75
       +
           cargo build $flagsArray --package clipboard-history-egui --no-default-features --features ${displayServer}

     

       76
       76
       +
       

     

       77
       77
       +
           runHook postBuild

     

       78
       78
       +
         '';

     

       79
       79
       +
       

     

       80
       80
       +
         # check needs nightly, see:

     

       81
       81
       +
         # https://github.com/SUPERCILEX/clipboard-history/issues/22#issuecomment-3322330559

     

       82
       82
       +
         doCheck = false;

     

       83
       83
       +
       

     

       84
       84
       +
         postInstall = ''

     

       85
       85
       +
           # Wrap the program in a script that sets the LD_LIBRARY_PATH environment variable

     

       86
       86
       +
           # so that it can find the shared libraries it depends on. This is currently a

     

       87
       87
       +
           # requirement for running Rust programs that depend on `egui` within a Nix environment.

     

       88
       88
       +
           # https://github.com/emilk/egui/issues/2486

     

       89
       89
       +
           wrapProgram  $out/bin/ringboard-egui --prefix LD_LIBRARY_PATH : "${lib.makeLibraryPath finalAttrs.buildInputs}"

     

       90
       90
       +
           install -m 444 -D egui/ringboard-egui.desktop $out/share/applications/ringboard-egui.desktop

     

       91
       91
       +
           install -Dm644 logo.jpeg $out/share/icons/hicolor/1024x1024/ringboard.jpeg

     

       92
       92
       +
           # Initializing a GUI can be quite slow, so GUI clients make their windows invisible when closed rather than completely quitting.

     

       93
       93
       +
           # To reopen the window, a special file can be deleted which wakes the GUI via inotify.

     

       94
       94
       +
           # If, instead, a new instance of the GUI is opened, this special file is used to first check for a previously running instance of the GUI and kill it if it exists.

     

       95
       95
       +
           # https://alexsaveau.dev/blog/projects/performance/clipboard/ringboard/ringboard#gui-startup-latency-and-long-lived-client-windows

     

       96
       96
       +
           sed -i "s|Exec=ringboard-egui|Exec=$(echo /bin/sh -c \"ps -p \`cat /tmp/.ringboard/\$USER.egui-sleep 2\> /dev/null\` \> /dev/null 2\>\\\&1 \\\&\\\& exec rm -f /tmp/.ringboard/\$USER.egui-sleep \\\|\\\| exec $out/bin/ringboard-egui\")|g" $out/share/applications/ringboard-egui.desktop

     

       97
       97
       +
           sed -i "s|Icon=ringboard|Icon=$out/share/icons/hicolor/1024x1024/ringboard.jpeg|g" $out/share/applications/ringboard-egui.desktop

     

       98
       98
       +
         '';

     

       99
       99
       +
       

     

       100
       100
       +
         passthru.tests.nixos = nixosTests.ringboard;

     

       101
       101
       +
       

     

       102
       102
       +
         meta = {

     

       103
       103
       +
           description = "Fast, efficient, and composable clipboard manager for Linux";

     

       104
       104
       +
           homepage = "https://github.com/SUPERCILEX/clipboard-history";

     

       105
       105
       +
           license = lib.licenses.asl20;

     

       106
       106
       +
           platforms = lib.platforms.linux;

     

       107
       107
       +
           maintainers = [ lib.maintainers.magnetophon ];

     

       108
       108
       +
         };

     

       109
       109
       +
       })

pkgs/top-level/all-packages.nix

···

       12612
       12612
        
       

     

       12613
       12613
        
         rgp = libsForQt5.callPackage ../development/tools/rgp { };

     

       12614
       12614
        
       

     

       12615
       12615
       +
         ringboard-wayland = callPackage ../by-name/ri/ringboard/package.nix { displayServer = "wayland"; };

     

       12616
       12616
       +
       

     

       12615
       12617
        
         ripcord =

     

       12616
       12618
        
           if stdenv.hostPlatform.isLinux then

     

       12617
       12619
        
             qt5.callPackage ../applications/networking/instant-messengers/ripcord { }