From 761a6974dc27dd66b14594f56e70606e193d3c41 Mon Sep 17 00:00:00 2001 From: rycee Date: Fri, 1 Nov 2024 22:01:11 +0000 Subject: [PATCH] deploy: 1743615b61c7285976f85b303a36cdf88a556503 --- options.xhtml | 1070 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1070 insertions(+) diff --git a/options.xhtml b/options.xhtml index 73af2d5b3..7676b9759 100644 --- a/options.xhtml +++ b/options.xhtml @@ -69959,6 +69959,1076 @@ JSON value

+
+ + services.podman.enable + + +
+
+

Whether to enable Podman, a daemonless container engine.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux> + +
+
+
+ + services.podman.enableTypeChecks + + +
+
+

Whether to enable type checks for podman quadlets.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/options.nix> + +
+
+
+ + services.podman.package + + +
+
+

The podman package to use.

+ +

Type: +package

+ +

Default: +pkgs.podman

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/options.nix> + +
+
+
+ + services.podman.autoUpdate.enable + + +
+
+

Automatically update the podman images.

+ +

Type: +boolean

+ +

Default: +false

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/services.nix> + +
+
+
+ + services.podman.autoUpdate.onCalendar + + +
+
+

The systemd OnCalendar expression for the update. See +systemd.time(7) for a description of the format.

+ +

Type: +string

+ +

Default: +"Sun *-*-* 00:00"

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/services.nix> + +
+
+
+ + services.podman.containers + + +
+
+

Defines Podman container quadlet configurations.

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.addCapabilities + + +
+
+

The capabilities to add to the container.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Example:

[
+  "CAP_DAC_OVERRIDE"
+  "CAP_IPC_OWNER"
+]
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.autoStart + + +
+
+

Whether to start the container on boot (requires user lingering).

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.autoUpdate + + +
+
+

The autoupdate policy for the container.

+ +

Type: +one of <null>, “registry”, “local”

+ +

Default: +null

+ +

Example: +"registry"

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.description + + +
+
+

The description of the container.

+ +

Type: +null or string

+ +

Default: +null

+ +

Example: +"My Container"

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.devices + + +
+
+

The devices to mount into the container

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Example:

[
+  "/dev/<host>:/dev/<container>"
+]
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.dropCapabilities + + +
+
+

The capabilities to drop from the container.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Example:

[
+  "CAP_DAC_OVERRIDE"
+  "CAP_IPC_OWNER"
+]
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.entrypoint + + +
+
+

The container entrypoint.

+ +

Type: +null or string

+ +

Default: +null

+ +

Example: +"/foo.sh"

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.environment + + +
+
+

Environment variables to set in the container.

+ +

Type: +attribute set of (null or boolean or signed integer or string or path or list of (null or boolean or signed integer or string or path))

+ +

Default: +{ }

+ +

Example:

{
+  VAR1 = "0:100";
+  VAR2 = true;
+  VAR3 = 5;
+}
+
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.environmentFile + + +
+
+

Paths to files containing container environment variables.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Example:

[
+  "/etc/environment"
+  "/etc/other-env"
+]
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.exec + + +
+
+

The command to run after the container start.

+ +

Type: +null or string

+ +

Default: +null

+ +

Example: +"sleep inf"

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.extraConfig + + +
+
+

INI sections and values to populate the Container Quadlet.

+ +

Type: +attribute set of attribute set of ((attribute set of (null or boolean or signed integer or string or path or list of (null or boolean or signed integer or string or path))) or list of (null or boolean or signed integer or string or path) or null or boolean or signed integer or string or path)

+ +

Default: +{ }

+ +

Example:

{
+  Container = {
+    User = 1000;
+  };
+  Service = {
+    TimeoutStartSec = 15;
+  };
+}
+
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.extraPodmanArgs + + +
+
+

Extra arguments to pass to the podman run command.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Example:

[
+  "--security-opt=no-new-privileges"
+  "--security-opt=seccomp=unconfined"
+]
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.group + + +
+
+

The group ID inside the container.

+ +

Type: +null or signed integer or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.image + + +
+
+

The container image.

+ +

Type: +string

+ +

Example: +"registry.access.redhat.com/ubi9-minimal:latest"

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.ip4 + + +
+
+

Set an IPv4 address for the container.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.ip6 + + +
+
+

Set an IPv6 address for the container.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.labels + + +
+
+

The labels to apply to the container.

+ +

Type: +attribute set of string

+ +

Default: +{ }

+ +

Example:

{
+  app = "myapp";
+  some-label = "somelabel";
+}
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.network + + +
+
+

The network mode or network/s to connect the container to. Equivalent +to podman run --network=<option>.

+ +

Type: +string or list of string

+ +

Default: +[ ]

+ +

Example: +"host" +or +"bridge_network_1" +or +[ "bridge_network_1" "bridge_network_2" ]

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.networkAlias + + +
+
+

Network aliases for the container.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Example:

[
+  "mycontainer"
+  "web"
+]
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.ports + + +
+
+

A mapping of ports between host and container

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Example:

[
+  "8080:80"
+  "8443:443"
+]
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.user + + +
+
+

The user ID inside the container.

+ +

Type: +null or signed integer or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.userNS + + +
+
+

Use a user namespace for the container.

+ +

Type: +null or string

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.containers.<name>.volumes + + +
+
+

The volumes to mount into the container.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Example:

[
+  "/tmp:/tmp"
+  "/var/run/test.secret:/etc/secret:ro"
+]
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/containers.nix> + +
+
+
+ + services.podman.networks + + +
+
+

Defines Podman network quadlet configurations.

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/networks.nix> + +
+
+
+ + services.podman.networks.<name>.autoStart + + +
+
+

Whether to start the network on boot (requires user lingering).

+ +

Type: +boolean

+ +

Default: +true

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/networks.nix> + +
+
+
+ + services.podman.networks.<name>.description + + +
+
+

The description of the network.

+ +

Type: +null or string

+ +

Default: +null

+ +

Example: +"My Network"

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/networks.nix> + +
+
+
+ + services.podman.networks.<name>.driver + + +
+
+

The network driver to use.

+ +

Type: +null or string

+ +

Default: +null

+ +

Example: +"bridge"

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/networks.nix> + +
+
+
+ + services.podman.networks.<name>.extraConfig + + +
+
+

INI sections and values to populate the Network Quadlet

+ +

Type: +attribute set of attribute set of ((attribute set of (null or boolean or signed integer or string or path or list of (null or boolean or signed integer or string or path))) or list of (null or boolean or signed integer or string or path) or null or boolean or signed integer or string or path)

+ +

Default: +{ }

+ +

Example:

{
+  Network = {
+    ContainerConfModule = "/etc/nvd.conf";
+  };
+  Service = {
+    TimeoutStartSec = 30;
+  };
+}
+
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/networks.nix> + +
+
+
+ + services.podman.networks.<name>.extraPodmanArgs + + +
+
+

Extra arguments to pass to the podman network create command.

+ +

Type: +list of string

+ +

Default: +[ ]

+ +

Example:

[
+  "--dns=192.168.55.1"
+  "--ipam-driver"
+]
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/networks.nix> + +
+
+
+ + services.podman.networks.<name>.gateway + + +
+
+

The gateway IP to use for the network.

+ +

Type: +null or string

+ +

Default: +null

+ +

Example: +"192.168.20.1"

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/networks.nix> + +
+
+
+ + services.podman.networks.<name>.internal + + +
+
+

Whether the network should be internal

+ +

Type: +null or boolean

+ +

Default: +null

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/networks.nix> + +
+
+
+ + services.podman.networks.<name>.labels + + +
+
+

The labels to apply to the network.

+ +

Type: +attribute set of string

+ +

Default: +{ }

+ +

Example:

{
+  app = "myapp";
+  some-label = "somelabel";
+}
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/networks.nix> + +
+
+
+ + services.podman.networks.<name>.subnet + + +
+
+

The subnet to use for the network.

+ +

Type: +null or string

+ +

Default: +null

+ +

Example: +"192.168.20.0/24"

+ +

Declared by:

+ + +
+ +<home-manager/modules/services/podman-linux/networks.nix> + +
+
services.polybar.enable