Homepage Configurations

NOTE

Starting from v0.9, you can edit, hide/unhide apps directly from WebUI by a right click.

Editing from WebUI will override labels and route files settings.

Please contribute to the category preset if you have the time.

Properties

Property	Description	Default	Allowed Values / Syntax
show	Whether to show the app	true	boolean
name	Display name on dashboard	Sanitized alias	string
icon	Icon from walkxcode or selfh.st Absolute Icon URL Relative path to proxy target	Automatic detected	"@walkxcode/<filename>.png" "@selfhst/<filename>.svg" "https://example.com/icon.png" "/path/to/icon.png"
url	Override app URL	Dynamic	Absolute URL
category	Category on dashboard	Preset value if container image or alias matched the list Docker for a docker containers Others otherwise	string
description	A short description shown under app name	empty	string
widget_config	Reserved, may support widgets in the future	null	widget specific

Examples

Docker compose

services:
  gitlab:
    image: gitlab/gitlab-ce:latest
    container_name: gitlab
    restart: always
    labels:
      proxy.aliases: gitlab,gitlab-reg,gitlab-ssh
      proxy.gitlab: |
        port: 80
        homepage:
          name: GitLab
          icon: "/-/pwa-icons/logo-192.png"
      proxy.gitlab-reg: |
        port: 5050
        homepage:
          show: false
      proxy.gitlab-ssh: |
        port: 22223:22
        homepage:
          show: false
    shm_size: 256m

Route file

adgh:
  host: 10.0.2.1
  homepage:
    name: AdGuard Home
    icon: "@selfhst/adguard-home.png"