sensimilla/docker-squidguard repository overview

⁠Introduction

this Dockerfile is an squidGuard⁠ addition to sameersbn/docker-squid⁠. I find squidGuard very useful to limit access to certain internet pages and to reduce the risk for downloading dangerous software. A central filtering solution is preferred especially if you have a family with children and different devices.

This image includes also automatic proxy discovery based on WPAT and DHCP. Here a Webserver is required that serves wpat.dat.

⁠Installation

Pull the image from the docker registry e.g.

docker pull muenchhausen/docker-squidguard

or build it

git clone https://github.com/muenchhausen/docker-squidguard.git

cd docker-squidguard

docker build --tag="$USER/squidguard" .

run your build: docker run --name='squidguard' -it --rm -p 3128:3128 -p 80:80 "$USER/squidguard"

Please refer to sameersbn/docker-squid⁠ for details!

⁠Quick Start

Run the downloaded image

docker run --name='squidguard' -it --rm -p 3128:3128 -p 80:80 muenchhausen/docker-squidguard:latest

or as daemon

docker run -d --name='squidguard' -it -p 3128:3128 -p 80:80 muenchhausen/docker-squidguard:latest

or run it including WPAT proxy autoconfig so your Operating system will find the settings automatically based on your DHCP settings:

docker run --name='squidguard' -it --env WPAT_IP=192.168.59.103 --env WPAT_NOPROXY_NET=192.168.59.0 --env WPAT_NOPROXY_MASK=255.255.255.0 --rm -p 3128:3128 -p 80:80 muenchhausen/docker-squidguard:latest

To use WPAT, add a cusom-proxy-server option 252 to your DHCP server. Use "http://${WPAT_IP}/wpat.dat" e.g. "http://192.168.59.103/wpat.dat⁠" as your option value. See squidGuard Wiki⁠ for further details.

⁠Test it

here curl should return the page: curl --proxy 192.168.59.103:3128 https://en.wikipedia.org/wiki/Main_Page

here an example of an advertising domain from the adv blacklist - curl gets blocked: curl --proxy 192.168.59.103:3128 http://www.linkadd.de

Finally configure docker host IP and port 3128 in your browser proxy settings or operating system proxy configuration.

Or - if you decided for the WPAT autoproxy variant, just do now a DHCP release and you get your proxy settings :)

⁠Configuration

For Squid basis configuration, please refer to the documentation of sameersbn/docker-squid⁠.

The central configuration file of squidGuard is squidGuard.conf. You can customize it either by building your own docker image or by specifying the -v /path/on/host/to/squidGuard.conf:/etc/squidguard/squidGuard.conf flag in the docker run command. A simple documentation of how to configure squidGuard blacklists can be found in the squidGuard configuration documentation⁠.

⁠Shell Access

For debugging and maintenance purposes you may want access the containers shell. Either add after the run command or tun e.g.

docker exec -it "$USER/squidguard" bash

or docker ps docker exec -it <container-id> bash

⁠Autostart the container

add the parameter --restart=always to your docker run command.