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

# Install Scout

> Run Scout with Docker Compose on a machine you want to back up.

Scout ships as a Docker image, `ghcr.io/thesteau/3to1go-scout`. You need a running [Station](/station/install) and a [credential](/station/scout-credentials) minted from it.

The image supports `linux/amd64`, `linux/arm64`, and `linux/arm/v7`, including Raspberry Pi.

## Set up

<Steps>
  <Step title="Get the example files">
    ```sh theme={null}
    mkdir 3to1go-scout && cd 3to1go-scout
    curl -fsSLO https://raw.githubusercontent.com/thesteau/3to1go/main/deploy-example/scout/docker-compose.yml
    curl -fsSL https://raw.githubusercontent.com/thesteau/3to1go/main/deploy-example/scout/.env.example -o .env
    ```

    Or copy [`deploy-example/scout/`](https://github.com/thesteau/3to1go/tree/main/deploy-example/scout) from GitHub.
  </Step>

  <Step title="Edit .env">
    ```sh .env theme={null}
    # Unique per Scout installation.
    SCOUT_ID=laptop-alice
    # Must be reachable from inside the Scout container.
    STATION_URL=http://station.example.lan:6555
    # Only used when Scout creates the first admin user.
    INITIAL_ADMIN_PASSWORD=admin
    # The folder on this machine that Scout sees at /scan.
    SCAN_DIR=/home/alice
    ```

    If Station runs on the same Docker Desktop host, use `STATION_URL=http://host.docker.internal:6555`.

    To back up more than one folder or drive, see [Multiple folders and drives](/scout/multiple-folders).
  </Step>

  <Step title="Start it">
    ```sh theme={null}
    docker compose up -d
    ```
  </Step>

  <Step title="Sign in and add the credential">
    Open `http://localhost:6556/`, sign in as `admin` (see [Sign-in](/shared/sign-in)), open **Edit Scout Settings**, paste the credential from Station into **Scout Credential**, and save.
  </Step>

  <Step title="Save your encryption key">
    Copy the **Encryption Key** from Scout's UI and store it somewhere safe, such as a password manager. See [Encryption key](/scout/encryption-key).
  </Step>

  <Step title="Choose what to back up">
    See [Backup jobs](/scout/backup-jobs).
  </Step>
</Steps>

<Note>
  Scout needs **write** access to the mounted folders to save `.upload_dir` markers and to restore files.
</Note>

## What gets created

```text theme={null}
3to1go-scout/
├── docker-compose.yml
├── .env
├── config/          # settings database, encryption.key, installation.id, trusted-certs/
├── hook-scripts/    # scripts for Custom Scripts
├── state/           # per-job backup state
└── spool/           # archives waiting to upload
```

## Update

```sh theme={null}
docker compose pull
docker compose up -d
```

**Admin** shows the running version: the tag (`v1.2.0`) on prod builds, the commit hash on main builds.

## Build from source

To build the image yourself, use the Compose file in [`scout/`](https://github.com/thesteau/3to1go/tree/main/scout) instead. It builds from the repository root so the shared code is included.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.