headplane/docs/Simple-Mode.md

# Simple Deployment

> **Note**: With Heady v1.0, we've unified the architecture! The distinction between "Simple" and "Integrated" modes has been streamlined. All deployments now support the full feature set, with integration capabilities configured through the `integration` section in your config.

Simple deployment enables you to quickly deploy Heady and is recommended for testing or environments where you want to manage Headscale separately. For advanced features like automatic DNS management and configuration updates, enable the appropriate integration in your [configuration](./Configuration.md).

## Deployment
> If you are not looking to deploy with Docker, follow the [**Bare-Metal**](./Bare-Metal.md) deployment guide.

Requirements:
- Docker and Docker Compose
- Headscale 0.26 or newer (already deployed)
- A finished configuration file (config.yaml)

Here is what a sample Docker Compose deployment would look like:
```yaml
services:
  heady:
    # I recommend you pin the version to a specific release
    image: ghcr.io/tale/heady:1.0.0
    container_name: heady
    restart: unless-stopped
    ports:
      - '3000:3000'
    volumes:
      - './config.yaml:/etc/heady/config.yaml'
      - './heady-data:/var/lib/heady'
    environment:
      - HEADY_CONFIG_PATH=/etc/heady/config.yaml
```

This will result in the Heady UI being available at the root path (`/`) of the
server you deployed it on. The path prefix is configurable via the `__INTERNAL_PREFIX` 
environment variable if needed.

> Refer to the [**Configuration**](./Configuration.md) guide for help with
> setting up your `config.yaml` file to the appropriate values.