Options
services.nix-ci.production.cache.bind-host
The host to bind the server on
Type:
null or string
Default:
null
services.nix-ci.production.cache.config
This option has no description.
Type:
submodule
Default:
{ }
services.nix-ci.production.cache.config.access-precision
Minimal differenc for an access time update. Increase this to reduce database load at the cost of less accurate access times.
Type:
null or string or signed integer
Default: Unspecified, interpreted as "1h"
services.nix-ci.production.cache.config.auth
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.auth.nix-ci
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.auth.nix-ci.leader-api
The base URL of the NixCI leader API for auth
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.auth.nix-ci.leader-web
The base URL of the NixCI leader web UI for documentation links
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.auth.static
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.auth.static.users
A map of user -> password combinations that are allowed to read from the cache, but not write
Type:
null or (attribute set of (submodule))
Default: Unspecified, interpreted as { }
services.nix-ci.production.cache.config.auth.static.users.<name>.password
The password in plain text
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.auth.static.users.<name>.password-file
A file containing the password
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.auth.static.users.<name>.read
Whether this user is allowed to read from the cache
Type:
null or (list of string) or value "all" (singular enum)
Default: Unspecified
services.nix-ci.production.cache.config.auth.static.users.<name>.write
Whether this user is allowed to write to the cache
Type:
null or string or value "global" (singular enum)
Default: Unspecified
services.nix-ci.production.cache.config.chunk-collector
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.chunk-collector.enable
enable the chunk-collector looper
Type:
null or boolean
Default: Unspecified
services.nix-ci.production.cache.config.chunk-collector.period
period of the chunk-collector looper in seconds
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 3600
services.nix-ci.production.cache.config.chunk-collector.phase
phase of the chunk-collector looper in seconds
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 2400
services.nix-ci.production.cache.config.chunk-size
The chunk size to use when uploading/downloading files (in bytes)
Type:
null or signed integer
Default: Unspecified, interpreted as 131072
services.nix-ci.production.cache.config.chunks-per-page
The number of chunks to fetch in each page for fetches
Type:
null or signed integer
Default: Unspecified, interpreted as 4
services.nix-ci.production.cache.config.database
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.database.postgresql
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.database.postgresql.connections
The maximum number of connections in the pool
Type:
null or signed integer
Default: Unspecified, interpreted as 16
services.nix-ci.production.cache.config.database.postgresql.database
The database name to connect to PostgreSQL with
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-cache"
services.nix-ci.production.cache.config.database.postgresql.host
The host of the PostgreSQL server
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.password
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.password-file
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.port
The port of the PostgreSQL server
Type:
null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default: Unspecified, interpreted as 5432
services.nix-ci.production.cache.config.database.postgresql.read-replica
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.database.postgresql.read-replica.database
The database name to connect to PostgreSQL with
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-cache"
services.nix-ci.production.cache.config.database.postgresql.read-replica.host
The host of the PostgreSQL server
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.read-replica.password
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.read-replica.password-file
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.read-replica.port
The port of the PostgreSQL server
Type:
null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default: Unspecified, interpreted as 5432
services.nix-ci.production.cache.config.database.postgresql.read-replica.sslcert
Path to the client SSL certificate
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.read-replica.sslkey
Path to the client SSL private key
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.read-replica.sslmode
The SSL mode for the PostgreSQL connection (disable, allow, prefer, require, verify-ca, verify-full)
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.read-replica.sslrootcert
Path to the root SSL certificate for server verification
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.read-replica.user
The user to connect to PostgreSQL as
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-cache"
services.nix-ci.production.cache.config.database.postgresql.session
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.database.postgresql.session.database
The database name to connect to PostgreSQL with
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-cache"
services.nix-ci.production.cache.config.database.postgresql.session.host
The host of the PostgreSQL server
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.session.password
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.session.password-file
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.session.port
The port of the PostgreSQL server
Type:
null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default: Unspecified, interpreted as 5432
services.nix-ci.production.cache.config.database.postgresql.session.sslcert
Path to the client SSL certificate
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.session.sslkey
Path to the client SSL private key
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.session.sslmode
The SSL mode for the PostgreSQL connection (disable, allow, prefer, require, verify-ca, verify-full)
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.session.sslrootcert
Path to the root SSL certificate for server verification
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.session.user
The user to connect to PostgreSQL as
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-cache"
services.nix-ci.production.cache.config.database.postgresql.sslcert
Path to the client SSL certificate
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.sslkey
Path to the client SSL private key
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.sslmode
The SSL mode for the PostgreSQL connection (disable, allow, prefer, require, verify-ca, verify-full)
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.sslrootcert
Path to the root SSL certificate for server verification
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.transaction
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.database.postgresql.transaction.database
The database name to connect to PostgreSQL with
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-cache"
services.nix-ci.production.cache.config.database.postgresql.transaction.host
The host of the PostgreSQL server
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.transaction.password
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.transaction.password-file
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.transaction.port
The port of the PostgreSQL server
Type:
null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default: Unspecified, interpreted as 5432
services.nix-ci.production.cache.config.database.postgresql.transaction.sslcert
Path to the client SSL certificate
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.transaction.sslkey
Path to the client SSL private key
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.transaction.sslmode
The SSL mode for the PostgreSQL connection (disable, allow, prefer, require, verify-ca, verify-full)
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.transaction.sslrootcert
Path to the root SSL certificate for server verification
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.database.postgresql.transaction.user
The user to connect to PostgreSQL as
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-cache"
services.nix-ci.production.cache.config.database.postgresql.user
The user to connect to PostgreSQL as
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-cache"
services.nix-ci.production.cache.config.download-claim-refresh-interval
How often a download in progress records that it is still going, so the garbage collector leaves what it reads alone. Lower means more database writes per download; higher keeps a finished download's path protected for longer.
Type:
null or string or signed integer
Default: Unspecified, interpreted as "10m"
services.nix-ci.production.cache.config.garbage-collector
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.garbage-collector.abandoned-upload-threshold
How long after it started an unfinished upload counts as abandoned and is collected. An upload that takes longer than this is deleted while it is still in progress. Must be longer than 0s.
Type:
null or string or signed integer
Default: Unspecified, interpreted as "1d"
services.nix-ci.production.cache.config.garbage-collector.age
Only GC paths registered longer than this much time ago
Type:
null or string or signed integer
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.batch-size
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.garbage-collector.batch-size.abandoned-uploads
How many nar paths of abandoned uploads each garbage collection step reads, and deletes, between pauses. Defaults to rows. Must be positive.
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.batch-size.chunks
How many orphaned chunks one garbage collection statement deletes. Must be positive.
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified, interpreted as 1024
services.nix-ci.production.cache.config.garbage-collector.batch-size.expired
How many nar paths past the maximum age each garbage collection step reads, and deletes, between pauses. Defaults to rows. Must be positive.
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.batch-size.missing-narinfo
How many nar paths without a narinfo each garbage collection step reads, and deletes, between pauses. Defaults to rows. Must be positive.
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.batch-size.nars
How many nars whose uploads no nar path points to each garbage collection step reads, and deletes, between pauses. Defaults to rows. Must be positive.
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.batch-size.orphaned-nars
How many nars without any upload each garbage collection step reads, and deletes, between pauses. Defaults to rows. Must be positive.
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.batch-size.orphaned-uploads
How many orphaned uploads each garbage collection step reads, and deletes, between pauses. Defaults to rows. Must be positive.
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.batch-size.owners
How many owners without nar paths each garbage collection step reads, and deletes, between pauses. Defaults to rows. Must be positive.
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.batch-size.redirects
How many unserved redirects each garbage collection step reads, and deletes, between pauses. Defaults to rows. Must be positive.
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.batch-size.rows
How many rows each garbage collection step reads, and deletes, between pauses, in every collection whose own batch size is not configured. Must be positive.
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified, interpreted as 100
services.nix-ci.production.cache.config.garbage-collector.batch-size.size-limits
How many nar paths over a size limit each garbage collection step reads, and deletes, between pauses. Defaults to rows. Must be positive.
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.batch-size.unreachable-paths
How many unreachable nar paths one garbage collection statement cuts the inbound references of. A nar path can be referred to by many others, so a statement can delete many times as many references. Must be positive.
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified, interpreted as 500
services.nix-ci.production.cache.config.garbage-collector.chunk-workers
How many workers delete orphaned chunks at once, each through a database connection of its own beyond the first, and each pausing for delay between its own batches. Must be at least 1.
Type:
null or signed integer
Default: Unspecified, interpreted as 1
services.nix-ci.production.cache.config.garbage-collector.delay
Delay between garbage collection deletions. Increase to GC more slowly for less internal load.
Type:
null or string or signed integer
Default: Unspecified, interpreted as "0s"
services.nix-ci.production.cache.config.garbage-collector.enable
enable the garbage-collector looper
Type:
null or boolean
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.max-age
Unconditionally delete any cache entry older than this many seconds, regardless of cache size. Must be at least abandoned-upload-threshold, because it deletes uploads in progress too.
Type:
null or string or signed integer
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.max-chunk-batch-conflicts
How many chunk deletions in a row, aborted by an upload referring to one of their chunks, the garbage collector retries before it leaves the chunks to its next pass. Zero gives up at the first.
Type:
null or signed integer
Default: Unspecified, interpreted as 10
services.nix-ci.production.cache.config.garbage-collector.missing-narinfo-threshold
How old a nar path that no narinfo points to must be before it is collected. A client uploads the narinfo after the nar, so this must be at least abandoned-upload-threshold.
Type:
null or string or signed integer
Default: Unspecified, interpreted as "1d"
services.nix-ci.production.cache.config.garbage-collector.orphaned-upload-threshold
How old an upload that no nar path points to must be before it is collected. An upload is orphaned while it is still in progress when another upload of the same path replaces it, so this must be at least abandoned-upload-threshold.
Type:
null or string or signed integer
Default: Unspecified, interpreted as "1d"
services.nix-ci.production.cache.config.garbage-collector.per-owner-size
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.garbage-collector.per-owner-size.max
Hard cap, in bytes of the NARs that nar paths still reach, that the GC evicts down to regardless of the age/unused thresholds. Reached exactly per-account; the whole-cache cap can take more than one run when nar paths share a NAR.
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.per-owner-size.target
Soft target size, in bytes of the NARs that nar paths still reach: the GC aims to stay below this, evicting only entries past the age/unused thresholds
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.period
period of the garbage-collector looper in seconds
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 3600
services.nix-ci.production.cache.config.garbage-collector.phase
phase of the garbage-collector looper in seconds
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 0
services.nix-ci.production.cache.config.garbage-collector.redirect-min-age
How old a redirect to an upstream cache must be before it can be collected for not being served.
Type:
null or string or signed integer
Default: Unspecified, interpreted as "1d"
services.nix-ci.production.cache.config.garbage-collector.redirect-unserved-for
How long a redirect to an upstream cache must have gone unserved before it is collected.
Type:
null or string or signed integer
Default: Unspecified, interpreted as "1d"
services.nix-ci.production.cache.config.garbage-collector.size
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.garbage-collector.size.max
Hard cap, in bytes of the NARs that nar paths still reach, that the GC evicts down to regardless of the age/unused thresholds. Reached exactly per-account; the whole-cache cap can take more than one run when nar paths share a NAR.
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.size.target
Soft target size, in bytes of the NARs that nar paths still reach: the GC aims to stay below this, evicting only entries past the age/unused thresholds
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.garbage-collector.unused
Only GC paths that have not been used for this much time
Type:
null or string or signed integer
Default: Unspecified
services.nix-ci.production.cache.config.host-preference
Host preference for binding to serve requests
Type:
null or string
Default: Unspecified, interpreted as "*6"
services.nix-ci.production.cache.config.log-level
Minimal severity of log messages
Type:
null or one of "Debug", "Info", "Warn", "Error"
Default: Unspecified, interpreted as "Info"
services.nix-ci.production.cache.config.max-upload-size
Hard upper limit on the size of a single uploaded or pulled-through NAR; reject anything larger
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.orphan-collector
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.orphan-collector.enable
enable the orphan-collector looper
Type:
null or boolean
Default: Unspecified
services.nix-ci.production.cache.config.orphan-collector.period
period of the orphan-collector looper in seconds
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 3600
services.nix-ci.production.cache.config.orphan-collector.phase
phase of the orphan-collector looper in seconds
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 1200
services.nix-ci.production.cache.config.port
The port to serve requests on
Type:
null or signed integer
Default: Unspecified, interpreted as 8000
services.nix-ci.production.cache.config.processor
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.processor.batch-size
How many narinfos the processor reads from the database at a time
Type:
null or signed integer
Default: Unspecified, interpreted as 10
services.nix-ci.production.cache.config.processor.delay
Delay between processing nars. Increase this to process more slowly for less internal load.
Type:
null or string or signed integer
Default: Unspecified, interpreted as "0s"
services.nix-ci.production.cache.config.processor.enable
enable the processor looper
Type:
null or boolean
Default: Unspecified
services.nix-ci.production.cache.config.processor.period
period of the processor looper in seconds
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 60
services.nix-ci.production.cache.config.processor.phase
phase of the processor looper in seconds
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 0
services.nix-ci.production.cache.config.send-stall-timeout
How many seconds a request may go without sending before its connection is closed. Raise this if clients that pause reading during a build have their downloads cut off.
Type:
null or signed integer
Default: Unspecified, interpreted as 600
services.nix-ci.production.cache.config.signing-key
Paths to Nix signing secret key files for on-the-fly narinfo signing
Type:
null or string or list of string
Default: Unspecified, interpreted as []
services.nix-ci.production.cache.config.upstream
Upstream binary caches to redirect to on cache miss
Type:
null or (submodule) or list of (submodule)
Default: Unspecified, interpreted as []
services.nix-ci.production.cache.config.version
The version tag to display: Use a git commit hash if you can!
Type:
null or string
Default: Unspecified
services.nix-ci.production.cache.config.watchdog-notifier
This option has no description.
Type:
submodule
services.nix-ci.production.cache.config.watchdog-notifier.enable
enable the watchdog-notifier looper
Type:
null or boolean
Default: Unspecified
services.nix-ci.production.cache.config.watchdog-notifier.period
period of the watchdog-notifier looper in seconds
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 30
services.nix-ci.production.cache.config.watchdog-notifier.phase
phase of the watchdog-notifier looper in seconds
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 0
services.nix-ci.production.cache.config.worker-queue-size
The number of workers to use for burstier performance. Make this bigger for better worst-case performance, at a cost of more memory usage.
Type:
null or signed integer
Default: Unspecified, interpreted as 1000
services.nix-ci.production.cache.enable
Enable the NixCI Cache
Type:
boolean
Default:
true
Example:
false
services.nix-ci.production.cache.enableSettingsCheck
Enable a static settings check. Turn this off if your system has secrets that are provisioned at runtime.
Type:
boolean
Default:
true
services.nix-ci.production.cache.extraConfig
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:
unspecified value
Default:
{ }
services.nix-ci.production.cache.hosts
The host to serve requests on
Type:
list of string
Default:
[ ]
Example:
"cache.nix-ci.com"
services.nix-ci.production.cache.openFirewall
Whether to open the specified ports in the firewall
Type:
boolean
Default:
false
services.nix-ci.production.cache.recommendedOSSettings
Enable recommended OS settings.
Type:
boolean
Default:
true
Example:
false
services.nix-ci.production.cache.state-dir
State directory of the cache, as a subdirectory
Type:
null or string
Default:
"production/cache/"
services.nix-ci.production.cache.working-dir
Working directory of the cache, a relative path that will be the RuntimeDirectory of the cache.
Type:
string
Default:
"nix-ci-production-cache"