X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=d69796aa3494cc924d7b50cc3df5a7d432810357;hb=e3b68ddc427a62fb77acd709b2dbdc8681c49158;hp=c3a6f07590b23878bf70482cadb3ac8fa3cbd23d;hpb=1a42e30a1752be5ab0fba5b224fad5686f12499e;p=github%2Fbastienwirtz%2Fhomer.git
diff --git a/README.md b/README.md
index c3a6f07..d69796a 100644
--- a/README.md
+++ b/README.md
@@ -1,243 +1,153 @@
-# Homer
-[](https://opensource.org/licenses/Apache-2.0)
-[](http://makeapullrequest.com)
-[](https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-[](https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip)
-[](https://github.com/awesome-selfhosted/awesome-selfhosted)
-
-A dead simple static **HOM**epage for your serv**ER** to keep your s
-ervices on hand, from a simple `yaml` configuration file.
-
-## [Live demo](https://homer-demo.netlify.app) ⢠[Chat](https://gitter.im/homer-dashboard/community)
-
+
+ 
+
+ Homer
+
+
+
+ A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file.
+
+
+ 
+
+
+
+ Demo
+ â¢
+ Chat
+ â¢
+ Getting started
+
+
+
+ 
+ 
+ 
+ 
+ 
+
+
+
+ 
+
## Table of Contents
+
- [Features](#features)
- [Getting started](#getting-started)
-- [Configuration](#configuration)
-- [Roadmap](#roadmap)
-- [Developement](#developement)
+- [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
+- Grouping
- Theme customization
-- Offline heathcheck
+- 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, generated from the source in `/src` using webpack. It's meant to be served by an HTTP server, **it will not work if you open dist/index.html directly over file:// protocol**.
+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 -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
+docker run -d \
+ -p 8080:8080 \
+ -v :/www/assets \
+ --restart=always \
+ b4bz/homer:latest
```
-As a bind mount is used here, docker will not copy the initial content of the `assets` directory to the mounted directory.
-You can initialise your assets directory with the content provided in this repository
-```sh
-cp -r /public/assets/* /your/local/assets/
-```
+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.
-**Alternatively** if you just want to provide images/icons without customizing the other files (app manifest & pwa icons), you can mount a custom directory in the `www` directory and use it in your `config.yml` for icons path.
+**Environment variables:**
-### Using the release tarball (prebuilt, ready to use)
+* **`INIT_ASSETS`** (default: `1`)
+Install example configuration file & assets (favicons, ...) to help you get started.
-Download and extract the latest the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `config.yml.dist` file to `config.yml`, and put it behind a webserver.
-
-```sh
-wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
-unzip homer.zip
-cd homer
-cp config.yml.dist config.yml
-npx serve # or python -m http.server 8010 or apache, nginx ...
-```
+* **`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`).
-### Build manually
+* **`PORT`** (default: `8080`)
+If you would like to change internal port of Homer from default `8080` to your port choice.
-```sh
-# Using yarn (recommended)
-yarn install
-yarn build
-# **OR** Using npm
-npm install
-npm run build
-```
+#### With docker-compose
-Then your dashboard is ready to use in the `/dist` directory.
-
-## Configuration
-
-Title, icons, links, colors, and services can be configured in the `config.yml` file (located in project root directory once built, or in the `public/` directory in developement mode), using [yaml](http://yaml.org/) format.
-
-```yaml
----
-# Homepage configuration
-# See https://fontawesome.com/icons for icons options
-
-# Optional: Use external configuration file.
-# Using this will ignore remaining config in this file
-# externalConfig: https://example.com/server-luci/config.yaml
-
-title: "App dashboard"
-subtitle: "Homer"
-logo: "assets/homer.png"
-# Alternatively a fa icon can be provided:
-# icon: "fas fa-skull-crossbones"
-
-header: true # Set to false to hide the header
-footer: 'Created with â¤ï¸ with bulma, vuejs & font awesome // Fork me on
' # set false if you want to hide it.
-
-# Optional theming
-theme: default # 'default' or one of the theme available in 'src/assets/themes'.
-
-# Here is the exaustive list of customization parameters
-# However all value are optional and will fallback to default if not set.
-# if you want to change only some of the colors, feel free to remove all unused key.
-colors:
- light:
- highlight-primary: "#3367d6"
- highlight-secondary: "#4285f4"
- highlight-hover: "#5a95f5"
- background: "#f5f5f5"
- card-background: "#ffffff"
- text: "#363636"
- text-header: "#424242"
- text-title: "#303030"
- text-subtitle: "#424242"
- card-shadow: rgba(0, 0, 0, 0.1)
- link-hover: "#363636"
- dark:
- highlight-primary: "#3367d6"
- highlight-secondary: "#4285f4"
- highlight-hover: "#5a95f5"
- background: "#131313"
- card-background: "#2b2b2b"
- text: "#eaeaea"
- text-header: "#ffffff"
- text-title: "#fafafa"
- text-subtitle: "#f5f5f5"
- card-shadow: rgba(0, 0, 0, 0.4)
- link-hover: "#ffdd57"
-
-# Optional message
-message:
- # url: "https://" # Can fetch information from an endpoint to override value below.
- style: "is-warning"
- title: "Optional message!"
- content: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
-
-# Optional navbar
-# links: [] # Allows for navbar (dark mode, layout, and search) without any links
-links:
- - name: "Link 1"
- icon: "fab fa-github"
- url: "https://github.com/bastienwirtz/homer"
- target: "_blank" # optional html tag target attribute
- - name: "link 2"
- icon: "fas fa-book"
- url: "https://github.com/bastienwirtz/homer"
-
-# Services
-# First level array represent a group.
-# Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
-services:
- - name: "Application"
- icon: "fa fa-code-fork"
- items:
- - name: "Awesome app"
- logo: "assets/tools/sample.png"
- # Alternatively a fa icon can be provided:
- # icon: "fab fa-jenkins"
- subtitle: "Bookmark example"
- tag: "app"
- url: "https://www.reddit.com/r/selfhosted/"
- target: "_blank" # optional html tag target attribute
- - name: "Another one"
- logo: "assets/tools/sample2.png"
- subtitle: "Another application"
- tag: "app"
- # Optional tagstyle
- tagstyle: "is-success"
- url: "#"
- - name: "Other group"
- icon: "fas fa-heartbeat"
- items:
- - name: "Another app"
- logo: "assets/tools/sample.png"
- subtitle: "Another example"
- tag: "other"
- url: "https://www.reddit.com/r/selfhosted/"
- target: "_blank" # optionnal html a tag target attribute
-```
+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).
-If you choose to fetch message information from an endpoint, the output format should be:
+Then launch the container:
-```json
-{
- "style": null,
- "title": "Lorem ipsum 42",
- "content": "LA LA LA Lorem ipsum dolor sit amet, ....."
-}
+```sh
+cd /path/to/docker-compose.yml/
+docker-compose up -d
```
-`null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
-Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
-
-### Style Options
+### Using the release tarball (prebuilt, ready to use)
-Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll notice in the config there is a `tagstyle` option. It can be set to any of the bulma modifiers. You'll probably want to use one of these 4 main colors:
+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.
-- `is-info` (blue)
-- `is-success` (green)
-- `is-warning` (yellow)
-- `is-danger` (red)
+```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 ...
+```
-You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
+### Using Helm
+Thanks to [@djjudas21](https://github.com/djjudas21) [charts](https://github.com/djjudas21/charts/tree/main/charts/homer):
-## Roadmap
+```sh
+helm repo add djjudas21 https://djjudas21.github.io/charts/
+helm repo update djjudas21
-- [ ] Add more themes.
-- [ ] Add support for custom service card (add custom feature to some service / app link)
+# 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
+```
-## Development
+### Build manually
```sh
# Using yarn (recommended)
yarn install
-yarn serve
+yarn build
# **OR** Using npm
npm install
-npm run serve
-```
-
-### Themes
-
-Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
-To addd a new theme, just add a file in the theme directory, and put all style in the `body #app.theme-` scope. Then import it in the main style file.
-
-```scss
-// `src/assets/themes/my-awesome-theme.scss`
-body #app.theme-my-awesome-theme. { ... }
+npm run build
```
-```scss
-// `src/assets/app.scss`
-// Themes import
-@import "./themes/sui.scss";
-...
-@import "./themes/my-awesome-theme.scss";
-```
+Then your dashboard is ready to use in the `/dist` directory.