Skip to content

Commit 5e94537

Browse files
committed
Add readme.md file.
1 parent 3b5dec1 commit 5e94537

1 file changed

Lines changed: 32 additions & 1 deletion

File tree

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,32 @@
1-
# docker-tinyproxy
1+
# docker-tinyproxy
2+
3+
A minimal Docker image for [Tinyproxy](https://tinyproxy.github.io/), built on Alpine Linux. This image is suitable for lightweight HTTP/HTTPS proxy deployments in containerized environments.
4+
5+
## Features
6+
7+
- Based on `alpine:latest` for a small footprint
8+
- Installs `tinyproxy` and `curl`
9+
- Exposes port `8888` by default
10+
- Automated multi-architecture builds (amd64, arm64) via GitHub Actions
11+
- Images published to GitHub Container Registry (`ghcr.io/querateam/docker-tinyproxy:latest`)
12+
13+
## Usage
14+
15+
### Pull the image
16+
17+
```sh
18+
docker pull ghcr.io/querateam/docker-tinyproxy:latest
19+
```
20+
21+
### Run the container
22+
23+
```sh
24+
docker run -d -p 8888:8888 ghcr.io/querateam/docker-tinyproxy:latest
25+
```
26+
27+
### Customization
28+
You can customize the Tinyproxy configuration by mounting a custom `tinyproxy.conf` file:
29+
30+
```sh
31+
docker run -d -p 8888:8888 -v /path/to/your/tinyproxy.conf:/etc/tinyproxy/tinyproxy.conf ghcr.io/querateam/docker-tinyproxy:latest
32+
```

0 commit comments

Comments
 (0)