BlockyUI

A modern web interface for managing and controlling your Blocky DNS server.

✨ Key Features

• DNS blocking controls with optional timed disable presets
• DNS query tool to test domain blocking and filtering rules
• One-click cache clearing and list refresh
• Search through query logs and filter them (requires query logging configured on blocky)
  • Currently only works with MySQL/MariaDB databases

🏁 Getting Started

Using Docker Compose

1. Create a docker-compose.yml file:

services:
  blocky:
    image: spx01/blocky
    container_name: blocky
    hostname: blocky
    restart: unless-stopped
    volumes:
      - /etc/localtime:/etc/localtime:ro
    ports:
      - 4000:4000
      - 53:53/udp
  blocky-ui:
    image: gabrielduartem/blocky-ui:latest
    container_name: blocky-ui
    restart: unless-stopped
    depends_on:
      - blocky
    ports:
      - 3000:3000
    environment:
      - BLOCKY_API_URL=http://blocky:4000
      # Uncomment to enable query logging features if you have it configured on blocky (MySQL/MariaDB only):
      # - DATABASE_URL=mysql://username:password@localhost:3306/blocky_query_log_table_name

2. Start the container:

docker compose up -d

Visit http://localhost:3000 to access BlockyUI.

Using Docker Run

docker run -d -p 3000:3000 -e BLOCKY_API_URL=http://your-blocky-server:4000 [-e DATABASE_URL="mysql://username:password@localhost:3306/blocky_query_log_table_name"] gabrielduartem/blocky-ui:latest

Local Development

1. Clone the repository:

git clone https://github.com/gabeduartem/blocky-ui.git
cd blocky-ui

2. Install dependencies:

pnpm install

3. Configure environment variables:

cp .env.example .env
# Don't forget to update the file with the correct values

4. Start the development server:

pnpm dev

Visit http://localhost:3000 to access BlockyUI.

🤝 Contributing

We welcome contributions! Whether it's bug fixes, new features, or documentation improvements, your input helps make BlockyUI better.