ides/docs/docs.md
2025-02-06 11:29:31 +11:00

6.2 KiB
Raw Blame History

auto

Whether to autostart ides services at devshell instantiation.

Type: boolean

Default: true

Declared by:

serviceDefs

Concrete service definitions, as per submodule options. Please put service-related options into options.services instead, and use this to implement those options.

Type: attribute set of (submodule)

Declared by:

serviceDefs.<name>.args

Arguments to supply to the service binary. Writing %CFG% in this will template to your config location.

Type: string

Default: ""

Example: "run -c %CFG% --adapter caddyfile"

Declared by:

serviceDefs.<name>.config

Options for setting the services configuration.

Type: submodule

Default: { }

Declared by:

serviceDefs.<name>.config.content

Attributes that define your config values.

Type: null or (attribute set)

Default: null

Example:

{
  this = "that";
}

Declared by:

serviceDefs.<name>.config.ext

If your service config requires a file extension, set it here. This overrides formats output path.

Type: string

Default: ""

Example: "json"

Declared by:

serviceDefs.<name>.config.file

Path to config file. This overrides all other values.

Type: null or path

Default: null

Example: "./configs/my-config.ini"

Declared by:

serviceDefs.<name>.config.format

Config output format. One of: java json yaml toml ini xml php.

Type: null or one of “java”, “json”, “yaml”, “toml”, “ini”, “xml”, “php”

Default: null

Example: "json"

Declared by:

serviceDefs.<name>.config.formatter

Serialisation/writer function to apply to content. format will auto-apply the correct format if the option value is valid. Should take path: attrs: and return a storepath.

Type: anything

Default: null

Example: "pkgs.formats.yaml {}.generate"

Declared by:

serviceDefs.<name>.config.text

Plaintext configuration to use.

Type: string

Default: ""

Example:

''
  http://*:8080 {
    respond "hello"
  }
''

Declared by:

serviceDefs.<name>.exec

Alternative executable name to use from pkg.

Type: string

Default: ""

Example: "caddy"

Declared by:

serviceDefs.<name>.path

List of path options for the unit (see man systemd.path) - supplied as a list due to some options allowing duplicates.

Type: attribute set of list of string

Default: { }

Example:

{
  PathModified = [
    "/some/path"
  ];
}

Declared by:

serviceDefs.<name>.pkg

Package to use for service.

Type: package

Example: "pkgs.caddy"

Declared by:

serviceDefs.<name>.socket

List of socket options for the unit (see man systemd.socket) - supplied as a list due to some options allowing duplicates.

Type: attribute set of list of string

Default: { }

Example:

{
  ListenStream = [
    "/run/user/1000/myapp.sock"
  ];
}

Declared by:

serviceDefs.<name>.timer

List of timer options for the unit (see man systemd.path) - supplied as a list due to some options allowing duplicates.

Type: attribute set of list of string

Default: { }

Example:

{
  OnActiveSec = [
    50
  ];
}

Declared by:

services.redis.enable

Whether to enable Enable Redis…

Type: boolean

Default: false

Example: true

Declared by:

services.redis.bind

List of IPs to bind to.

Type: list of string

Default:

[
  "127.0.0.1"
  "::1"
]

Declared by:

services.redis.databases

Number of databases.

Type: signed integer

Default: 16

Declared by:

services.redis.extraConfig

Additional config directives.

Type: string

Default: ""

Declared by:

services.redis.logLevel

Logging verbosity level.

Type: one of “debug”, “verbose”, “notice”, “warning”, “nothing”

Default: "notice"

Declared by:

services.redis.name

The name ides uses for this service.

Type: string

Default: "redis"

Declared by:

services.redis.port

Port to bind to.

Type: integer between 1024 and 65535 (both inclusive)

Default: 6379

Declared by:

services.redis.socket

Unix socket to bind to.

Type: null or string

Default: null

Declared by:

services.redis.socketPerms

Permissions for the unix socket.

Type: null or signed integer

Default: null

Declared by: