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