homer/README.md

129 lines
4.6 KiB
Markdown
Raw Normal View History

2020-06-29 06:42:07 +02:00
<h1 align="center">
2021-09-25 12:12:22 +02:00
<img
width="180"
alt="Homer's donut"
src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png">
2020-06-29 06:42:07 +02:00
<br/>
Homer
</h1>
<h4 align="center">
2021-09-25 12:12:22 +02:00
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.
2020-06-29 06:42:07 +02:00
</h4>
2024-10-25 21:58:32 +02:00
<p align="center">
2022-10-28 10:24:38 +02:00
<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>
2020-06-29 06:42:07 +02:00
<p align="center">
2021-09-25 12:12:22 +02:00
<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>
2020-06-29 06:42:07 +02:00
<a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img
2021-09-25 12:12:22 +02:00
alt="Gitter chat"
src="https://badges.gitter.im/homer-dashboard/community.svg"></a>
2020-06-29 06:42:07 +02:00
<a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img
2021-09-25 12:12:22 +02:00
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>
2021-09-25 12:12:22 +02:00
<a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img
alt="Awesome"
src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
2020-06-29 06:42:07 +02:00
</p>
<p align="center">
2021-09-25 12:12:22 +02:00
<img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
2020-06-29 06:42:07 +02:00
</p>
2020-06-06 07:56:53 +02:00
## Table of Contents
2021-09-25 12:12:22 +02:00
2020-06-06 07:56:53 +02:00
- [Features](#features)
- [Getting started](#get-started)
- [Kubernetes Installation](docs/kubernetes.md)
- [Configuration](docs/configuration.md)
- [Theming](docs/theming.md)
2024-10-25 21:58:32 +02:00
- [Smart cards](docs/customservices.md)
- [Tips & tricks](docs/tips-and-tricks.md)
- [Development](docs/development.md)
2021-09-25 12:13:04 +02:00
- [Troubleshooting](docs/troubleshooting.md)
2024-10-25 21:58:32 +02:00
## Highlights
- ⚡️ Lightweight & Fast
- 🥱 Low / No maintenance
- 📄 Simple [yaml](http://yaml.org/) file configuration
- Installable (pwa)
- 🧠 Smart cards
- 🔍️ Fuzzy search
- 📂 Multi pages & item grouping
- 🎨 Theme customization
- ⌨️ keyboard shortcuts:
2020-06-06 07:56:53 +02:00
- `/` 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.
2018-06-14 07:14:05 +02:00
2024-10-25 21:58:32 +02:00
## Get started
2020-03-22 23:51:54 +01:00
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.
2020-02-28 00:13:48 +01:00
It's meant to be served by an HTTP server, **it will not work if you open the index.html directly over file:// protocol**.
2020-02-28 00:13:48 +01:00
### Using docker
```sh
2021-02-16 07:23:16 +01:00
docker run -d \
-p 8080:8080 \
-v </your/local/assets/>:/www/assets \
--restart=always \
b4bz/homer:latest
2020-02-28 00:13:48 +01:00
```
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.
2024-10-25 21:58:32 +02:00
**Environment variables:**
2024-10-25 21:58:32 +02:00
- **`INIT_ASSETS`** (default: `1`)
2022-05-03 19:00:49 +02:00
Install example configuration file & assets (favicons, ...) to help you get started.
2020-06-07 08:15:27 +02:00
2024-10-25 21:58:32 +02:00
- **`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`).
2024-10-25 21:58:32 +02:00
- **`PORT`** (default: `8080`)
If you would like to change internal port of Homer from default `8080` to your port choice.
2024-10-25 21:58:32 +02:00
- **`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
```
2020-06-06 07:56:53 +02:00
### Using the release tarball (prebuilt, ready to use)
2021-09-25 12:12:22 +02:00
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
2020-06-06 07:56:53 +02:00
wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
unzip homer.zip -d homer
2020-06-06 07:56:53 +02:00
cd homer
cp assets/config.yml.dist assets/config.yml
pnpx http-server # or python -m http.server 8010 or any web server.
```
2020-06-06 07:56:53 +02:00
### Build manually
```sh
2024-04-22 19:55:25 +02:00
pnpm install
pnpm build
```
2020-06-06 07:56:53 +02:00
Then your dashboard is ready to use in the `/dist` directory.