File configuration

The less config the better! CasaVue is fully functional running on default configuration. Nevertheless, there are some configuration possibilities.

CasaVue configuration consists of two files: main.yaml and items.yaml.

Despite editing configuration differs depending on deployment method (Helm Chart or Docker Compose), body of YAML configuration is the same.

Below is an example of their contents with a description of the fields.

Main configuration file

If you want to modify CasaVue apperance, modyfing default main config file should be enough.

main.yaml

# CasaVue configuration file

# appearance settings
customization:

  # influences page title and PWA name
  name: CasaVue

  colors:
    # main color
    theme: "#deaded"

    # color settings for dashboard items
    items:
      # range: 0 <-> 100
      saturation: 8

      # range: -1 <-> 100
      # set lightness to -1 to use browser theme setting
      lightness: 84

# including or excluding items or namespaces by regex
content_filters:

  namespace:

    # possible values: "include", "exclude"
    mode: "include"

    # Go regexp syntax compatible (https://pkg.go.dev/regexp/syntax)
    # catches all values by default
    pattern: "^.*$"

  item:

    # possible values: "include", "exclude", "ingressAnnotation"
    # "ingressAnnotation" mode disables item regex pattern, and includes only
    # ingress resources with casavue.app/enable=true annotation
    mode: "include"

    # Go regexp syntax compatible (https://pkg.go.dev/regexp/syntax)
    # catches all values by default
    pattern: "^.*$"

# Allows connections to servers with an invalid TLS certificate
# Don't turn it on unless you know what you're doing
allow_skip_tls_verify: false

logging:

  # possible levels: "debug", "info", "warn", "error"
  level: "info"

Static items definitions

If you need to add a couple of entries from yourself in addition to the Kubernetes ones (or in case there is no entries from K8s), add the entries to the items.yaml. Each item entry is described by following fields:

Field name	Required	Type	Description
name	✅	string	The name of the item to be displayed.
namespace	✅	string	The category in which the item should be placed.
url	✅	string	URL to which the item should point to.
icon	❌	string	Item icon URL override.

Below is an example of static entry configuration content:

items.yaml

# static definitions of dashboard items
#
# Each item represents entry on dashboard.
# set to 'items: []' for empty list.
items:

    - # item title
      name: Duck Duck Go

      # name by which elements are aggregated
      namespace: searching

      # URL to which the element links to
      url: "https://duckduckgo.com/"

    - name: Bing
      namespace: searching
      url: "https://www.bing.com/"

    - name: Google
      namespace: searching
      url: "https://www.google.com/"

    - name: X
      namespace: social
      url: "https://x.com/"

    - name: Reddit
      namespace: social
      url: "https://www.reddit.com/"

    - name: XKCD
      namespace: timekill
      url: "https://xkcd.com/"
      icon: "https://xkcd.com/s/0b7742.png"

    - name: 9gag
      namespace: timekill
      url: "https://9gag.com/"

    - name: boredpanda
      namespace: timekill
      url: "https://www.boredpanda.com/"