nps.stacks.wg-portal.enable

Whether to enable wg-portal.

Type: boolean

Default: false

Example: true

Declared by:

nps.stacks.wg-portal.containers.wg-portal

Alias of services.podman.containers.wg-portal.

Type: submodule

Declared by:

nps.stacks.wg-portal.extraEnv

Extra environment variables to set for the container. Variables can be either set directly or sourced from a file (e.g. for secrets).

Can be used to pass secrets or other environment variables that are referenced in the settings.

Type: attribute set of (null or boolean or signed integer or string or absolute path or (submodule))

Default: { }

Example:

{
  ADMIN_PASSWORD = {
    fromFile = "/run/secrets/secret_name";
  };
}

Declared by:

nps.stacks.wg-portal.oidc.enable

Whether to enable OIDC login with Authelia. This will register an OIDC client in Authelia and setup the necessary configuration.

For details, see:

Type: boolean

Default: false

Declared by:

nps.stacks.wg-portal.oidc.adminGroup

Users of this group will be assigned admin rights

Type: string

Default: "wg-portal_admin"

Declared by:

nps.stacks.wg-portal.oidc.clientSecretFile

The file containing the client secret for the OIDC client that will be registered in Authelia.

Type: string

Declared by:

nps.stacks.wg-portal.oidc.clientSecretHash

The hashed client_secret. Will be set in the Authelia client config. For examples on how to generate a client secret, see

https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#client-secret

Type: string

Declared by:

nps.stacks.wg-portal.oidc.userGroup

Users of this group will be able to log in

Type: string

Default: "wg-portal_user"

Declared by:

nps.stacks.wg-portal.port

The default port for the first Wireguard interface that will be set up in the UI. Will be exposed and passed as the ‘start_listen_port’ setting in the configuration.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default: 51820

Declared by:

nps.stacks.wg-portal.settings

Settings for the wg-portal container. Will be converted to YAML and passed to the container.

See https://wgportal.org/latest/documentation/configuration/overview/

Type: YAML 1.1 value

Example:

{
  core = {
    admin = {
      password = "\${ADMIN_PASSWORD}";
      username = "admin";
    };
  };
}

Declared by: