Homer logo

Homer

  •  0 ratings
In category: ← Personal Dashboards

About Homer

A dead simple static homepage to expose your server services, with an easy yaml configuration and connectivity check.

  •   941  
  •   0  
  •   0  
  •   0  
    •
Github stats:
  •  Commits: N/A  
  •   N/A  
  •   N/A  
  •  Latest commit: N/A  

Deploy this app to RackNerd for $0.99/mo only!

Languages/Platforms/Technologies:
Lincenses:

More about Homer

Homer's donut
Homer

A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file.

Buy Me A Coffee

Demo • Chat • Getting started

License: Apache 2 Gitter chat Download homer static build speed-blazing Awesome

## 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 - [yaml](http://yaml.org/) file configuration - Installable (pwa) - Search - Grouping - Theme customization - Offline health check - 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 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. It's meant to be served by an HTTP server, **it will not work if you open the index.html directly over file:// protocol**. ### Using docker 
docker run -d \
  -p 8080:8080 \
  -v </your/local/assets/>:/www/assets \
  --restart=always \
  b4bz/homer:latest
The container will run using a user uid and gid 1000. Add `--user :` to the docker command to adjust it. Make sure this match the ownership of your assets directory. **Environment variables:** * **`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`). * **`PORT`** (default: `8080`) If you would like to change internal port of Homer 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 and volume binding (equivalent to `-p` and `-v` arguments). Then launch the container: 
cd /path/to/docker-compose.yml/
docker-compose up -d
### Using the release tarball (prebuilt, ready to use) 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. 
wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
unzip homer.zip
cd homer
cp assets/config.yml.dist assets/config.yml
npx serve # or python -m http.server 8010 or apache, nginx ...
### Using Helm Thanks to [@djjudas21](https://github.com/djjudas21) [charts](https://github.com/djjudas21/charts/tree/main/charts/homer): 
helm repo add djjudas21 https://djjudas21.github.io/charts/
helm repo update djjudas21

# install with all defaults
helm install homer djjudas21/homer

# install with customisations
wget https://raw.githubusercontent.com/djjudas21/charts/main/charts/homer/values.yaml
# edit values.yaml
helm install homer djjudas21/homer -f values.yaml
### Build manually 
# 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.

Comments (0)

Please login to join the discussion on this project.

Homer Reviews (0)

Overall Rating

None

based on 0 ratings

Please login to review this project.

No reviews for this project yet.

↑ back to top

pCloud Lifetime

Popular Projects

FluxBB

in Social Networks and Forums
 38k    0    0    0  

Nextcloud

in File Transfer & Synchronization
 27k    1    1    0  

Dashboard

in Personal Dashboards
 9k    0    0    0  

Libreddit

in Social Networks and Forums
 9k    0    1    0  

Audiobookshelf

in Audio Streaming
 8k    0    1    0  

CasaOS

in Self-hosting Solutions
 7k    0    0    0  

Mediagoblin

in Photo and Video Galleries
 7k    0    0    0  

Most Discussed

Nextcloud

in File Transfer & Synchronization
 27k    1    1    0  

Tube Archivist

in Automation
 4k    0    1    0  

OneDev

in Project Management
 3k    0    0    0  

iodine

in Proxy
 3k    0    0    0  

Alf.io

in Booking and Scheduling
 3k    0    0    0  

sysPass

in Password Managers
 1k    0    0    0  

Misskey

in Social Networks and Forums
 3k    0    0    0  
Linux VPS from $11/yr.
RackNerd VPS for $11.38/mo

Top Rated Projects

Gitea

 1 rating
in Project Management

Bagisto

 1 rating
in E-commerce

LinkAce

 1 rating
in Bookmarks and Link Sharing

Pydio

 1 rating
in File Transfer & Synchronization

Audiobookshelf

 1 rating
in Audio Streaming

Nextcloud

 1 rating
in File Transfer & Synchronization

Seafile

 1 rating
in File Transfer & Synchronization

Top Languages

Categories

You May Also Be Interested In

Dashy logo
Dashy cover

Dashy

Feature-rich homepage for your homelab, with easy YAML conf…

Organizr logo
Organizr cover

Organizr

Organizr aims to be your one stop shop for your Servers Fro…

Hiccup logo
Hiccup cover

Hiccup

A beautiful static homepage to get to your links and servic…