# Running locally with Docker

### Prerequisites

* Docker installed and running on your system
* Basic familiarity with YAML configuration
* Terminal/command-line access

### Setup Instructions

#### 1. Pull the Docker Image

First, pull the latest rated-log-indexer image from Docker Hub:

```bash
docker pull ratedlabs/rated-log-indexer
```

#### 2. Configure the Indexer

1. Create a copy of the example configuration file:

   ```bash
   cp rated-config.example.yaml config/rated-config.yaml
   ```
2. Open `rated-config.yaml` in your preferred text editor and modify the settings according to your needs:
   * Configure your desired integrations
   * Set up the output section
   * Adjust any additional parameters

{% hint style="info" %}
Refer to the Configuration Templates section for detailed instructions on configuring specific integrations and outputs.
{% endhint %}

#### 3. Run the Container

Launch the rated-log-indexer container using the following command:

```bash
docker run \
  --name rated-indexer \
  --volume "$(pwd)"/config/rated-config.yaml:/indexer/config/rated-config.yaml \
  --restart unless-stopped \
  ratedlabs/rated-log-indexer
```

This command:

* Mounts your local configuration file into the container
* Runs the container in the foreground
* Automatically removes the container when it stops (`--rm` flag)

### Verification

After starting the container, you should see:

1. Initialization logs
2. Configuration loading confirmation
3. Integration connection status
4. Indexing progress indicators

### Troubleshooting

If you encounter issues:

1. Verify your configuration file syntax
2. Check that all required credentials are properly set
3. Ensure Docker has sufficient permissions to access the mounted configuration file
4. Review the container logs for specific error messages