homebox/README.md

44 lines
1.5 KiB
Markdown
Raw Normal View History

<div align="center">
2022-09-14 17:45:23 +00:00
<img src="/docs/docs/assets/img/lilbox.svg" height="200"/>
</div>
2022-09-14 17:43:55 +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
# 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
2022-09-14 18:32:12 +00:00
```
<!-- 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
2022-09-14 05:17:13 +00:00
- Logo by [@lakotelman](https://github.com/lakotelman)