services.batsky.enable

Whether to enable batsky.

type

boolean

example

{
  services.batsky.enable = true;
}

default

{
  services.batsky.enable = false;
}

services.batsky.package

type

package

default

{
  services.batsky.package = " pkgs.nur.repos.kapack.batsky";
}

services.batsky.args

Basic options for Batsky.

type

null or string

default

{
  services.batsky.args = "-d -l /tmp/batsky.log";
}

services.batsky.controller

Hostname which controls the forgered time.

type

null or string

default

{
  services.batsky.controller = null;
}

services.batsky.ctrl_args

Basic options for controller.

type

null or string

default

{
  services.batsky.ctrl_args = " '-d -l /tmp/batsky-controller.log'";
}

services.bs-munge.enable

Whether to enable bs-munge service.

type

boolean

example

{
  services.bs-munge.enable = true;
}

default

{
  services.bs-munge.enable = false;
}

services.bs-munge.password

The path to a daemon's secret key.

type

path

default

{
  services.bs-munge.password = "/etc/munge/munge.key";
}

services.cigri.package

type

package

default

{
  services.cigri.package = "pkgs.nur.repos.kapack.cigri";
}

services.cigri.client.enable

Whether to enable CiGri client.

type

boolean

example

{
  services.cigri.client.enable = true;
}

default

{
  services.cigri.client.enable = false;
}

services.cigri.database.dbname

Name of the postgresql database

type

string

default

{
  services.cigri.database.dbname = "cigri";
}

services.cigri.database.host

Host of the postgresql server.

type

string

default

{
  services.cigri.database.host = "localhost";
}

services.cigri.database.passwordFile

A file containing the usernames/passwords for database, content example:

DATABASE_USER_NAME="cigri" DATABASE_USER_PASSWORD="cigri"

type

null or path

example

{
  services.cigri.database.passwordFile = "/run/keys/cigri-dbpassword";
}

default

{
  services.cigri.database.passwordFile = null;
}

services.cigri.dbserver.enable

Whether to enable CiGri database.

type

boolean

example

{
  services.cigri.dbserver.enable = true;
}

default

{
  services.cigri.dbserver.enable = false;
}

services.cigri.extraConfig

Extra configuration options that will replace default.

type

attribute set

example

{
  services.cigri.extraConfig = {
    DEFAULT_JOB_RESOURCES = "/resource_id=1";
    LOG_LEVEL = "3";
  };
}

default

{
  services.cigri.extraConfig = {};
}

services.cigri.server.enable

Whether to enable CiGri server.

type

boolean

example

{
  services.cigri.server.enable = true;
}

default

{
  services.cigri.server.enable = false;
}

services.cigri.server.api_SSL

Whether to enable Enable API_SSL.

type

boolean

example

{
  services.cigri.server.api_SSL = true;
}

default

{
  services.cigri.server.api_SSL = false;
}

services.cigri.server.api_base

Base location to Cigir's Rest API.

type

string

default

{
  services.cigri.server.api_base = "/cigri-api";
}

services.cigri.server.api_port

Port to access to Cigir's Rest API.

type

signed integer

default

{
  services.cigri.server.api_port = 80;
}

services.cigri.server.host

Host of the CiGri server.

type

string

default

{
  services.cigri.server.host = "localhost";
}

services.cigri.server.logfile

Specify the log file name.

type

string

example

{
  services.cigri.server.logfile = "/var/cigri/state/home/cigri.log";
}

default

{
  services.cigri.server.logfile = "/dev/null";
}

services.cigri.server.statePath

Cigri state directory. Configuration, repositories and logs, among other things, are stored here.

The directory will be created automatically if it doesn't exist already.

type

string

default

{
  services.cigri.server.statePath = "/var/cigri/state";
}

services.cigri.server.web.enable

Whether to enable Web server to serve rest-api.

type

boolean

example

{
  services.cigri.server.web.enable = true;
}

default

{
  services.cigri.server.web.enable = false;
}

services.my-startup.enable

Whether to enable My startup .

type

boolean

example

{
  services.my-startup.enable = true;
}

default

{
  services.my-startup.enable = false;
}

services.my-startup.path

Path to tools used by provided script

type

path

default

{
  services.my-startup.path = [];
}

services.my-startup.script

Script File to execute a start time

type

string

default

{
  services.my-startup.script = "/etc/my-startup.sh";
}

services.oar.package

type

package

default

{
  services.oar.package = "pkgs.nur.repos.kapack.oar";
}

services.oar.client.enable

Whether to enable OAR client.

type

boolean

example

{
  services.oar.client.enable = true;
}

default

{
  services.oar.client.enable = false;
}

services.oar.database.dbname

Name of the postgresql database

type

string

default

{
  services.oar.database.dbname = "oar";
}

services.oar.database.host

Host of the postgresql server.

type

string

default

{
  services.oar.database.host = "localhost";
}

services.oar.database.passwordFile

A file containing the usernames/passwords for database, content example:

DataBase user name

DB_BASE_LOGIN="oar"

DataBase user password

DB_BASE_PASSWD="oar"

DataBase read only user name

DB_BASE_LOGIN_RO="oar_ro"

DataBase read only user password

DB_BASE_PASSWD_RO="oar_ro"

type

null or path

example

{
  services.oar.database.passwordFile = "/run/keys/oar-dbpassword";
}

default

{
  services.oar.database.passwordFile = null;
}

services.oar.dbserver.enable

Whether to enable OAR database.

type

boolean

example

{
  services.oar.dbserver.enable = true;
}

default

{
  services.oar.dbserver.enable = false;
}

services.oar.extraConfig

Extra configuration options that will replace default.

type

attribute set

example

{
  services.oar.extraConfig = {
    LOG_LEVEL = "3";
    OARSUB_DEFAULT_RESOURCES = "/resource_id=1";
  };
}

default

{
  services.oar.extraConfig = {};
}

services.oar.node.enable

Whether to enable OAR node.

type

boolean

example

{
  services.oar.node.enable = true;
}

default

{
  services.oar.node.enable = false;
}

services.oar.node.register.enable

Whether to enable Register node into OAR server.

type

boolean

example

{
  services.oar.node.register.enable = true;
}

default

{
  services.oar.node.register.enable = false;
}

services.oar.node.register.add

Execute oarnodesseting

type

boolean

default

{
  services.oar.node.register.add = true;
}

services.oar.node.register.extraCommand

Extra command called once after registration

type

string

default

{
  services.oar.node.register.extraCommand = "";
}

services.oar.oarHomeDir

Home for oar user

type

string

default

{
  services.oar.oarHomeDir = "/var/lib/oar";
}

services.oar.privateKeyFile

Private key for oar user

type

string

default

{
  services.oar.privateKeyFile = "/run/keys/oar_id_rsa_key";
}

services.oar.publicKeyFile

Public key for oar user

type

string

default

{
  services.oar.publicKeyFile = "/run/keys/oar_id_rsa_key.pub";
}

services.oar.server.enable

Whether to enable OAR server.

type

boolean

example

{
  services.oar.server.enable = true;
}

default

{
  services.oar.server.enable = false;
}

services.oar.server.host

Host of the OAR server.

type

string

default

{
  services.oar.server.host = "localhost";
}

services.oar.web.enable

Whether to enable OAR web server and rest-api.

type

boolean

example

{
  services.oar.web.enable = true;
}

default

{
  services.oar.web.enable = false;
}

services.oar.web.drawgantt.enable

Whether to enable Drawgantt web page.

type

boolean

example

{
  services.oar.web.drawgantt.enable = true;
}

default

{
  services.oar.web.drawgantt.enable = false;
}

services.oar.web.extraConfig

Extra configuration to append to Nginx's one.

type

string

default

{
  services.oar.web.extraConfig = "";
}

services.oar.web.monika.enable

Whether to enable Monkia resources' status web page.

type

boolean

example

{
  services.oar.web.monika.enable = true;
}

default

{
  services.oar.web.monika.enable = false;
}

services.oar.web.proxy.enable

Whether to enable Enable proxy service based on Traefik.

type

boolean

example

{
  services.oar.web.proxy.enable = true;
}

default

{
  services.oar.web.proxy.enable = false;
}

services.oar.web.proxy.configOptions

Config for Traefik.

type

attribute set

default

{
  services.oar.web.proxy.configOptions = {
    defaultentrypoints = [
      "http"
    ];
    file = {
      filename = "/etc/oar/proxy/rules_oar_traefik.toml";
      watch = true;
    };
    wss = {
      protocol = "http";
    };
  };
}

services.oar.web.proxy.entryPointHttp

Entry Point for proxy server (example "server:5000").

type

string

default

{
  services.oar.web.proxy.entryPointHttp = "";
}

services.phpfpm0.extraConfig

Extra configuration that should be put in the global section of the PHP-FPM configuration file. Do not specify the options error_log or daemonize here, since they are generated by NixOS.

type

null or strings concatenated with "\n"

default

{
  services.phpfpm0.extraConfig = null;
}

services.phpfpm0.phpOptions

Options appended to the PHP configuration file php.ini.

type

strings concatenated with "\n"

example

{
  services.phpfpm0.phpOptions = ''
    date.timezone = "CET"
    
  '';
}

default

{
  services.phpfpm0.phpOptions = "";
}

services.phpfpm0.phpPackage

The PHP package to use for running the PHP-FPM service.

type

package

default

{
  services.phpfpm0.phpPackage = "pkgs.php";
}

services.phpfpm0.pools

PHP-FPM pools. If no pools are defined, the PHP-FPM service is disabled.

type

attribute set of submodule

example

{
  services.phpfpm0.pools = {
    _type = "literalExpression";
    text = ''
      {
        mypool = {
          user = "php";
          group = "php";
          phpPackage = pkgs.php;
          settings = ''
            "pm" = "dynamic";
            "pm.max_children" = 75;
            "pm.start_servers" = 10;
            "pm.min_spare_servers" = 5;
            "pm.max_spare_servers" = 20;
            "pm.max_requests" = 500;
          '';
        }
      }
    '';
  };
}

default

{
  services.phpfpm0.pools = {};
}

services.phpfpm0.pools.<name>.extraConfig

Extra lines that go into the pool configuration. See the documentation on php-fpm.conf for details on configuration directives.

type

null or strings concatenated with "\n"

default

{
  services.phpfpm0.pools.<name>.extraConfig = null;
}

services.phpfpm0.pools.<name>.group

Group account under which this pool runs.

type

string

services.phpfpm0.pools.<name>.listen

The address on which to accept FastCGI requests.

type

string

example

{
  services.phpfpm0.pools.<name>.listen = "/path/to/unix/socket";
}

default

{
  services.phpfpm0.pools.<name>.listen = "";
}

services.phpfpm0.pools.<name>.phpEnv

Environment variables used for this PHP-FPM pool.

type

attribute set of string

example

{
  services.phpfpm0.pools.<name>.phpEnv = {
    _type = "literalExpression";
    text = ''
      {
        HOSTNAME = "$HOSTNAME";
        TMP = "/tmp";
        TMPDIR = "/tmp";
        TEMP = "/tmp";
      }
      
    '';
  };
}

default

{
  services.phpfpm0.pools.<name>.phpEnv = {};
}

services.phpfpm0.pools.<name>.phpOptions

"Options appended to the PHP configuration file php.ini used for this PHP-FPM pool."

type

strings concatenated with "\n"

services.phpfpm0.pools.<name>.phpPackage

The PHP package to use for running this PHP-FPM pool.

type

package

default

{
  services.phpfpm0.pools.<name>.phpPackage = "config.services.phpfpm.phpPackage";
}

services.phpfpm0.pools.<name>.settings

PHP-FPM pool directives. Refer to the "List of pool directives" section of

for details. Note that settings names must be enclosed in quotes (e.g. "pm.max_children" instead of pm.max_children).

type

attribute set of string or signed integer or boolean

example

{
  services.phpfpm0.pools.<name>.settings = {
    _type = "literalExpression";
    text = ''
      {
        "pm" = "dynamic";
        "pm.max_children" = 75;
        "pm.start_servers" = 10;
        "pm.min_spare_servers" = 5;
        "pm.max_spare_servers" = 20;
        "pm.max_requests" = 500;
      }
      
    '';
  };
}

default

{
  services.phpfpm0.pools.<name>.settings = {};
}

services.phpfpm0.pools.<name>.socket

Path to the unix socket file on which to accept FastCGI requests. This option is read-only and managed by NixOS.

type

string

services.phpfpm0.pools.<name>.user

User account under which this pool runs.

type

string

services.phpfpm0.settings

PHP-FPM global directives. Refer to the "List of global php-fpm.conf directives" section of

for details. Note that settings names must be enclosed in quotes (e.g. "pm.max_children" instead of pm.max_children). You need not specify the options error_log or daemonize here, since they are generated by NixOS.

type

attribute set of string or signed integer or boolean

default

{
  services.phpfpm0.settings = {};
}