48 Commits

Author SHA1 Message Date
Paramtamtam
770665806e feat: Multiple accounts (#29) 2022-12-08 20:20:33 +04:00
dependabot[bot]
7be7f47fe4 Bump gcc from 12.1.0 to 12.2.0 (#25) 2022-09-01 17:40:35 +00:00
Paramtamtam
fb24456662 Entrypoint script replaced with mustpl (#24) 2022-08-26 17:05:50 +04:00
Paramtamtam
2e9ef61cf8 wip: readme file 2022-08-16 10:23:46 +04:00
Paramtamtam
d332716996 rename variables 2022-08-16 10:19:53 +04:00
Paramtamtam
7200ecad96 dns resolvers changing using environment variables 2022-08-16 10:08:19 +04:00
Paramtamtam
93902a6aef fix 3proxy version in the dockerfile 2022-06-12 13:30:42 +04:00
Paramtamtam
5f29bf16d7 update renovate config 2022-06-12 13:27:19 +04:00
Paramtamtam
1619760057 Update tests.yml 2022-06-12 13:39:28 +05:00
Paramtamtam
ab12170222 update renovate config 2022-06-10 11:59:54 +04:00
renovate[bot]
f28aed423b Update dependency z3APA3A/3proxy to v0.9.4 (#23)
Co-authored-by: Renovate Bot <bot@renovateapp.com>
2022-06-10 12:41:12 +05:00
Paramtamtam
1506af7c6c update renovate config 2022-06-10 11:35:33 +04:00
Paramtamtam
68bef38402 update renovate config 2022-06-10 11:33:31 +04:00
Paramtamtam
e17a4f6856 update renovate config 2022-06-10 11:21:48 +04:00
Paramtamtam
1ae0ac52cf dockerfile fix 2022-06-10 11:06:09 +04:00
Paramtamtam
f82ce4fac2 renovate 2022-06-10 11:04:26 +04:00
dependabot[bot]
30724ceee3 Bump docker/login-action from 1 to 2 (#21) 2022-06-01 17:08:32 +00:00
dependabot[bot]
a057e3fb1f Bump docker/setup-buildx-action from 1 to 2 (#20) 2022-06-01 17:04:52 +00:00
dependabot[bot]
fa2bd9ac44 Bump docker/build-push-action from 2 to 3 (#19) 2022-06-01 17:04:29 +00:00
dependabot[bot]
66c11e684a Bump gcc from 11.3.0 to 12.1.0 (#18) 2022-06-01 17:03:56 +00:00
Paramtamtam
541fac5147 Update release.yml 2022-05-12 17:25:00 +05:00
Paramtamtam
978cd98ff3 Update tests.yml 2022-05-12 17:24:37 +05:00
dependabot[bot]
5591967c35 Bump actions/upload-artifact from 2 to 3 (#16) 2022-05-01 17:24:57 +00:00
dependabot[bot]
f426c0f7e9 Bump gcc from 11.2.0 to 11.3.0 (#15) 2022-05-01 17:24:45 +00:00
dependabot[bot]
c374a6f597 Bump actions/download-artifact from 2 to 3 (#14) 2022-05-01 17:24:32 +00:00
dependabot[bot]
7650a0e75b Bump actions/checkout from 2 to 3 (#13) 2022-04-01 21:06:32 +00:00
dependabot[bot]
9fd0a90c69 Bump actions/labeler from 3 to 4 (#12) 2022-04-01 21:05:59 +00:00
dependabot[bot]
752502d85a Bump busybox from 1.34.0-glibc to 1.34.1-glibc (#11) 2021-11-01 19:09:53 +00:00
Paramtamtam
d72e72e7fc Update release.yml 2021-10-12 12:15:25 +05:00
Paramtamtam
b345e9859a Update dependabot.yml 2021-10-01 16:50:33 +05:00
Paramtamtam
6e5b989498 Docker healthcheck added, CI updated, docker image build optimized (#10) 2021-09-23 19:28:28 +05:00
dependabot[bot]
f62172c9dc Bump busybox from 1.33.1-glibc to 1.34.0-glibc (#9) 2021-09-20 19:00:52 +00:00
dependabot[bot]
078a3d9b79 Bump anchore/scan-action from 2 to 3 (#8) 2021-09-06 17:50:42 +00:00
dependabot[bot]
659fd3d395 Bump gcc from 11.1.0 to 11.2.0 (#7) 2021-08-03 03:50:42 +00:00
Paramtamtam
bf160a071e Update CI 2021-07-20 15:03:19 +05:00
Paramtamtam
93339d5159 Update CHANGELOG.md 2021-07-05 10:34:23 +05:00
Paramtamtam
1ef63988a7 Bump 3proxy version 2021-07-05 10:33:03 +05:00
dependabot[bot]
921fc47ade Bump busybox from 1.32-glibc to 1.33.1-glibc (#6) 2021-05-10 06:52:28 +00:00
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
15 changed files with 291 additions and 174 deletions

View File

@@ -5,8 +5,8 @@ charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 4
indent_size = 2
trim_trailing_whitespace = true
[*.{yml, yaml, sh, conf}]
indent_size = 2
[Dockerfile]
indent_size = 4

View File

@@ -1,21 +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: "weekly"
reviewers:
- "tarampampam"
assignees:
- "tarampampam"
- package-ecosystem: "docker"
directory: "/"
schedule:
interval: "weekly"
reviewers:
- "tarampampam"
assignees:
- "tarampampam"
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
View File

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

7
.github/renovate.json vendored Normal file
View File

@@ -0,0 +1,7 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"github>tarampampam/.github//renovate/default",
":rebaseStalePrs"
]
}

19
.github/workflows/documentation.yml vendored Normal file
View File

@@ -0,0 +1,19 @@
name: documentation
on:
push:
branches: [master, main]
paths: ['README.md']
jobs:
docker-hub-description:
name: Docker Hub Description
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v3
- uses: peter-evans/dockerhub-description@v3 # Action page: <https://github.com/peter-evans/dockerhub-description>
with:
username: ${{ secrets.DOCKER_LOGIN }}
password: ${{ secrets.DOCKER_USER_PASSWORD }}
repository: tarampampam/3proxy

View File

@@ -1,12 +0,0 @@
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

@@ -10,29 +10,33 @@ jobs:
runs-on: ubuntu-20.04
steps:
- name: Check out code
uses: actions/checkout@v2
uses: actions/checkout@v3
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1 # Action page: <https://github.com/docker/setup-buildx-action>
id: buildx
- uses: gacts/github-slug@v1
id: slug
- name: Docker login in default registry
run: echo "${{ secrets.DOCKER_PASSWORD }}" | docker login -u "${{ secrets.DOCKER_LOGIN }}" --password-stdin &> /dev/null
- uses: docker/setup-buildx-action@v2
- 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: Login to default Container Registry
uses: docker/login-action@v2 # Action page: <https://github.com/docker/login-action>
with:
username: ${{ secrets.DOCKER_LOGIN }}
password: ${{ secrets.DOCKER_PASSWORD }}
- 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: Login to GitHub Container Registry
uses: docker/login-action@v2 # Action page: <https://github.com/docker/login-action>
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Build image
run: |
docker buildx build \
--platform ${{ steps.buildx.outputs.platforms }} \
--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" \
--push \
.
- uses: docker/build-push-action@v3 # 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

View File

@@ -2,27 +2,37 @@ 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: {}
concurrency:
group: ${{ github.ref }}
cancel-in-progress: true
jobs: # Docs: <https://git.io/JvxXE>
gitleaks:
name: Gitleaks
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v3
with: {fetch-depth: 0}
- name: Check for GitLeaks
uses: gacts/gitleaks@v1 # Action page: <https://github.com/gacts/gitleaks>
build-image:
name: Build docker image
runs-on: ubuntu-20.04
steps:
- name: Check out code
uses: actions/checkout@v2
uses: actions/checkout@v3
- name: Build docker image
run: docker build -f ./Dockerfile --tag 3proxy:local .
- name: Scan image
uses: anchore/scan-action@v2 # action page: <https://github.com/anchore/scan-action>
uses: anchore/scan-action@v3 # action page: <https://github.com/anchore/scan-action>
with:
image: 3proxy:local
fail-build: true
@@ -32,10 +42,33 @@ jobs: # Docs: <https://git.io/JvxXE>
run: docker save 3proxy:local > ./docker-image.tar
- name: Upload artifact
uses: actions/upload-artifact@v2
uses: actions/upload-artifact@v3
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@v3
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 }})
@@ -46,8 +79,8 @@ jobs: # Docs: <https://git.io/JvxXE>
auth: [yes, no]
needs: [build-image]
steps:
- name: Download builded docker image
uses: actions/download-artifact@v2
- name: Download built docker image
uses: actions/download-artifact@v3
with:
name: docker-image
path: .artifact
@@ -62,7 +95,7 @@ jobs: # Docs: <https://git.io/JvxXE>
- 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
run: docker run --rm -d -p "3128:3128/tcp" -p "1080:1080/tcp" -e "PROXY_LOGIN=evil" -e "PROXY_PASSWORD=live" -e 'EXTRA_ACCOUNTS={"foo":"bar"}' 3proxy:local
- name: Pause
run: sleep 3
@@ -95,6 +128,16 @@ jobs: # Docs: <https://git.io/JvxXE>
--max-time 3 \
https://www.cloudflare.com/robots.txt
- name: Try to use HTTP proxy (with auth, extra user)
if: matrix.auth == 'yes'
run: |
curl -v --fail \
--proxy http://127.0.0.1:3128 \
--proxy-user foo:bar \
--connect-timeout 3 \
--max-time 3 \
https://www.cloudflare.com/robots.txt
- name: Try to use SOCKS proxy (with auth)
if: matrix.auth == 'yes'
run: |

View File

@@ -1,29 +0,0 @@
#!/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

23
3proxy.cfg.json Normal file
View File

@@ -0,0 +1,23 @@
{
"log": {
"output": "/dev/stdout"
},
"name_servers": [
"${PRIMARY_RESOLVER:-1.0.0.1}",
"${SECONDARY_RESOLVER:-8.8.4.4}",
"1.1.1.1",
"9.9.9.9",
"8.8.8.8"
],
"name_servers_cache": 65536,
"max_connections": "${MAX_CONNECTIONS:-1024}",
"auth": {
"login": "${PROXY_LOGIN:-}",
"password": "${PROXY_PASSWORD:-}",
"extra_accounts": ${EXTRA_ACCOUNTS:-{}}
},
"ports": {
"proxy": "${PROXY_PORT:-3128}",
"socks": "${SOCKS_PORT:-1080}"
}
}

33
3proxy.cfg.mustach Normal file
View File

@@ -0,0 +1,33 @@
#!/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 (max 5 servers)
{{#name_servers}}
nserver {{ . }}
{{/name_servers}}
# nscache is good to save speed, traffic and bandwidth
nscache {{ name_servers_cache }}
# 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 {{ log.output }}
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 {{ max_connections }}
{{^auth.login=}}{{^auth.password=}}
users {{ auth.login }}:CL:{{ auth.password }}{{#auth.extra_accounts.*}} {{ * }}:CL:{{ . }}{{/auth.extra_accounts.*}}
auth strong
allow {{ auth.login }}{{#auth.extra_accounts.*}},{{ * }}{{/auth.extra_accounts.*}}
{{/auth.password=}}{{/auth.login=}}
proxy -a -p{{ ports.proxy }}
socks -a -p{{ ports.socks }}
flush

View File

@@ -4,6 +4,57 @@ 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.8.0
### Added
- `EXTRA_ACCOUNTS` environment variable is supported now [#28]
[#28]:https://github.com/tarampampam/3proxy-docker/issues/28
## v1.7.0
### Added
- The following environment variables are supported now: `MAX_CONNECTIONS`, `PROXY_PORT`, `SOCKS_PORT`
### Changed
- Entrypoint script (`bash`) replaced with [`mustpl`](https://github.com/tarampampam/mustpl)
- The result docker image `busybox:1.34.1-glibc` replaced with `busybox:stable-glibc`
### Removed
- Dockerfile healthcheck
## v1.6.0
### Added
- Possibility of changing DNS resolvers using environment variables `PRIMARY_RESOLVER` (primary) and `SECONDARY_RESOLVER` (secondary)
## 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

View File

@@ -1,12 +1,12 @@
# Image page: <https://hub.docker.com/_/alpine>
FROM gcc:9.3 as builder
# Image page: <https://hub.docker.com/_/gcc>
FROM gcc:12.2.0 as builder
# e.g.: `docker build --build-arg "VERSION=0.9.3" .`
ARG VERSION="0.9.3"
# renovate: source=github-tags name=z3APA3A/3proxy
ARG Z3PROXY_VERSION=0.9.4
# Fetch 3proxy sources
RUN set -x \
&& git clone --branch "${VERSION}" https://github.com/z3APA3A/3proxy.git /tmp/3proxy
&& git -c advice.detachedHead=false clone --depth 1 --branch "${Z3PROXY_VERSION}" https://github.com/z3APA3A/3proxy.git /tmp/3proxy
WORKDIR /tmp/3proxy
@@ -34,39 +34,30 @@ RUN set -x \
&& strip ./bin/SSLPlugin.ld.so
# Prepare filesystem for 3proxy running
FROM busybox:1.32-glibc as buffer
FROM busybox:stable-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 a directory for the future root filesystem
WORKDIR /tmp/rootfs
# Create unprivileged user
# prepare the root filesystem
RUN set -x \
&& adduser \
--disabled-password \
--gecos "" \
--home /nonexistent \
--shell /sbin/nologin \
--no-create-home \
--uid 10001 \
3proxy
&& 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
# 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 --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 --from=ghcr.io/tarampampam/mustpl:0.1.0 /bin/mustpl ./bin/mustpl
COPY 3proxy.cfg.json ./etc/3proxy/3proxy.cfg.json
COPY 3proxy.cfg.mustach ./etc/3proxy/3proxy.cfg.mustach
# Copy our config and entrypoint script
COPY 3proxy.cfg /etc/3proxy/3proxy.cfg
COPY docker-entrypoint.sh /docker-entrypoint.sh
RUN chown -R 10001:10001 ./etc/3proxy
# Split all buffered layers into one
FROM scratch
# Merge into a single layer
FROM busybox:stable-glibc
LABEL \
org.opencontainers.image.title="3proxy" \
@@ -77,11 +68,17 @@ LABEL \
org.opencontainers.image.licenses="WTFPL"
# Import from builder
COPY --from=buffer / /
COPY --from=buffer /tmp/rootfs /
# Use an unprivileged user
USER 3proxy:3proxy
ENTRYPOINT ["/docker-entrypoint.sh"]
ENTRYPOINT [ \
"/bin/mustpl", \
"-f", "/etc/3proxy/3proxy.cfg.json", \
"-o", "/etc/3proxy/3proxy.cfg", \
"/etc/3proxy/3proxy.cfg.mustach", \
"--", "/bin/dumb-init" \
]
CMD ["/bin/3proxy", "/etc/3proxy/3proxy.cfg"]

View File

@@ -12,29 +12,38 @@
## 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].
TCP ports:
Port number | Description
----------- | -----------
`3128` | [HTTP proxy](https://3proxy.org/doc/man8/proxy.8.html)
`1080` | [SOCKS proxy](https://3proxy.org/doc/man8/socks.8.html)
| Port number | Description |
|-------------|---------------------------------------------------------|
| `3128` | [HTTP proxy](https://3proxy.org/doc/man8/proxy.8.html) |
| `1080` | [SOCKS proxy](https://3proxy.org/doc/man8/socks.8.html) |
## Supported tags
[![image stats](https://dockeri.co/image/tarampampam/3proxy)][link_docker_tags]
| Registry | Image |
|----------------------------------------|------------------------------|
| [GitHub Container Registry][link_ghcr] | `ghcr.io/tarampampam/3proxy` |
| [Docker Hub][link_docker_hub] | `tarampampam/3proxy` |
All supported image tags [can be found here][link_docker_tags].
## Supported environment variables
Variable name | Description | Example
---------------- | ----------------------------------------- | ---------------
`PROXY_LOGIN` | Authorization login | `username`
`PROXY_PASSWORD` | Authorization password | `password`
| Variable name | Description | Example |
|----------------------|-----------------------------------------------------------|-----------------------------------|
| `PROXY_LOGIN` | Authorization login (empty by default) | `username` |
| `PROXY_PASSWORD` | Authorization password (empty by default) | `password` |
| `EXTRA_ACCOUNTS` | Additional proxy users | `{"evil":"live", "guest":"pass"}` |
| `PRIMARY_RESOLVER` | Primary nameserver (dns resolver; `1.0.0.1` by default) | `8.8.8.8:5353/tcp` |
| `SECONDARY_RESOLVER` | Secondary nameserver (dns resolver; `8.8.4.4` by default) | `2001:4860:4860::8844` |
| `MAX_CONNECTIONS` | Maximal connections count (`1024` by default) | `2056` |
| `PROXY_PORT` | HTTP proxy port number (`3128` by default) | `8080` |
| `SOCKS_PORT` | SOCKS proxy port number (`1080` by default) | `8888` |
## How can I use this?
@@ -47,7 +56,7 @@ $ docker run --rm -d \
tarampampam/3proxy:latest
```
Or with auth settings:
Or with auth & resolver settings:
```bash
$ docker run --rm -d \
@@ -55,9 +64,18 @@ $ docker run --rm -d \
-p "1080:1080/tcp" \
-e "PROXY_LOGIN=evil" \
-e "PROXY_PASSWORD=live" \
-e "PRIMARY_RESOLVER=2001:4860:4860::8888" \
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]
@@ -70,7 +88,7 @@ Changes log can be [found here][link_changes_log].
[![Issues][badge_issues]][link_issues]
[![Issues][badge_pulls]][link_pulls]
If you will find any package errors, please, [make an issue][link_create_issue] in current repository.
If you find any errors, please, [make an issue][link_create_issue] in current repository.
## License
@@ -95,4 +113,5 @@ WTFPL. Use anywhere for your pleasure.
[link_license]:https://github.com/tarampampam/3proxy-docker/blob/master/LICENSE
[link_docker_tags]:https://hub.docker.com/r/tarampampam/3proxy/tags
[link_docker_hub]:https://hub.docker.com/r/tarampampam/3proxy/
[link_ghcr]:https://github.com/tarampampam/3proxy-docker/pkgs/container/3proxy
[link_3proxy]:https://github.com/z3APA3A/3proxy

View File

@@ -1,12 +0,0 @@
#!/bin/sh
set -e
PROXY_LOGIN=${PROXY_LOGIN:-} # string
PROXY_PASSWORD=${PROXY_PASSWORD:-} # string
if [ -n "$PROXY_LOGIN" ] && [ -n "$PROXY_PASSWORD" ]; then
echo "$0: setup '${PROXY_LOGIN}:${PROXY_PASSWORD}' as proxy user";
sed -i "s~#AUTH_SETTINGS~users ${PROXY_LOGIN}:CL:${PROXY_PASSWORD}\nauth strong\nallow ${PROXY_LOGIN}~" /etc/3proxy/3proxy.cfg
fi;
exec "$@"