X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=docs%2Fconfiguration.md;fp=docs%2Fconfiguration.md;h=a2469ed515c40374ad5ca00c736ca021261ef403;hb=5f71d1ea01c54a79fb8f459f8acbe92b0ea99c61;hp=0000000000000000000000000000000000000000;hpb=481ab9a01bdbe44ca64e5b065f2b81e41bee3ea0;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000..a2469ed --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,131 @@ +## Configuration + +Title, icons, links, colors, and services can be configured in the `config.yml` file (located in project root directory once built, or in the `public/` directory in developement mode), using [yaml](http://yaml.org/) format. + +```yaml +--- +# Homepage configuration +# See https://fontawesome.com/icons for icons options + +# Optional: Use external configuration file. +# Using this will ignore remaining config in this file +# externalConfig: https://example.com/server-luci/config.yaml + +title: "App dashboard" +subtitle: "Homer" +logo: "assets/homer.png" +# Alternatively a fa icon can be provided: +# icon: "fas fa-skull-crossbones" + +header: true # Set to false to hide the header +footer: '
Created with â¤ï¸ with bulma, vuejs & font awesome // Fork me on
' # set false if you want to hide it. + +columns: "3" # "auto" or number (must be a factor of 12: 1, 2, 3, 4, 6, 12) +connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example) + +# Optional theming +theme: default # 'default' or one of the theme available in 'src/assets/themes'. + +# Here is the exaustive list of customization parameters +# However all value are optional and will fallback to default if not set. +# if you want to change only some of the colors, feel free to remove all unused key. +colors: + light: + highlight-primary: "#3367d6" + highlight-secondary: "#4285f4" + highlight-hover: "#5a95f5" + background: "#f5f5f5" + card-background: "#ffffff" + text: "#363636" + text-header: "#424242" + text-title: "#303030" + text-subtitle: "#424242" + card-shadow: rgba(0, 0, 0, 0.1) + link-hover: "#363636" + dark: + highlight-primary: "#3367d6" + highlight-secondary: "#4285f4" + highlight-hover: "#5a95f5" + background: "#131313" + card-background: "#2b2b2b" + text: "#eaeaea" + text-header: "#ffffff" + text-title: "#fafafa" + text-subtitle: "#f5f5f5" + card-shadow: rgba(0, 0, 0, 0.4) + link-hover: "#ffdd57" + +# Optional message +message: + # url: "https://