HomeBox

Guides

First steps

Install an app, find where to log in, and learn your way around the dashboard.

Install an app

Open the Apps page, pick something, and press Install. The dashboard shows the image download and the start-up as they happen. When it is done, the app appears on your home page with a link straight to it.

The same from a terminal:

homebox list                 # everything available, and what is running
sudo homebox install photos  # install one app

Log in to it

Every app page on this site has a First login column, and the dashboard shows the same note under the app. Some apps create their account on first visit; some use a password HomeBox generated at install. To print a generated password:

homebox secrets passwords

Generated passwords live in /opt/homebox/.env, readable only by you.

Find your way around

If something does not start

  1. Open Live Logs and pick the app. The last lines usually say why.
  2. From a terminal, homebox status lists every container and its health.
  3. homebox doctor checks the environment and every app definition.