<h1 align="center">
- width="180"
- alt="Homer's donut"
- src="https://raw.githubusercontent.com//bastienwirtz/homer/master/public/logo.png">
+ <img
+ width="180"
+ alt="Homer's donut"
+ src="https://raw.githubusercontent.com//bastienwirtz/homer/main/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 `yaml` configuration file.
+ 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">
+ <a href="https://www.buymeacoffee.com/bastien" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-yellow.png" alt="Buy Me A Coffee" height="41" width="174"></a>
+<p>
<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>
+ <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://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>
+ 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>
+ alt="Download homer static build"
+ src="https://img.shields.io/badge/Download-homer.zip-orange"></a>
+ <a href="https://twitter.com/acdlite/status/974390255393505280"><img
+ alt="speed-blazing"
+ src="https://img.shields.io/badge/speed-blazing%20%F0%9F%94%A5-red"></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="https://raw.github.com/bastienwirtz/homer/master/docs/screenshot.png" width="100%">
+ <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
</p>
## Table of Contents
+
- [Features](#features)
- [Getting started](#getting-started)
- [Configuration](docs/configuration.md)
+- [Custom services](docs/customservices.md)
- [Tips & tricks](docs/tips-and-tricks.md)
-- [Roadmap](#roadmap)
-- [Developement](docs/developement.md)
-
+- [Development](docs/development.md)
+- [Troubleshooting](docs/troubleshooting.md)
## 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**.
+Homer is a full static html/js dashboard, based on a simple yaml configuration file. See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options.
-See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options.
+It's meant to be served by an HTTP server, **it will not work if you open the index.html directly over file:// protocol**.
### Using docker
```sh
-docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest
+docker run -d \
+ -p 8080:8080 \
+ -v </your/local/assets/>:/www/assets \
+ --restart=always \
+ b4bz/homer:latest
```
-Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner (`docker run -e "UID=1000" -e "GID=1000" [...]`).
+The container will run using a user uid and gid 1000. Add `--user <your-UID>:<your-GID>` to the docker command to adjust it. Make sure this match the ownership of your assets directory.
+
+**Environment variables:**
+
+* **`INIT_ASSETS`** (default: `1`)
+Install example configuration file & assets (favicons, ...) to help you get started.
+
+* **`SUBFOLDER`** (default: `null`)
+If you would like to host Homer in a subfolder, (ex: *http://my-domain/**homer***), set this to the subfolder path (ex `/homer`).
+
+* **`PORT`** (default: `8080`)
+If you would like to change internal port of Homer from default `8080` to your port choice.
+
+* **`IPV6_DISABLE`** (default: 0)
+Set to `1` to disable listening on IPv6.
+
+#### With docker-compose
+
+A [`docker-compose.yml`](docker-compose.yml) file is available as an example. It must be edited to match your needs. You probably want to adjust the port mapping and volume binding (equivalent to `-p` and `-v` arguments).
+
+Then launch the container:
+
+```sh
+cd /path/to/docker-compose.yml/
+docker-compose up -d
+```
### 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 `assets/config.yml.dist` file to `assets/config.yml`, and put it behind a webserver.
-
+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
npx serve # or python -m http.server 8010 or apache, nginx ...
```
-### Build manually
+### Using Helm
+
+Thanks to [@djjudas21](https://github.com/djjudas21) [charts](https://github.com/djjudas21/charts/tree/main/charts/homer):
```sh
-# Using yarn (recommended)
-yarn install
-yarn build
+helm repo add djjudas21 https://djjudas21.github.io/charts/
+helm repo update djjudas21
-# **OR** Using npm
-npm install
-npm run build
-```
+# install with all defaults
+helm install homer djjudas21/homer
-Then your dashboard is ready to use in the `/dist` directory.
+# install with customisations
+wget https://raw.githubusercontent.com/djjudas21/charts/main/charts/homer/values.yaml
+# edit values.yaml
+helm install homer djjudas21/homer -f values.yaml
+```
+### Build manually
-## Roadmap
+```sh
+pnpm install
+pnpm build
+```
-- [ ] Add new themes.
-- [ ] Add support for custom service card (add custom feature to some service / app link)
+Then your dashboard is ready to use in the `/dist` directory.
projects / github / bastienwirtz / homer.git / blobdiff