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 文件进行配置。
这是需要运行的应用，还是只是一个静态页面？它是一个由 Vue 应用生成的静态 HTML/JS 网站；你需要用任意 HTTP 服务器来提供构建后的文件（不能直接打开 index.html）。
怎么把它跑起来？使用官方镜像，通过 'docker run' 或 docker-compose 运行；或者下载预构建的发布压缩包（homer.zip），把 config.yml.dist 重命名为 config.yml，然后用 Web 服务器提供服务。
除了 YAML 配置和 Web 服务器，还需要别的东西吗？不需要后端或数据库——只需要一个能正常工作的 HTTP 服务器来提供静态文件，再加上一个描述你各项服务的 config.yml 即可。
安装时有什么需要注意的坑吗？如果你通过 file:// 协议直接打开 index.html，它将无法工作——必须通过 HTTP 提供服务。
它也能在树莓派之类的设备上运行吗？可以。它是一个轻量的静态 Docker 应用，在树莓派这类小型设备上运行没有问题，另外还提供 Kubernetes 的安装方式。
我可以把 Homer 安装成手机或电脑上的应用吗？可以。它支持作为 PWA（渐进式 Web 应用）安装，你可以把它添加到手机主屏幕或电脑桌面上，使用体验类似原生应用。
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