docs/configuration.md

   1 # Configuration
   2
   3 Title, icons, links, colors, and services can be configured in the `config.yml` file (located in `/assets` directory once built, or in the `public/assets` directory in development mode), using [yaml](http://yaml.org/) format.
   4
   5 ```yaml
   6 ---
   7 # Homepage configuration
   8 # See https://fontawesome.com/icons for icons options
   9
  10 # Optional: Use external configuration file.
  11 # Using this will ignore remaining config in this file
  12 # externalConfig: https://example.com/server-luci/config.yaml
  13
  14 title: "App dashboard"
  15 subtitle: "Homer"
  16 # documentTitle: "Welcome" # Customize the browser tab text
  17 logo: "assets/logo.png"
  18 # Alternatively a fa icon can be provided:
  19 # icon: "fas fa-skull-crossbones"
  20
  21 header: true # Set to false to hide the header
  22 # Optional: Different hotkey for search, defaults to "/"
  23 # hotkey: "Shift"
  24 footer: '<p>Created with <span class="has-text-danger">❤️</span> with <a href="https://bulma.io/">bulma</a>, <a href="https://vuejs.org/">vuejs</a> & <a href="https://fontawesome.com/">font awesome</a> // Fork me on <a href="https://github.com/bastienwirtz/homer"><i class="fab fa-github-alt"></i></a></p>' # set false if you want to hide it.
  25
  26 columns: "3" # "auto" or number (must be a factor of 12: 1, 2, 3, 4, 6, 12)
  27 connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example)
  28
  29 # Optional: Proxy / hosting option
  30 proxy:
  31   # NOT All custom services implements this new option YET. Support will be extended very soon.
  32   useCredentials: false # send cookies & authorization headers when fetching service specific data. Set to `true` if you use an authentication proxy. Can be overrided on service level.
  33
  34 # Optional theming
  35 theme: default # 'default' or one of the themes available in 'src/assets/themes'.
  36
  37 # Optional custom stylesheet
  38 # Will load custom CSS files. Especially useful for custom icon sets.
  39 # stylesheet:
  40 #   - "assets/custom.css"
  41
  42 # Here is the exhaustive list of customization parameters
  43 # However all value are optional and will fallback to default if not set.
  44 # if you want to change only some of the colors, feel free to remove all unused key.
  45 colors:
  46   light:
  47     highlight-primary: "#3367d6"
  48     highlight-secondary: "#4285f4"
  49     highlight-hover: "#5a95f5"
  50     background: "#f5f5f5"
  51     card-background: "#ffffff"
  52     text: "#363636"
  53     text-header: "#424242"
  54     text-title: "#303030"
  55     text-subtitle: "#424242"
  56     card-shadow: rgba(0, 0, 0, 0.1)
  57     link-hover: "#363636"
  58     background-image: "assets/your/light/bg.png"
  59   dark:
  60     highlight-primary: "#3367d6"
  61     highlight-secondary: "#4285f4"
  62     highlight-hover: "#5a95f5"
  63     background: "#131313"
  64     card-background: "#2b2b2b"
  65     text: "#eaeaea"
  66     text-header: "#ffffff"
  67     text-title: "#fafafa"
  68     text-subtitle: "#f5f5f5"
  69     card-shadow: rgba(0, 0, 0, 0.4)
  70     link-hover: "#ffdd57"
  71     background-image: "assets/your/dark/bg.png"
  72
  73 # Optional message
  74 message:
  75   # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
  76   # mapping: # allows to map fields from the remote format to the one expected by Homer
  77   #   title: 'id' # use value from field 'id' as title
  78   #   content: 'value' # value from field 'value' as content
  79   # refreshInterval: 10000 # Optional: time interval to refresh message
  80   #
  81   # Real example using chucknorris.io for showing Chuck Norris facts as messages:
  82   # url: https://api.chucknorris.io/jokes/random
  83   # mapping:
  84   #   title: 'id'
  85   #   content: 'value'
  86   # refreshInterval: 10000
  87   style: "is-warning"
  88   title: "Optional message!"
  89   icon: "fa fa-exclamation-triangle"
  90   content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
  91
  92 # Optional navbar
  93 # links: [] # Allows for navbar (dark mode, layout, and search) without any links
  94 links:
  95   - name: "Link 1"
  96     icon: "fab fa-github"
  97     url: "https://github.com/bastienwirtz/homer"
  98     target: "_blank" # optional html tag target attribute
  99   - name: "link 2"
 100     icon: "fas fa-book"
 101     url: "https://github.com/bastienwirtz/homer"
 102   # this will link to a second homer page that will load config from page2.yml and keep default config values as in config.yml file
 103   # see url field and assets/page.yml used in this example:
 104   - name: "Second Page"
 105     icon: "fas fa-file-alt"
 106     url: "#page2"
 107
 108 # Services
 109 # First level array represents a group.
 110 # Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
 111 services:
 112   - name: "Application"
 113     icon: "fas fa-code-branch"
 114     # A path to an image can also be provided. Note that icon take precedence if both icon and logo are set.
 115     # logo: "path/to/logo"
 116     items:
 117       - name: "Awesome app"
 118         logo: "assets/tools/sample.png"
 119         # Alternatively a fa icon can be provided:
 120         # icon: "fab fa-jenkins"
 121         subtitle: "Bookmark example"
 122         tag: "app"
 123         url: "https://www.reddit.com/r/selfhosted/"
 124         target: "_blank" # optional html tag target attribute
 125       - name: "Another one"
 126         logo: "assets/tools/sample2.png"
 127         subtitle: "Another application"
 128         tag: "app"
 129         # Optional tagstyle
 130         tagstyle: "is-success"
 131         url: "#"
 132   - name: "Other group"
 133     icon: "fas fa-heartbeat"
 134     items:
 135       - name: "Pi-hole"
 136         logo: "assets/tools/sample.png"
 137         # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown
 138         tag: "other"
 139         url: "http://192.168.0.151/admin"
 140         type: "PiHole" # optional, loads a specific component that provides extra features. MUST MATCH a file name (without file extension) available in `src/components/services`
 141         target: "_blank" # optional html a tag target attribute
 142         # class: "green" # optional custom CSS class for card, useful with custom stylesheet
 143         # background: red # optional color for card to set color directly without custom stylesheet
 144 ```
 145
 146 View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them.
 147
 148 If you choose to fetch message information from an endpoint, the output format should be as follows (or you can [custom map fields as shown in tips-and-tricks](./tips-and-tricks.md#mapping-fields)):
 149
 150 ```json
 151 {
 152   "style": null,
 153   "title": "Lorem ipsum 42",
 154   "content": "LA LA LA Lorem ipsum dolor sit amet, ....."
 155 }
 156 ```
 157
 158 `null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
 159 Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
 160
 161 ## Style Options
 162
 163 Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll notice in the config there is a `tagstyle` option. It can be set to any of the bulma modifiers. You'll probably want to use one of these 4 main colors:
 164
 165 - `is-info` (blue)
 166 - `is-success` (green)
 167 - `is-warning` (yellow)
 168 - `is-danger` (red)
 169
 170 You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
 171
 172 ## PWA Icons
 173
 174 In order to easily generate all required icon preset for the PWA to work, a tool like [vue-pwa-asset-generator](https://www.npmjs.com/package/vue-pwa-asset-generator) can be used:
 175
 176 ```bash
 177 npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
 178 ```
 179
 180 ## Supported services
 181
 182 Currently the following services are supported for showing quick infos on the card. They can be used by setting the type to one of the following values at the item.
 183
 184 - PiHole
 185 - AdGuardHome
 186 - PaperlessNG
 187 - Mealie
 188
 189 ## Additional configuration
 190
 191 ### Paperless
 192
 193 For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
 194
 195 ### Mealie
 196
 197 First off make sure to remove an existing `subtitle` as it will take precedence if set. Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized or the planned meal for today if one is planned. You will have to set an API key in the field `apikey` which can be created in your Mealie installation.