2022-09-12 22:47:27 +00:00
|
|
|
<div align="center">
|
2022-09-14 17:45:23 +00:00
|
|
|
<img src="/docs/docs/assets/img/lilbox.svg" height="200"/>
|
2022-09-12 22:47:27 +00:00
|
|
|
</div>
|
2022-09-14 17:43:55 +00:00
|
|
|
|
2022-09-12 22:47:27 +00:00
|
|
|
<h1 align="center" style="margin-top: -10px"> HomeBox </h1>
|
|
|
|
<p align="center" style="width: 100;">
|
|
|
|
<a href="https://hay-kot.github.io/homebox/">Docs</a>
|
|
|
|
|
|
|
|
|
<a href="https://homebox.fly.dev">Demo</a>
|
|
|
|
|
|
|
|
|
<a href="https://discord.gg/tuncmNrE4z">Discord</a>
|
2022-08-30 02:30:36 +00:00
|
|
|
</p>
|
2022-08-30 02:40:54 +00:00
|
|
|
|
2022-09-14 17:35:23 +00:00
|
|
|
## Quick Start
|
|
|
|
|
2022-09-14 18:32:12 +00:00
|
|
|
[Configuration & Docker Compose](https://hay-kot.github.io/homebox/quick-start)
|
2022-09-06 19:37:53 +00:00
|
|
|
|
2022-09-14 18:32:12 +00:00
|
|
|
```bash
|
2023-05-13 18:38:57 +00:00
|
|
|
# If using the rootless image, ensure data
|
|
|
|
# folder has correct permissions
|
|
|
|
mkdir -p /path/to/data/folder
|
|
|
|
chown 65532:65532 -R /path/to/data/folder
|
2023-03-21 19:32:48 +00:00
|
|
|
docker run -d \
|
|
|
|
--name homebox \
|
|
|
|
--restart unless-stopped \
|
|
|
|
--publish 3100:7745 \
|
|
|
|
--env TZ=Europe/Bucharest \
|
|
|
|
--volume /path/to/data/folder/:/data \
|
|
|
|
ghcr.io/hay-kot/homebox:latest
|
2023-05-13 18:38:57 +00:00
|
|
|
# ghcr.io/hay-kot/homebox:latest-rootless
|
2022-09-14 18:32:12 +00:00
|
|
|
```
|
2022-09-12 22:47:27 +00:00
|
|
|
|
|
|
|
## Credits
|
2022-09-14 05:17:13 +00:00
|
|
|
|
2022-09-12 22:47:27 +00:00
|
|
|
- Logo by [@lakotelman](https://github.com/lakotelman)
|