]>
Commit | Line | Data |
---|---|---|
1 | <h1 align="center"> | |
2 | <img | |
3 | width="180" | |
4 | alt="Homer's donut" | |
5 | src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png"> | |
6 | <br/> | |
7 | Homer | |
8 | </h1> | |
9 | ||
10 | <h4 align="center"> | |
11 | 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. | |
12 | </h4> | |
13 | ||
14 | <p align="center"> | |
15 | <strong> | |
16 | <a href="https://homer-demo.netlify.app">Demo</a> | |
17 | • | |
18 | <a href="https://gitter.im/homer-dashboard/community">Chat</a> | |
19 | • | |
20 | <a href="#getting-started">Getting started</a> | |
21 | </strong> | |
22 | </p> | |
23 | <p align="center"> | |
24 | <a href="https://opensource.org/licenses/Apache-2.0"><img | |
25 | alt="License: Apache 2" | |
26 | src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a> | |
27 | <a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img | |
28 | alt="Gitter chat" | |
29 | src="https://badges.gitter.im/homer-dashboard/community.svg"></a> | |
30 | <a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img | |
31 | alt="Download homer static build" | |
32 | src="https://img.shields.io/badge/Download-homer.zip-orange"></a> | |
33 | <a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img | |
34 | alt="Awesome" | |
35 | src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a> | |
36 | </p> | |
37 | ||
38 | <p align="center"> | |
39 | <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%"> | |
40 | </p> | |
41 | ||
42 | ## Table of Contents | |
43 | ||
44 | - [Features](#features) | |
45 | - [Getting started](#getting-started) | |
46 | - [Configuration](docs/configuration.md) | |
47 | - [Custom services](docs/customservices.md) | |
48 | - [Tips & tricks](docs/tips-and-tricks.md) | |
49 | - [Development](docs/development.md) | |
50 | - [Troubleshooting](docs/troubleshooting.md) | |
51 | ||
52 | ## Features | |
53 | ||
54 | - [yaml](http://yaml.org/) file configuration | |
55 | - Installable (pwa) | |
56 | - Search | |
57 | - Grouping | |
58 | - Theme customization | |
59 | - Offline health check | |
60 | - keyboard shortcuts: | |
61 | - `/` Start searching. | |
62 | - `Escape` Stop searching. | |
63 | - `Enter` Open the first matching result (respects the bookmark's `_target` property). | |
64 | - `Alt`/`Option` + `Enter` Open the first matching result in a new tab. | |
65 | ||
66 | ## Getting started | |
67 | ||
68 | 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**. | |
69 | ||
70 | See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options. | |
71 | ||
72 | ### Using docker | |
73 | ||
74 | To launch container: | |
75 | ||
76 | ```sh | |
77 | docker run -d \ | |
78 | -p 8080:8080 \ | |
79 | -v </your/local/assets/>:/www/assets \ | |
80 | --restart=always \ | |
81 | b4bz/homer:latest | |
82 | ``` | |
83 | ||
84 | 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" [...]`). | |
85 | ||
86 | ### Using docker-compose | |
87 | ||
88 | The `docker-compose.yml` file must be edited to match your needs. | |
89 | Set the port and volume (equivalent to `-p` and `-v` arguments): | |
90 | ||
91 | ```yaml | |
92 | volumes: | |
93 | - /your/local/assets/:/www/assets | |
94 | ports: | |
95 | - 8080:8080 | |
96 | ``` | |
97 | ||
98 | To launch container: | |
99 | ||
100 | ```sh | |
101 | cd /path/to/docker-compose.yml | |
102 | docker-compose up -d | |
103 | ``` | |
104 | ||
105 | Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner, also in `docker-compose.yml`: | |
106 | ||
107 | ```yaml | |
108 | environment: | |
109 | - UID=1000 | |
110 | - GID=1000 | |
111 | ``` | |
112 | ||
113 | ### Using the release tarball (prebuilt, ready to use) | |
114 | ||
115 | 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. | |
116 | ||
117 | ```sh | |
118 | wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip | |
119 | unzip homer.zip | |
120 | cd homer | |
121 | cp assets/config.yml.dist assets/config.yml | |
122 | npx serve # or python -m http.server 8010 or apache, nginx ... | |
123 | ``` | |
124 | ||
125 | ### Build manually | |
126 | ||
127 | ```sh | |
128 | # Using yarn (recommended) | |
129 | yarn install | |
130 | yarn build | |
131 | ||
132 | # **OR** Using npm | |
133 | npm install | |
134 | npm run build | |
135 | ``` | |
136 | ||
137 | Then your dashboard is ready to use in the `/dist` directory. |