X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=65ef9ab92fc21fe5fc1d088df9ecaf3249c9bdf4;hb=b24251110179b86e12d6823618777ef133738861;hp=11d4714d80c3ab36b038ca97268cf413024f1e27;hpb=2cf93f388130134d8ff9cf1af7535e21cafc207f;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index 11d4714..65ef9ab 100644 --- a/README.md +++ b/README.md @@ -1,116 +1,87 @@ # Homer -A dead simple static **HOM**epage for your serv**ER** to keep your services on hand, from a simple `yaml` configuration file. +[![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) -**Check out the live demo [here](https://homer-demo.netlify.com/).** +A dead simple static **HOM**epage for your serv**ER** to keep your s +ervices on hand, from a simple `yaml` configuration file. -If you need authentication support, you're on your own (it can be secured using a web server auth module or exposing it only through a VPN network / SSH tunnel, ...) +## [Live demo](https://homer-demo.netlify.app) ⢠[Chat](https://gitter.im/homer-dashboard/community) +![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png) -![screenshot](https://github.com/bastienwirtz/homer/blob/master/screenshot.png) +## Table of Contents +- [Features](#features) +- [Getting started](#getting-started) +- [Configuration](docs/configuration.md) +- [Tips & tricks](docs/tips-and-tricks.md) +- [Roadmap](#roadmap) +- [Developement](docs/developement.md) -## installation + +## Features +- [yaml](http://yaml.org/) file configuration +- Installable (pwa) +- Search +- Grouping +- Theme customization +- Offline heathcheck +- keyboard shortcuts: + - `/` Start searching. + - `Escape` Stop searching. + - `Enter` Open the first matching result (respects the bookmark's `_target` property). + - `Alt`/`Option` + `Enter` Open the first matching result in a new tab. + + +## Getting started + +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 -sudo 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/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/ ``` -### Manually - -**How to build / install it?** There is no build system (ð±), use it like that! It'meant to be stupid simple & zero maintenance required. just copy the static files somewhere, and visit the `index.html`. - - -## configuration - -Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format. - - -```yaml ---- -# Homepage configuration -# See https://fontawesome.com/icons for icons options - -title: "Simple homepage" -subtitle: "Homer" -logo: "assets/homer.png" -# Alternatively a fa icon can be provided: -# icon: "fas fa-skull-crossbones" -footer: '
Created with â¤ï¸ with bulma, vuejs & font awesome // Fork me on
' # set false if you want to hide it.header: - -# Optional message -message: - # url: "https://