X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=f65b417af3dd0cbc16efc92358f43ec6f8cec004;hb=a7ba289efa228613b18abc853c22fb3b5d99b9a7;hp=c2b7c84de31771355b63b32d70bb9a7f1151d839;hpb=b0a0fdaa3b2fca33ee128f39d9bd1c9dcfda0db8;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index c2b7c84..f65b417 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,24 @@ # 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 - [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 @@ -35,21 +38,23 @@ 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**. +See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options. + ### Using docker ```sh -docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest +docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest ``` ### 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. +Download and extract the latest the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `assets/config.yml.dist` file to `assets/config.yml`, and put it behind a webserver. ```sh wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip unzip homer.zip cd homer -cp config.yml.dist config.yml +cp assets/config.yml.dist assets/config.yml npx serve # or python -m http.server 8010 or apache, nginx ... ``` @@ -67,164 +72,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 - -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.header: - -# 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://