List apps

GET/api/install

Lists the apps homebutler can install. Use a name from this list as the app path parameter of the other install routes.

Authorizations

Authorizationstringheader

The token you start the server with: homebutler serve --token <token>, or web.token in the config file. Send it as Authorization: Bearer <token>. When the server has a token, every /api/ route except the CORS preflight requires it, reads included.

Response

200 · application/json

The catalogue. The example is shortened.

namestringrequired

The app name.

descriptionstringrequired

What the app does.

default_portstringrequired

The host port used when you send none.

container_portstringrequired

The port inside the container.

data_pathstringrequired

The data path inside the container.

cURLcURLPythonJavaScript

curl --request GET \
  --url 'http://localhost:8080/api/install' \
  --header 'Authorization: Bearer <token>'

[
  {
    "name": "pi-hole",
    "description": "Network-wide ad blocking via DNS filtering",
    "default_port": "8088",
    "container_port": "80",
    "data_path": "/etc/pihole"
  },
  {
    "name": "vaultwarden",
    "description": "Lightweight Bitwarden-compatible password manager",
    "default_port": "8080",
    "container_port": "80",
    "data_path": "/data"
  },
  {
    "name": "jellyfin",
    "description": "Free software media system for streaming movies, TV, and music",
    "default_port": "8096",
    "container_port": "8096",
    "data_path": "/config"
  }
]