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

# Installation

The PPL Dashboard is distributed as a Docker image that runs on your local machine. Follow the steps below to install
and run it.

### Install Docker Desktop

Before pulling the PPL Dashboard image, ensure Docker Desktop is installed on your machine.

<Steps>
  <Step title="Download Docker Desktop">
    * Visit the [Docker Desktop download page](https://www.docker.com/products/docker-desktop/).
    * Select the version for your operating system (Windows, macOS, or Linux) and download the installer.
  </Step>

  <Step title="Install Docker Desktop">
    * Run the downloaded installer and follow the on-screen instructions.
    * On **Windows**, ensure WSL 2 is enabled if prompted.
    * On **macOS**, drag the Docker icon into the Applications folder.
  </Step>

  <Step title="Launch Docker Desktop">
    * Open Docker Desktop from your applications.
    * Wait for Docker to fully start — the Docker icon in the system tray should indicate it is running.
  </Step>
</Steps>

### Pull the PPL Dashboard Image

Once Docker Desktop is running, pull the PPL Dashboard image from Docker Hub.

<Steps>
  <Step title="Open a Terminal">
    Open a terminal on your local machine:

    * **Windows**: use Command Prompt, PowerShell, or Git Bash.
    * **macOS or Linux**: open the default Terminal application.
  </Step>

  <Step title="Pull the Docker Image">
    Run the following command to pull the PPL Dashboard image from
    [Docker Hub](https://hub.docker.com/r/directenergypartners/ppl-dashboard):

    ```bash theme={null}
    docker pull directenergypartners/ppl-dashboard
    ```
  </Step>
</Steps>

### Run the PPL Dashboard

You can start the PPL Dashboard using either the terminal or Docker Desktop.

<Expandable title="Using the Terminal">
  Make sure Docker Desktop is running on your machine before executing the command. Run the following command in your terminal:

  ```bash theme={null}
  docker run -p 8000:8000 directenergypartners/ppl-dashboard:latest
  ```

  The dashboard will be accessible at [localhost:8000](http://localhost:8000).
</Expandable>

<Expandable title="Using Docker Desktop">
  <Steps>
    <Step title="Open Docker Desktop">
      Launch Docker Desktop on your machine.
    </Step>

    <Step title="Navigate to Images">
      Go to the **Images** section in the sidebar.
    </Step>

    <Step title="Start the Image">
      * Locate the `directenergypartners/ppl-dashboard` image.
      * Click the **Start** (Play) button.
      * In the **Optional Settings**, set the **Host Port** to `8000`.
      * Click **Run**.
    </Step>
  </Steps>

  The dashboard will be accessible at [localhost:8000](http://localhost:8000).
</Expandable>