Update README.md

[github/bastienwirtz/homer.git] / docs / configuration.md

diff --git a/docs/configuration.md b/docs/configuration.md
index 409db345f773d3a4e38c5c9c6cf7cb67733dd47b..7df565198dcec621190e8fd9fc0789dc76aa9fee 100644 (file)
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -13,7 +13,8 @@ Title, icons, links, colors, and services can be configured in the `config.yml`
 
 title: "App dashboard"
 subtitle: "Homer"
-logo: "assets/homer.png"
+# documentTitle: "Welcome" # Customize the browser tab text
+logo: "assets/logo.png"
 # Alternatively a fa icon can be provided:
 # icon: "fas fa-skull-crossbones"
 
@@ -26,6 +27,11 @@ connectivityCheck: true # whether you want to display a message when the apps ar
 # Optional theming
 theme: default # 'default' or one of the theme available in 'src/assets/themes'.
 
+# Optional custom stylesheet
+# Will load custom CSS files. Especially useful for custom icon sets.
+# stylesheet:
+#   - "assets/custom.css"
+
 # 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.
@@ -42,6 +48,7 @@ colors:
     text-subtitle: "#424242"
     card-shadow: rgba(0, 0, 0, 0.1)
     link-hover: "#363636"
+    background-image: "assets/your/light/bg.png"
   dark:
     highlight-primary: "#3367d6"
     highlight-secondary: "#4285f4"
@@ -54,12 +61,14 @@ colors:
     text-subtitle: "#f5f5f5"
     card-shadow: rgba(0, 0, 0, 0.4)
     link-hover: "#ffdd57"
+    background-image: "assets/your/dark/bg.png"
 
 # Optional message
 message:
   # url: "https://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
   style: "is-warning"
   title: "Optional message!"
+  icon: "fa fa-exclamation-triangle"
   content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
 
 # Optional navbar
@@ -78,7 +87,7 @@ links:
 # Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
 services:
   - name: "Application"
-    icon: "fa fa-code-fork"
+    icon: "fas fa-code-branch"
     items:
       - name: "Awesome app"
         logo: "assets/tools/sample.png"
@@ -98,12 +107,14 @@ services:
   - name: "Other group"
     icon: "fas fa-heartbeat"
     items:
-      - name: "Another app"
+      - name: "Pi-hole"
         logo: "assets/tools/sample.png"
-        subtitle: "Another example"
+        subtitle: "Network-wide Ad Blocking"
         tag: "other"
-        url: "https://www.reddit.com/r/selfhosted/"
-        target: "_blank" # optionnal html a tag target attribute
+        url: "http://192.168.0.151/admin"
+        type: "PiHole" # optional, loads a specific component that provides extra features. MUST MATCH a file name (without file extension) available in `src/components/services`
+        target: "_blank" # optional html a tag target attribute
+        # class: "green" # optional custom CSS class for card, useful with custom stylesheet
 ```
 
 If you choose to fetch message information from an endpoint, the output format should be:
@@ -129,3 +140,11 @@ Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](h
 - `is-danger` (red)
 
 You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
+
+### PWA Icons
+
+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:
+
+```bash
+npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
+```