Smos Logo Smos

A comprehensive self-management system

Home Manager Module Reference

Generated reference documentation about the home manager module for smos server deployments.

Options

programs.smos.backup

Periodic local backups of the workflow directory

Type: null or submodule


programs.smos.backup.backupDir

The directory to backup to

Type: string

Default: "/home/user/.local/share/smos/backup"


programs.smos.backup.enable

Whether to enable Smos backups.

Type: boolean

Default: false

Example: true


programs.smos.calendar

Periodic calendar imports

Type: null or submodule


programs.smos.calendar.enable

Whether to enable Smos calendar importing.

Type: boolean

Default: false

Example: true


programs.smos.calendar.sources

The list of sources to import from

Type: list of submodule

Default: []


programs.smos.calendar.sources.*.destination

The destination file within the workflow directory

Type: string

Example: "calendar/name.smos"


programs.smos.calendar.sources.*.name

The name of the source

Type: null or string

Example: "Personal"


programs.smos.calendar.sources.*.source

The url to download the calendar from

Type: string

Example: "https://calendar.google.com/calendar/ical/xxx.xxxxxxxxx%40gmail.com/private-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/basic.ics"


programs.smos.config

The contents of the config file, as an attribute set. This will be translated to Yaml and put in the right place along with the rest of the options defined in this submodule.

Type: attribute set

Default: {}


programs.smos.enable

Whether to enable Smos.

Type: boolean

Default: false

Example: true


programs.smos.notify

Desktop notifications

Type: null or submodule


programs.smos.notify.enable

Whether to enable Smos notification activation.

Type: boolean

Default: false

Example: true


programs.smos.scheduler

Automatic scheduled project scheduling

Type: null or submodule


programs.smos.scheduler.enable

Whether to enable Smos scheduler activation.

Type: boolean

Default: false

Example: true


programs.smos.scheduler.schedule

The schedule to activate

Type: list of submodule

Default: []


programs.smos.scheduler.schedule.*.description

A description of the schedule item. This is only used for logging and error messages.

Type: null or string

Example: "Weekly tasks for work"


programs.smos.scheduler.schedule.*.destination

The template relative path to the destination in the workflow dir

Type: string

Example: "workflow/work-[ %Y-%V | monday ].smos"


programs.smos.scheduler.schedule.*.schedule

The cron schedule for when to activate this item

Type: string

Example: "0 12 * * 6"


programs.smos.scheduler.schedule.*.template

The relative path to the template in the workflow dir

Type: null or string or path

Example: "templates/weekly.smos"


programs.smos.smosReleasePackages

The smosPackages attribute defined in the nix/overlay.nix file in the smos repository.

Type: attribute set

Default: { "smos": { "_type": "derivation", "name": "smos-0.6.0" }, "smos-api": { "_type": "derivation", "name": "smos-api-0.5.0" }, "smos-api-gen": { "_type": "derivation", "name": "smos-api-gen-0.3.1" }, "smos-archive": { "_type": "derivation", "name": "smos-archive-0.3.2" }, "smos-calendar-import": { "_type": "derivation", "name": "smos-calendar-import-0.6.0" }, "smos-client": { "_type": "derivation", "name": "smos-client-0.5.1" }, "smos-cursor": { "_type": "derivation", "name": "smos-cursor-0.5.0" }, "smos-cursor-gen": { "_type": "derivation", "name": "smos-cursor-gen-0.2.1" }, "smos-data": { "_type": "derivation", "name": "smos-data-0.5.0" }, "smos-data-gen": { "_type": "derivation", "name": "smos-data-gen-0.3.2" }, "smos-docs-site": { "_type": "derivation", "name": "smos-docs-site-0.0.0" }, "smos-github": { "_type": "derivation", "name": "smos-github-0.5.1" }, "smos-notify": { "_type": "derivation", "name": "smos-notify-0.2.1" }, "smos-query": { "_type": "derivation", "name": "smos-query-0.8.0" }, "smos-report": { "_type": "derivation", "name": "smos-report-0.9.0" }, "smos-report-cursor": { "_type": "derivation", "name": "smos-report-cursor-0.3.0" }, "smos-report-cursor-gen": { "_type": "derivation", "name": "smos-report-cursor-gen-0.2.0" }, "smos-report-gen": { "_type": "derivation", "name": "smos-report-gen-0.4.3" }, "smos-scheduler": { "_type": "derivation", "name": "smos-scheduler-0.5.0" }, "smos-server": { "_type": "derivation", "name": "smos-server-0.10.0" }, "smos-server-gen": { "_type": "derivation", "name": "smos-server-gen-0.6.0" }, "smos-single": { "_type": "derivation", "name": "smos-single-0.2.1" }, "smos-stripe-client": { "_type": "derivation", "name": "smos-stripe-client-0.1.0.0" }, "smos-sync-client": { "_type": "derivation", "name": "smos-sync-client-0.4.3" }, "smos-sync-client-gen": { "_type": "derivation", "name": "smos-sync-client-gen-0.4.0" }, "smos-web-server": { "_type": "derivation", "name": "smos-web-server-0.9.0" }, "smos-web-style": { "_type": "derivation", "name": "smos-web-style-0.0.2" } }


programs.smos.sync

Periodic local backups of the workflow directory

Type: null or submodule


programs.smos.sync.enable

Whether to enable Smos syncing.

Type: boolean

Default: false

Example: true


programs.smos.sync.password

The password to use when logging into the sync server

Type: string

Example: "hunter12"


programs.smos.sync.server-url

The url of the sync server

Type: string

Example: "api.smos.cs-syd.eu"


programs.smos.sync.username

The username to use when logging into the sync server

Type: string

Example: "syd"


programs.smos.workflowDir

Smos' workflow directory

Type: string

Default: "/home/user/workflow"