X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=529ceff638b985ae1aa682e18db88832f0cf08d3;hb=81c90009b48f22d65bc8b59944b18c9503fc5676;hp=c98564ad72f1a114e25b3b3a6513914854cf2fe8;hpb=b21bf8b1af775e17833da4432d48ffc18a294ebc;p=github%2Fbastienwirtz%2Fhomer.git

diff --git a/README.md b/README.md
index c98564a..529ceff 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,134 @@
-# homer
-A very simple static homepage for your server.
+<h1 align="center">
+ <img
+  width="180"
+  alt="Homer's donut"
+  src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png">
+    <br/>
+    Homer
+</h1>
+
+<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">
+ <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"
+  src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
+  <a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img
+  alt="Gitter chat"
+  src="https://badges.gitter.im/homer-dashboard/community.svg"></a>
+  <a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img
+  alt="Download homer static build"
+  src="https://img.shields.io/badge/Download-homer.zip-orange"></a>
+ <a href="https://twitter.com/acdlite/status/974390255393505280"><img
+  alt="speed-blazing"
+  src="https://img.shields.io/badge/speed-blazing%20%F0%9F%94%A5-red"></a>
+ <a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img
+  alt="Awesome"
+  src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
+</p>
+
+<p align="center">
+ <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
+</p>
+
+## 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
+
+```sh
+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 <your-UID>:<your-GID>` 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:
+
+```sh
+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.
+
+```sh
+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 ...
+```
+
+### 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.