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

# Docker Login

> Guide to install and login to Docker

## Introduction

This document provides detailed instructions on how to install Docker and login to the Raven Docker registry located at `releases.cloud.raven.io`. This guide is intended for users who need to authenticate with the Docker registry to access and deploy Docker images for the Raven platform.

If you are deploying Raven Platform (self-hosted) using Helm. You won't need to login to docker. However, you will need to provide the docker login credentials as parameters to the helm chart as per the [helm installation documentation](/helm-installation).

## Prerequisites

* Access to the Docker command line interface (CLI) on your local machine.
* Docker installation files or access to install Docker.

## Step-by-Step Guide

### Step 1: Install Docker

Docker is a platform for developing, shipping, and running applications in containers. Follow the steps below to install Docker on your local machine.

#### macOS

If you're using macOS, you can install Docker using Homebrew:

```bash theme={null}
brew install --cask docker
```

Alternatively, download and install Docker Desktop from the [Docker website](https://www.docker.com/products/docker-desktop).

#### Windows

For Windows, you can use Chocolatey:

```bash theme={null}
choco install docker-desktop
```

Alternatively, download and install Docker Desktop from the [Docker website](https://www.docker.com/products/docker-desktop).

#### Linux

On Linux, you can use the following commands to install Docker:

```bash theme={null}
sudo apt-get update
sudo apt-get install \
    ca-certificates \
    curl \
    gnupg \
    lsb-release

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg

echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io
```

Alternatively, follow the instructions on the [Docker installation guide](https://docs.docker.com/get-docker/).

### Step 2: Verify Docker Installation

After installation, verify that Docker is correctly installed by checking the version:

```bash theme={null}
docker --version
```

You should see output similar to:

```
Docker version 20.10.x, build ...
```

### Step 3: Login to Docker Registry

The Raven platform Docker images are hosted in a private registry at `releases.cloud.raven.io`. To access these images, you need to login to the registry using your credentials.

Use the following command to login:

```bash theme={null}
docker login releases.cloud.raven.io
```

You will be prompted to enter your username and password. Ensure you have these credentials provided by your system administrator or the Raven platform team.

### Step 4: Verify Login

To confirm that you have successfully logged in, you can use one of the following methods:

#### Method 1: Inspect Docker Config File

Check the Docker configuration file to verify that your login credentials are saved.

```bash theme={null}
cat ~/.docker/config.json
```

In the output, look for an entry under the `auths` section for `releases.cloud.raven.io`. This indicates that your login credentials have been stored.

#### Method 2: Docker Info Command

Use the `docker info` command to check if the registry is listed under `Registry Mirrors`.

```bash theme={null}
docker info
```

In the output, look for `Registry Mirrors`. If you see `releases.cloud.raven.io` listed, it confirms your login status.

#### Method 3: Pull a Private Image

Attempt to pull a private image from the registry to ensure you have access.

```bash theme={null}
docker pull releases.cloud.raven.io/self-hosted/query_service:latest
```

Replace `self-hosted/query_service` with the actual name of an image you have access to. If the pull is successful, your login was successful.

## Conclusion

You are now ready to use Docker to pull and run images for the Raven platform. If you encounter any issues or need further assistance, refer to the [Raven Documentation](https://docs.raven.io) or contact support.