> For the complete documentation index, see [llms.txt](https://documentation.grax.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.grax.com/technology/deploy/install-on-docker-desktop.md).

# Install on Docker Desktop

This guide runs GRAX and its database on your own computer with Docker Desktop, for trials and testing. Backed-up data goes to a cloud storage bucket that you connect once GRAX is running.

{% stepper %}
{% step %}

## Set Up Docker Desktop

Download, install, and run [Docker Desktop](https://www.docker.com/products/docker-desktop/). GRAX runs natively on both Intel and Apple Silicon machines.
{% endstep %}

{% step %}

## Get a Registration Key

Sign into the [GRAX Platform](https://platform.grax.com) and go to "Deployments," then "New deployment," then "GRAX for Docker Desktop." Select "Continue with Docker Desktop," then "Create registration key."

Open the new deployment and use "Copy registration key" to copy it. This key can only be activated once.

{% hint style="info" %}
If "GRAX for Docker Desktop" isn't listed, contact [GRAX Support](https://documentation.grax.com/support/get-support) to enable it for your team.
{% endhint %}
{% endstep %}

{% step %}

## Download and Configure GRAX Docker Compose Files

Download [GRAX Docker Compose Files](https://s3.amazonaws.com/grax-public-templates/master/docker/docker.zip), unzip them, and create a settings file from the included example:

```bash
curl -L -o docker.zip https://s3.amazonaws.com/grax-public-templates/master/docker/docker.zip
unzip docker.zip
cd stacks/docker/grax
cp .env.example .env
```

Fill in every value in `.env`:

* `GRAX_REGISTRATION_KEY`: the key from GRAX Platform.
* `SECRET_STORE_BASE`: a long random string, such as the output of `openssl rand -hex 32`. GRAX encrypts the credentials it stores with this value, so keep a copy somewhere safe; they can't be read without it.
* `ADMIN_PASSWORD`: the password for the local `admin` sign-in.
  {% endstep %}

{% step %}

## Start Up GRAX with Docker Compose

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

The first run downloads and builds everything, which takes a few minutes. GRAX is ready once `docker compose ps` shows it as healthy.

Use "Open GRAX" on your deployment in [GRAX Platform](https://platform.grax.com), or go to `https://localhost:8000` and sign in as `admin` with your `ADMIN_PASSWORD`. Your browser warns about the self-signed certificate on the local address.
{% endstep %}

{% step %}

## Connect Storage

Before backing anything up, [connect a storage bucket](https://documentation.grax.com/other/settings/connecting-storage) in GRAX's storage settings.
{% endstep %}
{% endstepper %}

## Pausing and Resuming

Pause GRAX with:

```bash
docker compose stop
```

Resume with `docker compose start`.

## Resetting Everything

{% hint style="warning" %}
The following deletes GRAX's local database and releases the URL you used to access GRAX. This can't be undone. Data in your storage bucket isn't affected.
{% endhint %}

From the `stacks/docker/grax` directory, remove GRAX's containers, data, and image with:

```bash
docker compose down --volumes --rmi local
```

Then, sign into the [GRAX Platform](https://platform.grax.com), open your deployment, and use "Destroy deployment" to delete it and its registration key.
