homer README

The project's README from github.com/bastienwirtz/homer. As one markdown file: README.md.

Homer's donut
Homer

A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file.

Buy Me A Coffee

License: Apache 2 Download homer static build speed-blazing Awesome

Demo • Docker Hub • Get started

Highlights

Table of Contents

Get started

Homer is a full static html/js dashboard, based on a simple yaml configuration file. See documentation 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

The configuration directory is bind mounted to make your dashboard easy to maintain.

Start the container with docker run

# Make sure your local config directory exists
docker run -d \
  --name homer \
  -p 8080:8080 \
  --mount type=bind,source="/path/to/config/dir",target=/www/assets \
  --restart=unless-stopped \
  b4bz/homer:latest

[!NOTE]
The container will run using a user uid and gid 1000 by default, add --user <your-UID>:<your-GID> to the docker command to adjust it if necessary. Make sure this match the permissions of your assets directory.

or docker-compose

services:
  homer:
    image: b4bz/homer
    container_name: homer
    volumes:
      - /path/to/config/dir:/www/assets # Make sure your local config directory exists
    ports:
      - 8080:8080
    user: 1000:1000 # default
    environment:
      - INIT_ASSETS=1 # default, requires the config directory to be writable for the container user (see user option)
    restart: unless-stopped

Environment variables:

Using the release tarball (prebuilt, ready to use)

Download and extract the latest release (homer.zip) from the release page, rename the assets/config.yml.dist file to assets/config.yml, and put it behind a web server.

wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
unzip homer.zip -d homer
cd homer
cp assets/config.yml.dist assets/config.yml
pnpx http-server # or python -m http.server 8010 or any web server.

Build manually

pnpm install
pnpm build

Then your dashboard is ready to use in the /dist directory.

homer (bastienwirtz/homer)

Searching Database…

11.7K ·GitHub
Homer
Что это такое?Homer — максимально простая статическая панель для вашего сервера, которая выводит все ваши сервисы на одной главной странице. Настраивается она через один YAML-файл.
Это приложение, которое нужно запускать, или просто статическая страница?Это статический сайт из HTML/JS, сгенерированный из Vue-приложения. Собранные файлы нужно отдавать через любой HTTP-сервер, а не открывать index.html напрямую.
Как его запустить?Запустите его командой 'docker run' или docker-compose, используя официальный образ, либо скачайте готовый архив релиза (homer.zip), переименуйте config.yml.dist в config.yml и раздавайте файлы через веб-сервер.
Нужно ли что-то кроме YAML-конфига и веб-сервера?Бэкенд и база данных не нужны — достаточно работающего HTTP-сервера для раздачи статических файлов и файла config.yml с описанием ваших сервисов.
Есть ли подводные камни при установке?Не будет работать, если открыть index.html напрямую по протоколу file:// — страницу обязательно нужно отдавать по HTTP.
Заработает ли это на Raspberry Pi?Да. Это легковесное статическое Docker-приложение, поэтому оно нормально работает на маломощных устройствах вроде Raspberry Pi. Также есть вариант установки в Kubernetes.
Можно ли установить Homer как приложение на телефон или компьютер?Да, его можно установить как PWA (Progressive Web App), то есть добавить на домашний экран телефона или на рабочий стол компьютера, как обычное нативное приложение.
Что такое «умная карточка» в Homer?Умные карточки — это плитки панели, которые для некоторых сервисов могут показывать текущий статус или дополнительную информацию, а не только ссылку и иконку.
Можно ли разложить много сервисов по группам или страницам?Да, Homer поддерживает многостраничную структуру и группировку элементов, так что большое количество сервисов можно аккуратно упорядочить.
Есть ли горячие клавиши?Да: '/' начинает поиск, 'Escape' его завершает, 'Enter' открывает первое совпадение, а 'Alt+Enter' открывает его в новой вкладке.
What are similar projects?dashy, Piped, glance, homepage, chatwoot, habitica, hoppscotch, MyIP
Which topics is it in?toolbox, static-site, vuejs, self-hosting, pwa, yaml, raspberry-pi, vue, dashboard, hacktoberfest, web-app, apache-2.0
Creator
bastienwirtz
Size
5.5 MB
Stars
11.7K
Updated
CommitAug 30Releasev26.08.3Aug 30
Age
8y
Commits · 90 Days