Skip to content

Oink

services.oink.domains

List of attribute sets containing configuration for each domain.

Each attribute set must have two attributes, one named domain and another named subdomain. The domain attribute must specify the root domain that you want to configure, and the subdomain attribute must specify its subdomain if any. If you want to configure the root domain rather than a subdomain, leave the subdomain attribute as an empty string.

Additionally, you can use attributes from services.oink.settings to override settings per-domain.

Every domain listed here must have API access enabled in Porkbun's control panel.

Type: list of attribute set of anything

Default

[ ]

Example

[{domain = "nixos.org";subdomain = "";ttl = 1200;}{domain = "nixos.org";subdomain = "hydra";}]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/oink.nix

services.oink.enable

Whether to enable Oink, a dynamic DNS client for Porkbun. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/oink.nix

services.oink.package

The oink package to use. Type: package

Default

pkgs.oink

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/oink.nix

services.oink.settings.apiKey

API key to use when modifying DNS records. Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/oink.nix

services.oink.settings.interval

Seconds to wait before sending another request. Type: integer between 60 and 172800 (both inclusive)

Default

900

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/oink.nix

services.oink.settings.secretApiKey

Secret API key to use when modifying DNS records. Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/oink.nix

services.oink.settings.ttl

The TTL ("Time to Live") value to set for your DNS records.

The TTL controls how long in seconds your records will be cached for. A smaller value will allow the record to update quicker.

Type: integer between 600 and 172800 (both inclusive)

Default

600

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/oink.nix