mirror of
https://github.com/bastienwirtz/homer.git
synced 2026-01-23 02:15:09 +00:00
doc: review documentation
This commit is contained in:
parent
ea12ee520b
commit
c6571b48b4
7 changed files with 90 additions and 96 deletions
47
README.md
47
README.md
|
|
@ -10,18 +10,9 @@
|
|||
<h4 align="center">
|
||||
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.
|
||||
</h4>
|
||||
<p align="center">
|
||||
<p align="center">
|
||||
<a href="https://www.buymeacoffee.com/bastien" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-yellow.png" alt="Buy Me A Coffee" height="41" width="174"></a>
|
||||
<p>
|
||||
<p align="center">
|
||||
<strong>
|
||||
<a href="https://homer-demo.netlify.app">Demo</a>
|
||||
•
|
||||
<a href="https://gitter.im/homer-dashboard/community">Chat</a>
|
||||
•
|
||||
<a href="#getting-started">Getting started</a>
|
||||
</strong>
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://opensource.org/licenses/Apache-2.0"><img
|
||||
alt="License: Apache 2"
|
||||
|
|
@ -51,26 +42,28 @@
|
|||
- [Kubernetes Installation](docs/kubernetes.md)
|
||||
- [Configuration](docs/configuration.md)
|
||||
- [Theming](docs/theming.md)
|
||||
- [Custom services](docs/customservices.md)
|
||||
- [Smart cards](docs/customservices.md)
|
||||
- [Tips & tricks](docs/tips-and-tricks.md)
|
||||
- [Development](docs/development.md)
|
||||
- [Troubleshooting](docs/troubleshooting.md)
|
||||
|
||||
## Features
|
||||
## Highlights
|
||||
|
||||
- [yaml](http://yaml.org/) file configuration
|
||||
- Installable (pwa)
|
||||
- Search
|
||||
- Grouping
|
||||
- Theme customization
|
||||
- Offline health check
|
||||
- keyboard shortcuts:
|
||||
- ⚡️ Lightweight & Fast
|
||||
- 🥱 Low / No maintenance
|
||||
- 📄 Simple [yaml](http://yaml.org/) file configuration
|
||||
- ➕ Installable (pwa)
|
||||
- 🧠 Smart cards
|
||||
- 🔍️ Fuzzy search
|
||||
- 📂 Multi pages & item grouping
|
||||
- 🎨 Theme customization
|
||||
- ⌨️ keyboard shortcuts:
|
||||
- `/` Start searching.
|
||||
- `Escape` Stop searching.
|
||||
- `Enter` Open the first matching result (respects the bookmark's `_target` property).
|
||||
- `Alt`/`Option` + `Enter` Open the first matching result in a new tab.
|
||||
|
||||
## Getting started
|
||||
## Get started
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -88,18 +81,18 @@ docker run -d \
|
|||
|
||||
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.
|
||||
|
||||
**Environment variables:**
|
||||
**Environment variables:**
|
||||
|
||||
* **`INIT_ASSETS`** (default: `1`)
|
||||
- **`INIT_ASSETS`** (default: `1`)
|
||||
Install example configuration file & assets (favicons, ...) to help you get started.
|
||||
|
||||
* **`SUBFOLDER`** (default: `null`)
|
||||
If you would like to host Homer in a subfolder, (ex: *http://my-domain/**homer***), set this to the subfolder path (ex `/homer`).
|
||||
- **`SUBFOLDER`** (default: `null`)
|
||||
If you would like to host Homer in a subfolder, (ex: *<http://my-domain/homer>*), set this to the subfolder path (ex `/homer`).
|
||||
|
||||
* **`PORT`** (default: `8080`)
|
||||
- **`PORT`** (default: `8080`)
|
||||
If you would like to change internal port of Homer from default `8080` to your port choice.
|
||||
|
||||
* **`IPV6_DISABLE`** (default: 0)
|
||||
- **`IPV6_DISABLE`** (default: 0)
|
||||
Set to `1` to disable listening on IPv6.
|
||||
|
||||
#### With docker-compose
|
||||
|
|
@ -122,7 +115,7 @@ 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
|
||||
npx serve # or python -m http.server 8010 or apache, nginx ...
|
||||
npx serve # or python -m http.server 8010 or any web server.
|
||||
```
|
||||
|
||||
### Build manually
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue