Provide config file examples with all values filled out (and options).

[mglaske]

Description

Currently trying to configure homepage, and it would be super helpful (maybe in github per the version), to provide full examples of all the files that getHomepage looks at, and (maybe not the widgets), but all possible fields, and values (especially for settings) ?

Main issue is that I have a layout, where I set tabs (but they don't seem to ever show up), and set syle=row, but it still renders the things as a single column. I also set headerStyle to boxedWidgets, but it doesn't seem to be doing that either. Therefore, troubleshooting on my end is basically, 1) read docs 2) try something 3) restart, 4) fails, so go back to 1.

There seems to be some ambiguity around the yaml format for the layout: section, whether this is Object or Array (and I see the code handles both, but what would be preferred)

I also have additional questions around where exactly some of the settings fields belong. For instance, fullWidth shows under layout, so do I put it under the root, or under layout.fullWidth = x ?

Additionally, it would be nice to have a feature where you could lookup (maybe a UI url that exposes these), the configuration that getHomePage has parsed from your given configs (eg, didn't parse headerStyle because it was misspelt (eg, the value would just be missing from the report (eg, go go /config/settings.yaml (and have it be a rendered version of what getHomepage saw). Probably somewhat difficult because it doesn't look like it really parses the files, just looks up the values it requires.

homepage version

v.1.5.0

Installation method

Other (please describe above)

Configuration

settings.yaml:

title: GlaskeNET
theme: dark # or light
base: http://home.glaske.net
color: slate
headerStyle: boxedWidgets
language: en
target: _blank
showStats: true
hideVersion: false
disableUpdateCheck: false
hideErrors: false
maxGroupColumns: 4
maxBookmarkGroupColumns: 6
disableCollapse: false
useEqualHeights: true
fullWidth: true
layout:
  Media:
    tab: First
    style: row
    columns: 4
  Services:
    tab: First
    style: row
    columns: 4
  Network:
    tab: Second
    style: row
    columns: 4
  Power:
    tab: Second
    style: row
    columns: 4
  Cluster Management:
    tab: Third
    style: row
    columns: 4
  SA00:
    tab: Second
    style: row
    columns: 4
quicklaunch:
  searchDescriptions: true
  hideInternetSearch: true
  showSearchSuggestions: true
  hideVisitURL: true
  provider: google

services (partial):

- Media:
    - Plex:
        icon: plex.png
        href: https://plex
        description: Plex
        server: sa00
        widget:
          type: tautulli
          url: https://plexpy
          key: xxx
        ping: sa00
        siteMonitor: https://plex
    - Sonarr:
        icon: sonarr.png
        href: https://sonarr
        description: TV Series Management
        widget:
          type: sonarr
          url: https://sonarr
          key: xxx
        ping: sa00
        siteMonitor: https://sonarr
        server: sa00-docker
        container: sonarr
    - Radarr:
        icon: radarr.png
        href: https://radarr
        description: Movie Management
        widget:
          type: radarr
          url: https://radarr
          key: xxx
        ping: sa00
        siteMonitor: https://radarr
        server: sa00-docker
        container: radarr
    - QBTorrent:
        icon: qbittorrent.png
        href: https://qbt
        description: Torrent downloader
        widget:
          type: qbittorrent
          url: https://qbt
          username: xxx
          password: xxx
        siteMonitor: https://qbt

### Container Logs

Nothing relevant

### Browser Logs

Only a error getting /api/bookmarks (500), I'll check this out.

### Troubleshooting

Just kept updating the config and trying things.. no success.

[mglaske]

To note: I did find the issue (related to the browser logs), my bookmarks file had a starting 'Bookmarks:' in it.. removed that, and everything started working properly. It would be nice if this had produced an error (eg. Error reading bookmarks.yaml) in the UI..

[Byrnesdigital]

Agreed. I've thought this for a while.

[github-actions[bot]]

This discussion has been automatically closed due to inactivity. See our contributing guidelines for more details.

[github-actions[bot]]

This discussion has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion for related concerns. See our contributing guidelines for more details.