Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DeepWoods/nxfilter-docker
NxFilter docker container
https://github.com/DeepWoods/nxfilter-docker
adblocker content-filtering dns dns-filter dns-server dnsfilter docker free nxfilter web-filter webfilter
Last synced: about 2 months ago
JSON representation
NxFilter docker container
- Host: GitHub
- URL: https://github.com/DeepWoods/nxfilter-docker
- Owner: DeepWoods
- Created: 2022-06-23T22:30:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T13:12:54.000Z (4 months ago)
- Last Synced: 2024-09-13T01:15:53.556Z (3 months ago)
- Topics: adblocker, content-filtering, dns, dns-filter, dns-server, dnsfilter, docker, free, nxfilter, web-filter, webfilter
- Language: Dockerfile
- Homepage:
- Size: 16.6 KB
- Stars: 10
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NxFilter #
## About ##
[NxFilter](http://nxfilter.org/p3/) is a scalable and reliable DNS filtering server software by Jahastech.
Container image is based off of Ubuntu:latest minimal with the most current DEB package for NxFilter from [NxFilter](https://nxfilter.org/p3/download/).
## Usage ##
#### Interactive container for testing: ####
```
docker run -it --name nxfilter \
-p 53:53/udp \
-p 19004:19004/udp \
-p 80:80 \
-p 443:443 \
-p 19002-19004:19002-19004 \
deepwoods/nxfilter:latest
```
#### Detached container with persistent data volumes: ####
```
docker run -dt --name nxfilter \
-e TZ=America/Chicago \
-v nxfconf:/nxfilter/conf \
-v nxfdb:/nxfilter/db \
-v nxflog:/nxfilter/log \
-p 53:53/udp \
-p 19004:19004/udp \
-p 80:80 \
-p 443:443 \
-p 19002-19004:19002-19004 \
deepwoods/nxfilter:latest
```
## Configuration
* The admin GUI URL is http://[DOCKER_HOST_SERVER_IP]/admin
* The default Block Redirection IP under System -> Setup needs to match your [DOCKER_HOST_SERVER_IP] unless you're bridging your docker network to your local LAN or using MACVLAN.
* TZ of the container defaults to UTC unless overridden by setting the environment variable to your locale. [see List of tz time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
---
## Docker-compose example ##
```yaml
version: '3.5'
services:
nxfilter:
image: deepwoods/nxfilter:latest
container_name: nxfilter
hostname: nxfilter
restart: unless-stopped
environment:
TZ: "America/Chicago"
volumes:
- nxfconf:/nxfilter/conf
- nxflog:/nxfilter/log
- nxfdb:/nxfilter/db
ports:
- 53:53/udp
- 19004:19004/udp
- 80:80
- 443:443
- 19002-19004:19002-19004
volumes:
nxfconf:
nxfdb:
nxflog:
```
### Useful Commands ###
docker-compose to start and detach container: `docker-compose up -d`
Stop and remove container: `docker-compose down`
Restart a service: `docker-compose restart nxfilter`
View logs: `docker-compose logs`
Open a bash shell on running container name: `docker exec -it nxfilter /bin/bash`
> **Warning**
> Commands below will delete all data volumes not associated with a container!
>
> Remove container & persistent volumes(clean slate): `docker-compose down && docker volume prune`
## Updating ##
1. Pull the latest container. `docker pull deepwoods/nxfilter:latest`
2. Stop and remove the current container. `docker stop nxfilter && docker rm nxfilter`
> **Note** If using docker-compose: `docker-compose down`
3. Run the new container with the same command from above. [Detached container](#detached-container-with-persistent-data-volumes)
> **Note** If using docker-compose: `docker-compose up -d`
4. Make sure that the container is running. `docker ps`
5. Check the container logs if unable to access the GUI for some reason. `docker logs nxfilter`
> **Note** If using docker-compose: `docker-compose logs`