homebox/README.md

<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
```

## Credits

- Logo by [@lakotelman](https://github.com/lakotelman)
feat: items-editor (#5) * format readme * update logo * format html * add logo to docs * repository for document and document tokens * add attachments type and repository * autogenerate types via scripts * use autogenerated types * attachment type updates * add insured and quantity fields for items * implement HasID interface for entities * implement label updates for items * implement service update method * WIP item update client side actions * check err on attachment * finish types for basic items editor * remove unused var * house keeping 2022-09-12 14:47:27 -08:00			`<div align="center">`
type img tag 2022-09-14 09:45:23 -08:00			`<img src="/docs/docs/assets/img/lilbox.svg" height="200"/>`
feat: items-editor (#5) * format readme * update logo * format html * add logo to docs * repository for document and document tokens * add attachments type and repository * autogenerate types via scripts * use autogenerated types * attachment type updates * add insured and quantity fields for items * implement HasID interface for entities * implement label updates for items * implement service update method * WIP item update client side actions * check err on attachment * finish types for basic items editor * remove unused var * house keeping 2022-09-12 14:47:27 -08:00			`</div>`
update readme 2022-09-14 09:43:55 -08:00
feat: items-editor (#5) * format readme * update logo * format html * add logo to docs * repository for document and document tokens * add attachments type and repository * autogenerate types via scripts * use autogenerated types * attachment type updates * add insured and quantity fields for items * implement HasID interface for entities * implement label updates for items * implement service update method * WIP item update client side actions * check err on attachment * finish types for basic items editor * remove unused var * house keeping 2022-09-12 14:47:27 -08: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>`
Initial commit 2022-08-29 18:30:36 -08:00			`</p>`
update imports 2022-08-29 18:40:54 -08:00
update docs 2022-09-14 09:35:23 -08:00			`## Quick Start`

update readme 2022-09-14 10:32:12 -08:00			`[Configuration & Docker Compose](https://hay-kot.github.io/homebox/quick-start)`
update todo list 2022-09-06 11:37:53 -08:00
update readme 2022-09-14 10:32:12 -08:00			```bash
feat: Low-Privileged and Distroless Docker Image (#372) * feat: use distroless image and non-root user * fix: remove conflicts after merge * chore: Commen the Dockerfile * chore: Update documentation to reflect image changes * Split docker build in latest and latest-rootless One more job added to the publish Github Action, to build and push TAG-rootless images. * fix: add missing workflow * feat: update documentation about double tags * feat: update readme with double tags --------- Co-authored-by: daniele <daniele@coolbyte.eu> 2023-05-13 21:38:57 +03: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`
feat: use notifiers on schedule (#362) * fix potential memory leak with time.After * add new background service to manage scheduled notifications * update docs * remove old js reference * closes #278 * tidy 2023-03-21 11:32:48 -08: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`
feat: Low-Privileged and Distroless Docker Image (#372) * feat: use distroless image and non-root user * fix: remove conflicts after merge * chore: Commen the Dockerfile * chore: Update documentation to reflect image changes * Split docker build in latest and latest-rootless One more job added to the publish Github Action, to build and push TAG-rootless images. * fix: add missing workflow * feat: update documentation about double tags * feat: update readme with double tags --------- Co-authored-by: daniele <daniele@coolbyte.eu> 2023-05-13 21:38:57 +03:00			`# ghcr.io/hay-kot/homebox:latest-rootless`
update readme 2022-09-14 10:32:12 -08:00			```
feat: items-editor (#5) * format readme * update logo * format html * add logo to docs * repository for document and document tokens * add attachments type and repository * autogenerate types via scripts * use autogenerated types * attachment type updates * add insured and quantity fields for items * implement HasID interface for entities * implement label updates for items * implement service update method * WIP item update client side actions * check err on attachment * finish types for basic items editor * remove unused var * house keeping 2022-09-12 14:47:27 -08:00
			`## Credits`
update todos 2022-09-13 21:17:13 -08:00
feat: items-editor (#5) * format readme * update logo * format html * add logo to docs * repository for document and document tokens * add attachments type and repository * autogenerate types via scripts * use autogenerated types * attachment type updates * add insured and quantity fields for items * implement HasID interface for entities * implement label updates for items * implement service update method * WIP item update client side actions * check err on attachment * finish types for basic items editor * remove unused var * house keeping 2022-09-12 14:47:27 -08:00			`- Logo by [@lakotelman](https://github.com/lakotelman)`