b8f7ce7eb2
* doc fix: match configure option names with help message (1/2) This is a first commit in an attempt to reconcile the differences between the /en/configure/index doc page and the automatically generated help message. This addresses typos including, though not limited to, Discussion #954, titled "[doc] apparent typo in the documentation of GitHub release check option". This commit fixes the CLI help command, preserving the original order, while manually matching the option names with the help message generated by the backend api executable. Options are only checked for spelling correctness and existence. In particular, the following are removed because i could not find them in the help message. * --swagger-host/$HBOX_SWAGGER_HOST <string> (default: localhost:7745) * --swagger-scheme/$HBOX_SWAGGER_SCHEME <string> (default: http) The following default values have also been updated: * --storage-conn-string/$HBOX_STORAGE_CONN_STRING (a slash is added to the URI path) * --database-sqlite-path/$HBOX_DATABASE_SQLITE_PATH (a query param '&_time_format=sqlite' is added) * --database-ssl-mode/$HBOX_DATABASE_SSL_MODE (default 'prefer' added) * doc fix: match configure option names with help message (2/2) This is a second commit in an attempt to reconcile the differences between the /en/configure/index doc page and the automatically generated help message. See the previous commit for details. This commit fixes the Markdown table. Options are only checked for spelling correctness and existence. The following rows are deleted in particular: * HBOX_SWAGGER_HOST * HBOX_SWAGGER_SCHEME The following default values are updated: * HBOX_STORAGE_CONN_STRING (a slash is added to the URI path) * HBOX_DATABASE_SQLITE_PATH (a query param '&_time_format=sqlite' is added) * HBOX_DATABASE_SSL_MODE (default 'prefer' added)
HomeBox
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. You can also try the demo instances of Homebox:
Quick Start
Configuration & Docker Compose
# 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.
Credits
- Original project by @hay-kot
- Logo by @lakotelman