{"id":13552705,"url":"https://github.com/DeepWoods/nxfilter-docker","last_synced_at":"2025-04-03T03:32:41.765Z","repository":{"id":40512266,"uuid":"506809278","full_name":"DeepWoods/nxfilter-docker","owner":"DeepWoods","description":"NxFilter docker container","archived":false,"fork":false,"pushed_at":"2025-04-02T01:03:04.000Z","size":21,"stargazers_count":14,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-02T02:21:30.026Z","etag":null,"topics":["adblocker","content-filtering","dns","dns-filter","dns-server","dnsfilter","docker","free","nxfilter","web-filter","webfilter"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DeepWoods.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-23T22:30:08.000Z","updated_at":"2025-04-02T01:03:07.000Z","dependencies_parsed_at":"2023-02-04T06:01:07.712Z","dependency_job_id":"926983df-1142-4c47-9d68-05cc8200f788","html_url":"https://github.com/DeepWoods/nxfilter-docker","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepWoods%2Fnxfilter-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepWoods%2Fnxfilter-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepWoods%2Fnxfilter-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DeepWoods%2Fnxfilter-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DeepWoods","download_url":"https://codeload.github.com/DeepWoods/nxfilter-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246933421,"owners_count":20857049,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adblocker","content-filtering","dns","dns-filter","dns-server","dnsfilter","docker","free","nxfilter","web-filter","webfilter"],"created_at":"2024-08-01T12:02:08.133Z","updated_at":"2025-04-03T03:32:36.746Z","avatar_url":"https://github.com/DeepWoods.png","language":"Dockerfile","funding_links":[],"categories":["Dockerfile"],"sub_categories":[],"readme":"# NxFilter #\n\n## About ##\n[NxFilter](http://nxfilter.org/p3/) is a scalable and reliable DNS filtering server software by Jahastech.\n\nContainer image is based off of Ubuntu:latest minimal with the most current DEB package for NxFilter from [NxFilter](https://nxfilter.org/p3/download/).\n\n\n## Usage ##\n\n#### Interactive container for testing: ####\n\n```\ndocker run -it --name nxfilter \\\n   -p 53:53/udp \\\n   -p 19004:19004/udp \\\n   -p 80:80 \\\n   -p 443:443 \\\n   -p 19002-19004:19002-19004 \\\n   deepwoods/nxfilter:latest\n```\n\n#### Detached container with persistent data volumes: ####\n\n```\ndocker run -dt --name nxfilter \\\n  -e TZ=America/Chicago \\\n  -v nxfconf:/nxfilter/conf \\\n  -v nxfdb:/nxfilter/db \\\n  -v nxflog:/nxfilter/log \\\n  -p 53:53/udp \\\n  -p 19004:19004/udp \\\n  -p 80:80 \\\n  -p 443:443 \\\n  -p 19002-19004:19002-19004 \\\n  deepwoods/nxfilter:latest\n```\n\n\n## Configuration\n* The admin GUI URL is http://[DOCKER_HOST_SERVER_IP]/admin\n* The default Block Redirection IP under System -\u003e Setup needs to match your [DOCKER_HOST_SERVER_IP] unless you're bridging your docker network to your local LAN or using MACVLAN.  \n* 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)\n\n\n---\n## Docker-compose example ##\n\n```yaml\nversion: '3.5'\n\nservices:\n  nxfilter:\n    image: deepwoods/nxfilter:latest\n    container_name: nxfilter\n    hostname: nxfilter\n    restart: unless-stopped\n    environment:\n      TZ: \"America/Chicago\"\n    volumes:\n      - nxfconf:/nxfilter/conf\n      - nxflog:/nxfilter/log\n      - nxfdb:/nxfilter/db\n    ports:\n      - 53:53/udp\n      - 19004:19004/udp\n      - 80:80\n      - 443:443\n      - 19002-19004:19002-19004\nvolumes:\n  nxfconf:\n  nxfdb:\n  nxflog:\n```\n\n### Useful Commands ###\ndocker-compose to start and detach container: `docker-compose up -d`\n\nStop and remove container: `docker-compose down`\n\nRestart a service: `docker-compose restart nxfilter`\n\nView logs: `docker-compose logs`\n\nOpen a bash shell on running container name: `docker exec -it nxfilter /bin/bash`\n\n\u003e **Warning**\n\u003e Commands below will delete all data volumes not associated with a container!\n\u003e \n\u003e Remove container \u0026 persistent volumes(clean slate): `docker-compose down \u0026\u0026 docker volume prune`\n\n## Updating ##\n1. Pull the latest container.  `docker pull deepwoods/nxfilter:latest`\n2. Stop and remove the current container.  `docker stop nxfilter \u0026\u0026 docker rm nxfilter`\n\u003e **Note** If using docker-compose:  `docker-compose down`\n3. Run the new container with the same command from above.  [Detached container](#detached-container-with-persistent-data-volumes)\n\u003e **Note** If using docker-compose:  `docker-compose up -d`\n4. Make sure that the container is running.  `docker ps`\n5. Check the container logs if unable to access the GUI for some reason.  `docker logs nxfilter`\n\u003e **Note** If using docker-compose:  `docker-compose logs`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDeepWoods%2Fnxfilter-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDeepWoods%2Fnxfilter-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDeepWoods%2Fnxfilter-docker/lists"}