diff --git a/README.md b/README.md index 29fb96f..d90eb95 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,37 @@ # honey -A sweet dashboard I use on my homeserver with some self-hosted stuff... +_A sweet dashboard I use on my homeserver with some self-hosted stuff..._ -**[πŸ“Ί Live demo](https://honeyy.vercel.app/)** +honey is written in **pure** `HTML` `CSS` `JS` so dynamic backend or special webserver configuration is not required. +It works out-of-the-box as all operations are done client-side. + +**[πŸ“Ί Live demo](https://honeyy.vercel.app/)** ## πŸš€ Installation +### πŸ•ΈοΈ On existing webserver + 1. Download latest prebuilt archive from **[Releases](https://github.com/dani3l0/honey/releases)**. 2. Extract downloaded archive to your webserver root. 3. You're done! -**Note:** honey is written in **pure** `HTML` `CSS` `JS` so dynamic backend or special webserver configuration is not required. -It works out-of-the-box as all operations are done client-side. + +### πŸ‹ via Docker + +``` +docker run -p 4173:4173 -v /path/to/config:/app/dist/config:ro ghcr.io/dani3l0/honey:latest +``` + +- `-p 4173:4173` - exposes HTTP port to your machine +- `-v /path/to/config:/app/dist/config:ro` - mounts config directory to your local filesystem in read-only mode (we don't need write permissions) + +If you have custom icons or background images, you can freely put them in `config` dir. +Just remember to provide valid URLs (with `/config` prefix). ## βš™οΈ Configuration