Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ivvija/blocky-ui
Simple web interface for blocky: https://github.com/0xERR0R/blocky
https://github.com/ivvija/blocky-ui
adblock dns golang pihole self-hosted selfhosted status webapp
Last synced: 2 months ago
JSON representation
Simple web interface for blocky: https://github.com/0xERR0R/blocky
- Host: GitHub
- URL: https://github.com/ivvija/blocky-ui
- Owner: ivvija
- Created: 2024-07-08T22:11:31.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-15T19:27:09.000Z (5 months ago)
- Last Synced: 2024-09-27T13:01:33.144Z (3 months ago)
- Topics: adblock, dns, golang, pihole, self-hosted, selfhosted, status, webapp
- Language: Go
- Homepage:
- Size: 362 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# blocky-ui
Simple web interface for [blocky](https://github.com/0xERR0R/blocky), a lightweight DNS proxy and DNS ad-blocker.
## Features
- web interface for all blocky API functions:
- toggle or pause blocking
- execute DNS queries
- refresh allow and deny lists
- flush DNS cache
- uses [HTMX](https://htmx.org/) to get status and query updates
- **no lost functionality if Javascript is disabled:**
- uses `` for full page reloads
- pause end time instead of countdown
### Screenshot
## Config
All config is done via environment variables:
| Name | Info | Default |
|------------------|------------------------------------------------------------------------|--------------------------|
| `HOST` | HTTP host | `0.0.0.0` |
| `PORT` | HTTP port | `3000` |
| `API_BASE_URL` | blocky API URL, no trailing slash | `http://blocky:4000/api` |
| `PAUSE_DURATION` | [Duration](https://pkg.go.dev/time#ParseDuration) for the pause button | `5m` |
## Run with docker
Use `-e API_BASE_URL=...` or `--env-file .env` to set the variables if needed.
```shell
docker run --name blocky-ui -p 3000:3000 ghcr.io/ivvija/blocky-ui
```
Build it yourself:
```shell
docker buildx build --build-arg VERSION=latest . -t blocky-ui
```
### compose.yml
```yaml
services:
blocky:
image: spx01/blocky # alt: ghcr.io/0xerr0r/blocky
container_name: blocky
# ... other blocky config
# https://0xerr0r.github.io/blocky/latest/installation/#run-with-docker-compose
blocky-ui:
image: ghcr.io/ivvija/blocky-ui
container_name: blocky-ui
restart: unless-stopped
depends_on:
- blocky
environment:
API_BASE_URL: http://blocky:4000/api
ports:
- "3000:3000/tcp"
```
## Run locally for tinkering
This project is set up for [live-reloading with air](https://github.com/air-verse/air), so just run `air` and
open `http://127.0.0.1:8080/`
## Notes
This is my first Go project, so issues and other comments are welcome!