Archisteamfarm

`services.archisteamfarm.bots`

Bots name and configuration.

Type: attribute set of (submodule)

Default

{ }

Example

{exampleBot = {passwordFile = "/var/lib/archisteamfarm/secrets/password";settings = {SteamParentalCode = "1234";};username = "alice";};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/archisteamfarm.nix

`services.archisteamfarm.bots.<name>.enabled`

Whether to enable the bot on startup. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/archisteamfarm.nix

`services.archisteamfarm.bots.<name>.passwordFile`

Path to a file containing the password. The file must be readable by the archisteamfarm user/group. Omit or set to null to provide the password a different way, such as through the web-ui.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/archisteamfarm.nix

`services.archisteamfarm.bots.<name>.settings`

Additional settings that are documented here.

Type: attribute set

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/archisteamfarm.nix

`services.archisteamfarm.bots.<name>.username`

Name of the user to log in. Default is attribute name. Type: string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/archisteamfarm.nix

`services.archisteamfarm.dataDir`

The ASF home directory used to store all data. If left as the default value this directory will automatically be created before the ASF server starts, otherwise the sysadmin is responsible for ensuring the directory exists with appropriate ownership and permissions. Type: path

Default

"/var/lib/archisteamfarm"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/archisteamfarm.nix

`services.archisteamfarm.enable`

If enabled, starts the ArchisSteamFarm service. For configuring the SteamGuard token you will need to use the web-ui, which is enabled by default over on 127.0.0.1:1242. You cannot configure ASF in any way outside of nix, since all the config files get wiped on restart and replaced with the programnatically set ones by nix.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/archisteamfarm.nix

`services.archisteamfarm.ipcPasswordFile`

Path to a file containing the password. The file must be readable by the archisteamfarm user/group. Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/archisteamfarm.nix

`services.archisteamfarm.ipcSettings`

Settings to write to IPC.config. All options can be found here.

Type: JSON value

Default

{ }

Example

{Kestrel = {Endpoints = {HTTP = {Url = "http://*:1242";};};};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/archisteamfarm.nix

`services.archisteamfarm.package`

The ArchiSteamFarm package to use. ::: {.warning} Should always be the latest version, for security reasons, since this module uses very new features and to not get out of sync with the Steam API. :::

Type: package

Default

pkgs.ArchiSteamFarm

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/archisteamfarm.nix

`services.archisteamfarm.settings`

The ASF.json file, all the options are documented here. Do note that AutoRestart and UpdateChannel is always to false respectively 0 because NixOS takes care of updating everything. Headless is also always set to true because there is no way to provide inputs via a systemd service. You should try to keep ASF up to date since upstream does not provide support for anything but the latest version and you're exposing yourself to all kinds of issues - as is outlined here.

Type: JSON value

Default

{ }

Example

{Statistics = false;}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/archisteamfarm.nix

`services.archisteamfarm.web-ui`

The Web-UI hosted on 127.0.0.1:1242. Type: submodule

Default

{enable = true;}

Example

{enable = false;}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/archisteamfarm.nix

`services.archisteamfarm.web-ui.enable`

Whether to start the web-ui. This is the preferred way of configuring things such as the steam guard token. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/archisteamfarm.nix

`services.archisteamfarm.web-ui.package`

The ui package to use. ::: {.note} Contents must be in lib/dist :::

Type: package

Default

pkgs.ArchiSteamFarm.ui

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/archisteamfarm.nix