X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=65ef9ab92fc21fe5fc1d088df9ecaf3249c9bdf4;hb=1bc75494cae6efd5a0fdff3195db110451bad2ec;hp=8818e322423ee847b5770617bf21c49a60cb380f;hpb=cad54a560f77382d9584fd804f9cdd84c92012b7;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index 8818e32..65ef9ab 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,11 @@ ervices on hand, from a simple `yaml` configuration file. ## Table of Contents - [Features](#features) - [Getting started](#getting-started) -- [Configuration](#configuration) +- [Configuration](docs/configuration.md) +- [Tips & tricks](docs/tips-and-tricks.md) - [Roadmap](#roadmap) -- [Developement](#developement) +- [Developement](docs/developement.md) + ## Features - [yaml](http://yaml.org/) file configuration @@ -36,6 +38,8 @@ ervices on hand, from a simple `yaml` configuration file. Homer is a full static html/js dashboard, generated from the source in `/src` using webpack. It's meant to be served by an HTTP server, **it will not work if you open dist/index.html directly over file:// protocol**. +For more information about the `config.yml` file see [configuration](docs/configuration.md) the section. + ### Using docker ```sh @@ -76,171 +80,8 @@ npm run build Then your dashboard is ready to use in the `/dist` directory. -## 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://