mirror of
https://github.com/khairul169/honey.git
synced 2025-04-28 14:59:32 +07:00
README: Hello, Docker
This commit is contained in:
parent
75bcd53e73
commit
f83855f8d3
23
README.md
23
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.
|
||||
|
||||
<font size="4">**[📺 Live demo](https://honeyy.vercel.app/)**</font>
|
||||
|
||||
<img src="screenshot.jpg" style="width: 720px">
|
||||
|
||||
|
||||
## 🚀 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
|
||||
|
Loading…
x
Reference in New Issue
Block a user