Table of Contents
Defined in /modules/services/pinchflat.nix.
This NixOS module is a service that sets up a Pinchflat instance.
Compared to the stock module from nixpkgs, this one sets up, in a fully declarative manner, LDAP and SSO integration and has a nicer option for secrets.
The following snippet assumes a few blocks have been setup already:
the secrets block with SOPS,
the shb.ssl block,
the shb.lldap block.
the shb.authelia block.
shb.pinchflat = {
enable = true;
secretKeyBase.result = config.shb.sops.secret."pinchflat/secretKeyBase".result;
timeZone = "Europe/Brussels";
mediaDir = "/srv/pinchflat";
domain = "example.com";
subdomain = "pinchflat";
ssl = config.shb.certs.certs.letsencrypt.${domain};
ldap = {
enable = true;
};
sso = {
enable = true;
authEndpoint = "https://${config.shb.authelia.subdomain}.${config.shb.authelia.domain}";
};
};
shb.sops.secret."pinchflat/secretKeyBase".request = config.shb.pinchflat.secretKeyBase.request;
Secrets can be randomly generated with nix run nixpkgs#openssl -- rand -hex 64.
The user LDAP group is created automatically.
Backing up Pinchflat using the Restic block is done like so:
shb.restic.instances."pinchflat" = {
request = config.shb.pinchflat.backup;
settings = {
enable = true;
};
};
The name "pinchflat" in the instances can be anything.
The config.shb.pinchflat.backup option provides what directories to backup.
You can define any number of Restic instances to backup Pinchflat multiple times.
shb.pinchflat.enable
Whether to enable the Pinchflat service…
Type: boolean
Default:
false
Example:
true
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.backup
Backup media directory shb.mediaDir.
Type: submodule
Default:
{ }
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.backup.request
Request part of the backup contract.
Options set by the requester module enforcing how to backup files.
Type: submodule
Default: { user = pinchflat; sourceDirectories = [ config.shb.pinchflat.mediaDir ]; excludePatterns = [ ]; hooks.beforeBackup = [ ]; hooks.afterBackup = [ ]; };
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.backup.request.excludePatterns
File patterns to exclude.
Type: list of string
Default:
[ ]
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.backup.request.hooks
Hooks to run around the backup.
Type: submodule
Default:
{ }
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.backup.request.hooks.afterBackup
Hooks to run after backup.
Type: list of string
Default:
[ ]
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.backup.request.hooks.beforeBackup
Hooks to run before backup.
Type: list of string
Default:
[ ]
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.backup.request.sourceDirectories
Directories to backup.
Type: non-empty (list of string)
Default: [ config.shb.pinchflat.mediaDir ]
Example:
"/var/lib/vaultwarden"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.backup.request.user
Unix user doing the backups.
Type: string
Default:
"pinchflat"
Example:
"vaultwarden"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.backup.result
Result part of the backup contract.
Options set by the provider module that indicates the name of the backup and restor scripts.
Type: submodule
Default:
""
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.backup.result.backupService
Name of service backing up the database.
This script can be ran manually to backup the database:
$ systemctl start backup.service
Type: string
Default:
"backup.service"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.backup.result.restoreScript
Name of script that can restore the database. One can then list snapshots with:
$ restore snapshots
And restore the database with:
$ restore restore latest
Type: string
Default:
"restore"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.domain
domain under which Pinchflat will be served.
Type: string
Example:
"mydomain.com"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.ldap
Setup LDAP integration.
Type: submodule
Default:
{ }
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.ldap.enable
Whether to enable LDAP integration…
Type: boolean
Default:
false
Example:
true
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.ldap.userGroup
Group users must belong to be able to login.
Type: string
Default:
"pinchflat_user"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.mediaDir
Path where videos are stored.
Type: string
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.port
Port Pinchflat listens to incoming requests.
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8945
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.secretKeyBase
Used to sign/encrypt cookies and other secrets.
Make sure the secret is at least 64 characters long.
Type: submodule
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.secretKeyBase.request
Request part of the secret contract.
Options set by the requester module enforcing some properties the secret should have.
Type: submodule
Default:
""
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.secretKeyBase.request.group
Linux group owning the secret file.
Type: string
Default:
"root"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.secretKeyBase.request.mode
Mode of the secret file.
Type: string
Default:
"0400"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.secretKeyBase.request.owner
Linux user owning the secret file.
Type: string
Default:
"root"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.secretKeyBase.request.restartUnits
Systemd units to restart after the secret is updated.
Type: list of string
Default:
[
"pinchflat.service"
]
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.secretKeyBase.result
Result part of the secret contract.
Options set by the provider module that indicates where the secret can be found.
Type: submodule
Default:
{
path = "/run/secrets/secret";
}
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.secretKeyBase.result.path
Path to the file containing the secret generated out of band.
This path will exist after deploying to a target host, it is not available through the nix store.
Type: absolute path
Default:
"/run/secrets/secret"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.ssl
Path to SSL files
Type: null or (anything)
Default:
null
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.ssl.paths
Paths where the files for the certificate will be located.
This option is the contract output of the shb.certs.certs SSL block.
Type: anything
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.ssl.paths.cert
Path to the cert file.
Type: absolute path
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.ssl.paths.key
Path to the key file.
Type: absolute path
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.ssl.systemdService
Systemd oneshot service used to generate the certificate. Ends with the .service suffix.
Use this if downstream services must wait for the certificates to be generated before starting.
Type: string
Example:
"cert-generator.service"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.sso
Setup SSO integration.
Type: submodule
Default:
{ }
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.sso.enable
Whether to enable SSO integration…
Type: boolean
Default:
false
Example:
true
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.sso.authEndpoint
Endpoint to the SSO provider. Leave null to not have SSO configured.
Type: null or string
Default:
null
Example:
"https://authelia.example.com"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.sso.authorization_policy
Require one factor (password) or two factor (device) authentication.
Type: one of “one_factor”, “two_factor”
Default:
"one_factor"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.subdomain
Subdomain under which Pinchflat will be served.
Type: string
Default:
"pinchflat"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|
shb.pinchflat.timeZone
Timezone of this instance.
Type: string or (submodule)
Example:
"America/Los_Angeles"
Declared by:
<selfhostblocks/modules/services/pinchflat.nix>
|