diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 12 |
1 files changed, 10 insertions, 2 deletions
@@ -1,14 +1,14 @@ | |||
1 | # Homer | 1 | # Homer |
2 | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) | 2 | [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) |
3 | [![Contribution Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) | 3 | [![Contribution Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com) |
4 | [![Gitter chat](https://img.shields.io/badge/chat-on_gitter-008080.svg?style=flat-square)](https://gitter.im/homer-dashboard) | 4 | [![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) |
5 | [![Dowload](https://img.shields.io/badge/Dowload-homer.zip-orange)](https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip) | 5 | [![Dowload](https://img.shields.io/badge/Dowload-homer.zip-orange)](https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip) |
6 | [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/awesome-selfhosted/awesome-selfhosted) | 6 | [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/awesome-selfhosted/awesome-selfhosted) |
7 | 7 | ||
8 | A dead simple static **HOM**epage for your serv**ER** to keep your s | 8 | A dead simple static **HOM**epage for your serv**ER** to keep your s |
9 | ervices on hand, from a simple `yaml` configuration file. | 9 | ervices on hand, from a simple `yaml` configuration file. |
10 | 10 | ||
11 | ## [Live demo](https://homer-demo.netlify.app) • [Chat](https://gitter.im/homer-dashboard/) | 11 | ## [Live demo](https://homer-demo.netlify.app) • [Chat](https://gitter.im/homer-dashboard/community) |
12 | ![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png) | 12 | ![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png) |
13 | 13 | ||
14 | ## Table of Contents | 14 | ## Table of Contents |
@@ -42,6 +42,14 @@ Homer is a full static html/js dashboard, generated from the source in `/src` us | |||
42 | docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest | 42 | docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest |
43 | ``` | 43 | ``` |
44 | 44 | ||
45 | As a bind mount is used here, docker will not copy the initial content of the `assets` directory to the mounted directory. | ||
46 | You can initialise your assets directory with the content provided in this repository | ||
47 | ```sh | ||
48 | cp -r /public/assets/* /your/local/assets/ | ||
49 | ``` | ||
50 | |||
51 | **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. | ||
52 | |||
45 | ### Using the release tarball (prebuilt, ready to use) | 53 | ### Using the release tarball (prebuilt, ready to use) |
46 | 54 | ||
47 | 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. | 55 | 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. |