Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Hub module options

The NixOS modules: nixosModules.hub (services.ccdash-hub) runs the hub, nixosModules.default (programs.ccdash) allowlists the channel. Generated from the modules; keys the options do not cover go into settings (configuration).

programs.ccdash.channel.allow

Whether to enable the ccdash channel in Claude Code’s managed settings (/etc/claude-code/managed-settings.d/ccdash.json), so sessions started by the home-manager module’s claude wrapper load it without the development-channel warning. This replaces Anthropic’s default channel allowlist on this machine; list any other channel plugins you use in allowedChannelPlugins yourself .

Type: boolean

Default:

false

Example:

true

Declared by:

services.ccdash-hub.enable

Whether to enable the ccdash hub.

Type: boolean

Default:

false

Example:

true

Declared by:

services.ccdash-hub.package

The ccdash package.

Type: package

Default:

ccdash.packages.${system}.ccdash

Declared by:

services.ccdash-hub.attachments.enable

Whether the panel can attach files to prompts (photos, recordings, documents): the hub keeps them as plain files until a session’s machine fetches them, within the bounds below. Off, the panel offers no attaching and its Files area is gone.

Type: boolean

Default:

true

Declared by:

services.ccdash-hub.attachments.directory

Where the hub keeps attached files, outside the database and its nightly copies.

Type: string

Default:

"/var/lib/ccdash-hub/attachments"

Declared by:

services.ccdash-hub.attachments.maxAudioMb

The largest sound recording taken, in MiB.

Type: positive integer, meaning >0

Default:

50

Declared by:

services.ccdash-hub.attachments.maxFileMb

The largest file of any other kind taken, in MiB.

Type: positive integer, meaning >0

Default:

50

Declared by:

services.ccdash-hub.attachments.maxImageMb

The largest picture taken, in MiB.

Type: positive integer, meaning >0

Default:

25

Declared by:

services.ccdash-hub.attachments.maxVideoMb

The largest video taken, in MiB.

Type: positive integer, meaning >0

Default:

300

Declared by:

services.ccdash-hub.attachments.quotaMb

All attachments together, in MiB: over it the oldest ones not marked Keep go first. 0 sets no quota.

Type: unsigned integer, meaning >=0

Default:

5120

Declared by:

services.ccdash-hub.attachments.retentionDays

Attachments not marked Keep are dropped this many days after their upload. 0 keeps them until the quota or the owner removes them.

Type: unsigned integer, meaning >=0

Default:

30

Declared by:

services.ccdash-hub.backup.enable

Whether to enable a nightly copy of the database through SQLite’s backup API, checked with PRAGMA integrity_check, kept in directory for a file-level backup tool (restic, say) to pick up .

Type: boolean

Default:

false

Example:

true

Declared by:

services.ccdash-hub.backup.directory

Where the copies go.

Type: string

Default:

"/var/lib/ccdash-hub/backups"

Declared by:

services.ccdash-hub.backup.keep

How many daily copies to keep.

Type: positive integer, meaning >0

Default:

7

Declared by:

services.ccdash-hub.backup.onCalendar

When to copy (systemd.time(7)).

Type: string

Default:

"*-*-* 03:30:00"

Declared by:

services.ccdash-hub.collectors

Collector token files by host name: the name each collector announces, and the file holding the token it must send. Readable by the ccdash user.

Type: attribute set of string

Default:

{ }

Example:

{
  desk = "/run/agenix/ccdash-collector-desk";
  laptop = "/run/agenix/ccdash-collector-laptop";
}

Declared by:

services.ccdash-hub.localCollector.enable

Whether to enable a collector on this machine too (a single node: the hub and a workstation in one). Generates its token once into /var/lib/ccdash-hub-local/collector.token, readable by user and the hub, and lists it under host; the home-manager module’s services.ccdash.hub.local picks it up .

Type: boolean

Default:

false

Example:

true

Declared by:

services.ccdash-hub.localCollector.host

The host name that collector announces (the kernel’s host name by default).

Type: string

Default:

config.networking.hostName

Declared by:

services.ccdash-hub.localCollector.user

The user whose collector runs on this machine.

Type: string

Example:

"alice"

Declared by:

services.ccdash-hub.nginx.enable

Whether to enable an nginx virtual host proxying to the hub, WebSocket and server-sent events included. Listening addresses, TLS and access control are yours to add on services.nginx.virtualHosts.<domain> .

Type: boolean

Default:

false

Example:

true

Declared by:

services.ccdash-hub.nginx.domain

The virtual host’s name, also the hub’s public URL.

Type: string

Example:

"ccdash.example.org"

Declared by:

services.ccdash-hub.port

Loopback port of the HTTP API and web UI; put a TLS reverse proxy in front of it (nginx).

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default:

7837

Declared by:

services.ccdash-hub.reports.directory

Where the hub keeps the HTML reports sessions publish, as plain files (<workspace>/<slug>.html), outside the database and its nightly copies (backup): put it in a file-level backup of its own.

Type: string

Default:

"/var/lib/ccdash-hub/reports"

Declared by:

services.ccdash-hub.reports.maxMb

The largest report taken, in MiB; also sizes nginx’s body limit on /reports/.

Type: positive integer, meaning >0

Default:

32

Declared by:

services.ccdash-hub.settings

Hub configuration beyond the options here, written to the TOML the daemon reads. Unset keys keep their built-in defaults.

Type: TOML value

Default:

{ }

Example:

{
  workspaces.dirs = [ "~/code/work" ];
  store.retention_days = 90;
  notify.workspaces = [ "work" ];
}

Declared by:

services.ccdash-hub.sync.directory

Where the hub keeps the collectors’ Claude Code state (sessions, rewind checkpoints, plans, tasks, pasted content), as plain files. Not in the nightly database copies (backup): put it in a file-level backup of its own.

Type: string

Default:

"/var/lib/ccdash-hub/claude"

Declared by:

services.ccdash-hub.tokenFile

File holding the bootstrap bearer token of the web UI and API, readable by the ccdash user; null generates one once into /var/lib/ccdash-hub/ui-token. Devices paired through a link (ccdash url --hub) get tokens of their own (Settings › Devices); the hub accepts this one alongside them, so changing it signs out only the devices still on it.

Type: null or string

Default:

null

Example:

"/run/agenix/ccdash-ui-token"

Declared by:

services.ccdash-hub.webPackage

The built panel the hub serves at / (http.web_dir).

Type: package

Default:

ccdash.packages.${system}.ccdash-web

Declared by:

services.ccdash-hub.workspace.enable

Whether to enable the workspace sync: every collector’s workspace root (its repositories and plain directories) kept in step through bare repositories under sync.directory/workspace/, pushed and fetched over git smart HTTP at /git/ with the collector tokens. Adds git to the hub’s closure, the nginx location with unlimited bodies, and a nightly git gc over the repositories (next to the database copy when backup.enable is on) .

Type: boolean

Default:

false

Example:

true

Declared by:

services.ccdash-hub.workspace.gcOnCalendar

When to run git gc over the repositories (systemd.time(7)).

Type: string

Default:

"*-*-* 03:30:00"

Declared by:

services.ccdash-hub.workspaces

The workspaces: top-level directories on the workstations, each holding project directories (repository clones). Memories, issues, documents and reports belong to a workspace and are shared by its sessions; the panel scopes by them. A workspace is named by its entry’s last path component, and an entry is one of:

  • ~/code/work: a directory under each workstation’s home, whatever its user is called;
  • clients, clients/acme: a directory under each workstation’s workspace root (Home Manager services.ccdash.workspace.root, [workspace] root); a machine without a root has none of it;
  • /srv/shared, C:\work: that path, on every machine that has it.

So the machines need neither the same user nor the same layout. The knowledge tools refuse sessions outside every workspace, so set at least one.

Type: list of string

Default:

[ ]

Example:

[
  "~/code/work"
  "clients"
  "/srv/shared"
]

Declared by: