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