Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 136b8b43c0 | |||
| d8bceae6e8 | |||
| 8c49a0a326 | |||
| 2788c9641f |
@@ -0,0 +1,269 @@
|
|||||||
|
# ntfy Notification Module Implementation Plan
|
||||||
|
|
||||||
|
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||||
|
|
||||||
|
**Goal:** Add a `my.profiles.ntfy` NixOS module that runs an auth-required self-hosted ntfy server on jupiter, exposes a homepage tile, and wires a Home Assistant `rest_command` for publishing notifications.
|
||||||
|
|
||||||
|
**Architecture:** A single profile module under `modules/environments/ntfy/`, following the repo's `my.profiles.<name>` pattern. It configures `services.ntfy-sh` with `auth-default-access = deny-all`, opens the firewall, registers a homepage tile, and — when the home-assistant profile is enabled — merges a `rest_command.ntfy_send` into `services.home-assistant.config`. No secrets touch the Nix store; credentials are provisioned manually by the operator, and the only secret lives in HA's `secrets.yaml`.
|
||||||
|
|
||||||
|
**Tech Stack:** Nix (flake-parts NixOS config), nixpkgs `services.ntfy-sh`, `services.home-assistant`, nixfmt-rfc-style.
|
||||||
|
|
||||||
|
## Global Constraints
|
||||||
|
|
||||||
|
- Follow the profile pattern exactly: `let cfg = config.my.profiles.<name>; in { options.my.profiles.<name>.enable = lib.mkEnableOption "..."; config = lib.mkIf cfg.enable { ... }; }`.
|
||||||
|
- Namespace is `my.profiles.ntfy`.
|
||||||
|
- Homepage self-registration uses `my.homepage.services` (list of `{ group; name; description; href; icon; }`).
|
||||||
|
- `hostName` is bound from `config.networking.hostName`, matching sibling modules.
|
||||||
|
- All `.nix` files must be formatted with `nixfmt-rfc-style`.
|
||||||
|
- No secret values may appear in any `.nix` file (nothing enters the Nix store). The only secret is `ntfy_password` in `/var/lib/hass/secrets.yaml`, provisioned by hand.
|
||||||
|
- Evaluation check used throughout (runs on darwin without a Linux builder):
|
||||||
|
`nix eval '.#nixosConfigurations.jupiter.config.system.build.toplevel.drvPath'`
|
||||||
|
- Do NOT run `nixos-rebuild` or SSH to jupiter; deploy + provisioning are operator steps the user runs on the host.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Task 1: Create the ntfy server module (server + homepage tile)
|
||||||
|
|
||||||
|
**Files:**
|
||||||
|
- Create: `modules/environments/ntfy/default.nix`
|
||||||
|
- Modify: `modules/environments/default.nix` (add `./ntfy` to `imports`)
|
||||||
|
- Modify: `machines/jupiter/environments.nix` (enable the profile)
|
||||||
|
|
||||||
|
**Interfaces:**
|
||||||
|
- Consumes: `config.networking.hostName`; `services.ntfy-sh` (nixpkgs); `my.homepage.services` (repo homepage module).
|
||||||
|
- Produces: option `my.profiles.ntfy.enable` (bool), `my.profiles.ntfy.port` (port, default 2586), `my.profiles.ntfy.topic` (str, default "ha"), `my.profiles.ntfy.haIntegration.enable` (bool, default true). Later tasks rely on `cfg.port`, `cfg.topic`, and `cfg.haIntegration.enable`.
|
||||||
|
|
||||||
|
- [ ] **Step 1: Create the module file**
|
||||||
|
|
||||||
|
Create `modules/environments/ntfy/default.nix`:
|
||||||
|
|
||||||
|
```nix
|
||||||
|
# self-hosted push notification server (ntfy)
|
||||||
|
{
|
||||||
|
config,
|
||||||
|
lib,
|
||||||
|
...
|
||||||
|
}:
|
||||||
|
let
|
||||||
|
cfg = config.my.profiles.ntfy;
|
||||||
|
hostName = config.networking.hostName;
|
||||||
|
in
|
||||||
|
{
|
||||||
|
options.my.profiles.ntfy = with lib; {
|
||||||
|
enable = mkEnableOption "ntfy notification server";
|
||||||
|
|
||||||
|
port = mkOption {
|
||||||
|
type = types.port;
|
||||||
|
default = 2586;
|
||||||
|
description = "HTTP port ntfy listens on.";
|
||||||
|
};
|
||||||
|
|
||||||
|
topic = mkOption {
|
||||||
|
type = types.str;
|
||||||
|
default = "ha";
|
||||||
|
description = "Topic Home Assistant publishes notifications to.";
|
||||||
|
};
|
||||||
|
|
||||||
|
haIntegration.enable = mkOption {
|
||||||
|
type = types.bool;
|
||||||
|
default = true;
|
||||||
|
description = "Wire a Home Assistant rest_command that publishes to ntfy.";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
config = lib.mkIf cfg.enable {
|
||||||
|
services.ntfy-sh = {
|
||||||
|
enable = true;
|
||||||
|
settings = {
|
||||||
|
base-url = "http://${hostName}:${toString cfg.port}";
|
||||||
|
listen-http = ":${toString cfg.port}";
|
||||||
|
auth-file = "/var/lib/ntfy-sh/user.db";
|
||||||
|
auth-default-access = "deny-all";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
networking.firewall.allowedTCPPorts = [ cfg.port ];
|
||||||
|
|
||||||
|
my.homepage.services = [
|
||||||
|
{
|
||||||
|
group = "Services";
|
||||||
|
name = "ntfy";
|
||||||
|
description = "Push notifications";
|
||||||
|
href = "http://${hostName}:${toString cfg.port}";
|
||||||
|
icon = "ntfy.svg";
|
||||||
|
}
|
||||||
|
];
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] **Step 2: Register the module in the environments import list**
|
||||||
|
|
||||||
|
In `modules/environments/default.nix`, add `./ntfy` to the `imports` list (place it near the other service modules, e.g. after `./home-assistant`):
|
||||||
|
|
||||||
|
```nix
|
||||||
|
./home-assistant
|
||||||
|
./ntfy
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] **Step 3: Enable the profile on jupiter**
|
||||||
|
|
||||||
|
In `machines/jupiter/environments.nix`, inside the `my.profiles = { ... }` block, add:
|
||||||
|
|
||||||
|
```nix
|
||||||
|
ntfy.enable = true;
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] **Step 4: Format the new file**
|
||||||
|
|
||||||
|
Run: `nixfmt-rfc-style modules/environments/ntfy/default.nix`
|
||||||
|
Expected: exits 0, no diff on re-run.
|
||||||
|
|
||||||
|
- [ ] **Step 5: Evaluate the configuration**
|
||||||
|
|
||||||
|
Run: `nix eval '.#nixosConfigurations.jupiter.config.system.build.toplevel.drvPath'`
|
||||||
|
Expected: prints a `/nix/store/...-nixos-system-jupiter-*.drv` path with no evaluation errors. (This forces full module-system evaluation, catching option/type mistakes, without building a Linux derivation.)
|
||||||
|
|
||||||
|
- [ ] **Step 6: Confirm the ntfy settings evaluate as expected**
|
||||||
|
|
||||||
|
Run: `nix eval --json '.#nixosConfigurations.jupiter.config.services.ntfy-sh.settings'`
|
||||||
|
Expected JSON includes `"auth-default-access":"deny-all"`, `"listen-http":":2586"`, and `"base-url":"http://jupiter:2586"`.
|
||||||
|
|
||||||
|
- [ ] **Step 7: Commit**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git add modules/environments/ntfy/default.nix modules/environments/default.nix machines/jupiter/environments.nix
|
||||||
|
git commit -m "feat(ntfy): add self-hosted notification server module
|
||||||
|
|
||||||
|
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>"
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Task 2: Wire the Home Assistant rest_command
|
||||||
|
|
||||||
|
**Files:**
|
||||||
|
- Modify: `modules/environments/ntfy/default.nix` (add HA integration block)
|
||||||
|
|
||||||
|
**Interfaces:**
|
||||||
|
- Consumes: `cfg.port`, `cfg.topic`, `cfg.haIntegration.enable` (Task 1); `config.my.profiles.home-assistant.enable`; `services.home-assistant.config` (nixpkgs / repo home-assistant module).
|
||||||
|
- Produces: `services.home-assistant.config.rest_command.ntfy_send`, callable from HA automations as `service: rest_command.ntfy_send`.
|
||||||
|
|
||||||
|
- [ ] **Step 1: Add the HA integration block to the module**
|
||||||
|
|
||||||
|
The module currently has a single `config = lib.mkIf cfg.enable { ... };`. Change it to merge two conditional configs with `lib.mkMerge` so the HA wiring is gated independently. Replace the `config = lib.mkIf cfg.enable { ... };` assignment with:
|
||||||
|
|
||||||
|
```nix
|
||||||
|
config = lib.mkMerge [
|
||||||
|
(lib.mkIf cfg.enable {
|
||||||
|
services.ntfy-sh = {
|
||||||
|
enable = true;
|
||||||
|
settings = {
|
||||||
|
base-url = "http://${hostName}:${toString cfg.port}";
|
||||||
|
listen-http = ":${toString cfg.port}";
|
||||||
|
auth-file = "/var/lib/ntfy-sh/user.db";
|
||||||
|
auth-default-access = "deny-all";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
networking.firewall.allowedTCPPorts = [ cfg.port ];
|
||||||
|
|
||||||
|
my.homepage.services = [
|
||||||
|
{
|
||||||
|
group = "Services";
|
||||||
|
name = "ntfy";
|
||||||
|
description = "Push notifications";
|
||||||
|
href = "http://${hostName}:${toString cfg.port}";
|
||||||
|
icon = "ntfy.svg";
|
||||||
|
}
|
||||||
|
];
|
||||||
|
})
|
||||||
|
|
||||||
|
(lib.mkIf (cfg.enable && cfg.haIntegration.enable && config.my.profiles.home-assistant.enable) {
|
||||||
|
services.home-assistant.config.rest_command.ntfy_send = {
|
||||||
|
url = "http://${hostName}:${toString cfg.port}/${cfg.topic}";
|
||||||
|
method = "POST";
|
||||||
|
payload = "{{ message }}";
|
||||||
|
content_type = "text/plain";
|
||||||
|
username = "homeassistant";
|
||||||
|
password = "!secret ntfy_password";
|
||||||
|
headers = {
|
||||||
|
Title = "{{ title | default('Home Assistant') }}";
|
||||||
|
Priority = "{{ priority | default('default') }}";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
})
|
||||||
|
];
|
||||||
|
```
|
||||||
|
|
||||||
|
(The first `mkIf cfg.enable` block is identical to Task 1's config body — it is repeated here because the whole `config` assignment is being replaced with the `mkMerge` form.)
|
||||||
|
|
||||||
|
- [ ] **Step 2: Format the file**
|
||||||
|
|
||||||
|
Run: `nixfmt-rfc-style modules/environments/ntfy/default.nix`
|
||||||
|
Expected: exits 0, no diff on re-run.
|
||||||
|
|
||||||
|
- [ ] **Step 3: Evaluate the configuration**
|
||||||
|
|
||||||
|
Run: `nix eval '.#nixosConfigurations.jupiter.config.system.build.toplevel.drvPath'`
|
||||||
|
Expected: prints a `.drv` path, no evaluation errors (confirms the `rest_command` merges cleanly into the HA config the home-assistant module already defines).
|
||||||
|
|
||||||
|
- [ ] **Step 4: Confirm the rest_command evaluated into HA config**
|
||||||
|
|
||||||
|
Run: `nix eval --json '.#nixosConfigurations.jupiter.config.services.home-assistant.config.rest_command.ntfy_send'`
|
||||||
|
Expected JSON includes `"url":"http://jupiter:2586/ha"`, `"username":"homeassistant"`, and `"password":"!secret ntfy_password"`.
|
||||||
|
|
||||||
|
- [ ] **Step 5: Commit**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git add modules/environments/ntfy/default.nix
|
||||||
|
git commit -m "feat(ntfy): wire Home Assistant rest_command publisher
|
||||||
|
|
||||||
|
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>"
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Operator steps (run by the user on jupiter — not part of the agent's task loop)
|
||||||
|
|
||||||
|
These require the host and manual credentials, so they are performed by the user after the branch is merged/deployed:
|
||||||
|
|
||||||
|
1. Deploy: `sudo nixos-rebuild switch --flake '.#jupiter'`
|
||||||
|
2. Create ntfy users:
|
||||||
|
```bash
|
||||||
|
ntfy user add homeassistant # set a password
|
||||||
|
ntfy access homeassistant ha write-only
|
||||||
|
ntfy user add --role=admin admin
|
||||||
|
```
|
||||||
|
3. Add the publisher password to Home Assistant secrets:
|
||||||
|
```yaml
|
||||||
|
# /var/lib/hass/secrets.yaml
|
||||||
|
ntfy_password: <the homeassistant user's password>
|
||||||
|
```
|
||||||
|
4. Restart Home Assistant, then test from an automation / Developer Tools:
|
||||||
|
```yaml
|
||||||
|
service: rest_command.ntfy_send
|
||||||
|
data:
|
||||||
|
message: "ntfy test"
|
||||||
|
title: "Home Assistant"
|
||||||
|
priority: high
|
||||||
|
```
|
||||||
|
5. Subscribe from the ntfy app as `admin` to receive the message.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Self-Review
|
||||||
|
|
||||||
|
**Spec coverage:**
|
||||||
|
- Module structure + options → Task 1. ✔
|
||||||
|
- Server config (deny-all, port, firewall) → Task 1 (steps 1, 6). ✔
|
||||||
|
- Homepage tile → Task 1. ✔
|
||||||
|
- Registration in `default.nix` + enable on jupiter → Task 1 (steps 2–3). ✔
|
||||||
|
- HA `rest_command` wiring, gated on HA profile, `!secret` password → Task 2. ✔
|
||||||
|
- Manual provisioning runbook → Operator steps section. ✔
|
||||||
|
- Verification (eval/build + nixfmt) → per-task steps. ✔
|
||||||
|
- Out-of-scope items (no seeding, no sops, no reverse proxy) → honored; no tasks added for them. ✔
|
||||||
|
|
||||||
|
**Placeholder scan:** No TBD/TODO/"handle edge cases". The one "similar to Task 1" note is accompanied by the full repeated code, per the no-placeholders rule. ✔
|
||||||
|
|
||||||
|
**Type consistency:** `cfg.port`/`cfg.topic`/`cfg.haIntegration.enable` defined in Task 1 and used identically in Task 2. `rest_command.ntfy_send` name consistent across Task 2 and operator steps. Homepage tile shape matches sibling modules. ✔
|
||||||
@@ -0,0 +1,176 @@
|
|||||||
|
# ntfy self-hosted notification module — design
|
||||||
|
|
||||||
|
Date: 2026-07-05
|
||||||
|
Target machine: jupiter
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Add a NixOS profile module that runs and configures a self-hosted
|
||||||
|
[ntfy](https://ntfy.sh) notification server on jupiter, with authentication
|
||||||
|
required, a homepage dashboard tile, and out-of-the-box plumbing so Home
|
||||||
|
Assistant automations can publish push notifications.
|
||||||
|
|
||||||
|
## Scope decisions (from brainstorming)
|
||||||
|
|
||||||
|
- **Service:** ntfy (self-hosted server), not Apprise/Gotify/HA-only.
|
||||||
|
- **Access control:** authentication required (`auth-default-access = deny-all`).
|
||||||
|
- **Home Assistant:** the module wires an HA `rest_command` so automations can
|
||||||
|
send notifications out of the box.
|
||||||
|
- **Credentials:** fully manual. The module runs the server and wires the HA
|
||||||
|
plumbing, but does **not** seed users or store any secret. The operator
|
||||||
|
provisions ntfy users/passwords by hand, and the only secret lives in Home
|
||||||
|
Assistant's `secrets.yaml` — never in the world-readable Nix store.
|
||||||
|
|
||||||
|
## Module structure
|
||||||
|
|
||||||
|
New module at `modules/environments/ntfy/default.nix` following the repo's
|
||||||
|
standard profile pattern (`my.profiles.<name>` with `options` +
|
||||||
|
`config = lib.mkIf cfg.enable { ... }`).
|
||||||
|
|
||||||
|
Registration:
|
||||||
|
1. Add `./ntfy` to the `imports` list in `modules/environments/default.nix`.
|
||||||
|
2. Enable via `my.profiles.ntfy.enable = true;` in
|
||||||
|
`machines/jupiter/environments.nix`.
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```nix
|
||||||
|
options.my.profiles.ntfy = with lib; {
|
||||||
|
enable = mkEnableOption "ntfy notification server";
|
||||||
|
|
||||||
|
port = mkOption {
|
||||||
|
type = types.port;
|
||||||
|
default = 2586;
|
||||||
|
description = "HTTP port ntfy listens on.";
|
||||||
|
};
|
||||||
|
|
||||||
|
topic = mkOption {
|
||||||
|
type = types.str;
|
||||||
|
default = "ha";
|
||||||
|
description = "Topic Home Assistant publishes notifications to.";
|
||||||
|
};
|
||||||
|
|
||||||
|
haIntegration.enable = mkOption {
|
||||||
|
type = types.bool;
|
||||||
|
default = true;
|
||||||
|
description = "Wire a Home Assistant rest_command that publishes to ntfy.";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Server configuration
|
||||||
|
|
||||||
|
```nix
|
||||||
|
config = lib.mkIf cfg.enable {
|
||||||
|
services.ntfy-sh = {
|
||||||
|
enable = true;
|
||||||
|
settings = {
|
||||||
|
base-url = "http://${hostName}:${toString cfg.port}";
|
||||||
|
listen-http = ":${toString cfg.port}";
|
||||||
|
auth-file = "/var/lib/ntfy-sh/user.db";
|
||||||
|
auth-default-access = "deny-all";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
networking.firewall.allowedTCPPorts = [ cfg.port ];
|
||||||
|
|
||||||
|
my.homepage.services = [
|
||||||
|
{
|
||||||
|
group = "Services";
|
||||||
|
name = "ntfy";
|
||||||
|
description = "Push notifications";
|
||||||
|
href = "http://${hostName}:${toString cfg.port}";
|
||||||
|
icon = "ntfy.svg";
|
||||||
|
}
|
||||||
|
];
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
`hostName` is bound from `config.networking.hostName`, matching the pattern in
|
||||||
|
the home-assistant and paperless modules.
|
||||||
|
|
||||||
|
## Home Assistant wiring
|
||||||
|
|
||||||
|
Applied only when ntfy, the HA integration flag, and the home-assistant profile
|
||||||
|
are all enabled:
|
||||||
|
|
||||||
|
```nix
|
||||||
|
lib.mkIf (cfg.enable && cfg.haIntegration.enable
|
||||||
|
&& config.my.profiles.home-assistant.enable) {
|
||||||
|
services.home-assistant.config.rest_command.ntfy_send = {
|
||||||
|
url = "http://${hostName}:${toString cfg.port}/${cfg.topic}";
|
||||||
|
method = "POST";
|
||||||
|
payload = "{{ message }}";
|
||||||
|
content_type = "text/plain";
|
||||||
|
username = "homeassistant";
|
||||||
|
password = "!secret ntfy_password";
|
||||||
|
headers = {
|
||||||
|
Title = "{{ title | default('Home Assistant') }}";
|
||||||
|
Priority = "{{ priority | default('default') }}";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
- `services.home-assistant.config` is an attrset that NixOS merges, so adding
|
||||||
|
`rest_command.ntfy_send` from this module composes with the config the
|
||||||
|
home-assistant module already defines.
|
||||||
|
- `password = "!secret ntfy_password"` is a whole-value `!secret` reference. The
|
||||||
|
upstream home-assistant module unquotes such values when rendering the config
|
||||||
|
(the same mechanism the repo already relies on for `!include`), so the secret
|
||||||
|
resolves from `/var/lib/hass/secrets.yaml` at runtime and never enters the
|
||||||
|
Nix store. See `reference_nixos_ha_yaml_includes`.
|
||||||
|
- `rest_command` is chosen over the `notify` REST platform because ntfy's
|
||||||
|
per-topic URL path plus header-based metadata map cleanly onto rest_command,
|
||||||
|
whereas the notify platform's fixed JSON payload fights ntfy's format.
|
||||||
|
|
||||||
|
## Manual provisioning (operator runbook)
|
||||||
|
|
||||||
|
Because credentials are fully manual, after the first `nixos-rebuild switch`
|
||||||
|
run these once on jupiter:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Dedicated publisher for Home Assistant, scoped to the ha topic
|
||||||
|
ntfy user add homeassistant # prompts for a password
|
||||||
|
ntfy access homeassistant ha write-only
|
||||||
|
|
||||||
|
# Admin account for the app / web UI
|
||||||
|
ntfy user add --role=admin admin
|
||||||
|
```
|
||||||
|
|
||||||
|
Then add the homeassistant password to Home Assistant's secrets:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# /var/lib/hass/secrets.yaml
|
||||||
|
ntfy_password: <the homeassistant user's password>
|
||||||
|
```
|
||||||
|
|
||||||
|
Restart Home Assistant. Automations can then publish with:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
service: rest_command.ntfy_send
|
||||||
|
data:
|
||||||
|
message: "Garage door left open"
|
||||||
|
title: "Alert"
|
||||||
|
priority: high
|
||||||
|
```
|
||||||
|
|
||||||
|
Subscribers (phone/desktop ntfy app) log in as `admin` (or another user granted
|
||||||
|
read access) to receive messages.
|
||||||
|
|
||||||
|
## Testing / verification
|
||||||
|
|
||||||
|
- Build check: `nix build '.#nixosConfigurations.jupiter.config.system.build.toplevel'`
|
||||||
|
must succeed with the module enabled.
|
||||||
|
- `nixfmt-rfc-style` clean on the new file.
|
||||||
|
- Post-deploy manual verification (documented, not automated): create the users
|
||||||
|
above, publish a test message from HA, confirm it reaches a subscribed client.
|
||||||
|
|
||||||
|
## Out of scope
|
||||||
|
|
||||||
|
- No automated user/token seeding (explicitly deferred to manual provisioning).
|
||||||
|
- No sops-nix setup (repo has dangling `config.sops.secrets` references, but
|
||||||
|
wiring up sops is a separate change and not required here).
|
||||||
|
- No reverse-proxy / TLS termination (`behind-proxy` left default; LAN-only via
|
||||||
|
firewall).
|
||||||
@@ -1,61 +0,0 @@
|
|||||||
# mibook: choose terminal-only vs desktop at boot
|
|
||||||
|
|
||||||
## Goal
|
|
||||||
|
|
||||||
Let mibook boot to a text console by default, with KDE fully installed and
|
|
||||||
launchable on demand. The user decides after boot whether they need the
|
|
||||||
graphical desktop, without rebuilding the system.
|
|
||||||
|
|
||||||
## Behavior
|
|
||||||
|
|
||||||
- mibook boots to a text console (`multi-user.target`). SDDM and Plasma do
|
|
||||||
**not** start automatically.
|
|
||||||
- KDE (SDDM + Plasma 6) remains fully installed.
|
|
||||||
- Running `desktop` in the terminal starts the SDDM display manager, which
|
|
||||||
presents the graphical login screen; logging in there enters a Plasma 6
|
|
||||||
session.
|
|
||||||
- No reverse command. To return to a text console, stop the display manager
|
|
||||||
(`sudo systemctl stop display-manager`) or reboot.
|
|
||||||
- Other machines that enable the `kde-desktop` profile are unaffected; their
|
|
||||||
desktop still starts on boot.
|
|
||||||
|
|
||||||
## Implementation
|
|
||||||
|
|
||||||
### `modules/environments/kde-desktop/default.nix`
|
|
||||||
|
|
||||||
Add an opt-out option to the existing profile:
|
|
||||||
|
|
||||||
- New option `my.profiles.kde-desktop.startOnBoot`, a boolean defaulting to
|
|
||||||
`true`. The default preserves the current behavior for every consumer.
|
|
||||||
- The existing `config` block (SDDM, Plasma 6, user packages) stays enabled
|
|
||||||
whenever the profile is enabled, regardless of `startOnBoot`.
|
|
||||||
- When `startOnBoot = false`, additionally apply:
|
|
||||||
- `systemd.services.display-manager.wantedBy = lib.mkForce [ ];` so SDDM is
|
|
||||||
defined but not pulled in by any boot target.
|
|
||||||
- `systemd.defaultUnit = "multi-user.target";` so the boot target is the
|
|
||||||
text console.
|
|
||||||
- A `desktop` command provided via
|
|
||||||
`pkgs.writeShellScriptBin "desktop" "exec sudo systemctl start display-manager.service"`,
|
|
||||||
added to `environment.systemPackages`.
|
|
||||||
|
|
||||||
### `machines/mibook/environments.nix`
|
|
||||||
|
|
||||||
Set `kde-desktop.startOnBoot = false;` alongside the existing
|
|
||||||
`kde-desktop.enable = true;`.
|
|
||||||
|
|
||||||
## Testing / verification
|
|
||||||
|
|
||||||
- `nix build '.#nixosConfigurations.mibook.config.system.build.toplevel'`
|
|
||||||
builds without error.
|
|
||||||
- After `nixos-rebuild switch` on mibook: system boots to a TTY, no SDDM;
|
|
||||||
running `desktop` brings up the SDDM login and a working Plasma session.
|
|
||||||
- Confirm jupiter (or any non-mibook consumer) is unchanged: its evaluated
|
|
||||||
`systemd.defaultUnit` / display-manager wantedBy are not altered.
|
|
||||||
|
|
||||||
## Trade-offs
|
|
||||||
|
|
||||||
- `desktop` relies on `sudo`; the user has sudo access, so no extra
|
|
||||||
configuration is required.
|
|
||||||
- Chose "boot to terminal, launch on demand" over a GRUB boot-menu entry
|
|
||||||
because it is more robust across NixOS generations and needs no fragile
|
|
||||||
static kernel entries.
|
|
||||||
Generated
+33
-30
@@ -21,11 +21,11 @@
|
|||||||
"nixpkgs-lib": "nixpkgs-lib"
|
"nixpkgs-lib": "nixpkgs-lib"
|
||||||
},
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1782949081,
|
"lastModified": 1778716662,
|
||||||
"narHash": "sha256-vp6Y/Grm98ESt6ceOkWiHWyZRDV3J1RID4w+6NWK9yA=",
|
"narHash": "sha256-m1Yf0wZ8j1OHjTc2UwHwyQRSnNeSgLJOd7q5Y45hzi4=",
|
||||||
"owner": "hercules-ci",
|
"owner": "hercules-ci",
|
||||||
"repo": "flake-parts",
|
"repo": "flake-parts",
|
||||||
"rev": "17c9d6cdfc60c64f4ee8d306f9bc0b4ccb51481e",
|
"rev": "f7c1a2d347e4c52d5fb8d10cb4d94b5884e546fb",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -42,11 +42,11 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1782949081,
|
"lastModified": 1778716662,
|
||||||
"narHash": "sha256-vp6Y/Grm98ESt6ceOkWiHWyZRDV3J1RID4w+6NWK9yA=",
|
"narHash": "sha256-m1Yf0wZ8j1OHjTc2UwHwyQRSnNeSgLJOd7q5Y45hzi4=",
|
||||||
"owner": "hercules-ci",
|
"owner": "hercules-ci",
|
||||||
"repo": "flake-parts",
|
"repo": "flake-parts",
|
||||||
"rev": "17c9d6cdfc60c64f4ee8d306f9bc0b4ccb51481e",
|
"rev": "f7c1a2d347e4c52d5fb8d10cb4d94b5884e546fb",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -60,17 +60,20 @@
|
|||||||
"flake-compat": [
|
"flake-compat": [
|
||||||
"nix"
|
"nix"
|
||||||
],
|
],
|
||||||
|
"gitignore": [
|
||||||
|
"nix"
|
||||||
|
],
|
||||||
"nixpkgs": [
|
"nixpkgs": [
|
||||||
"nix",
|
"nix",
|
||||||
"nixpkgs"
|
"nixpkgs"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1783008725,
|
"lastModified": 1781733627,
|
||||||
"narHash": "sha256-jGiy6+sxjNWXSjp25uoJuNfyH9zBK1PEDY0lVoL4ibQ=",
|
"narHash": "sha256-U3yTuGBnmXvXoQI3qkpfEDsn9RovQPAjN7ndRco+3u0=",
|
||||||
"owner": "cachix",
|
"owner": "cachix",
|
||||||
"repo": "git-hooks.nix",
|
"repo": "git-hooks.nix",
|
||||||
"rev": "bca82caa46d5ec0f5d422c61fb1e30bc51313cbe",
|
"rev": "3bbec39bc90eadfa031e6f3b77272f3f60803e39",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -89,11 +92,11 @@
|
|||||||
"nixpkgs-regression": "nixpkgs-regression"
|
"nixpkgs-regression": "nixpkgs-regression"
|
||||||
},
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1784762557,
|
"lastModified": 1782337899,
|
||||||
"narHash": "sha256-R/r6jRnANV50c8F5Fz5+1Q1moab0IGWRk+cg5ME2nMY=",
|
"narHash": "sha256-Imevyelg3r2N5iDonnGdOKGRiB56m3HgVFAljTB3CLU=",
|
||||||
"owner": "NixOS",
|
"owner": "NixOS",
|
||||||
"repo": "nix",
|
"repo": "nix",
|
||||||
"rev": "d10c84cd0cc0efdcb29cf2611caf5fbcd10fa071",
|
"rev": "3887a906b178836818a62e8eba666ad652e8a388",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -143,11 +146,11 @@
|
|||||||
"nixpkgs": "nixpkgs_2"
|
"nixpkgs": "nixpkgs_2"
|
||||||
},
|
},
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1784723954,
|
"lastModified": 1782379505,
|
||||||
"narHash": "sha256-1CfD8ZUjCkTgjsneLZ/lxCHhgDfqxxE7/GX0MmsgiqA=",
|
"narHash": "sha256-zPvPiU+a7pqtH47xrtZLNRABJKpOjfZQclDbcvNtH+I=",
|
||||||
"owner": "NixOS",
|
"owner": "NixOS",
|
||||||
"repo": "nixos-hardware",
|
"repo": "nixos-hardware",
|
||||||
"rev": "a017f5b72210026af5b3ac5949f08d94380a6fbd",
|
"rev": "603d3afd1b6145bd66e97ae38a34d91c95df70cf",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -158,11 +161,11 @@
|
|||||||
},
|
},
|
||||||
"nixpkgs": {
|
"nixpkgs": {
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1783148766,
|
"lastModified": 1780902259,
|
||||||
"narHash": "sha256-H9+N+GFtsbVC8ZniHliChM7ndizxtqVZs6bnGOLM3WQ=",
|
"narHash": "sha256-YMnBf9lk/LYgvqfmSSJuOGigtRs5Lsy26pJHVlR9yMY=",
|
||||||
"rev": "a50de1b7d8a586adc18d2395c19de7d6058e6030",
|
"rev": "bd0ff2d3eac24699c3664d5966b9ef36f388e2ca",
|
||||||
"type": "tarball",
|
"type": "tarball",
|
||||||
"url": "https://releases.nixos.org/nixos/26.05/nixos-26.05.4193.a50de1b7d8a5/nixexprs.tar.xz"
|
"url": "https://releases.nixos.org/nixos/26.05/nixos-26.05.1550.bd0ff2d3eac2/nixexprs.tar.xz"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
"type": "tarball",
|
"type": "tarball",
|
||||||
@@ -187,11 +190,11 @@
|
|||||||
},
|
},
|
||||||
"nixpkgs-lib": {
|
"nixpkgs-lib": {
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1782614948,
|
"lastModified": 1777168982,
|
||||||
"narHash": "sha256-ePjCwr1sNm9NYUqywL7QfK3JnlS015msC+eBu2zKlp8=",
|
"narHash": "sha256-GOkGPcboWE9BmGCRMLX3worL4EMnsnG8MyKmXNeYuhQ=",
|
||||||
"owner": "nix-community",
|
"owner": "nix-community",
|
||||||
"repo": "nixpkgs.lib",
|
"repo": "nixpkgs.lib",
|
||||||
"rev": "db3f255737b94216eb71cce308e2912cf6bc2d7c",
|
"rev": "f5901329dade4a6ea039af1433fb087bd9c1fe14",
|
||||||
"type": "github"
|
"type": "github"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
@@ -218,11 +221,11 @@
|
|||||||
},
|
},
|
||||||
"nixpkgs-unstable": {
|
"nixpkgs-unstable": {
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1784796856,
|
"lastModified": 1782467914,
|
||||||
"narHash": "sha256-vwxWgF+Gj276WznzGb1LxGsK/39HaQwgQXiU3EkC844=",
|
"narHash": "sha256-inDx/w70OSJoJPqtKh0BrzAsbZZhpya7YgS43jHnhwg=",
|
||||||
"rev": "e2587caef70cea85dd97d7daab492899902dbf5d",
|
"rev": "e73de5be04e0eff4190a1432b946d469c794e7b4",
|
||||||
"type": "tarball",
|
"type": "tarball",
|
||||||
"url": "https://releases.nixos.org/nixos/unstable/nixos-26.11pre1040357.e2587caef70c/nixexprs.tar.xz"
|
"url": "https://releases.nixos.org/nixos/unstable/nixos-26.11pre1022855.e73de5be04e0/nixexprs.tar.xz"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
"id": "nixpkgs",
|
"id": "nixpkgs",
|
||||||
@@ -245,11 +248,11 @@
|
|||||||
},
|
},
|
||||||
"nixpkgs_3": {
|
"nixpkgs_3": {
|
||||||
"locked": {
|
"locked": {
|
||||||
"lastModified": 1784707089,
|
"lastModified": 1782375420,
|
||||||
"narHash": "sha256-DUedXhD2Rg8q4Xyd07Sb90eZGy4gg6W+Vl/WbLNwAZo=",
|
"narHash": "sha256-f+/IH5ng5P91VHrhcNxqpW2RYDySD68V1fcX00COQy4=",
|
||||||
"rev": "b3fe9581c9061c749abef42b6d4ee7b7c05c33fa",
|
"rev": "4062d36ebeae843c750011eef6b61ec9a9dbc9a9",
|
||||||
"type": "tarball",
|
"type": "tarball",
|
||||||
"url": "https://releases.nixos.org/nixos/26.05/nixos-26.05.5845.b3fe9581c906/nixexprs.tar.xz"
|
"url": "https://releases.nixos.org/nixos/26.05/nixos-26.05.3250.4062d36ebeae/nixexprs.tar.xz"
|
||||||
},
|
},
|
||||||
"original": {
|
"original": {
|
||||||
"id": "nixpkgs",
|
"id": "nixpkgs",
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ in
|
|||||||
jellyseerr.enable = true;
|
jellyseerr.enable = true;
|
||||||
development.enable = true;
|
development.enable = true;
|
||||||
home-assistant.enable = true;
|
home-assistant.enable = true;
|
||||||
|
ntfy.enable = true;
|
||||||
|
|
||||||
homepage.enable = true;
|
homepage.enable = true;
|
||||||
paperless = {
|
paperless = {
|
||||||
|
|||||||
@@ -44,14 +44,6 @@
|
|||||||
|
|
||||||
services.openssh.enable = true;
|
services.openssh.enable = true;
|
||||||
|
|
||||||
# KDE (PowerDevil) power settings: do nothing on lid close while on AC power.
|
|
||||||
# Shipped as a system-wide default; KConfig cascades so a user's own
|
|
||||||
# ~/.config/powerdevilrc will override this if present.
|
|
||||||
environment.etc."xdg/powerdevilrc".text = ''
|
|
||||||
[AC][SuspendAndShutdown]
|
|
||||||
LidAction=0
|
|
||||||
'';
|
|
||||||
|
|
||||||
system = {
|
system = {
|
||||||
stateVersion = "23.05";
|
stateVersion = "23.05";
|
||||||
autoUpgrade.enable = true;
|
autoUpgrade.enable = true;
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ in
|
|||||||
{
|
{
|
||||||
my.profiles = {
|
my.profiles = {
|
||||||
kde-desktop.enable = true;
|
kde-desktop.enable = true;
|
||||||
kde-desktop.startOnBoot = false;
|
|
||||||
zsh.enable = true;
|
zsh.enable = true;
|
||||||
apps = {
|
apps = {
|
||||||
desktop_apps = true;
|
desktop_apps = true;
|
||||||
|
|||||||
@@ -7,6 +7,7 @@
|
|||||||
./claude-code
|
./claude-code
|
||||||
./development
|
./development
|
||||||
./home-assistant
|
./home-assistant
|
||||||
|
./ntfy
|
||||||
./hyprland
|
./hyprland
|
||||||
./zsh
|
./zsh
|
||||||
./paperless
|
./paperless
|
||||||
|
|||||||
@@ -11,19 +11,9 @@ in
|
|||||||
{
|
{
|
||||||
options.my.profiles.kde-desktop = with lib; {
|
options.my.profiles.kde-desktop = with lib; {
|
||||||
enable = mkEnableOption "KDE Desktop Environment";
|
enable = mkEnableOption "KDE Desktop Environment";
|
||||||
startOnBoot = mkOption {
|
|
||||||
type = types.bool;
|
|
||||||
default = true;
|
|
||||||
description = ''
|
|
||||||
Whether the display manager (SDDM) starts automatically at boot.
|
|
||||||
When false, the system boots to a text console and KDE can be
|
|
||||||
launched on demand with the `desktop` command.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
|
|
||||||
config = lib.mkIf cfg.enable (lib.mkMerge [
|
config = lib.mkIf cfg.enable {
|
||||||
{
|
|
||||||
services = {
|
services = {
|
||||||
displayManager.sddm.enable = true;
|
displayManager.sddm.enable = true;
|
||||||
displayManager.sddm.wayland.enable = true;
|
displayManager.sddm.wayland.enable = true;
|
||||||
@@ -33,15 +23,5 @@ in
|
|||||||
# Programms can be added here...
|
# Programms can be added here...
|
||||||
numix-icon-theme
|
numix-icon-theme
|
||||||
];
|
];
|
||||||
}
|
};
|
||||||
(lib.mkIf (!cfg.startOnBoot) {
|
|
||||||
# Boot to a text console; SDDM stays installed but is not pulled in
|
|
||||||
# by any boot target. Launch KDE on demand with `desktop`.
|
|
||||||
systemd.services.display-manager.wantedBy = lib.mkForce [ ];
|
|
||||||
systemd.defaultUnit = lib.mkForce "multi-user.target";
|
|
||||||
environment.systemPackages = [
|
|
||||||
(pkgs.writeShellScriptBin "desktop" "exec sudo systemctl start display-manager.service")
|
|
||||||
];
|
|
||||||
})
|
|
||||||
]);
|
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,74 @@
|
|||||||
|
# self-hosted push notification server (ntfy)
|
||||||
|
{
|
||||||
|
config,
|
||||||
|
lib,
|
||||||
|
...
|
||||||
|
}:
|
||||||
|
let
|
||||||
|
cfg = config.my.profiles.ntfy;
|
||||||
|
hostName = config.networking.hostName;
|
||||||
|
in
|
||||||
|
{
|
||||||
|
options.my.profiles.ntfy = with lib; {
|
||||||
|
enable = mkEnableOption "ntfy notification server";
|
||||||
|
|
||||||
|
port = mkOption {
|
||||||
|
type = types.port;
|
||||||
|
default = 2586;
|
||||||
|
description = "HTTP port ntfy listens on.";
|
||||||
|
};
|
||||||
|
|
||||||
|
topic = mkOption {
|
||||||
|
type = types.str;
|
||||||
|
default = "ha";
|
||||||
|
description = "Topic Home Assistant publishes notifications to.";
|
||||||
|
};
|
||||||
|
|
||||||
|
haIntegration.enable = mkOption {
|
||||||
|
type = types.bool;
|
||||||
|
default = true;
|
||||||
|
description = "Wire a Home Assistant rest_command that publishes to ntfy.";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
config = lib.mkMerge [
|
||||||
|
(lib.mkIf cfg.enable {
|
||||||
|
services.ntfy-sh = {
|
||||||
|
enable = true;
|
||||||
|
settings = {
|
||||||
|
base-url = "http://${hostName}:${toString cfg.port}";
|
||||||
|
listen-http = ":${toString cfg.port}";
|
||||||
|
auth-file = "/var/lib/ntfy-sh/user.db";
|
||||||
|
auth-default-access = "deny-all";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
networking.firewall.allowedTCPPorts = [ cfg.port ];
|
||||||
|
|
||||||
|
my.homepage.services = [
|
||||||
|
{
|
||||||
|
group = "Services";
|
||||||
|
name = "ntfy";
|
||||||
|
description = "Push notifications";
|
||||||
|
href = "http://${hostName}:${toString cfg.port}";
|
||||||
|
icon = "ntfy.svg";
|
||||||
|
}
|
||||||
|
];
|
||||||
|
})
|
||||||
|
|
||||||
|
(lib.mkIf (cfg.enable && cfg.haIntegration.enable && config.my.profiles.home-assistant.enable) {
|
||||||
|
services.home-assistant.config.rest_command.ntfy_send = {
|
||||||
|
url = "http://${hostName}:${toString cfg.port}/${cfg.topic}";
|
||||||
|
method = "POST";
|
||||||
|
payload = "{{ message }}";
|
||||||
|
content_type = "text/plain";
|
||||||
|
username = "homeassistant";
|
||||||
|
password = "!secret ntfy_password";
|
||||||
|
headers = {
|
||||||
|
Title = "{{ title | default('Home Assistant') }}";
|
||||||
|
Priority = "{{ priority | default('default') }}";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
})
|
||||||
|
];
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user