X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=09218c8684846583bcb1ea4b59bd1b7cb2e9a955;hb=897f67f0b62884a3dd6b01fbdbba9509e4ed2936;hp=fba8ce3d5f066cd69a829447bd37cb6e0dc7cbee;hpb=aabb7d538ece9cf093cc12ae7a253047ee0daf5e;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index fba8ce3..09218c8 100644 --- a/README.md +++ b/README.md @@ -1,129 +1,239 @@ # 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.app).** +A dead simple static **HOM**epage for your serv**ER** to keep your s +ervices on hand, from a simple `yaml` configuration file. -It supports 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. +## [Live demo](https://homer-demo.netlify.app) ⢠[Chat](https://gitter.im/homer-dashboard/community) +![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png) -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, ...) +## Table of Contents +- [Features](#features) +- [Getting started](#getting-started) +- [Configuration](#configuration) +- [Roadmap](#roadmap) +- [Developement](#developement) -![screenshot](https://raw.github.com/bastienwirtz/homer/master/screenshot.png) +## 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. -## Roadmap -- [ ] Colors / theme customization -- [ ] Enable PWA support (making possible to "install" - add to homescreen - it) -- [ ] Improve maintenability (external library import & service workers cached file list.) +## Getting started -## Installation +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**. ### 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 ``` -### Manually +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/ +``` -**How to build / install it?** There is no build system (ð±), use it like that! It's meant to be stupid simple & zero maintenance required. Just copy the static files somewhere, and visit the `index.html`. +**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) -## Configuration +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. + +```sh +wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip +unzip homer.zip +cd homer +cp config.yml.dist config.yml +npx serve # or python -m http.server 8010 or apache, nginx ... +``` -Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format. +### Build manually +```sh +# Using yarn (recommended) +yarn install +yarn build + +# **OR** Using npm +npm install +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: "Simple homepage" +title: "App dashboard" 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: +# 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://