Skip to content

wanyinglong/alpine-squid

 
 

Repository files navigation

build status commit version:x86_64 size:x86_64 version:armhf size:armhf version:armv7l size:armv7l version:aarch64 size:aarch64

Container for Alpine Linux + Squid Proxy Server


This image containerizes the Squid3 proxy server to setup a local web content cache or transparent proxy.

Based on Alpine Linux from my alpine-s6 image with the s6 init system overlayed in it.

The image is tagged respectively for the following architectures,

  • armhf
  • armv7l
  • aarch64
  • x86_64 (retagged as the latest )

non-x86_64 builds have embedded binfmt_misc support and contain the qemu-user-static binary that allows for running it also inside an x86_64 environment that has it.


Get the Image


Pull the image for your architecture it's already available from Docker Hub.

# make pull
docker pull woahbase/alpine-squid:x86_64

Configuration Defaults


  • Config files are loaded from /etc/squid/, if none found, the defaults from /defaults/squid are used, remount this with your own.

  • Cached content stored at /var/cache/squid.

  • Default configuration sets up htpasswd authentication for hosts. the user and password are configurable by the environment variables WEBADMIN and PASSWORD. Disable it in squid.conf if you don't need authentication with the proxy.

  • Default configuration listens to ports 3128 and 3129(interceptor).


Run


If you want to run images for other architectures, you will need to have binfmt support configured for your machine. multiarch, has made it easy for us containing that into a docker container.

# make regbinfmt
docker run --rm --privileged multiarch/qemu-user-static:register --reset

Without the above, you can still run the image that is made for your architecture, e.g for an x86_64 machine..

Running make starts the service.

# make
docker run --rm -it \
  --name docker_squid --hostname squid \
  -c 256 -m 256m \
  -e PGID=1000 -e PUID=1000 \
  -p 3128:3128 -p 3129:3129 \
  -v $(CURDIR)/data/config:/etc/squid \
  -v $(CURDIR)/data/cache:/var/cache/squid \
  -v /etc/hosts:/etc/hosts:ro \
  -v /etc/localtime:/etc/localtime:ro \
  woahbase/alpine-squid:x86_64

Stop the container with a timeout, (defaults to 2 seconds)

# make stop
docker stop -t 2 docker_squid

Removes the container, (always better to stop it first and -f only when needed most)

# make rm
docker rm -f docker_squid

Restart the container with

# make restart
docker restart docker_squid

Shell access


Get a shell inside a already running container,

# make debug
docker exec -it docker_squid /bin/bash

set user or login as root,

# make rdebug
docker exec -u root -it docker_squid /bin/bash

To check logs of a running container in real time

# make logs
docker logs -f docker_squid

Development


If you have the repository access, you can clone and build the image yourself for your own system, and can push after.


Setup


Before you clone the repo, you must have Git, GNU make, and Docker setup on the machine.

git clone https://github.com/woahbase/alpine-squid
cd alpine-squid

You can always skip installing make but you will have to type the whole docker commands then instead of using the sweet make targets.


Build


You need to have binfmt_misc configured in your system to be able to build images for other architectures.

Otherwise to locally build the image for your system. [ARCH defaults to x86_64, need to be explicit when building for other architectures.]

# make ARCH=x86_64 build
# sets up binfmt if not x86_64
docker build --rm --compress --force-rm \
  --no-cache=true --pull \
  -f ./Dockerfile_x86_64 \
  --build-arg DOCKERSRC=woahbase/alpine-s6:x86_64 \
  --build-arg PGID=1000 \
  --build-arg PUID=1000 \
  -t woahbase/alpine-squid:x86_64 \
  .

To check if its working..

# make ARCH=x86_64 test
docker run --rm -it \
  --name docker_squid --hostname squid \
  -e PGID=1000 -e PUID=1000 \
  --entrypoint sh \
  woahbase/alpine-squid:x86_64 \
  -ec 'squid -v'

And finally, if you have push access,

# make ARCH=x86_64 push
docker push woahbase/alpine-squid:x86_64

Maintenance


Sources at Github. Built at Travis-CI.org (armhf / x64 builds). Images at Docker hub. Metadata at Microbadger.

Maintained by WOAHBase.

About

Squid Proxy/Content Cache based on Alpine Linux + S6

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Makefile 66.2%
  • CSS 33.8%