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

services.muchsync.package

The muchsync package to use.

Type: package

Default:

pkgs.muchsync

Declared by:

services.muchsync.remotes

Muchsync remotes to synchronise with.

Type: attribute set of (submodule)

Default:

{ }

Example:

{
  server = {
    frequency = "*:0/10";
    remote = {
      host = "server.tld";
    };
  };
}

Declared by:

services.muchsync.remotes.<name>.frequency

How often to run muchsync. This value is passed to the systemd timer configuration as the OnCalendar option. See systemd.time(7) for more information about the format.

Type: string

Default:

"*:0/5"

Declared by:

services.muchsync.remotes.<name>.local.checkForModifiedFiles

Check for locally modified files. Without this option, muchsync assumes that files in a maildir are never edited.

checkForModifiedFiles disables certain optimizations so as to make muchsync at least check the timestamp on every file, which will detect modified files at the cost of a longer startup time.

This option is useful if your software regularly modifies the contents of mail files (e.g., because you are running offlineimap with “synclabels = yes”).

Type: boolean

Default:

false

Declared by:

services.muchsync.remotes.<name>.local.importNew

Whether to begin the synchronisation by running notmuch new locally.

Type: boolean

Default:

true

Declared by:

services.muchsync.remotes.<name>.remote.checkForModifiedFiles

Check for modified files on the remote side. Without this option, muchsync assumes that files in a maildir are never edited.

checkForModifiedFiles disables certain optimizations so as to make muchsync at least check the timestamp on every file, which will detect modified files at the cost of a longer startup time.

This option is useful if your software regularly modifies the contents of mail files (e.g., because you are running offlineimap with “synclabels = yes”).

Type: boolean

Default:

false

Declared by:

services.muchsync.remotes.<name>.remote.host

Remote SSH host to synchronize with.

Type: string

Declared by:

services.muchsync.remotes.<name>.remote.importNew

Whether to begin the synchronisation by running notmuch new on the remote side.

Type: boolean

Default:

true

Declared by:

services.muchsync.remotes.<name>.remote.muchsyncPath

Specifies the path to muchsync on the server. Ordinarily, muchsync should be in the default PATH on the server so this option is not required. However, this option is useful if you have to install muchsync in a non-standard place or wish to test development versions of the code.

Type: string

Default:

"$PATH/muchsync"

Declared by:

services.muchsync.remotes.<name>.sshCommand

Specifies a command line to pass to /bin/sh to execute a command on another machine.

Note that because this string is passed to the shell, special characters including spaces may need to be escaped.

Type: string

Default:

"ssh -CTaxq"

Declared by:

services.muchsync.remotes.<name>.upload

Whether to propagate local changes to the remote.

Type: boolean

Default:

true

Declared by: