powerful but friendly backup program that runs in your tray, powered by restic
devins.page/restray
go
restic
system-tray
feat: nix module config + hm
also migrated "general" config section to "gui" and deprecated "general". i think it makes more sense since the general settings were not used by daemon at all
+287
-47
+3
-1
README.md
+3
-1
README.md
···
48
48
49
49
## Configuration
50
50
51
-
### `[general]`
51
+
### `[gui]`
52
+
53
+
GUI-only settings, ignored by `restray daemon`.
52
54
53
55
| Key | Type | Default | Description |
54
56
| ------------------ | ------ | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+13
-5
cmd/restray/config.go
+13
-5
cmd/restray/config.go
···
63
63
Mount Mount `toml:"mount"`
64
64
}
65
65
66
-
type General struct {
66
+
type GUI struct {
67
67
CheckUpdates *bool `toml:"check_updates"`
68
68
ManageRestic bool `toml:"manage_restic"`
69
69
Notifications string `toml:"notifications"`
···
71
71
Terminal string `toml:"terminal"`
72
72
}
73
73
74
-
func (g General) UpdatesEnabled() bool {
74
+
func (g GUI) UpdatesEnabled() bool {
75
75
return g.CheckUpdates == nil || *g.CheckUpdates
76
76
}
77
77
78
78
type Config struct {
79
-
General General `toml:"general"`
79
+
GUI GUI `toml:"gui"`
80
+
General GUI `toml:"general"` // deprecated, use [gui]
80
81
Profiles []Profile `toml:"profiles"`
81
82
Profile []Profile `toml:"profile"`
82
83
}
···
214
215
cfg.Profiles = append(cfg.Profiles, cfg.Profile...)
215
216
cfg.Profile = nil
216
217
}
217
-
if cfg.General.ScheduleDisplay == "" {
218
-
cfg.General.ScheduleDisplay = "description"
218
+
if cfg.General != (GUI{}) {
219
+
log.Printf("config: [general] is deprecated, use [gui] instead")
220
+
if cfg.GUI == (GUI{}) {
221
+
cfg.GUI = cfg.General
222
+
}
223
+
cfg.General = GUI{}
224
+
}
225
+
if cfg.GUI.ScheduleDisplay == "" {
226
+
cfg.GUI.ScheduleDisplay = "description"
219
227
}
220
228
if len(cfg.Profiles) == 0 {
221
229
cfg.Profiles = append(cfg.Profiles, Profile{Name: "default"})
+1
-1
cmd/restray/templates/config.toml
+1
-1
cmd/restray/templates/config.toml
+7
-7
cmd/restray/tray.go
+7
-7
cmd/restray/tray.go
···
295
295
return prefix + "Paused (battery)"
296
296
}
297
297
next := formatNextFor(sched, eids)
298
-
display := cfg.General.ScheduleDisplay
298
+
display := cfg.GUI.ScheduleDisplay
299
299
switch display {
300
300
case "none", "hidden":
301
301
if next != "" {
···
427
427
}
428
428
cfg := loadConfig()
429
429
state.mu.Lock()
430
-
state.notifications = strings.ToLower(cfg.General.Notifications)
430
+
state.notifications = strings.ToLower(cfg.GUI.Notifications)
431
431
state.mu.Unlock()
432
432
sched.Stop()
433
433
sched = cron.New()
···
439
439
440
440
resticPath, managed := findRestic()
441
441
442
-
if resticPath == "" && selfManagesRestic && cfg.General.ManageRestic {
442
+
if resticPath == "" && selfManagesRestic && cfg.GUI.ManageRestic {
443
443
mGlobalStatus.SetTitle("Downloading restic...")
444
444
mGlobalStatus.Show()
445
445
go doDownload()
···
548
548
applyProfileUI(cfg)
549
549
550
550
if managed {
551
-
go checkResticUpdate(resticPath, cfg.General.ManageRestic, mUpdate, mGlobalStatus, applyConfig)
551
+
go checkResticUpdate(resticPath, cfg.GUI.ManageRestic, mUpdate, mGlobalStatus, applyConfig)
552
552
}
553
553
}
554
554
···
568
568
resticPath, managed := findRestic()
569
569
if managed && !isAnyBusy() {
570
570
cfg := loadConfig()
571
-
checkResticUpdate(resticPath, cfg.General.ManageRestic, mUpdate, mGlobalStatus, applyConfig)
571
+
checkResticUpdate(resticPath, cfg.GUI.ManageRestic, mUpdate, mGlobalStatus, applyConfig)
572
572
}
573
573
}
574
574
}()
···
669
669
}
670
670
case <-mConsole.ClickedCh:
671
671
cfg := loadConfig()
672
-
openConsole(selectedProfile(), len(cfg.Profiles), cfg.General.Terminal, "")
672
+
openConsole(selectedProfile(), len(cfg.Profiles), cfg.GUI.Terminal, "")
673
673
case <-mPreHook.ClickedCh:
674
674
prof := selectedProfile()
675
675
if prof.PreHook != "" {
···
726
726
}
727
727
case <-mLog.ClickedCh:
728
728
cfg := loadConfig()
729
-
openConsole(selectedProfile(), len(cfg.Profiles), cfg.General.Terminal, logPath())
729
+
openConsole(selectedProfile(), len(cfg.Profiles), cfg.GUI.Terminal, logPath())
730
730
case <-mFolder.ClickedCh:
731
731
openFile(configDir())
732
732
case <-mAbout.ClickedCh:
+3
-33
flake.nix
+3
-33
flake.nix
···
11
11
nixpkgs,
12
12
flake-utils,
13
13
}: let
14
-
# ./packaging/linux/restray.service
15
-
nixosModules.default = {
16
-
config,
17
-
lib,
18
-
pkgs,
19
-
...
20
-
}: let
21
-
cfg = config.services.restray;
22
-
in {
23
-
options.services.restray = {
24
-
enable = lib.mkEnableOption "Restray backup scheduler daemon";
25
-
package = lib.mkPackageOption self.packages.${pkgs.system} "default" {};
26
-
};
27
-
28
-
config = lib.mkIf cfg.enable {
29
-
systemd.services.restray = {
30
-
description = "Restray backup scheduler daemon";
31
-
wantedBy = ["multi-user.target"];
32
-
serviceConfig = {
33
-
Type = "simple";
34
-
ExecStart = "${lib.getExe cfg.package} daemon";
35
-
ExecReload = "${pkgs.coreutils}/bin/kill -HUP $MAINPID";
36
-
Restart = "on-failure";
37
-
StateDirectory = "restray";
38
-
Environment = [
39
-
"RESTRAY_CONFIG=/etc/restray"
40
-
"RESTRAY_STATE=/var/lib/restray"
41
-
];
42
-
};
43
-
};
44
-
};
45
-
};
14
+
nixosModules.default = import ./nix/nixos-module.nix self;
15
+
homeManagerModules.default = import ./nix/hm-module.nix self;
46
16
in
47
17
{
48
-
inherit nixosModules;
18
+
inherit nixosModules homeManagerModules;
49
19
}
50
20
// flake-utils.lib.eachDefaultSystem (system: let
51
21
pkgs = nixpkgs.legacyPackages.${system};
+69
nix/hm-module.nix
+69
nix/hm-module.nix
···
1
+
self: {
2
+
config,
3
+
lib,
4
+
pkgs,
5
+
...
6
+
}: let
7
+
cfg = config.programs.restray;
8
+
daemon = config.services.restray;
9
+
shared = import ./shared.nix {inherit lib pkgs;};
10
+
in {
11
+
options.programs.restray = {
12
+
enable = lib.mkEnableOption "Restray backup scheduler";
13
+
package = lib.mkPackageOption self.packages.${pkgs.system} "default" {};
14
+
15
+
profiles = lib.mkOption {
16
+
type = lib.types.attrsOf (lib.types.submodule shared.profileOpts);
17
+
default = {};
18
+
description = "Restray backup profiles.";
19
+
};
20
+
};
21
+
22
+
options.services.restray.enable = lib.mkEnableOption "Restray backup scheduler daemon";
23
+
24
+
config = lib.mkMerge [
25
+
(lib.mkIf daemon.enable {
26
+
programs.restray.enable = lib.mkDefault true;
27
+
})
28
+
29
+
(lib.mkIf cfg.enable {
30
+
home.packages = [cfg.package];
31
+
xdg.configFile."restray/config.toml".source = shared.configFile cfg.profiles;
32
+
})
33
+
34
+
(lib.mkIf (daemon.enable && cfg.enable) {
35
+
assertions = [
36
+
{
37
+
assertion = cfg.profiles != {};
38
+
message = "services.restray.enable requires at least one programs.restray.profiles.<name> to be configured.";
39
+
}
40
+
];
41
+
})
42
+
43
+
(lib.mkIf (daemon.enable && cfg.enable && pkgs.stdenv.isLinux) {
44
+
systemd.user.services.restray = {
45
+
Unit.Description = "Restray backup scheduler daemon";
46
+
Install.WantedBy = ["default.target"];
47
+
Service = {
48
+
Type = "simple";
49
+
ExecStart = "${lib.getExe cfg.package} daemon";
50
+
ExecReload = "${pkgs.coreutils}/bin/kill -HUP $MAINPID";
51
+
Restart = "on-failure";
52
+
};
53
+
};
54
+
})
55
+
56
+
(lib.mkIf (daemon.enable && cfg.enable && pkgs.stdenv.isDarwin) {
57
+
launchd.agents.restray = {
58
+
enable = true;
59
+
config = {
60
+
ProgramArguments = ["${lib.getExe cfg.package}" "daemon"];
61
+
KeepAlive = true;
62
+
RunAtLoad = true;
63
+
StandardErrorPath = "${config.home.homeDirectory}/Library/Logs/restray.daemon.log";
64
+
StandardOutPath = "${config.home.homeDirectory}/Library/Logs/restray.daemon.log";
65
+
};
66
+
};
67
+
})
68
+
];
69
+
}
+47
nix/nixos-module.nix
+47
nix/nixos-module.nix
···
1
+
self: {
2
+
config,
3
+
lib,
4
+
pkgs,
5
+
...
6
+
}: let
7
+
cfg = config.services.restray;
8
+
shared = import ./shared.nix {inherit lib pkgs;};
9
+
in {
10
+
options.services.restray = {
11
+
enable = lib.mkEnableOption "Restray backup scheduler daemon";
12
+
package = lib.mkPackageOption self.packages.${pkgs.system} "default" {};
13
+
14
+
profiles = lib.mkOption {
15
+
type = lib.types.attrsOf (lib.types.submodule shared.profileOpts);
16
+
default = {};
17
+
description = "Restray backup profiles.";
18
+
};
19
+
};
20
+
21
+
config = lib.mkIf cfg.enable {
22
+
assertions = [
23
+
{
24
+
assertion = cfg.profiles != {};
25
+
message = "services.restray.enable requires at least one services.restray.profiles.<name> to be configured.";
26
+
}
27
+
];
28
+
29
+
systemd.services.restray = {
30
+
description = "Restray backup scheduler daemon";
31
+
wantedBy = ["multi-user.target"];
32
+
serviceConfig = {
33
+
Type = "simple";
34
+
ExecStart = "${lib.getExe cfg.package} daemon";
35
+
ExecReload = "${pkgs.coreutils}/bin/kill -HUP $MAINPID";
36
+
Restart = "on-failure";
37
+
StateDirectory = "restray";
38
+
Environment = [
39
+
"RESTRAY_CONFIG=/etc/restray"
40
+
"RESTRAY_STATE=/var/lib/restray"
41
+
];
42
+
};
43
+
};
44
+
45
+
environment.etc."restray/config.toml".source = shared.configFile cfg.profiles;
46
+
};
47
+
}