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