Compare commits
28 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d72e72e7fc | ||
|
|
b345e9859a | ||
|
|
6e5b989498 | ||
|
|
f62172c9dc | ||
|
|
078a3d9b79 | ||
|
|
659fd3d395 | ||
|
|
bf160a071e | ||
|
|
93339d5159 | ||
|
|
1ef63988a7 | ||
|
|
921fc47ade | ||
|
|
e2d06289c4 | ||
|
|
009ec66d86 | ||
|
|
19c9d5528e | ||
|
|
edc91855c5 | ||
|
|
e53ceaa3e3 | ||
|
|
8c5b04a0df | ||
|
|
ce90d6dc89 | ||
|
|
b8ab9af377 | ||
|
|
6bd02fba06 | ||
|
|
97e1214f68 | ||
|
|
6f590edfc5 | ||
|
|
9d5ceade36 | ||
|
|
bad8266d07 | ||
|
|
7287fec0ed | ||
|
|
2c12e774bd | ||
|
|
32e62010f9 | ||
|
|
04fb12076c | ||
|
|
6d94db1ba6 |
8
.dockerignore
Normal file
8
.dockerignore
Normal file
@@ -0,0 +1,8 @@
|
||||
.editorconfig
|
||||
.git
|
||||
.github
|
||||
.idea
|
||||
.vscode
|
||||
temp
|
||||
tmp
|
||||
LICENSE
|
||||
3
.github/CODEOWNERS
vendored
Normal file
3
.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
# @link <https://help.github.com/en/articles/about-code-owners>
|
||||
|
||||
* @tarampampam
|
||||
16
.github/dependabot.yml
vendored
Normal file
16
.github/dependabot.yml
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
# 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: monthly}
|
||||
reviewers: [tarampampam]
|
||||
assignees: [tarampampam]
|
||||
|
||||
- package-ecosystem: docker
|
||||
directory: /
|
||||
schedule: {interval: monthly}
|
||||
reviewers: [tarampampam]
|
||||
assignees: [tarampampam]
|
||||
21
.github/labeler.yml
vendored
Normal file
21
.github/labeler.yml
vendored
Normal 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
12
.github/workflows/labeler.yml
vendored
Normal 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
|
||||
36
.github/workflows/release.yml
vendored
36
.github/workflows/release.yml
vendored
@@ -7,22 +7,36 @@ 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`
|
||||
- uses: gacts/github-slug@v1
|
||||
id: slug
|
||||
|
||||
- name: Make docker login
|
||||
run: echo "${{ secrets.DOCKER_PASSWORD }}" | docker login -u "${{ secrets.DOCKER_LOGIN }}" --password-stdin &> /dev/null
|
||||
- uses: docker/setup-buildx-action@v1
|
||||
|
||||
- name: Build image
|
||||
run: docker build --tag "tarampampam/3proxy:${IMAGE_TAG}" --tag "tarampampam/3proxy:latest" -f ./Dockerfile .
|
||||
- name: Login to default Container Registry
|
||||
uses: docker/login-action@v1 # Action page: <https://github.com/docker/login-action>
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_LOGIN }}
|
||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||
|
||||
- name: Push version image
|
||||
run: docker push "tarampampam/3proxy:${IMAGE_TAG}"
|
||||
- name: Login to GitHub Container Registry
|
||||
uses: docker/login-action@v1 # Action page: <https://github.com/docker/login-action>
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GHCR_PASSWORD }}
|
||||
|
||||
- name: Push latest image
|
||||
run: docker push "tarampampam/3proxy:latest"
|
||||
- uses: docker/build-push-action@v2 # Action page: <https://github.com/docker/build-push-action>
|
||||
with:
|
||||
context: .
|
||||
file: Dockerfile
|
||||
push: true
|
||||
tags: |
|
||||
tarampampam/3proxy:${{ steps.slug.outputs.version-semantic }}
|
||||
tarampampam/3proxy:latest
|
||||
ghcr.io/${{ github.actor }}/3proxy:${{ steps.slug.outputs.version-semantic }}
|
||||
ghcr.io/${{ github.actor }}/3proxy:latest
|
||||
|
||||
137
.github/workflows/tests.yml
vendored
137
.github/workflows/tests.yml
vendored
@@ -2,84 +2,139 @@ name: tests
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
tags-ignore:
|
||||
- '**'
|
||||
pull_request:
|
||||
schedule:
|
||||
- cron: '0 0 * * 0' # once in a week, docs: <https://git.io/JvxXE#onschedule>
|
||||
branches: [master, main]
|
||||
tags-ignore: ['**']
|
||||
pull_request: {}
|
||||
|
||||
jobs: # Docs: <https://git.io/JvxXE>
|
||||
docker-image:
|
||||
name: Build and use docker image
|
||||
runs-on: ubuntu-latest
|
||||
gitleaks:
|
||||
name: Gitleaks
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Check for GitLeaks
|
||||
uses: zricethezav/gitleaks-action@v1.6.0 # Action page: <https://github.com/zricethezav/gitleaks-action>
|
||||
|
||||
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@v3 # 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
|
||||
retention-days: 1
|
||||
|
||||
scan-image:
|
||||
name: Scan docker image
|
||||
runs-on: ubuntu-20.04
|
||||
needs: [build-image]
|
||||
steps:
|
||||
- name: Download built 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: Scan image
|
||||
uses: anchore/scan-action@v3 # action page: <https://github.com/anchore/scan-action>
|
||||
with:
|
||||
image: 3proxy:local
|
||||
fail-build: true
|
||||
severity-cutoff: low # negligible, low, medium, high or critical
|
||||
|
||||
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 "AUTH_REQUIRED=true" \
|
||||
-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)
|
||||
|
||||
30
3proxy.cfg
Normal file
30
3proxy.cfg
Normal file
@@ -0,0 +1,30 @@
|
||||
#!/bin/3proxy
|
||||
config /etc/3proxy/3proxy.cfg
|
||||
|
||||
# you may use system to execute some external command if proxy starts
|
||||
system "echo `which 3proxy`': Starting 3proxy'"
|
||||
|
||||
# We can configure nservers to avoid unsafe gethostbyname() usage
|
||||
nserver 1.0.0.1
|
||||
nserver 1.1.1.1
|
||||
nserver 8.8.4.4
|
||||
nserver 8.8.8.8
|
||||
|
||||
# nscache is good to save speed, traffic and bandwidth
|
||||
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 "-\""+_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
|
||||
|
||||
#AUTH_SETTINGS
|
||||
|
||||
proxy -a -p3128
|
||||
socks -a -p1080
|
||||
|
||||
flush
|
||||
50
CHANGELOG.md
50
CHANGELOG.md
@@ -4,6 +4,56 @@ 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.5.0
|
||||
|
||||
### Fixed
|
||||
|
||||
- Docker image building optimized
|
||||
|
||||
### Added
|
||||
|
||||
- Healthcheck in the dockerfile
|
||||
|
||||
## v1.4.0
|
||||
|
||||
### Changed
|
||||
|
||||
- 3proxy updated from `0.9.3` up to `0.9.4`
|
||||
|
||||
## 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
|
||||
|
||||
- Environment variable `AUTH_REQUIRED` support
|
||||
|
||||
### Changed
|
||||
|
||||
- Proxy error pages a little bit styled
|
||||
|
||||
## v1.0.0
|
||||
|
||||
### Fixed
|
||||
|
||||
- Dockerfile and docker entry-point script cleanup
|
||||
|
||||
## v0.1.1
|
||||
|
||||
### Fixed
|
||||
|
||||
- Docker entry-point script clean
|
||||
|
||||
## v0.1.0
|
||||
|
||||
### Changed
|
||||
|
||||
111
Dockerfile
111
Dockerfile
@@ -1,54 +1,81 @@
|
||||
# Image page: <https://hub.docker.com/_/alpine>
|
||||
FROM alpine:latest as builder
|
||||
# Image page: <https://hub.docker.com/_/gcc>
|
||||
FROM gcc:11.2.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.4" .`
|
||||
ARG VERSION="0.9.4"
|
||||
|
||||
# Fetch 3proxy sources
|
||||
RUN set -x \
|
||||
&& apk add --no-cache \
|
||||
ca-certificates \
|
||||
linux-headers \
|
||||
build-base \
|
||||
git \
|
||||
&& update-ca-certificates \
|
||||
&& git clone --branch ${VERSION} https://github.com/z3APA3A/3proxy.git /tmp/3proxy \
|
||||
&& cd /tmp/3proxy \
|
||||
&& echo '#define ANONYMOUS 1' >> /tmp/3proxy/src/3proxy.h \
|
||||
&& make -f Makefile.Linux
|
||||
&& git clone --branch "${VERSION}" https://github.com/z3APA3A/3proxy.git /tmp/3proxy
|
||||
|
||||
FROM alpine:latest
|
||||
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~' ./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.34.0-glibc as buffer
|
||||
|
||||
# create a directory for the future root filesystem
|
||||
WORKDIR /tmp/rootfs
|
||||
|
||||
# prepare the root filesystem
|
||||
RUN set -x \
|
||||
&& mkdir -p ./etc ./bin ./usr/local/3proxy/libexec ./etc/3proxy \
|
||||
&& echo '3proxy:x:10001:10001::/nonexistent:/sbin/nologin' > ./etc/passwd \
|
||||
&& echo '3proxy:x:10001:' > ./etc/group \
|
||||
&& wget -O ./bin/dumb-init "https://github.com/Yelp/dumb-init/releases/download/v1.2.5/dumb-init_1.2.5_x86_64" \
|
||||
&& chmod +x ./bin/dumb-init
|
||||
|
||||
# Copy binaries
|
||||
COPY --from=builder /lib/x86_64-linux-gnu/libdl.so.* ./lib/
|
||||
COPY --from=builder /tmp/3proxy/bin/3proxy ./bin/3proxy
|
||||
COPY --from=builder /tmp/3proxy/bin/*.ld.so ./usr/local/3proxy/libexec/
|
||||
COPY 3proxy.cfg ./etc/3proxy/3proxy.cfg
|
||||
COPY docker-entrypoint.sh ./docker-entrypoint.sh
|
||||
|
||||
RUN chown -R 10001:10001 ./etc/3proxy
|
||||
|
||||
FROM busybox:1.34.0-glibc
|
||||
|
||||
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.license="WTFPL" \
|
||||
org.label-schema.schema-version="1.0"
|
||||
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"
|
||||
|
||||
COPY docker-entrypoint.sh /docker-entrypoint.sh
|
||||
COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
|
||||
COPY --from=builder /tmp/3proxy/src/3proxy /usr/bin/3proxy
|
||||
COPY --from=builder /tmp/3proxy/cfg/3proxy.cfg.sample /etc/3proxy/3proxy.cfg
|
||||
|
||||
RUN set -x \
|
||||
# Unprivileged user creation <https://stackoverflow.com/a/55757473/12429735RUN>
|
||||
&& adduser \
|
||||
--disabled-password \
|
||||
--gecos "" \
|
||||
--home /nonexistent \
|
||||
--shell /sbin/nologin \
|
||||
--no-create-home \
|
||||
--uid 10001 \
|
||||
3proxy \
|
||||
&& touch /etc/3proxy/passwd \
|
||||
&& chown 3proxy:3proxy -R /etc/3proxy
|
||||
# Import from builder
|
||||
COPY --from=buffer /tmp/rootfs /
|
||||
|
||||
# Use an unprivileged user
|
||||
USER 3proxy:3proxy
|
||||
|
||||
ENTRYPOINT ["/docker-entrypoint.sh"]
|
||||
# Docs: <https://docs.docker.com/engine/reference/builder/#healthcheck>
|
||||
HEALTHCHECK --interval=5s --timeout=2s --retries=2 --start-period=2s CMD \
|
||||
netstat -ltn | grep 3128 && netstat -ltn | grep 1080
|
||||
|
||||
CMD ["/usr/bin/3proxy", "/etc/3proxy/3proxy.cfg"]
|
||||
ENTRYPOINT ["/bin/dumb-init", "--"]
|
||||
|
||||
CMD ["/docker-entrypoint.sh", "/bin/3proxy", "/etc/3proxy/3proxy.cfg"]
|
||||
|
||||
16
README.md
16
README.md
@@ -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.
|
||||
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].
|
||||
|
||||
@@ -33,7 +33,6 @@ All supported image tags [can be found here][link_docker_tags].
|
||||
|
||||
Variable name | Description | Example
|
||||
---------------- | ----------------------------------------- | ---------------
|
||||
`AUTH_REQUIRED` | Require authorization? (default: `false`) | `true`, `false`
|
||||
`PROXY_LOGIN` | Authorization login | `username`
|
||||
`PROXY_PASSWORD` | Authorization password | `password`
|
||||
|
||||
@@ -54,12 +53,19 @@ Or with auth settings:
|
||||
$ docker run --rm -d \
|
||||
-p "3128:3128/tcp" \
|
||||
-p "1080:1080/tcp" \
|
||||
-e "AUTH_REQUIRED=true" \
|
||||
-e "PROXY_LOGIN=evil" \
|
||||
-e "PROXY_PASSWORD=live" \
|
||||
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]
|
||||
@@ -79,7 +85,7 @@ If you will find any package errors, please, [make an issue][link_create_issue]
|
||||
WTFPL. Use anywhere for your pleasure.
|
||||
|
||||
[badge_build_status]:https://img.shields.io/github/workflow/status/tarampampam/3proxy-docker/tests/master?logo=github&label=build
|
||||
[badge_release_status]:https://img.shields.io/github/workflow/status/tarampampam/3proxy-docker/release/master?logo=github&label=release
|
||||
[badge_release_status]:https://img.shields.io/github/workflow/status/tarampampam/3proxy-docker/release?logo=github&label=release
|
||||
[badge_release_date]:https://img.shields.io/github/release-date/tarampampam/3proxy-docker.svg?style=flat-square&maxAge=180
|
||||
[badge_commits_since_release]:https://img.shields.io/github/commits-since/tarampampam/3proxy-docker/latest.svg?style=flat-square&maxAge=180
|
||||
[badge_issues]:https://img.shields.io/github/issues/tarampampam/3proxy-docker.svg?style=flat-square&maxAge=180
|
||||
@@ -92,7 +98,7 @@ WTFPL. Use anywhere for your pleasure.
|
||||
[link_changes_log]:https://github.com/tarampampam/3proxy-docker/blob/master/CHANGELOG.md
|
||||
[link_issues]:https://github.com/tarampampam/3proxy-docker/issues
|
||||
[link_pulls]:https://github.com/tarampampam/3proxy-docker/pulls
|
||||
[link_build_status]:https://travis-ci.org/tarampampam/3proxy-docker
|
||||
[link_build_status]:https://github.com/tarampampam/3proxy-docker/actions
|
||||
[link_create_issue]:https://github.com/tarampampam/3proxy-docker/issues/new
|
||||
[link_license]:https://github.com/tarampampam/3proxy-docker/blob/master/LICENSE
|
||||
[link_docker_tags]:https://hub.docker.com/r/tarampampam/3proxy/tags
|
||||
|
||||
@@ -1,62 +1,12 @@
|
||||
#!/usr/bin/env sh
|
||||
#!/bin/sh
|
||||
set -e
|
||||
|
||||
AUTH_REQUIRED=${AUTH_REQUIRED:-false} # true|false
|
||||
PROXY_LOGIN=${PROXY_LOGIN:-} # string
|
||||
PROXY_PASSWORD=${PROXY_PASSWORD:-} # string
|
||||
|
||||
if [ "$AUTH_REQUIRED" = "true" ]; then
|
||||
if [ -z "$PROXY_LOGIN" ]; then
|
||||
(>&2 echo "$0: environment variable 'PROXY_LOGIN' is not specified!"); exit 1;
|
||||
fi;
|
||||
|
||||
if [ -z "$PROXY_PASSWORD" ]; then
|
||||
(>&2 echo "$0: environment variable 'PROXY_PASSWORD' is not specified!"); exit 1;
|
||||
fi;
|
||||
|
||||
if [ -n "$PROXY_LOGIN" ] && [ -n "$PROXY_PASSWORD" ]; then
|
||||
echo "$0: setup '${PROXY_LOGIN}:${PROXY_PASSWORD}' as proxy user";
|
||||
echo "${PROXY_LOGIN}:CL:${PROXY_PASSWORD}" > /etc/3proxy/passwd
|
||||
sed -i "s~#AUTH_SETTINGS~users ${PROXY_LOGIN}:CL:${PROXY_PASSWORD}\nauth strong\nallow ${PROXY_LOGIN}~" /etc/3proxy/3proxy.cfg
|
||||
fi;
|
||||
|
||||
echo "$0: rewrite configuration file";
|
||||
cat << \EOF > /etc/3proxy/3proxy.cfg
|
||||
#!/usr/bin/3proxy
|
||||
config /etc/3proxy/3proxy.cfg
|
||||
|
||||
# you may use system to execute some external command if proxy starts
|
||||
system "echo `which 3proxy`': Starting 3proxy'"
|
||||
|
||||
# We can configure nservers to avoid unsafe gethostbyname() usage
|
||||
nserver 1.0.0.1
|
||||
nserver 1.1.1.1
|
||||
nserver 8.8.4.4
|
||||
nserver 8.8.8.8
|
||||
|
||||
# nscache is good to save speed, traffic and bandwidth
|
||||
nscache 65536
|
||||
|
||||
# Here we can change timeout values
|
||||
timeouts 1 5 30 60 180 1800 15 60
|
||||
|
||||
log /dev/stdout
|
||||
logformat "- +_L%t.%. %N.%p %E %U %C:%c %R:%r %O %I %h %T"
|
||||
|
||||
maxconn 1024
|
||||
|
||||
#AUTH_SETTINGS
|
||||
|
||||
proxy -a -p3128
|
||||
socks -a -p1080
|
||||
|
||||
flush
|
||||
EOF
|
||||
|
||||
if [ "$AUTH_REQUIRED" = "true" ]; then
|
||||
echo "$0: setup auth settings in configuration file";
|
||||
|
||||
sed -i "s~#AUTH_SETTINGS~users \$/etc/3proxy/passwd\nauth strong\nallow ${PROXY_LOGIN}~" /etc/3proxy/3proxy.cfg
|
||||
fi;
|
||||
|
||||
cat /etc/3proxy/3proxy.cfg
|
||||
|
||||
exec "$@"
|
||||
|
||||
Reference in New Issue
Block a user