12 Commits

Author SHA1 Message Date
Paramtamtam
e2d06289c4 Fix logformat 2021-05-03 21:14:15 +05:00
Paramtamtam
009ec66d86 Logging in JSON format 2021-05-03 20:57:35 +05:00
dependabot[bot]
19c9d5528e Bump gcc from 10.3.0 to 11.1.0 (#5) 2021-05-03 07:02:04 +00:00
dependabot[bot]
edc91855c5 Bump gcc from 10.2.0 to 10.3.0 (#4)
Bumps gcc from 10.2.0 to 10.3.0.

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-04-12 19:23:30 +05:00
Paramtamtam
e53ceaa3e3 Revert "Docker image arch linux/arm/v7 added"
This reverts commit 8c5b04a0df.
2021-03-23 15:16:05 +05:00
Paramtamtam
8c5b04a0df Docker image arch linux/arm/v7 added 2021-03-23 15:08:46 +05:00
Paramtamtam
ce90d6dc89 Update tests.yml 2021-03-22 10:11:12 +05:00
dependabot[bot]
b8ab9af377 Bump gcc from 9.3 to 10.2.0 (#2) 2021-01-16 07:22:45 +00:00
Paramtamtam
6bd02fba06 Github Actions (release) fixed 2021-01-16 01:43:35 +05:00
Paramtamtam
97e1214f68 Github Actions and readme file updated 2021-01-16 01:42:44 +05:00
Paramtamtam
6f590edfc5 Release CI fixed (#3) 2021-01-16 01:35:09 +05:00
Paramtamtam
9d5ceade36 3proxy updated up to 0.9.3 (#1) 2021-01-16 01:16:25 +05:00
12 changed files with 230 additions and 88 deletions

8
.dockerignore Normal file
View File

@@ -0,0 +1,8 @@
.editorconfig
.git
.github
.idea
.vscode
temp
tmp
LICENSE

3
.github/CODEOWNERS vendored Normal file
View File

@@ -0,0 +1,3 @@
# @link <https://help.github.com/en/articles/about-code-owners>
* @tarampampam

21
.github/dependabot.yml vendored Normal file
View File

@@ -0,0 +1,21 @@
# Docs: <https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/customizing-dependency-updates>
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
reviewers:
- "tarampampam"
assignees:
- "tarampampam"
- package-ecosystem: "docker"
directory: "/"
schedule:
interval: "weekly"
reviewers:
- "tarampampam"
assignees:
- "tarampampam"

21
.github/labeler.yml vendored Normal file
View File

@@ -0,0 +1,21 @@
docs:
- '**/*.md'
- '**/*.MD'
.github:
- '.github/**/*'
CI:
- '.github/workflows/**/*'
- '.github/actions/**/*'
docker:
- 'Dockerfile'
- 'docker/**/*'
- '.dockerignore'
- 'docker-entrypoint.sh'
- '3proxy.cfg'
dev:
- '.gitignore'
- '.editorconfig'

12
.github/workflows/labeler.yml vendored Normal file
View File

@@ -0,0 +1,12 @@
name: labeler
on: [pull_request_target]
jobs:
triage:
runs-on: ubuntu-20.04
steps:
- uses: actions/labeler@v3 # Action page: <https://github.com/actions/labeler>
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
sync-labels: true

View File

@@ -7,27 +7,32 @@ on:
jobs:
docker-image:
name: Build docker image
runs-on: ubuntu-latest
runs-on: ubuntu-20.04
steps:
- name: Check out code
uses: actions/checkout@v2
- name: Generate image tag value
run: echo "::set-env name=IMAGE_TAG::${GITHUB_REF##*/[vV]}" # `/refs/tags/v1.2.3` -> `1.2.3`
- name: Make docker login
- name: Docker login in default registry
run: echo "${{ secrets.DOCKER_PASSWORD }}" | docker login -u "${{ secrets.DOCKER_LOGIN }}" --password-stdin &> /dev/null
- name: Docker login in ghcr.io # Auth docs: <https://git.io/JLDaw>
run: echo "${{ secrets.GHCR_PASSWORD }}" | docker login ghcr.io -u tarampampam --password-stdin
- name: Generate image tag value
id: tag
run: echo "::set-output name=value::`echo ${GITHUB_REF##*/} | sed -e 's/^[vV ]*//'`" # `/refs/tags/v1.2.3` -> `1.2.3`
- name: Build image
run: |
docker build \
--build-arg "BUILD_DATE=`date -u +'%Y-%m-%dT%H:%M:%SZ'`" \
--tag "tarampampam/3proxy:${IMAGE_TAG}" \
--tag "tarampampam/3proxy:${{ steps.tag.outputs.value }}" \
--tag "tarampampam/3proxy:latest" \
--tag "ghcr.io/tarampampam/3proxy:${{ steps.tag.outputs.value }}" \
--tag "ghcr.io/tarampampam/3proxy:latest" \
-f ./Dockerfile .
- name: Push version image
run: docker push "tarampampam/3proxy:${IMAGE_TAG}"
- name: Push into default registry
run: docker push "tarampampam/3proxy:${{ steps.tag.outputs.value }}" && docker push "tarampampam/3proxy:latest"
- name: Push latest image
run: docker push "tarampampam/3proxy:latest"
- name: Push into ghcr.io
run: docker push "ghcr.io/tarampampam/3proxy:${{ steps.tag.outputs.value }}" && docker push "ghcr.io/tarampampam/3proxy:latest"

View File

@@ -7,78 +7,101 @@ on:
tags-ignore:
- '**'
pull_request:
schedule:
- cron: '0 0 * * 0' # once in a week, docs: <https://git.io/JvxXE#onschedule>
jobs: # Docs: <https://git.io/JvxXE>
docker-image:
name: Build and use docker image
runs-on: ubuntu-latest
build-image:
name: Build docker image
runs-on: ubuntu-20.04
steps:
- name: Check out code
uses: actions/checkout@v2
- name: Build docker image
run: docker build -f ./Dockerfile --tag image:local .
run: docker build -f ./Dockerfile --tag 3proxy:local .
- name: Run docker image with default settings
run: |
docker run --rm -d \
-p "3128:3128/tcp" \
-p "1080:1080/tcp" \
image:local
- name: Scan image
uses: anchore/scan-action@v2 # action page: <https://github.com/anchore/scan-action>
with:
image: 3proxy:local
fail-build: true
severity-cutoff: low # negligible, low, medium, high or critical
- name: Save docker image
run: docker save 3proxy:local > ./docker-image.tar
- name: Upload artifact
uses: actions/upload-artifact@v2
with:
name: docker-image
path: ./docker-image.tar
try-to-use:
name: Build and use docker image (auth ${{ matrix.auth }})
runs-on: ubuntu-20.04
strategy:
fail-fast: false
matrix:
auth: [yes, no]
needs: [build-image]
steps:
- name: Download builded docker image
uses: actions/download-artifact@v2
with:
name: docker-image
path: .artifact
- name: Prepare image to run
working-directory: .artifact
run: docker load < docker-image.tar
- name: Start server without auth setup
if: matrix.auth != 'yes'
run: docker run --rm -d -p "3128:3128/tcp" -p "1080:1080/tcp" 3proxy:local
- name: Start server with auth setup
if: matrix.auth == 'yes'
run: docker run --rm -d -p "3128:3128/tcp" -p "1080:1080/tcp" -e "PROXY_LOGIN=evil" -e "PROXY_PASSWORD=live" 3proxy:local
- name: Pause
run: sleep 2
run: sleep 3
- name: Try to use HTTP proxy
if: matrix.auth != 'yes'
run: |
curl -v --fail \
--proxy http://127.0.0.1:3128 \
--connect-timeout 3 \
--max-time 3 \
https://github.com/robots.txt
https://www.cloudflare.com/robots.txt
- name: Try to use SOCKS proxy
if: matrix.auth != 'yes'
run: |
curl -v --fail \
--proxy socks5://127.0.0.1:1080 \
--connect-timeout 3 \
--max-time 3 \
https://github.com/robots.txt
https://www.cloudflare.com/robots.txt
- name: Stop container
run: docker stop $(docker ps -a --filter ancestor=image:local -q)
- name: Run docker image with auth settings
run: |
docker run --rm -d \
-p "3128:3128/tcp" \
-p "1080:1080/tcp" \
-e "PROXY_LOGIN=evil" \
-e "PROXY_PASSWORD=live" \
image:local
- name: Pause
run: sleep 2
- name: Try to use HTTP proxy
- name: Try to use HTTP proxy (with auth)
if: matrix.auth == 'yes'
run: |
curl -v --fail \
--proxy http://127.0.0.1:3128 \
--proxy-user evil:live \
--connect-timeout 3 \
--max-time 3 \
https://github.com/robots.txt
https://www.cloudflare.com/robots.txt
- name: Try to use SOCKS proxy
- name: Try to use SOCKS proxy (with auth)
if: matrix.auth == 'yes'
run: |
curl -v --fail \
--proxy socks5://127.0.0.1:1080 \
--proxy-user evil:live \
--connect-timeout 3 \
--max-time 3 \
https://github.com/robots.txt
https://www.cloudflare.com/robots.txt
- name: Stop container
run: docker stop $(docker ps -a --filter ancestor=image:local -q)
run: docker stop $(docker ps -a --filter ancestor=3proxy:local -q)

View File

@@ -1,4 +1,4 @@
#!/usr/bin/3proxy
#!/bin/3proxy
config /etc/3proxy/3proxy.cfg
# you may use system to execute some external command if proxy starts
@@ -16,8 +16,9 @@ nscache 65536
# Here we can change timeout values
timeouts 1 5 30 60 180 1800 15 60
# Logging docs: <https://3proxy.org/doc/howtor.html#LOGFORMAT>
log /dev/stdout
logformat "- +_L%t.%. %N.%p %E %U %C:%c %R:%r %O %I %h %T"
logformat "-\""+_G{""time_unix"":%t, ""proxy"":{""type:"":""%N"", ""port"":%p}, ""error"":{""code"":""%E""}, ""auth"":{""user"":""%U""}, ""client"":{""ip"":""%C"", ""port"":%c}, ""server"":{""ip"":""%R"", ""port"":%r}, ""bytes"":{""sent"":%O, ""received"":%I}, ""request"":{""hostname"":""%n""}, ""message"":""%T""}"
maxconn 1024

View File

@@ -4,6 +4,18 @@ All notable changes to this package will be documented in this file.
The format is based on [Keep a Changelog][keepachangelog] and this project adheres to [Semantic Versioning][semver].
## v1.3.0
### Changed
- Logging in JSON format
## v1.2.0
### Changed
- 3proxy updated from `0.8.13` up to `0.9.3`
## v1.1.0
### Removed

View File

@@ -1,46 +1,48 @@
# Image page: <https://hub.docker.com/_/alpine>
FROM alpine:latest as builder
# Image page: <https://hub.docker.com/_/gcc>
FROM gcc:11.1.0 as builder
# e.g.: `docker build --build-arg "VERSION=0.8.13" .`
ARG VERSION="0.8.13"
# e.g.: `docker build --build-arg "VERSION=0.9.3" .`
ARG VERSION="0.9.3"
# Fetch 3proxy sources
RUN set -x \
&& apk add --no-cache \
linux-headers \
build-base \
git \
&& git clone --branch ${VERSION} https://github.com/z3APA3A/3proxy.git /tmp/3proxy \
&& cd /tmp/3proxy \
&& echo '#define ANONYMOUS 1' >> /tmp/3proxy/src/3proxy.h \
&& git clone --branch "${VERSION}" https://github.com/z3APA3A/3proxy.git /tmp/3proxy
WORKDIR /tmp/3proxy
# Patch sources
RUN set -x \
&& echo '#define ANONYMOUS 1' >> ./src/3proxy.h \
# proxy.c source: <https://github.com/z3APA3A/3proxy/blob/0.9.3/src/proxy.c>
&& sed -i 's~\(<\/head>\)~<style>html,body{background-color:#222526;color:#fff;font-family:sans-serif;\
text-align:center;display:flex;flex-direction:column;justify-content:center}h1,h2{margin-bottom:0;font-size:2.5em}\
h2::before{content:'"'"'Proxy error'"'"';display:block;font-size:0.4em;color:#bbb;font-weight:100}\
h3,p{color:#bbb}</style>\1~' /tmp/3proxy/src/proxy.c \
&& cat ./src/proxy.c | grep '</head>' \
&& make -f Makefile.Linux
FROM alpine:latest
# e.g.: `docker build --build-arg "BUILD_DATE=`date -u +'%Y-%m-%dT%H:%M:%SZ'`" .`
ARG BUILD_DATE
LABEL \
org.label-schema.name="3proxy" \
org.label-schema.description="Tiny free proxy server" \
org.label-schema.url="https://github.com/tarampampam/3proxy-docker" \
org.label-schema.vcs-url="https://github.com/tarampampam/3proxy-docker" \
org.label-schema.docker.cmd="docker run --rm -d -p \"3128:3128/tcp\" -p \"1080:1080/tcp\" this_image" \
org.label-schema.vendor="tarampampam" \
org.label-schema.build-date="$BUILD_DATE" \
org.label-schema.license="WTFPL" \
org.label-schema.schema-version="1.0"
COPY 3proxy.cfg /etc/3proxy/3proxy.cfg
COPY docker-entrypoint.sh /docker-entrypoint.sh
COPY --from=builder /tmp/3proxy/src/3proxy /usr/bin/3proxy
h3,p{color:#bbb}</style>\1~' ./src/proxy.c \
&& cat ./src/proxy.c | grep '</head>'
# And compile
RUN set -x \
&& echo "" >> ./Makefile.Linux \
&& echo "PLUGINS = StringsPlugin TrafficPlugin PCREPlugin TransparentPlugin SSLPlugin" >> ./Makefile.Linux \
&& echo "LIBS = -l:libcrypto.a -l:libssl.a -ldl" >> ./Makefile.Linux \
&& make -f Makefile.Linux \
&& strip ./bin/3proxy \
&& strip ./bin/StringsPlugin.ld.so \
&& strip ./bin/TrafficPlugin.ld.so \
&& strip ./bin/PCREPlugin.ld.so \
&& strip ./bin/TransparentPlugin.ld.so \
&& strip ./bin/SSLPlugin.ld.so
# Prepare filesystem for 3proxy running
FROM busybox:1.32-glibc as buffer
# Copy binaries
COPY --from=builder /lib/x86_64-linux-gnu/libdl.so.* /lib/
COPY --from=builder /tmp/3proxy/bin/3proxy /bin/
COPY --from=builder /tmp/3proxy/bin/*.ld.so /usr/local/3proxy/libexec/
# Create unprivileged user
RUN set -x \
# Unprivileged user creation <https://stackoverflow.com/a/55757473/12429735RUN>
&& adduser \
--disabled-password \
--gecos "" \
@@ -48,12 +50,38 @@ RUN set -x \
--shell /sbin/nologin \
--no-create-home \
--uid 10001 \
3proxy \
&& chown 3proxy:3proxy -R /etc/3proxy
3proxy
# Prepare files and directories
RUN set -x \
&& chown -R 10001:10001 /usr/local/3proxy \
&& chmod -R 550 /usr/local/3proxy \
&& chmod -R 555 /usr/local/3proxy/libexec \
&& chown -R root /usr/local/3proxy/libexec \
&& mkdir /etc/3proxy \
&& chown -R 10001:10001 /etc/3proxy
# Copy our config and entrypoint script
COPY 3proxy.cfg /etc/3proxy/3proxy.cfg
COPY docker-entrypoint.sh /docker-entrypoint.sh
# Split all buffered layers into one
FROM scratch
LABEL \
org.opencontainers.image.title="3proxy" \
org.opencontainers.image.description="Tiny free proxy server" \
org.opencontainers.image.url="https://github.com/tarampampam/3proxy-docker" \
org.opencontainers.image.source="https://github.com/tarampampam/3proxy-docker" \
org.opencontainers.image.vendor="Tarampampam" \
org.opencontainers.image.licenses="WTFPL"
# Import from builder
COPY --from=buffer / /
# Use an unprivileged user
USER 3proxy:3proxy
ENTRYPOINT ["/docker-entrypoint.sh"]
CMD ["/usr/bin/3proxy", "/etc/3proxy/3proxy.cfg"]
CMD ["/bin/3proxy", "/etc/3proxy/3proxy.cfg"]

View File

@@ -12,7 +12,7 @@
## Why this image created?
3proxy is awesome and lightweight proxy-server. This image contains stable version with it and can be configured using environment variables. By default, it uses anonymous (information about client hiding) proxy settings.
3proxy is awesome and lightweight proxy-server. This image contains stable version with it and can be configured using environment variables. By default, it uses anonymous (information about client hiding) proxy settings. Logging in JSON format.
> Page on `hub.docker.com` can be [found here][link_docker_hub].
@@ -58,6 +58,14 @@ $ docker run --rm -d \
tarampampam/3proxy:latest
```
## Releasing
New versions publishing is very simple - just make required changes in this repository, update [changelog file](CHANGELOG.md) and "publish" new release using repo releases page.
Docker images will be build and published automatically.
> New release will overwrite the `latest` docker image tag in both registers.
## Changes log
[![Release date][badge_release_date]][link_releases]

View File

@@ -1,4 +1,4 @@
#!/usr/bin/env sh
#!/bin/sh
set -e
PROXY_LOGIN=${PROXY_LOGIN:-} # string