From 561c0c28519c7b378078d5ee510c6727fb310d28 Mon Sep 17 00:00:00 2001 From: midchildan Date: Mon, 14 Feb 2022 00:49:15 +0900 Subject: nixos/rl-2205: add entries for EPGStation v2 --- .../from_md/release-notes/rl-2205.section.xml | 53 ++++++++++++++++++++++ nixos/doc/manual/release-notes/rl-2205.section.md | 24 ++++++++++ .../modules/services/video/epgstation/default.nix | 8 ++-- 3 files changed, 81 insertions(+), 4 deletions(-) diff --git a/nixos/doc/manual/from_md/release-notes/rl-2205.section.xml b/nixos/doc/manual/from_md/release-notes/rl-2205.section.xml index 9cf27e56827..b4b31ad4b66 100644 --- a/nixos/doc/manual/from_md/release-notes/rl-2205.section.xml +++ b/nixos/doc/manual/from_md/release-notes/rl-2205.section.xml @@ -826,6 +826,59 @@ include serif fonts. + + + pkgs.epgstation has been upgraded from v1 + to v2, resulting in incompatible changes in the database + scheme and configuration format. + + + + + Some top-level settings under + services.epgstation + is now deprecated because it was redudant due to the same + options being present in + services.epgstation.settings. + + + + + The option + services.epgstation.basicAuth + was removed because basic authentication support was dropped + by upstream. + + + + + The option + services.epgstation.database.passwordFile + no longer has a default value. Make sure to set this option + explicitly before upgrading. Change the database password if + necessary. + + + + + The + services.epgstation.settings + option now expects options for config.yml + in EPGStation v2. + + + + + Existing data for the + services.epgstation + module would have to be backed up prior to the upgrade. To + back up exising data to + /tmp/epgstation.bak, run + sudo -u epgstation epgstation run backup /tmp/epgstation.bak. + To import that data after to the upgrade, run + sudo -u epgstation epgstation run v1migrate /tmp/epgstation.bak + + switch-to-configuration (the script that is diff --git a/nixos/doc/manual/release-notes/rl-2205.section.md b/nixos/doc/manual/release-notes/rl-2205.section.md index 58a1b23d17b..1c4a8735277 100644 --- a/nixos/doc/manual/release-notes/rl-2205.section.md +++ b/nixos/doc/manual/release-notes/rl-2205.section.md @@ -321,6 +321,30 @@ In addition to numerous new and upgraded packages, this release has the followin `pkgs.noto-fonts-cjk` is currently an alias of `pkgs.noto-fonts-cjk-sans` and doesn't include serif fonts. +- `pkgs.epgstation` has been upgraded from v1 to v2, resulting in incompatible + changes in the database scheme and configuration format. + +- Some top-level settings under [services.epgstation](#opt-services.epgstation) + is now deprecated because it was redudant due to the same options being + present in [services.epgstation.settings](#opt-services.epgstation.settings). + +- The option [services.epgstation.basicAuth](#opt-services.epgstation.basicAuth) + was removed because basic authentication support was dropped by upstream. + +- The option [services.epgstation.database.passwordFile](#opt-services.epgstation.database.passwordFile) + no longer has a default value. Make sure to set this option explicitly before + upgrading. Change the database password if necessary. + +- The [services.epgstation.settings](#opt-services.epgstation.settings) + option now expects options for `config.yml` in EPGStation v2. + +- Existing data for the [services.epgstation](#opt-services.epgstation.enable) + module would have to be backed up prior to the upgrade. To back up exising + data to `/tmp/epgstation.bak`, run + `sudo -u epgstation epgstation run backup /tmp/epgstation.bak`. + To import that data after to the upgrade, run + `sudo -u epgstation epgstation run v1migrate /tmp/epgstation.bak` + - `switch-to-configuration` (the script that is run when running `nixos-rebuild switch` for example) has been reworked * The interface that allows activation scripts to restart units has been streamlined. Restarting and reloading is now done by a single file `/run/nixos/activation-restart-list` that honors `restartIfChanged` and `reloadIfChanged` of the units. * Preferring to reload instead of restarting can still be achieved using `/run/nixos/activation-reload-list`. diff --git a/nixos/modules/services/video/epgstation/default.nix b/nixos/modules/services/video/epgstation/default.nix index 71428a00e4d..191f6eb52e5 100644 --- a/nixos/modules/services/video/epgstation/default.nix +++ b/nixos/modules/services/video/epgstation/default.nix @@ -171,20 +171,20 @@ in options.socketioPort = lib.mkOption { type = lib.types.port; default = cfg.settings.port + 1; - defaultText = lib.literalExpression "config.${opt.settings.port} + 1"; + defaultText = lib.literalExpression "config.${opt.settings}.port + 1"; description = '' Socket.io port for EPGStation to listen on. It is valid to share - ports with . + ports with . ''; }; options.clientSocketioPort = lib.mkOption { type = lib.types.port; default = cfg.settings.socketioPort; - defaultText = lib.literalExpression "config.${opt.settings.socketioPort}"; + defaultText = lib.literalExpression "config.${opt.settings}.socketioPort"; description = '' Socket.io port that the web client is going to connect to. This may - be different from if + be different from if EPGStation is hidden behind a reverse proxy. ''; }; -- cgit 1.4.1