https://github.com/sysadminsmedia/homebox

A continuation of HomeBox the inventory and organization system built for the Home User
https://github.com/sysadminsmedia/homebox

hacktoberfest inventory selfhosted

Last synced: 7 days ago
JSON representation

A continuation of HomeBox the inventory and organization system built for the Home User

• Host: GitHub
• URL: https://github.com/sysadminsmedia/homebox
• Owner: sysadminsmedia
• License: agpl-3.0
• Created: 2024-06-17T18:07:09.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-10-29T20:36:13.000Z (15 days ago)
• Last Synced: 2024-10-29T21:40:57.688Z (15 days ago)
• Topics: hacktoberfest, inventory, selfhosted
• Language: Go
• Homepage: https://homebox.software
• Size: 45.8 MB
• Stars: 1,058
• Watchers: 13
• Forks: 58
• Open Issues: 79
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


  



 HomeBox 



   Docs

   |

   Demo

   |

   Discord



## What is HomeBox

Homebox is the inventory and organization system built for the Home User! With a focus on simplicity and ease of use, Homebox is the perfect solution for your home inventory, organization, and management needs. While developing this project, I've tried to keep the following principles in mind:

- _Simple_ - Homebox is designed to be simple and easy to use. No complicated setup or configuration required. Use either a single docker container, or deploy yourself by compiling the binary for your platform of choice.

- _Blazingly Fast_ - Homebox is written in Go, which makes it extremely fast and requires minimal resources to deploy. In general, idle memory usage is less than 50MB for the whole container.

- _Portable_ - Homebox is designed to be portable and run on anywhere. We use SQLite and an embedded Web UI to make it easy to deploy, use, and backup.

# Screenshots

Check out screenshots of the project [here](https://imgur.com/a/5gLWt2j).

## Quick Start

[Configuration & Docker Compose](https://homebox.software/en/quick-start.html)

```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/sysadminsmedia/homebox:latest

# ghcr.io/sysadminsmedia/homebox:latest-rootless

```

## 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.

## Help us Translate

We want to make sure that Homebox is available in as many languages as possible. If you are interested in helping us translate Homebox, please help us via our [Weblate instance](https://translate.sysadminsmedia.com/projects/homebox/).

[![Translation status](http://translate.sysadminsmedia.com/widget/homebox/multi-auto.svg)](http://translate.sysadminsmedia.com/engage/homebox/)

## Credits

- Original project by [@hay-kot](https://github.com/hay-kot)

- Logo by [@lakotelman](https://github.com/lakotelman)