Skip to content

Blocky Blocky

Description / nameInput element
Container Registry
Container Configuration Root Path
Timezone
Blocky Host Port
Blocky /config Path

Build Status Last Commit OCI Pulls

Fast and lightweight DNS proxy and ad-blocker for the local network, on FreeBSD.

Port 4000
Registry ghcr.io/daemonless/blocky
Daemonless daemonless/blocky
Source 0xERR0R/blocky
Website 0xerr0r.github.io/blocky

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users — recommended.

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

services:
  blocky:
    image: "ghcr.io/daemonless/blocky:latest"
    container_name: blocky
    environment:
      - TZ=UTC  # Timezone for the container
    volumes:
      - "/containers/blocky:/config"
    ports:
      - "4000:4000"
      - "53:53"
      - "53:53"
    # 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.

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.

1
2
3
4
# .env

DIRECTOR_PROJECT=blocky
TZ=UTC
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  blocky:
    name: blocky
    options:
      - container: 'args:--pull'
      - expose: '4000:4000 proto:tcp'
      - expose: '53:53 proto:udp'
      - expose: '53:53 proto:tcp'
    oci:
      user: root
      environment:
        - TZ: !ENV '${TZ}'
    volumes:
      - BLOCKY_CONFIG_PATH: /config
volumes:
  BLOCKY_CONFIG_PATH:
    device: '/containers/blocky'
1
2
3
4
5
6
7
# Makejail

ARG tag=latest

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

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

Experimental

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}.

services:
  blocky:
    name: blocky
    image: "ghcr.io/daemonless/blocky:latest"
    network:
      - mode: host
    environment:
      - TZ=UTC
    volumes:
      - "/containers/blocky:/config"

Save as bastille-compose.yml, then run bastille up.

Open http://<server>:4000 from another machine (the server's own browser can't use a published port).

Interactive Configuration

Parameters

Environment Variables

Variable Default Description
TZ Etc/UTC Timezone for the container

Volumes

Path Description
/config Your config.yml — optional, the image ships a working default that resolves and blocks ads. Must be writable; a read-only mount stops the container

Ports

Port Protocol Description
4000 TCP REST API and Prometheus metrics
53 UDP DNS (UDP and TCP)
53 TCP DNS (UDP and TCP)

Implementation Details

  • Architectures: amd64
  • User: root (UID/GID set via PUID/PGID). Defaults to 1000:1000.
  • Base: Built on ghcr.io/daemonless/base (FreeBSD 15.1).

Need help? Join our Discord community.