# Install

Inspector watches Docker containers, restarts the ones you tell it to,
and notifies you via Gotify and/or Pushover. All configuration lives in
a single `config.yml` that you can edit by hand or from the built-in web
settings page.

## Requirements

- Docker Engine 24+ and `docker compose` v2.
- A machine that can reach `/var/run/docker.sock` (any Docker host).
- Optional: a Gotify server and/or a Pushover account for notifications.

## Quickstart

```bash
# 1. Grab the compose file and example config
mkdir -p ~/docker/inspector && cd ~/docker/inspector
curl -L -o compose.yml https://gitea.euronvault.com/euronvault/inspector/raw/branch/main/compose.yml
curl -L -o config.yml   https://gitea.euronvault.com/euronvault/inspector/raw/branch/main/config.example.yml

# 2. Edit config.yml — at minimum, list the containers you want watched
#    under the `containers:` key.
$EDITOR config.yml

# 3. Set your Docker group GID so the container can read the socket.
echo "DOCKER_GID=$(getent group docker | cut -d: -f3)" > .env

# 4. Pull and run
docker compose pull
docker compose up -d
docker compose logs -f inspector
```

If `dashboard.enabled: true` in your config, visit
`http://<host>:8080/` after startup to see the dashboard, and
`http://<host>:8080/settings` to edit the config from the browser.

## Pinning a version

Prefer an immutable tag over `latest` in production:

```bash
# .env
INSPECTOR_TAG=0.7.0
```

Images are published at `gitea.euronvault.com/euronvault/inspector`.

## Upgrading

```bash
docker compose pull
docker compose up -d
```

Your `config.yml` is persisted outside the container, so upgrades don't
touch it. The settings page keeps a `.bak` of the previous file next to
`config.yml` on every save (when the directory is bind-mounted; see the
README for the Docker caveat).

## Uninstall

```bash
docker compose down
rm -rf logs data config.yml compose.yml .env
```

Inspector doesn't store anything outside the directory it was started
from.