mirror of
https://github.com/hay-kot/homebox.git
synced 2024-11-25 01:55:43 +00:00
43 lines
1.5 KiB
Markdown
43 lines
1.5 KiB
Markdown
<div align="center">
|
|
<img src="/docs/docs/assets/img/lilbox.svg" height="200"/>
|
|
</div>
|
|
|
|
<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>
|
|
</p>
|
|
|
|
## Quick Start
|
|
|
|
[Configuration & Docker Compose](https://hay-kot.github.io/homebox/quick-start)
|
|
|
|
```bash
|
|
# 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
|
|
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
|
|
# ghcr.io/hay-kot/homebox:latest-rootless
|
|
```
|
|
|
|
<!-- CONTRIBUTING -->
|
|
## Contributing
|
|
|
|
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
|
|
|
If you are not a coder, you can still contribute financially. Financial contributions help me prioritize working on this project over others and helps me know that there is a real demand for project development.
|
|
|
|
<a href="https://www.buymeacoffee.com/haykot" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-green.png" alt="Buy Me A Coffee" style="height: 30px !important;width: 107px !important;" ></a>
|
|
## Credits
|
|
|
|
- Logo by [@lakotelman](https://github.com/lakotelman)
|