Nix Podman Stacks
Search K

Appearance

homepage ​

Example ​

nix
{
  homepage = {
    enable = true;

    containers.homepage.volumes = [
      "/hostpath/to/image:/app/public/images/background.jpg"
    ];
    settings.background = {
      image = "/images/background.jpg";
      opacity = 50;
    };
    widgets = [
      {
        openweathermap = {
          units = "metric";
          cache = 5;
          apiKey.path = config.sops.secrets."OPENWEATHERMAP_API_KEY".path;
        };
      }
    ];
  };
}

Stack Options ​

nps.stacks.homepage.bookmarks ​

Homepage bookmarks configuration.

See https://gethomepage.dev/configs/bookmarks/.

Type
plaintext
YAML 1.1 value
Default
nix
[ ]
Example
nix
[
  {
    Developer = [
      {
        Github = [
          {
            abbr = "GH";
            href = "https://github.com/";
          }
        ];
      }
    ];
  }
  {
    Entertainment = [
      {
        YouTube = [
          {
            abbr = "YT";
            href = "https://youtube.com/";
          }
        ];
      }
    ];
  }
]
Declaration
<nps/modules/homepage>

nps.stacks.homepage.containers.homepage ​

Alias of {option}services.podman.containers.homepage.

Type
plaintext
submodule
Declaration
<nps/modules/homepage>

nps.stacks.homepage.docker ​

Homepage docker configuration.

See https://gethomepage.dev/configs/docker/.

Type
plaintext
YAML 1.1 value
Default
nix
{ }
Declaration
<nps/modules/homepage>

nps.stacks.homepage.enable ​

Whether to enable the Homepage stack.

The services of enabled stacks will be automatically added to Homepage. The module will also automatically configure the docker integration for the local host and setup some widgets.

Type
plaintext
boolean
Default
nix
false
Example
nix
true
Declaration
<nps/modules/homepage>

nps.stacks.homepage.services ​

Homepage services configuration.

See https://gethomepage.dev/configs/services/.

Type
plaintext
YAML 1.1 value
Default
nix
{ }
Example
nix
{
  "My First Group" = {
    "My First Service" = {
      description = "Some Service";
      href = "http://localhost/";
    };
  };
  "My Second Group" = {
    "My Second Service" = {
      description = "Some other Service";
      href = "http://localhost/";
    };
  };
}
Declaration
<nps/modules/homepage>

nps.stacks.homepage.settings ​

Type
plaintext
YAML 1.1 value
Default
nix
{ }
Declaration
<nps/modules/homepage>

nps.stacks.homepage.useSocketProxy ​

Whether to access the Podman socket through the read-only proxy for the homepage stack. Will be enabled by default if the 'docker-socket-proxy' stack is enabled.

Type
plaintext
boolean
Default
nix
config.nps.stacks.docker-socket-proxy.enable
Declaration
<nps/modules/homepage>

nps.stacks.homepage.widgets ​

Homepage widgets configuration.

See https://gethomepage.dev/widgets/.

Type
plaintext
YAML 1.1 value
Default
nix
[ ]
Example
nix
[
  {
    resources = {
      cpu = true;
      disk = "/";
      memory = true;
    };
  }
  {
    search = {
      provider = "duckduckgo";
      target = "_blank";
    };
  }
]
Declaration
<nps/modules/homepage>