Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/realashleybailey/homerui
A full featured version of the original Homer
https://github.com/realashleybailey/homerui
dashboard homepage self-hosted toolbox vuejs
Last synced: about 1 month ago
JSON representation
A full featured version of the original Homer
- Host: GitHub
- URL: https://github.com/realashleybailey/homerui
- Owner: realashleybailey
- License: apache-2.0
- Created: 2022-12-24T00:02:23.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-27T00:43:28.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T10:56:42.472Z (10 months ago)
- Topics: dashboard, homepage, self-hosted, toolbox, vuejs
- Language: Vue
- Homepage:
- Size: 13.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Not Complete Yet Will Finish Project in a Couple of Months
HomerUI
A not so dead simple take on Homer by bastienwirtz.
Please read before usage
This is a fork of Homer by bastienwirtz, this project aims to allow users to configure and manage there Homer Dashboard from the browser and also bring Live Stats to the Service cards, if you want something more simple then please go over to the original Homer and give them some love, there work is great, however if you are looking for something with a more advanced feature set then continue below.
## Table of Contents
- [Features](#features)
- [Getting started](#getting-started)
- [Configuration](docs/configuration.md)
- [Custom services](docs/customservices.md)
- [Tips & tricks](docs/tips-and-tricks.md)
- [Development](docs/development.md)
- [Troubleshooting](docs/troubleshooting.md)
## Features
- Full GUI for configuration using the browser
- Grouping Services
- Theme customization
- Offline health check
- API intergration
- Live Statistics
- Dark Mode
- Authentication
- and more...
## Getting started
HomerUI is a dashboard for all your services and websites, as mentioned above HomerUI is based on the original Homer and carries over the interface styles, so if you previously used Homer you won't loose that lovely CSS.
See [documentation](docs/configuration.md) for information about the configuration options.
Unlike Homer, HomerUI must be served by the included Express server, **it will not work if you simply host the dist folder**, this is because HomerUI relies on a SQlite database to store all the configuration and services and will communicate with the backend using the REST API.
### Using docker
```sh
docker run -d \
-p 8080:8080 \
--restart=always \
realashleybailey/homerui:latest
```
**Environment variables:**
* **`PORT`** (default: `8080`)
If you would like to change internal port of HomerUI from default `8080` to your port choice.
#### With docker-compose
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 (equivalent to `-p` argument).
Then launch the container:
```sh
cd /path/to/docker-compose.yml/
docker-compose up -d
```
### Build manually
```sh
# Using yarn (recommended)
yarn install
yarn build
# **OR** Using npm
npm install
npm run build
```
Then your dashboard is ready to use in the `/dist` directory.