Options
services.nix-ci.production.background.config
The configuration of the background workers. Nothing is taken from the leader's configuration, so the settings the background workers share with the leader, such as the database, the workers, the forges and the approots, have to be given here too. A block they share is read the same way by both, so one without secrets can be inherited from the leader's configuration; the secrets inside a block are read only by the processes that use them, and from files of their own.
Type:
submodule
Default:
{ }
services.nix-ci.production.background.config.api
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.api.approot
Where the API is reached from outside: where links to it and the webhooks registered with the forges point, unless a forge's settings name a webhook URL of their own. Required by the background workers, which make those.
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.api.host-preference
Host preference for binding to serve API requests
Type:
null or string
Default: Unspecified, interpreted as "*6"
services.nix-ci.production.background.config.api.port
The port to serve API requests on
Type:
null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default: Unspecified, interpreted as 8000
services.nix-ci.production.background.config.background-job-poll-interval
How long a background worker waits for an announced job before looking at the queue anyway. The floor under job latency whenever nothing announces a job.
Type:
null or string or signed integer
Default: Unspecified, interpreted as "1m"
services.nix-ci.production.background.config.background-worker-count
Number of background worker threads that take every job type, at least 1. Pinned workers beside them each take only some job types.
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified, interpreted as 4
services.nix-ci.production.background.config.changelog-dir
The changelog of this release: a directory with an entries/ directory of markdown entries in it. The version of the newest entry is the release this process reports itself as running.
Type:
null or string
Default: Unspecified, interpreted as "changelog"
services.nix-ci.production.background.config.cloudflare-access
Authenticate the people using the web interface with Cloudflare Access instead of with accounts here, or null to use accounts here. Required, so that either is a decision. A person's web request has to carry a Cf-Access-Jwt-Assertion for the configured Cloudflare Access application, and the person's Cloudflare Access groups decide what they may do. A request without one may instead carry a token from a federated OIDC issuer, and gets what its rule grants on the repositories it names, as it would without Cloudflare Access. That holds whether or not the request came through Cloudflare Access, so Cloudflare Access is not the only way into the web interface. Forge login, local accounts, sessions, Basic Auth, NixCI API tokens and OIDC rules that grant a local account are not accepted on the web interface. Nobody gets a NixCI account this way, so account pages, API tokens and impersonation are not available there, and a license report counts every pusher as a seat. The API, workers, webhooks and the cache authenticate as they otherwise would.
Type:
null or (submodule)
services.nix-ci.production.background.config.cloudflare-access.admin-groups
Cloudflare Access groups whose members may also use the admin panel. Matched in the same way as the member groups.
Type:
list of string
Required when services.nix-ci.production.background.config.cloudflare-access
is specified
services.nix-ci.production.background.config.cloudflare-access.audience
The Application Audience (AUD) tag of the Cloudflare Access application in front of this leader. A token is accepted only if its aud claim holds this. That is what stops a token issued for another application of the same team being replayed against this leader.
Type:
string
Required when services.nix-ci.production.background.config.cloudflare-access
is specified
services.nix-ci.production.background.config.cloudflare-access.member-groups
Cloudflare Access groups whose members may read and change every repository on this leader, private ones and their secrets included. Matched exactly against the group names Cloudflare's get-identity endpoint lists for the person. Somebody in none of these groups and none of the admin groups is refused.
Type:
list of string
Required when services.nix-ci.production.background.config.cloudflare-access
is specified
services.nix-ci.production.background.config.cloudflare-access.team-name
The Cloudflare Zero Trust team name. The part of the team domain before .cloudflareaccess.com. The issuer, its keys and each person's groups are fetched from that domain over https, never from anywhere a token names.
Type:
string
Required when services.nix-ci.production.background.config.cloudflare-access
is specified
services.nix-ci.production.background.config.codeberg
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.codeberg.instance
The Codeberg instance: codeberg.org most likely
Type:
null or string
Default: Unspecified, interpreted as "codeberg.org"
services.nix-ci.production.background.config.codeberg.integration
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.codeberg.integration.hook-url
The hook url for contacting nix-ci from codeberg.
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.codeberg.integration.title-prefix
Optional prefix for Codeberg commit status titles (e.g., 'nix-ci-staging')
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.codeberg.oauth
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.codeberg.oauth.client-id
The client identifier
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.codeberg.oauth.client-secret
The client secret
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.codeberg.oauth.client-secret-file
The client secret
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.codeberg.suites
Which webhook events trigger a suite for Codeberg repositories
Type:
null or (submodule)
Default: Unspecified, interpreted as { push = true; }
services.nix-ci.production.background.config.codeberg.suites.push
Which pushes build a suite: true, false, or which branches and tags to build
Type:
boolean or (submodule)
Default:
true
services.nix-ci.production.background.config.database
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.database.postgresql
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.database.postgresql.connections
The maximum number of connections in the pool
Type:
null or signed integer
Default: Unspecified, interpreted as 8
services.nix-ci.production.background.config.database.postgresql.database
The database name to connect to PostgreSQL with
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-leader"
services.nix-ci.production.background.config.database.postgresql.host
The host of the PostgreSQL server
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.idle-in-transaction-timeout
How long any of this process's sessions may leave a transaction open without running a statement before PostgreSQL ends the session, releasing its locks. Too short ends transactions that are waiting on something other than the database; too long lets a forgotten transaction hold its locks. A duration, or off. Must be off when a transaction pooler is configured.
Type:
null or string or signed integer or value "off" (singular enum)
Default: Unspecified, interpreted as "5m"
services.nix-ci.production.background.config.database.postgresql.lock-timeout
How long a statement on this process's pools may wait for a lock before PostgreSQL cancels it. Too short fails requests that wait behind an ordinary transaction; too long lets requests pile up behind one that has stopped. A duration, or off. Must be off when a transaction pooler is configured.
Type:
null or string or signed integer or value "off" (singular enum)
Default: Unspecified, interpreted as "10s"
services.nix-ci.production.background.config.database.postgresql.password
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.password-file
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.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.background.config.database.postgresql.read-replica
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.database.postgresql.read-replica.database
The database name to connect to PostgreSQL with
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-leader"
services.nix-ci.production.background.config.database.postgresql.read-replica.host
The host of the PostgreSQL server
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.read-replica.password
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.read-replica.password-file
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.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.background.config.database.postgresql.read-replica.sslcert
Path to the client SSL certificate
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.read-replica.sslkey
Path to the client SSL private key
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.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.background.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.background.config.database.postgresql.read-replica.user
The user to connect to PostgreSQL as
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-leader"
services.nix-ci.production.background.config.database.postgresql.session
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.database.postgresql.session.database
The database name to connect to PostgreSQL with
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-leader"
services.nix-ci.production.background.config.database.postgresql.session.host
The host of the PostgreSQL server
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.session.password
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.session.password-file
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.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.background.config.database.postgresql.session.sslcert
Path to the client SSL certificate
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.session.sslkey
Path to the client SSL private key
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.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.background.config.database.postgresql.session.sslrootcert
Path to the root SSL certificate for server verification
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.session.user
The user to connect to PostgreSQL as
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-leader"
services.nix-ci.production.background.config.database.postgresql.sslcert
Path to the client SSL certificate
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.sslkey
Path to the client SSL private key
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.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.background.config.database.postgresql.sslrootcert
Path to the root SSL certificate for server verification
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.statement-timeout
How long a statement on this process's pools may run before PostgreSQL cancels it. Not applied to the sessions that hold a looper's lock, whose garbage collection sweeps may run long. Too short fails requests whose queries are merely slow, which restarts the workers whose poll fails; too long lets a stuck statement hold its connection and its locks. A duration, or off. Must be off when a transaction pooler is configured.
Type:
null or string or signed integer or value "off" (singular enum)
Default: Unspecified, interpreted as "30s"
services.nix-ci.production.background.config.database.postgresql.transaction
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.database.postgresql.transaction.database
The database name to connect to PostgreSQL with
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-leader"
services.nix-ci.production.background.config.database.postgresql.transaction.host
The host of the PostgreSQL server
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.transaction.password
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.transaction.password-file
The password to connect to PostgreSQL with
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.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.background.config.database.postgresql.transaction.sslcert
Path to the client SSL certificate
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.transaction.sslkey
Path to the client SSL private key
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.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.background.config.database.postgresql.transaction.sslrootcert
Path to the root SSL certificate for server verification
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.database.postgresql.transaction.user
The user to connect to PostgreSQL as
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-leader"
services.nix-ci.production.background.config.database.postgresql.user
The user to connect to PostgreSQL as
Type:
null or string
Default: Unspecified, interpreted as "nix-ci-leader"
services.nix-ci.production.background.config.forge-breaker-reporter
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.forge-breaker-reporter.enable
enable the forge-breaker-reporter looper
Type:
null or boolean
Default: Unspecified
services.nix-ci.production.background.config.forge-breaker-reporter.period
period of the forge-breaker-reporter looper in seconds
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 5
services.nix-ci.production.background.config.forge-breaker-reporter.phase
phase of the forge-breaker-reporter looper in seconds
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 0
services.nix-ci.production.background.config.github
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.github.instance
The GitHub instance: github.com most likely
Type:
null or string
Default: Unspecified, interpreted as "github.com"
services.nix-ci.production.background.config.github.integration
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.github.integration.app-id
The application identifier
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.github.integration.app-slug
The application slug, used to build the installation configuration URL
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.github.integration.private-key
The private key file
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.github.integration.private-key-file
The private key file
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.github.merge-wait-window
How long to go on asking GitHub what a pull request's merge is before giving up and reporting that on the pull request. GitHub generates a trial merge on its own schedule and announces it with no event, so this is a wait on somebody else's work rather than on ours. Longer means a pull request whose merge GitHub is slow to produce still gets built; shorter means it is told sooner that it will not be.
Type:
null or string or signed integer
Default: Unspecified, interpreted as "15m"
services.nix-ci.production.background.config.github.oauth
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.github.oauth.client-id
The client identifier
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.github.oauth.client-secret
The client secret file
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.github.oauth.client-secret-file
The client secret file
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.github.requests-per-hour
How many requests an hour to pace any one GitHub App installation at until GitHub says what that installation is allowed. GitHub says so in a header on every answer, so this is only the assumption the first call is paced at, and only lasts for an installation whose answers never carry one. Must be positive.
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified, interpreted as 4500
services.nix-ci.production.background.config.github.suites
Which webhook events trigger a suite for GitHub repositories
Type:
null or (submodule)
Default: Unspecified, interpreted as { branch-pushes = "when-no-pr"; merge-group = true; pull-request-head = "when-no-merge-ref"; pull-request-merge = false; push = true; }
services.nix-ci.production.background.config.github.suites.branch-pushes
Whether a branch push keeps its own suite when a pull request suite stands for the commit it pushed: 'when-no-pr' or 'always'.
Type:
string
Default:
"when-no-pr"
services.nix-ci.production.background.config.github.suites.merge-group
Build the commit a merge queue asks for checks on
Type:
boolean
Default:
true
services.nix-ci.production.background.config.github.suites.pull-request-head
Build the head-commit suite of a pull request: true, false, or 'when-no-merge-ref'. The default builds the head only where the pull request will have no merge-commit suite, so that it is built once whichever way pull-request-merge is set.
Type:
string or boolean
Default:
"when-no-merge-ref"
services.nix-ci.production.background.config.github.suites.pull-request-merge
Build the merge a forge would make of a pull request, rather than the head somebody pushed. Off by default: a repository that rebases or fast-forwards lands the head commit itself, so the merge is a tree that never reaches its history and is built cold whenever the base has moved. Worth turning on for a repository that lands a merge commit, where the tree that lands is neither the head nor the base.
Type:
boolean
Default:
false
services.nix-ci.production.background.config.github.suites.push
Which pushes build a suite: true, false, or which branches and tags to build. The check suite GitHub creates for a push is governed by this too.
Type:
boolean or (submodule)
Default:
true
services.nix-ci.production.background.config.gitlab
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.gitlab.instance
The gitlab instance: gitlab.com most likely
Type:
null or string
Default: Unspecified, interpreted as "gitlab.com"
services.nix-ci.production.background.config.gitlab.integration
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.gitlab.integration.access-token-name
The name to use for GitLab access tokens created by nix-ci
Type:
null or string
Default: Unspecified, interpreted as "nix-ci"
services.nix-ci.production.background.config.gitlab.integration.hook-url
The hook url for contacting nix-ci from gitlab. Use this to override the default URL rendering using the approot.
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.gitlab.integration.title-prefix
Optional prefix for GitLab commit status titles (e.g., 'nix-ci-staging')
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.gitlab.minimum-access-level
The minimum GitLab repository access level required to use CI on a repo
Type:
null or string
Default: Unspecified, interpreted as "maintainer"
services.nix-ci.production.background.config.gitlab.oauth
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.gitlab.oauth.client-id
The client identifier
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.gitlab.oauth.client-secret
The client secret file
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.gitlab.oauth.client-secret-file
The client secret file
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.gitlab.suites
Which webhook events trigger a suite for GitLab repositories
Type:
null or (submodule)
Default: Unspecified, interpreted as { branch-pushes = "when-no-mr"; merge-request-merge = true; push = ":any"; }
services.nix-ci.production.background.config.gitlab.suites.branch-pushes
Whether a branch push keeps its own suite when a merge request suite stands for the commit it pushed: 'when-no-mr' or 'always'.
Type:
string
Default:
"when-no-mr"
services.nix-ci.production.background.config.gitlab.suites.merge-request-merge
Build the merge-commit suite of a merge request
Type:
boolean
Default:
true
services.nix-ci.production.background.config.gitlab.suites.push
Which branches build a suite when they are pushed: true, false, or the branches to run on
Type:
string or list of (value ":any" (singular enum) or value ":default" (singular enum) or value ":pull-requests" (singular enum) or value ":merge-requests" (singular enum) or string or value "any" (singular enum) or value "all" (singular enum) or value "default" (singular enum)) or (submodule) or boolean or one of ":any", ":default", ":pull-requests", ":merge-requests", "any", "all", "default"
Default:
":any"
services.nix-ci.production.background.config.http
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.http.circuit-breaker-degraded-window
How long after a failed request a dependency is still reported as degraded, even once requests are succeeding again. Zero reports only the circuit itself.
Type:
null or string or signed integer
Default: Unspecified, interpreted as "1h"
services.nix-ci.production.background.config.http.circuit-breaker-failure-threshold
Number of consecutive failed requests before the circuit breaker opens, which is also how many requests one call may spend on retries
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified, interpreted as 5
services.nix-ci.production.background.config.http.circuit-breaker-reset-timeout
How long the circuit breaker stays open before it admits a probe call. Must be positive.
Type:
null or string or signed integer
Default: Unspecified, interpreted as "30s"
services.nix-ci.production.background.config.license
This option has no description.
Type:
null or (submodule)
services.nix-ci.production.background.config.license.private-key
The leader private key this installation signs its reports with, from nix-ci-leader-keygen
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.license.private-key-file
The leader private key this installation signs its reports with, from nix-ci-leader-keygen
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.license.url
The API root of the NixCI to report usage to
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.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.background.config.metrics-port
The port to serve /metrics on. Every installation on a machine needs a port of its own.
Type:
null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default: Unspecified, interpreted as 8091
services.nix-ci.production.background.config.monetisation
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.monetisation.contact
Contact email address for sales inquiries
Type:
null or string
Default: Unspecified, interpreted as "sales@nix-ci.com"
services.nix-ci.production.background.config.monetisation.conversion-fee
Conversion fee, in CHF
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 0
services.nix-ci.production.background.config.monetisation.currencies
Currencies' settings
Type:
null or (attribute set of (submodule))
Default: Unspecified
services.nix-ci.production.background.config.monetisation.currencies.<name>.payment-details
Invoice 'Payment Details' section
Type:
unspecified value
Required in every item of services.nix-ci.production.background.config.monetisation.currencies
services.nix-ci.production.background.config.monetisation.currencies.<name>.quantisation-factor
Currency quantisation factor
Type:
32 bit unsigned integer; between 0 and 4294967295 (both inclusive)
Default:
100
services.nix-ci.production.background.config.monetisation.currency-risk
Currency risk
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 0
services.nix-ci.production.background.config.monetisation.customers
Customers
Type:
null or (attribute set of (submodule))
Default: Unspecified, interpreted as { }
services.nix-ci.production.background.config.monetisation.customers.<name>.currency
Customer's preferred currency
Type:
string
Required in every item of services.nix-ci.production.background.config.monetisation.customers
services.nix-ci.production.background.config.monetisation.customers.<name>.email
Email 'To' address
Type:
string
Required in every item of services.nix-ci.production.background.config.monetisation.customers
services.nix-ci.production.background.config.monetisation.customers.<name>.method
Charging method
Type:
submodule
Required in every item of services.nix-ci.production.background.config.monetisation.customers
services.nix-ci.production.background.config.monetisation.customers.<name>.method.flat-amount
Flat rate amount (only for flat-rate)
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.monetisation.customers.<name>.method.license-keys
Public keys this self-hosted customer signs its usage reports with
Type:
null or string or list of string
Default: Unspecified
services.nix-ci.production.background.config.monetisation.customers.<name>.method.repositories
Customer's repositories to charge for
Type:
null or (submodule)
services.nix-ci.production.background.config.monetisation.customers.<name>.method.repositories.codeberg
Codeberg owners
Type:
null or (list of string)
Default:
[ ]
services.nix-ci.production.background.config.monetisation.customers.<name>.method.repositories.github
GitHub owners
Type:
null or (list of string)
Default:
[ ]
services.nix-ci.production.background.config.monetisation.customers.<name>.method.repositories.gitlab
GitLab namespaces
Type:
null or (list of string)
Default:
[ ]
services.nix-ci.production.background.config.monetisation.customers.<name>.method.repositories.url
Url repos
Type:
null or (list of string)
Default:
[ ]
services.nix-ci.production.background.config.monetisation.customers.<name>.method.seats
Customer's amount of leader seats (only for hosted)
Type:
null or (unsigned integer, meaning >=0)
Default: Unspecified
services.nix-ci.production.background.config.monetisation.customers.<name>.method.type
Charging method type
Type:
string
Required when services.nix-ci.production.background.config.monetisation.customers.<name>.method
is specified
services.nix-ci.production.background.config.monetisation.customers.<name>.method.worker-discount
Customer's worker discount rate (only for hosted)
Type:
null or signed integer or floating point number
Default: Unspecified
services.nix-ci.production.background.config.monetisation.customers.<name>.to
Invoice 'To' section
Type:
unspecified value
Required in every item of services.nix-ci.production.background.config.monetisation.customers
services.nix-ci.production.background.config.monetisation.customers.<name>.vat-id
Customer's VAT ID, shown on their invoice. An invoice whose 'to' country is Germany also states that the customer accounts for the VAT (reverse charge), which is only valid with their VAT ID on it.
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.monetisation.from
Invoice 'From' section
Type:
null or unspecified value
Default: Unspecified
services.nix-ci.production.background.config.monetisation.leader-rate
How many CHF to charge per seat per day for the leader
Type:
null or signed integer or floating point number
Default: Unspecified
services.nix-ci.production.background.config.monetisation.self-hosted-leader-rate
How many CHF to charge per seat per day for the self-hosted leader
Type:
null or signed integer or floating point number
Default: Unspecified
services.nix-ci.production.background.config.monetisation.stripe
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.monetisation.stripe.leader-meter-event-name
The Stripe billing meter event name for leader seat-day usage
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.monetisation.stripe.leader-price
The Stripe price ID for leader seat metered billing (must start with 'price_')
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.monetisation.stripe.secret-key
The Stripe secret key (must start with 'sk_')
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.monetisation.stripe.secret-key-file
The Stripe secret key (must start with 'sk_')
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.monetisation.stripe.worker-meter-event-name
The Stripe billing meter event name for worker time usage
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.monetisation.stripe.worker-price
The Stripe price ID for worker usage metered billing (must start with 'price_')
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.monetisation.worker-comparison
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.monetisation.worker-comparison.instance-type
The comparable cloud instance type
Type:
null or string
Default: Unspecified, interpreted as "m7i.4xlarge"
services.nix-ci.production.background.config.monetisation.worker-comparison.provider
The cloud provider name
Type:
null or string
Default: Unspecified, interpreted as "AWS"
services.nix-ci.production.background.config.monetisation.worker-comparison.rate
On-demand rate in USD per hour
Type:
null or signed integer or floating point number
Default: Unspecified, interpreted as 0.8064
services.nix-ci.production.background.config.monetisation.worker-rate
How many CHF to charge per second of worker-time
Type:
null or signed integer or floating point number
Default: Unspecified
services.nix-ci.production.background.config.version
The version tag to report: Use a git commit hash if you can!
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.watchdog-notifier
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.watchdog-notifier.enable
enable the watchdog-notifier looper
Type:
null or boolean
Default: Unspecified
services.nix-ci.production.background.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.background.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.background.config.web
This option has no description.
Type:
submodule
services.nix-ci.production.background.config.web.approot
Where the web interface is reached from outside: where the links into it point, such as the ones in commit statuses. Required by the background workers, which make those, and by the leader where it talks to a forge.
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.web.host-preference
Host preference for binding to serve web requests
Type:
null or string
Default: Unspecified, interpreted as "*6"
services.nix-ci.production.background.config.web.port
The port to serve web requests on
Type:
null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default: Unspecified, interpreted as 8080
services.nix-ci.production.background.config.workers
The workers that are allowed to register, and the jobs each of them may take. The jobs a worker may take also decide whose runs its time is billed to and which queue the autoscale tick is told about. Required, with [] for none.
Type:
null or (list of (submodule))
Default: Unspecified
services.nix-ci.production.background.config.workers.*.allowed
The jobs this worker may take. Every job for the architecture of the machine that reads this, unless it is set.
Type:
null or (submodule) or list of (submodule)
Default: Unspecified
services.nix-ci.production.background.config.workers.*.name
This option has no description.
Type:
string
Required in every item of services.nix-ci.production.background.config.workers
services.nix-ci.production.background.config.workers.*.public-key
The worker's public key. Either this or public-key-file is required.
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.config.workers.*.public-key-file
A file with the worker's public key, read by the leader alone.
Type:
null or string
Default: Unspecified
services.nix-ci.production.background.enable
Enable the NixCI background workers, as a process of their own. A leader runs none of its own, so every installation needs this somewhere. They use the leader's database, and expect the leader to have migrated it.
Type:
boolean
Default:
false
Example:
true
services.nix-ci.production.background.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.background.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.background.hosts
The hosts to serve the metrics on through nginx, with a certificate from ACME, for a Prometheus on another machine to scrape. The first is the virtual host and the rest are its aliases. None serves them on the metrics port only.
Type:
list of string
Default:
[ ]
Example:
[
"background.nix-ci.com"
]
services.nix-ci.production.background.openFirewall
Whether to open the metrics port in the firewall
Type:
boolean
Default:
false