]>
Commit | Line | Data |
---|---|---|
a9aed9f9 | 1 | <h1 align="center"> |
1d3287dc BW |
2 | <img |
3 | width="180" | |
4 | alt="Homer's donut" | |
5 | src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png"> | |
a9aed9f9 BW |
6 | <br/> |
7 | Homer | |
8 | </h1> | |
9 | ||
10 | <h4 align="center"> | |
1d3287dc | 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. |
a9aed9f9 BW |
12 | </h4> |
13 | ||
14 | <p align="center"> | |
1d3287dc BW |
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> | |
a9aed9f9 BW |
22 | </p> |
23 | <p align="center"> | |
1d3287dc BW |
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> | |
a9aed9f9 | 27 | <a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img |
1d3287dc BW |
28 | alt="Gitter chat" |
29 | src="https://badges.gitter.im/homer-dashboard/community.svg"></a> | |
a9aed9f9 | 30 | <a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img |
1d3287dc BW |
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> | |
a9aed9f9 BW |
36 | </p> |
37 | ||
38 | <p align="center"> | |
1d3287dc | 39 | <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%"> |
a9aed9f9 | 40 | </p> |
a4de4a3a | 41 | |
e1470a8c | 42 | ## Table of Contents |
1d3287dc | 43 | |
e1470a8c BW |
44 | - [Features](#features) |
45 | - [Getting started](#getting-started) | |
1bc75494 | 46 | - [Configuration](docs/configuration.md) |
92d899bd | 47 | - [Custom services](docs/customservices.md) |
1bc75494 | 48 | - [Tips & tricks](docs/tips-and-tricks.md) |
2662b170 | 49 | - [Development](docs/development.md) |
7129af3b | 50 | - [Troubleshooting](docs/troubleshooting.md) |
a4de4a3a | 51 | |
e1470a8c | 52 | ## Features |
1d3287dc | 53 | |
e1470a8c BW |
54 | - [yaml](http://yaml.org/) file configuration |
55 | - Installable (pwa) | |
56 | - Search | |
86f4680a | 57 | - Grouping |
e1470a8c | 58 | - Theme customization |
26dbed93 | 59 | - Offline health check |
e1470a8c BW |
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. | |
09763dbf | 65 | |
e1470a8c | 66 | ## Getting started |
22555b55 | 67 | |
e1470a8c | 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**. |
b79e6ed1 | 69 | |
b102c9b2 | 70 | See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options. |
1bc75494 | 71 | |
b79e6ed1 BW |
72 | ### Using docker |
73 | ||
86f4680a | 74 | To launch container: |
e4537f13 | 75 | |
b79e6ed1 | 76 | ```sh |
9ba0d54e BW |
77 | docker run -d \ |
78 | -p 8080:8080 \ | |
79 | -v </your/local/assets/>:/www/assets \ | |
80 | --restart=always \ | |
81 | b4bz/homer:latest | |
b79e6ed1 BW |
82 | ``` |
83 | ||
b102c9b2 | 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" [...]`). |
897f67f0 | 85 | |
caf5fae8 BG |
86 | ## Host in subfolder |
87 | ||
88 | If you would like to host Homer in a subfolder, for e.g. behind a reverse proxy, supply the name of subfolder by using the `SUBFOLDER` env var. | |
89 | ||
e4537f13 | 90 | ### Using docker-compose |
91 | ||
92 | The `docker-compose.yml` file must be edited to match your needs. | |
86f4680a | 93 | Set the port and volume (equivalent to `-p` and `-v` arguments): |
e4537f13 | 94 | |
95 | ```yaml | |
96 | volumes: | |
97 | - /your/local/assets/:/www/assets | |
98 | ports: | |
99 | - 8080:8080 | |
100 | ``` | |
101 | ||
86f4680a | 102 | To launch container: |
e4537f13 | 103 | |
104 | ```sh | |
105 | cd /path/to/docker-compose.yml | |
106 | docker-compose up -d | |
107 | ``` | |
108 | ||
86f4680a | 109 | 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`: |
e4537f13 | 110 | |
111 | ```yaml | |
112 | environment: | |
86f4680a | 113 | - UID=1000 |
114 | - GID=1000 | |
e4537f13 | 115 | ``` |
116 | ||
e1470a8c | 117 | ### Using the release tarball (prebuilt, ready to use) |
b9c5fcf0 | 118 | |
1d3287dc | 119 | 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. |
86f4680a | 120 | |
b9c5fcf0 | 121 | ```sh |
e1470a8c BW |
122 | wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip |
123 | unzip homer.zip | |
124 | cd homer | |
b102c9b2 | 125 | cp assets/config.yml.dist assets/config.yml |
e1470a8c | 126 | npx serve # or python -m http.server 8010 or apache, nginx ... |
b9c5fcf0 BW |
127 | ``` |
128 | ||
e1470a8c | 129 | ### Build manually |
b9c5fcf0 BW |
130 | |
131 | ```sh | |
132 | # Using yarn (recommended) | |
133 | yarn install | |
e1470a8c | 134 | yarn build |
b9c5fcf0 BW |
135 | |
136 | # **OR** Using npm | |
137 | npm install | |
e1470a8c | 138 | npm run build |
b9c5fcf0 BW |
139 | ``` |
140 | ||
e1470a8c | 141 | Then your dashboard is ready to use in the `/dist` directory. |