Portainer Templates logo

Portainer Templates

Homebox Homebox

Container

InventoryProductivity

Inventory and organization system built for the home user. Source: https://github.com/sysadminsmedia/homebox

Image details

Architecture: amd64, arm64
Image size: 49 MB
User: sysadminsmedia

Source details

Repo: sysadminsmedia/homebox
Stars: 7k
Forks: 507
Language: Go
License: AGPL-3.0
Latest: v0.26.2 · 2 months ago
Updated: 15 hours ago
Website: homebox.software/

Configuration

Type
Container
Platform
linux
Image
ghcr.io/sysadminsmedia/homebox:latest
Ports
7745:7745/tcp
Volumes
/data
Env vars
TZ=UTC
Restart
unless-stopped

Standalone Install

Select an install method, to see config/commands for deploying Homebox

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Homebox, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation, or see sysadminsmedia/homebox for app-specific guidance.


HomeBox 

<a href="https://homebox.software/en/">Docs</a>
|
<a href="https://demo.homebox.software">Demo</a>
|
<a href="https://discord.gg/aY4DCkpNA9">Discord</a>

<img src="https://img.shields.io/github/check-runs/sysadminsmedia/homebox/main" alt="Github Checks"/>
<img src="https://img.shields.io/github/license/sysadminsmedia/homebox"/>
<img src="https://img.shields.io/github/v/release/sysadminsmedia/homebox?sort=semver&display_name=release"/>
<img src="https://img.shields.io/weblate/progress/homebox?server=https%3A%2F%2Ftranslate.sysadminsmedia.com"/>

<img src="https://img.shields.io/reddit/subreddit-subscribers/homebox"/>
<img src="https://img.shields.io/mastodon/follow/110749314839831923?domain=infosec.exchange"/>
<img src="https://img.shields.io/lemmy/homebox%40lemmy.world?label=lemmy"/>

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, We've tried to keep the following principles in mind:
  • 🧘 Simple but Expandable - Homebox is designed to be simple and easy to use. No complicated setup or configuration required. But expandable to whatever level of infrastructure you want to put into it.
  • 🚀 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.

Key Features

  • 📇 Rich Organization - Organize your items into categories, locations, and tags. You can also create custom fields to store additional information about your items.
  • 🔍 Powerful Search - Quickly find items in your inventory using the powerful search feature.
  • 📸 Image Upload - Upload images of your items to make it easy to identify them.
  • 📄 Document and Warranty Tracking - Keep track of important documents and warranties for your items.
  • 💰 Purchase & Maintenance Tracking - Track purchase dates, prices, and maintenance schedules for your items.
  • 📱 Responsive Design - Homebox is designed to work on any device, including desktops, tablets, and smartphones.

Screenshots

Login Screen Dashboard Item View Create Item Search
You can also try the demo instances of Homebox:

Quick Start

Configuration & Docker Compose
# If using the rootless or hardened 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
# ghcr.io/sysadminsmedia/homebox:latest-hardened

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.
To get started with code based contributions, please see our contributing guide.
If you are not a coder and can't help translate, you can still contribute financially. Financial contributions help us maintain the project and keep demos running.

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.
Translation status

Credits

Contributors

Serve Homebox on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying homebox.example.com to http://homebox:7745

Add this to your Caddyfile

homebox.example.com {
	reverse_proxy http://homebox:7745
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs homebox
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:7745 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :7745
  • Stop the other service, or pick a different host port. In 7745:7745 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:7745. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, homebox can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 7745

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/sysadminsmedia/homebox:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect homebox --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Homebox runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Homebox needs bundled into one download. This template pulls ghcr.io/sysadminsmedia/homebox:latest, which Docker fetches once (about 49 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Homebox's comes from the GitHub Container Registry, published by sysadminsmedia.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 7745:7745 means it's reachable on port 7745 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 7745:7745

Volumes

A volume is where Homebox keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /data as a volume Docker manages for you

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Homebox takes 1 of them, all with defaults you can leave alone or tweak:

  • TZ, defaults to UTC. Timezone

Restart policy

The restart policy here is unless-stopped, so Docker restarts Homebox after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Homebox sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container homebox. That's what you'll spot in the containers list and use in commands like docker logs homebox.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Homebox is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Homebox up. Add the template list to Portainer once, then deploying Homebox is a click rather than a wall of config.