]>
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 | |
b5bf9774 | 68 | 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. |
b79e6ed1 | 69 | |
b5bf9774 | 70 | It's meant to be served by an HTTP server, **it will not work if you open the index.html directly over file:// protocol**. |
1bc75494 | 71 | |
b79e6ed1 BW |
72 | ### Using docker |
73 | ||
74 | ```sh | |
9ba0d54e BW |
75 | docker run -d \ |
76 | -p 8080:8080 \ | |
77 | -v </your/local/assets/>:/www/assets \ | |
78 | --restart=always \ | |
79 | b4bz/homer:latest | |
b79e6ed1 BW |
80 | ``` |
81 | ||
b5bf9774 BW |
82 | 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. |
83 | ||
84 | **Environment variables:** | |
049f8522 BW |
85 | |
86 | * **`INIT_ASSETS`** (default: `1`) | |
766efb1a | 87 | Install example configuration file & assets (favicons, ...) to help you get started. |
897f67f0 | 88 | |
049f8522 BW |
89 | * **`SUBFOLDER`** (default: `null`) |
90 | If you would like to host Homer in a subfolder, (ex: *http://my-domain/**homer***), set this to the subfolder path (ex `/homer`). | |
caf5fae8 | 91 | |
b5bf9774 | 92 | #### With docker-compose |
caf5fae8 | 93 | |
b5bf9774 | 94 | 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). |
e4537f13 | 95 | |
049f8522 | 96 | Then launch the container: |
e4537f13 | 97 | |
98 | ```sh | |
049f8522 | 99 | cd /path/to/docker-compose.yml/ |
e4537f13 | 100 | docker-compose up -d |
101 | ``` | |
102 | ||
e1470a8c | 103 | ### Using the release tarball (prebuilt, ready to use) |
b9c5fcf0 | 104 | |
1d3287dc | 105 | 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 | 106 | |
b9c5fcf0 | 107 | ```sh |
e1470a8c BW |
108 | wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip |
109 | unzip homer.zip | |
110 | cd homer | |
b102c9b2 | 111 | cp assets/config.yml.dist assets/config.yml |
e1470a8c | 112 | npx serve # or python -m http.server 8010 or apache, nginx ... |
b9c5fcf0 BW |
113 | ``` |
114 | ||
e1470a8c | 115 | ### Build manually |
b9c5fcf0 BW |
116 | |
117 | ```sh | |
118 | # Using yarn (recommended) | |
119 | yarn install | |
e1470a8c | 120 | yarn build |
b9c5fcf0 BW |
121 | |
122 | # **OR** Using npm | |
123 | npm install | |
e1470a8c | 124 | npm run build |
b9c5fcf0 BW |
125 | ``` |
126 | ||
e1470a8c | 127 | Then your dashboard is ready to use in the `/dist` directory. |