> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ipmideck.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install ipmideck with Docker or pip, and understand the --network host requirement.

## Docker (recommended)

```bash theme={null}
docker run --network host ipmideck/ipmideck:latest
```

`--network host` is required so the container can reach your BMCs directly on your local
network over UDP port 623 (the IPMI/RMCP+ port). Without host networking, the container
sits behind Docker's NAT and cannot complete an IPMI session with your hardware.

Once the container is up, open `http://<your-ip>:3000` and follow the setup wizard.

<Note>
  The published image lives on Docker Hub at
  [hub.docker.com/r/ipmideck/ipmideck](https://hub.docker.com/r/ipmideck/ipmideck).
  The image is coming soon, the command above is the exact command you will run once
  it is published.
</Note>

## pip

```bash theme={null}
pip install ipmideck
```

The pip package requires `ipmitool` to be installed on the host, ipmideck shells out to
`ipmitool` for every IPMI operation. Install it from your distribution's package manager
first (for example `apt install ipmitool` or `dnf install ipmitool`).

## Where ipmideck stores data

ipmideck writes its configuration and database under a data directory:

* **Docker:** `/data` inside the container (the image sets `IPMIDECK_DATA_DIR=/data`;
  persist it with a volume).
* **pip on Linux:** `/data` by default: set `IPMIDECK_DATA_DIR` to relocate it.
* **pip on Windows:** `./data`, relative to the directory you run `ipmideck` from.

You can override the location on any platform with the `IPMIDECK_DATA_DIR` environment
variable. This directory holds `config.yaml`, the SQLite database, and the encryption key
file used to protect your stored BMC credentials. See [Configuration](/en/configuration) and
[Running ipmideck](/en/running) for details.

## Next steps

* [Configuration](/en/configuration): tune ports, polling intervals, and retention.
* [Supported Hardware](/en/supported-hardware): confirm your BMC is covered.
* [Troubleshooting](/en/troubleshooting): connection and IPMI errors.