X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=8818e322423ee847b5770617bf21c49a60cb380f;hb=a23914d573841f9088cc9cd69bce24c28f432acf;hp=337fb5d3a67dfe2d42df01eaea3e562069035248;hpb=e1470a8c42d3e8bff52c6a9bf79710625612fe16;p=github%2Fbastienwirtz%2Fhomer.git

diff --git a/README.md b/README.md
index 337fb5d..8818e32 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,14 @@
 # Homer
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Contribution Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
+[![Gitter](https://badges.gitter.im/homer-dashboard/community.svg)](https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 [![Dowload](https://img.shields.io/badge/Dowload-homer.zip-orange)](https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip)
 [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/awesome-selfhosted/awesome-selfhosted)
 
 A dead simple static **HOM**epage for your serv**ER** to keep your s
 ervices on hand, from a simple `yaml` configuration file.
 
-## [Live demo](https://homer-demo.netlify.app).
+## [Live demo](https://homer-demo.netlify.app)  • [Chat](https://gitter.im/homer-dashboard/community)
 ![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png)
 
 ## Table of Contents
@@ -41,6 +42,14 @@ Homer is a full static html/js dashboard, generated from the source in `/src` us
 docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
 ```
 
+As a bind mount is used here, docker will not copy the initial content of the `assets` directory to the mounted directory. 
+You can initialise your assets directory with the content provided in this repository
+```sh
+cp -r /public/assets/* /your/local/assets/
+```
+
+**Alternatively** if you just want to provide images/icons without customizing the other files (app manifest & pwa icons), you can mount a custom directory in the `www` directory and use it in your `config.yml` for icons path.
+
 ### Using the release tarball (prebuilt, ready to use)
 
 Download and extract the latest the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `config.yml.dist` file to `config.yml`, and put it behind a webserver.
@@ -76,6 +85,10 @@ Title, icons, links, colors, and services can be configured in the `config.yml`
 # 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"
@@ -83,7 +96,10 @@ logo: "assets/homer.png"
 # icon: "fas fa-skull-crossbones"
 
 header: true # Set to false to hide the header
-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.header:
+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.
+
+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'.
@@ -166,7 +182,6 @@ services:
         tag: "other"
         url: "https://www.reddit.com/r/selfhosted/"
         target: "_blank" # optionnal html a tag target attribute
-      
 ```
 
 If you choose to fetch message information from an endpoint, the output format should be: