kalaksi/tinyproxy repository overview

⁠Attention!

Since automated builds are not available anymore, this README will not be updated automatically, but should be up-to-date. This also means that the Github repository is no longer displayed as the source. Images are now pushed using GitLab CI so the build process logs are available there. The images are also available on GitLab so definitely use those especially if we start hitting the new Docker Hub limits.

⁠Repositories

• GitLab repository⁠ (image: registry.gitlab.com/kalaksi-containers/tinyproxy)
• Docker Hub repository⁠ (image: docker.io/kalaksi/tinyproxy)
• GitHub repository⁠

⁠Why use this container?

Simply put, this container has been written with simplicity and security in mind.

Many community containers run unnecessarily with root privileges by default and don't provide help for dropping unneeded CAPabilities either. On top of that, overly complex shell scripts, monolithic designs and unofficial base images make it harder to verify the source among other issues.

To remedy the situation, these images have been written with security, simplicity and overall quality in mind.

⁠Supported tags

See the Tags tab on Docker Hub for specifics. Basically you have:

• The default latest tag that always has the latest changes.
• Minor versioned tags (follow Semantic Versioning), e.g. 1.1 which would follow branch 1.1.x on GitHub.

⁠Configuration

See Dockerfile and docker-compose.yml (https://github.com/kalaksi/docker-tinyproxy⁠) for usable environment variables. Variables that are left empty will use default values. If you need more customization, mount your own tinyproxy.conf to /etc/tinyproxy/tinyproxy.conf, otherwise, the default tinyproxy configuration file will be used and customized according to the environment variables.

⁠Considerations for the native configuration file

This section doesn't apply to the current version (but is relevant for the future release)! Note that you can't use /dev/stdout directly as the logfile: https://github.com/tinyproxy/tinyproxy/issues/43⁠. The proper way to get Tinyproxy to log to stdout is to disable LogFile and Syslog on the configuration so make sure that's how your file is set up.

⁠Development

⁠Contributing

See the repository on https://github.com/kalaksi/docker-tinyproxy⁠. All kinds of contributions are welcome!

⁠License

Copyright (c) 2018 [email protected]⁠. See LICENSE⁠ for license information.

As with all Docker images, the built image likely also contains other software which may be under other licenses (such as software from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.