README.md

Rama main · réplica de lectura del repositorio original.

<!--
THIS FILE IS AUTOGENERATED - DO NOT EDIT MANUALLY
Source: dbuild templates
-->

# Headscale

[![Build Status](https://img.shields.io/github/actions/workflow/status/daemonless/headscale/build.yaml?style=flat-square&label=Build&color=green)](https://github.com/daemonless/headscale/actions)
[![Last Commit](https://img.shields.io/github/last-commit/daemonless/headscale?style=flat-square&label=Last+Commit&color=blue)](https://github.com/daemonless/headscale/commits)
[![OCI Pulls](https://img.shields.io/docker/pulls/daemonless/headscale?style=flat-square&label=OCI+Pulls&color=blue)](https://hub.docker.com/r/daemonless/headscale)

An open source, self-hosted implementation of the Tailscale control server.

| | |
|---|---|
| **Port** | 8080 |
| **Registry** | `ghcr.io/daemonless/headscale` |
| **Source** | [https://github.com/juanfont/headscale](https://github.com/juanfont/headscale) |
| **Website** | [https://headscale.net/](https://headscale.net/) |

## Version Tags
| Tag | Description | Best For |
| :--- | :--- | :--- |
| `latest` | Built from the official upstream FreeBSD release binary. | Most users — recommended. |
| `pkg` | Installed from the FreeBSD quarterly package repository. | Alternative build. |
| `pkg-latest` | Installed from the FreeBSD latest package repository. | Alternative build. |

## Prerequisites
Before deploying, ensure your host environment is ready. See the [Quick Start Guide](https://daemonless.io/guides/quick-start) for host setup instructions.

## Deployment

### Podman Compose

```yaml
services:
  headscale:
    image: "ghcr.io/daemonless/headscale:latest"
    container_name: headscale
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
    volumes:
      - "/containers/headscale:/config"
    ports:
      - "8080:8080"
      - "3478:3478/udp"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always
```

Save as `compose.yaml`, then run `podman-compose up -d`.

### AppJail Director
**.env**:

```
# .env

DIRECTOR_PROJECT=headscale
PUID=1000
PGID=1000
TZ=UTC
```

**appjail-director.yml**:

```yaml
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  headscale:
    name: headscale
    options:
      - container: 'args:--pull'
      - expose: '8080:8080 proto:tcp'
      - expose: '3478:3478 proto:udp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - headscale: /config
volumes:
  headscale:
    device: '/containers/headscale'
```

**Makejail**:

```
# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/headscale:${tag}
```

Save the files above, then run `appjail-director up`.


> [!WARNING]
> Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.
>
> To avoid exposing ports, just remove the `expose` option in your `appjail-director.yml` or from your command-line arguments.

### Bastille

> [!WARNING]
> Bastille's OCI support is **experimental**. It requires `buildah` and shares the host network stack (`inherit`). Mount volumes with `--volume HOST JAIL`; without it, image-declared volumes are stored under `${bastille_volumesdir}/${jail}`.

```yaml
services:
  headscale:
    name: headscale
    image: "ghcr.io/daemonless/headscale:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - "/containers/headscale:/config"
```

Save as `bastille-compose.yml`, then run `bastille up`.
Open `http://<server>:8080` from another machine (the server's own browser can't use a published port).

## Parameters

### Environment Variables

| Variable | Default | Description |
|----------|---------|-------------|
| `PUID` | `1000` | User ID for the application process |
| `PGID` | `1000` | Group ID for the application process |
| `TZ` | `UTC` | Timezone for the container |

### Volumes

| Path | Description |
|------|-------------|
| `/config` | Configuration directory |

### Ports

| Port | Protocol | Description |
|------|----------|-------------|
| `8080` | TCP | Control server (HTTP) |
| `3478` | UDP | Embedded DERP STUN (UDP) |

**Architectures:** amd64
**User:** `bsd` (UID/GID via PUID/PGID, defaults to 1000:1000)
**Base:** FreeBSD 15

---

Need help? Join our [Discord](https://discord.gg/Kb9tkhecZT) community.