-# Homer
-[](https://opensource.org/licenses/Apache-2.0)
-[](http://makeapullrequest.com)
-[](https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip)
-[](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).
-
+<h1 align="center">
+ <img
+ width="180"
+ alt="Homer's donut"
+ src="public/logo.png">
+ <br/>
+ Homer
+</h1>
+
+<h4 align="center">
+ A dead simple static <strong>HOM</strong>epage for your serv<strong>ER</strong> to keep your services on hand, from a simple <code>yaml</code> configuration file.
+</h4>
+
+<p align="center">
+ <strong>
+ <a href="https://homer-demo.netlify.app">Demo</a>
+ •
+ <a href="https://gitter.im/homer-dashboard/community">Chat</a>
+ •
+ <a href="#getting-started">Getting started</a>
+ </strong>
+</p>
+<p align="center">
+ <a href="https://opensource.org/licenses/Apache-2.0"><img
+ alt="License: Apache 2"
+ src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
+ <a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img
+ alt="Gitter chat"
+ src="https://badges.gitter.im/homer-dashboard/community.svg"></a>
+ <a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img
+ alt="Download homer static build"
+ src="https://img.shields.io/badge/Download-homer.zip-orange"></a>
+ <a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img
+ alt="Awesome"
+ src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
+</p>
+
+<p align="center">
+ <img src="docs/images/screenshot.png" width="100%">
+</p>
## Table of Contents
+
- [Features](#features)
- [Getting started](#getting-started)
-- [Configuration](#configuration)
-- [Roadmap](#roadmap)
-- [Developement](#developement)
+- [Configuration](https://bastienwirtz.github.io/homer/configuration)
+- [Custom services](https://bastienwirtz.github.io/homer/custom_services)
+- [Tips & tricks](https://bastienwirtz.github.io/homer/tips_and_tricks)
+- [Development](https://bastienwirtz.github.io/homer/development)
+- [Troubleshooting](https://bastienwirtz.github.io/homer/troubleshooting)
## Features
+
- [yaml](http://yaml.org/) file configuration
- Installable (pwa)
- Search
-- Grouping
+- Grouping
- Theme customization
-- Offline heathcheck
+- Offline health check
- 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**.
+### Using Docker
-### Using docker
+The fastest and recommended way to get your Homer instance up and running is
+with Docker. The Docker image comes with a web server built-in so that all you
+need to worry about is your config file.
-```sh
-docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
-```
+Internally, the Docker image looks for the assets in the `/www/assets` directory
+so you can bind a volume from your host machine to that directory in order to
+modify and persist the configuration files. The web server serves the dashboard
+on port 8080, but using a port binding will let you expose that to whatever
+external port you like.
+
+#### docker
-### Using the release tarball (prebuilt, ready to use)
+To launch container:
-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 ...
+docker run -d \
+ -p 8080:8080 \
+ -v </your/local/assets>:/www/assets \
+ --restart=always \
+ b4bz/homer:latest
```
-### Build manually
+Use `UID` and/or `GID` env var to change the assets owner:
```sh
-# Using yarn (recommended)
-yarn install
-yarn build
-
-# **OR** Using npm
-npm install
-npm run build
+docker run -d \
+ -p 8080:8080 \
+ -v </your/local/assets>:/www/assets \
+ -e "UID=1000" -e "GID=1000" \
+ --restart=always \
+ b4bz/homer:latest
```
-Then your dashboard is ready to use in the `/dist` directory.
-
-## Configuration
+#### docker-compose
-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.
+It is recommended to use docker-compose to manage your Docker containers, and
+below you can find a simple compose yaml file. Copy the contents into a
+`docker-compose.yaml` and modify the volume binding to your desired directory to
+get started:
```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: '<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:
-
-# 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://<my-api-endpoint>" # Can fetch information from an endpoint to override value below.
- style: "is-warning"
- title: "Optional message!"
- content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
-
-# Optional navbar
-# links: [] # Allows for navbar (dark mode, layout, and search) without any links
-links:
- - name: "Link 1"
- icon: "fab fa-github"
- url: "https://github.com/bastienwirtz/homer"
- target: "_blank" # optional html tag target attribute
- - name: "link 2"
- icon: "fas fa-book"
- url: "https://github.com/bastienwirtz/homer"
-
-# Services
-# First level array represent a group.
-# Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
+version: '3.3'
services:
- - name: "Application"
- icon: "fa fa-code-fork"
- items:
- - name: "Awesome app"
- logo: "assets/tools/sample.png"
- # Alternatively a fa icon can be provided:
- # icon: "fab fa-jenkins"
- subtitle: "Bookmark example"
- tag: "app"
- url: "https://www.reddit.com/r/selfhosted/"
- target: "_blank" # optional html tag target attribute
- - name: "Another one"
- logo: "assets/tools/sample2.png"
- subtitle: "Another application"
- tag: "app"
- # Optional tagstyle
- tagstyle: "is-success"
- url: "#"
- - name: "Other group"
- icon: "fas fa-heartbeat"
- items:
- - name: "Another app"
- logo: "assets/tools/sample.png"
- subtitle: "Another example"
- tag: "other"
- url: "https://www.reddit.com/r/selfhosted/"
- target: "_blank" # optionnal html a tag target attribute
+ homer:
+ restart: always
+ volumes:
+ - /your/local/assets:/www/assets
+ ports:
+ - 8080:8080
+ image: b4bz/homer
```
-If you choose to fetch message information from an endpoint, the output format should be:
+To launch container:
-```json
-{
- "style": null,
- "title": "Lorem ipsum 42",
- "content": "LA LA LA Lorem ipsum dolor sit amet, ....."
-}
+```sh
+cd /path/to/docker-compose.yml
+docker-compose up -d
```
-`null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
-Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
-
-### Style Options
-
-Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll notice in the config there is a `tagstyle` option. It can be set to any of the bulma modifiers. You'll probably want to use one of these 4 main colors:
+Use `UID` and/or `GID` env var to change the assets owner:
-- `is-info` (blue)
-- `is-success` (green)
-- `is-warning` (yellow)
-- `is-danger` (red)
-
-You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
+```yaml
+version: '3.3'
+services:
+ homer:
+ restart: always
+ volumes:
+ - /your/local/assets:/www/assets
+ ports:
+ - 8080:8080
+ environment:
+ - UID=1000
+ - GID=1000
+ image: b4bz/homer
+```
+### Shipping your own web server
-## Roadmap
+#### Prebuilt release tarball
-- [ ] Add more themes.
-- [ ] Add support for custom service card (add custom feature to some service / app link)
+Download and extract 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 web
+server.
+```sh
+wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
+unzip homer.zip
+cd homer
+cp assets/config.yml.dist assets/config.yml
+npx serve # or python -m http.server 8010 or apache, nginx ...
+```
-## Development
+#### Building from source
```sh
# Using yarn (recommended)
yarn install
-yarn serve
+yarn build
# **OR** Using npm
npm install
-npm run serve
-```
-
-### Themes
-
-Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
-To addd a new theme, just add a file in the theme directory, and put all style in the `body #app.theme-<name>` scope. Then import it in the main style file.
-
-```scss
-// `src/assets/themes/my-awesome-theme.scss`
-body #app.theme-my-awesome-theme. { ... }
+npm run build
```
-```scss
-// `src/assets/app.scss`
-// Themes import
-@import "./themes/sui.scss";
-...
-@import "./themes/my-awesome-theme.scss";
-```
+Then your dashboard is ready to use in the `/dist` directory.
projects / github / bastienwirtz / homer.git / blobdiff