pr-tracker NixOS modules manual

Options


services.pr-tracker.api.enable

Whether to enable pr-tracker-api.

Type: boolean

Default: false

Example: true

services.pr-tracker.api.package

The api package to use.

Type: package

Default: pr-tracker.packages.api

services.pr-tracker.api.db.isLocal

Whether database is local.

Type: boolean

Default: false

services.pr-tracker.api.db.passwordFile

Path to a file containing the database password. Contents will be appended to the database URL as a parameter.

Type: null or path

Default: null

Example: "/run/secrets/db-password"

services.pr-tracker.api.db.urlParams

URL parameters from which to compose the PostgreSQL connection URI.

Required unless services.pr-tracker.db.createLocally is true.

Type: null or (attribute set of string)

Default: null

Example:

{
  dbname = "pr-tracker";
  host = "localhost";
  port = "5432";
  user = "pr-tracker";
}
services.pr-tracker.api.group

Group to run under.

Type: string

Default: "pr-tracker-api"

services.pr-tracker.api.port

Port to listen on.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

services.pr-tracker.api.user

User to run under.

Type: string

Default: "pr-tracker-api"

services.pr-tracker.db.createLocally

Whether to create a local database automatically.

Type: boolean

Default: false

services.pr-tracker.db.name

Automatically created local database name.

Type: string

Default: "pr-tracker"

services.pr-tracker.fetcher.enable

Whether to enable pr-tracker-fetcher.

Type: boolean

Default: false

Example: true

services.pr-tracker.fetcher.package

The fetcher package to use.

Type: package

Default: pr-tracker.packages.fetcher

services.pr-tracker.fetcher.branchPatterns

JSON array of strings representing branch patterns to track.

  • ? matches a single occurrence of any character.

  • * matches zero or more occurrences of any character.

No escape characters.

Type: list of string

Example:

[
  "release-*"
]
services.pr-tracker.fetcher.db.isLocal

Whether database is local.

Type: boolean

Default: false

services.pr-tracker.fetcher.db.passwordFile

Path to a file containing the database password. Contents will be appended to the database URL as a parameter.

Type: null or path

Default: null

Example: "/run/secrets/db-password"

services.pr-tracker.fetcher.db.urlParams

URL parameters from which to compose the PostgreSQL connection URI.

Required unless services.pr-tracker.db.createLocally is true.

Type: null or (attribute set of string)

Default: null

Example:

{
  dbname = "pr-tracker";
  host = "localhost";
  port = "5432";
  user = "pr-tracker";
}
services.pr-tracker.fetcher.githubApiTokenFile

Path to a file containing a GitHub API token with read access to the repository’s pull requests.

Type: path

Example: "/run/secrets/github-api.token"

services.pr-tracker.fetcher.group

Group to run under.

Type: string

Default: "pr-tracker-fetcher"

services.pr-tracker.fetcher.onCalendar

When to run the fetcher. This is a systemd timer OnCalendar string, see systemd.time(7) for a full specification.";

Type: string

Example: "daily"

services.pr-tracker.fetcher.repo.name

GitHub repository name.

Type: string

Example: "nixpkgs"

services.pr-tracker.fetcher.repo.owner

GitHub repository owner.

Type: string

Example: "NixOS"

services.pr-tracker.fetcher.user

User to run under.

Type: string

Default: "pr-tracker-fetcher"