X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=33716f63607fcc9fa76aac5bb59f24ce34d70a87;hb=fb158d4767b85160c0c2c5fea5c6429c265576a9;hp=b965f9b58374b083393115e04ea286c1ba90eb48;hpb=fbe9338fd3a78141110530055c9b90a5958f845f;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index b965f9b..33716f6 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ Homer's donut + src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png">
Homer

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

@@ -36,7 +36,7 @@

- +

## Table of Contents @@ -44,15 +44,15 @@ - [Getting started](#getting-started) - [Configuration](docs/configuration.md) - [Tips & tricks](docs/tips-and-tricks.md) -- [Roadmap](#roadmap) -- [Developement](docs/developement.md) +- [Roadmap](#roadmap) +- [Development](docs/development.md) ## Features - [yaml](http://yaml.org/) file configuration - Installable (pwa) - Search -- Grouping +- Grouping - Theme customization - Offline heathcheck - keyboard shortcuts: @@ -70,7 +70,7 @@ See [documentation](docs/configuration.md) for information about the configurati ### Using docker -To launch container : +To launch container: ```sh docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest @@ -81,7 +81,7 @@ Default assets will be automatically installed in the `/www/assets` directory. U ### Using docker-compose The `docker-compose.yml` file must be edited to match your needs. -Set the port and volume (equivalent to -p and -v arguments) : +Set the port and volume (equivalent to `-p` and `-v` arguments): ```yaml volumes: @@ -90,25 +90,25 @@ ports: - 8080:8080 ``` -To launch container : +To launch container: ```sh cd /path/to/docker-compose.yml docker-compose up -d ``` -Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner, also in `docker-compose.yml` : +Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner, also in `docker-compose.yml`: ```yaml environment: -- UID=1000 -- GID=1000 + - UID=1000 + - GID=1000 ``` ### Using the release tarball (prebuilt, ready to use) -Download and extract the latest 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 webserver. - +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 webserver. + ```sh wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip unzip homer.zip