Compare commits
22 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4f60889624 | ||
|
|
298e65c0b0 | ||
|
|
f3596b86ea | ||
|
|
513a467b11 | ||
|
|
7b2e6ac6da | ||
|
|
a44fde46e6 | ||
|
|
283a52abe6 | ||
|
|
63731eca8c | ||
|
|
7dd058d8aa | ||
|
|
7490d4dce8 | ||
|
|
6d215e502c | ||
|
|
d8f9aa2024 | ||
|
|
98a8747a3c | ||
|
|
1febd8abe7 | ||
|
|
e5e9f108eb | ||
|
|
7b6870751c | ||
|
|
a1a23544ac | ||
|
|
713f37e79c | ||
|
|
597d6e28ec | ||
|
|
40678de18c | ||
|
|
770665806e | ||
|
|
7be7f47fe4 |
2
.github/dependabot.yml
vendored
2
.github/dependabot.yml
vendored
@@ -6,11 +6,9 @@ updates:
|
||||
- package-ecosystem: github-actions
|
||||
directory: /
|
||||
schedule: {interval: monthly}
|
||||
reviewers: [tarampampam]
|
||||
assignees: [tarampampam]
|
||||
|
||||
- package-ecosystem: docker
|
||||
directory: /
|
||||
schedule: {interval: monthly}
|
||||
reviewers: [tarampampam]
|
||||
assignees: [tarampampam]
|
||||
|
||||
25
.github/workflows/dependabot.yml
vendored
Normal file
25
.github/workflows/dependabot.yml
vendored
Normal file
@@ -0,0 +1,25 @@
|
||||
name: dependabot
|
||||
|
||||
on:
|
||||
pull_request: {}
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
|
||||
jobs:
|
||||
dependabot: # https://tinyurl.com/e69djmen
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ github.actor == 'dependabot[bot]' }}
|
||||
steps:
|
||||
- uses: dependabot/fetch-metadata@v1
|
||||
id: metadata
|
||||
with: {github-token: "${{ secrets.GITHUB_TOKEN }}"}
|
||||
|
||||
- name: Enable auto-merge for Dependabot PRs
|
||||
if: ${{ contains(fromJSON('["version-update:semver-minor", "version-update:semver-patch"]'), steps.metadata.outputs.update-type) }}
|
||||
run: gh pr merge --auto --merge "$PR_URL"
|
||||
continue-on-error: true
|
||||
env:
|
||||
PR_URL: ${{ github.event.pull_request.html_url }}
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
4
.github/workflows/documentation.yml
vendored
4
.github/workflows/documentation.yml
vendored
@@ -10,9 +10,9 @@ jobs:
|
||||
name: Docker Hub Description
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: peter-evans/dockerhub-description@v3 # Action page: <https://github.com/peter-evans/dockerhub-description>
|
||||
- uses: peter-evans/dockerhub-description@v4 # Action page: <https://github.com/peter-evans/dockerhub-description>
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_LOGIN }}
|
||||
password: ${{ secrets.DOCKER_USER_PASSWORD }}
|
||||
|
||||
20
.github/workflows/release.yml
vendored
20
.github/workflows/release.yml
vendored
@@ -9,32 +9,30 @@ jobs:
|
||||
name: Build docker image
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: gacts/github-slug@v1
|
||||
id: slug
|
||||
- {uses: gacts/github-slug@v1, id: slug}
|
||||
|
||||
- uses: docker/setup-buildx-action@v2
|
||||
- uses: docker/setup-qemu-action@v3
|
||||
|
||||
- name: Login to default Container Registry
|
||||
uses: docker/login-action@v2 # Action page: <https://github.com/docker/login-action>
|
||||
- uses: docker/setup-buildx-action@v3
|
||||
|
||||
- uses: docker/login-action@v3 # Action page: <https://github.com/docker/login-action>
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_LOGIN }}
|
||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||
|
||||
- name: Login to GitHub Container Registry
|
||||
uses: docker/login-action@v2 # Action page: <https://github.com/docker/login-action>
|
||||
- uses: docker/login-action@v3 # Action page: <https://github.com/docker/login-action>
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.actor }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- uses: docker/build-push-action@v3 # Action page: <https://github.com/docker/build-push-action>
|
||||
- uses: docker/build-push-action@v5 # Action page: <https://github.com/docker/build-push-action>
|
||||
with:
|
||||
context: .
|
||||
file: Dockerfile
|
||||
push: true
|
||||
platforms: linux/amd64,linux/arm64
|
||||
tags: |
|
||||
tarampampam/3proxy:${{ steps.slug.outputs.version-semantic }}
|
||||
tarampampam/3proxy:latest
|
||||
|
||||
55
.github/workflows/tests.yml
vendored
55
.github/workflows/tests.yml
vendored
@@ -15,61 +15,30 @@ jobs: # Docs: <https://git.io/JvxXE>
|
||||
name: Gitleaks
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
with: {fetch-depth: 0}
|
||||
|
||||
- name: Check for GitLeaks
|
||||
uses: gacts/gitleaks@v1 # Action page: <https://github.com/gacts/gitleaks>
|
||||
- uses: gacts/gitleaks@v1
|
||||
|
||||
build-image:
|
||||
name: Build docker image
|
||||
runs-on: ubuntu-20.04
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Build docker image
|
||||
run: docker build -f ./Dockerfile --tag 3proxy: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@v3
|
||||
uses: actions/upload-artifact@v4
|
||||
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 }})
|
||||
runs-on: ubuntu-20.04
|
||||
@@ -79,8 +48,8 @@ jobs: # Docs: <https://git.io/JvxXE>
|
||||
auth: [yes, no]
|
||||
needs: [build-image]
|
||||
steps:
|
||||
- name: Download builded docker image
|
||||
uses: actions/download-artifact@v3
|
||||
- name: Download built docker image
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: docker-image
|
||||
path: .artifact
|
||||
@@ -95,7 +64,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
|
||||
@@ -128,6 +97,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: |
|
||||
|
||||
@@ -13,10 +13,12 @@
|
||||
"max_connections": "${MAX_CONNECTIONS:-1024}",
|
||||
"auth": {
|
||||
"login": "${PROXY_LOGIN:-}",
|
||||
"password": "${PROXY_PASSWORD:-}"
|
||||
"password": "${PROXY_PASSWORD:-}",
|
||||
"extra_accounts": ${EXTRA_ACCOUNTS:-{}}
|
||||
},
|
||||
"ports": {
|
||||
"proxy": "${PROXY_PORT:-3128}",
|
||||
"socks": "${SOCKS_PORT:-1080}"
|
||||
}
|
||||
},
|
||||
"extra_config": "${EXTRA_CONFIG}"
|
||||
}
|
||||
|
||||
@@ -22,12 +22,17 @@ logformat "-\""+_G{""time_unix"":%t, ""proxy"":{""type:"":""%N"", ""port"":%p},
|
||||
maxconn {{ max_connections }}
|
||||
|
||||
{{^auth.login=}}{{^auth.password=}}
|
||||
users {{ auth.login }}:CL:{{ auth.password }}
|
||||
users {{ auth.login }}:CL:{{ auth.password }}{{#auth.extra_accounts.*}} {{ * }}:CL:{{ . }}{{/auth.extra_accounts.*}}
|
||||
auth strong
|
||||
allow {{ auth.login }}
|
||||
allow {{ auth.login }}{{#auth.extra_accounts.*}},{{ * }}{{/auth.extra_accounts.*}}
|
||||
{{/auth.password=}}{{/auth.login=}}
|
||||
|
||||
proxy -a -p{{ ports.proxy }}
|
||||
socks -a -p{{ ports.socks }}
|
||||
|
||||
flush
|
||||
flush{{^extra_config=}}
|
||||
|
||||
# Additional configuration
|
||||
{{extra_config}}
|
||||
{{/extra_config=}}
|
||||
|
||||
|
||||
40
CHANGELOG.md
40
CHANGELOG.md
@@ -4,6 +4,46 @@ 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.9.0
|
||||
|
||||
### Added
|
||||
|
||||
- `EXTRA_CONFIG` environment variable is supported now [#47]
|
||||
|
||||
[#47]:https://github.com/tarampampam/3proxy-docker/issues/47
|
||||
|
||||
## v1.8.3
|
||||
|
||||
### Fixed
|
||||
|
||||
- Missing port definitions when `EXTRA_ACCOUNTS` is set
|
||||
|
||||
## v1.8.2
|
||||
|
||||
### Removed
|
||||
|
||||
- `ppc64le` architecture support
|
||||
|
||||
## v1.8.1
|
||||
|
||||
### Added
|
||||
|
||||
- Multi-arch image support (plus `arm64` and `ppc64le`) [#31]
|
||||
|
||||
### Fixed
|
||||
|
||||
- Error page colors now depend on the theme, and the text is centered [#31]
|
||||
|
||||
[#31]:https://github.com/tarampampam/3proxy-docker/pull/31
|
||||
|
||||
## 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
|
||||
|
||||
25
Dockerfile
25
Dockerfile
@@ -1,5 +1,5 @@
|
||||
# Image page: <https://hub.docker.com/_/gcc>
|
||||
FROM gcc:12.1.0 as builder
|
||||
FROM gcc:13.2.0 as builder
|
||||
|
||||
# renovate: source=github-tags name=z3APA3A/3proxy
|
||||
ARG Z3PROXY_VERSION=0.9.4
|
||||
@@ -14,10 +14,12 @@ WORKDIR /tmp/3proxy
|
||||
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 \
|
||||
&& sed -i 's~\(<\/head>\)~<style>:root{--color-bg-primary:#fff;--color-text-primary:#131313;--color-text-secondary:#232323}\
|
||||
@media (prefers-color-scheme: dark){:root{--color-bg-primary:#212121;--color-text-primary:#fafafa;--color-text-secondary:#bbb}}\
|
||||
html,body{height:100%;font-family:sans-serif;background-color:var(--color-bg-primary);color:var(--color-text-primary);margin:0;\
|
||||
padding:0;text-align:center}body{align-items:center;display:flex;justify-content:center;flex-direction:column;height:100vh}\
|
||||
h1,h2{margin-bottom:0;font-size:2.5em}h2::before{content:'"'"'Proxy error'"'"';display:block;font-size:.4em;\
|
||||
color:var(--color-text-secondary);font-weight:100}h3,p{color:var(--color-text-secondary)}</style>\1~' ./src/proxy.c \
|
||||
&& cat ./src/proxy.c | grep '</head>'
|
||||
|
||||
# And compile
|
||||
@@ -34,7 +36,7 @@ RUN set -x \
|
||||
&& strip ./bin/SSLPlugin.ld.so
|
||||
|
||||
# Prepare filesystem for 3proxy running
|
||||
FROM busybox:stable-glibc as buffer
|
||||
FROM alpine:latest as buffer
|
||||
|
||||
# create a directory for the future root filesystem
|
||||
WORKDIR /tmp/rootfs
|
||||
@@ -44,13 +46,16 @@ 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
|
||||
&& apk add --no-cache --virtual .build-deps curl ca-certificates \
|
||||
&& update-ca-certificates \
|
||||
&& curl -SsL -o ./bin/dumb-init "https://github.com/Yelp/dumb-init/releases/download/v1.2.5/dumb-init_1.2.5_$(arch)" \
|
||||
&& chmod +x ./bin/dumb-init \
|
||||
&& apk del .build-deps
|
||||
|
||||
COPY --from=builder /lib/x86_64-linux-gnu/libdl.so.* ./lib/
|
||||
COPY --from=builder /lib/*-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 --from=ghcr.io/tarampampam/mustpl:0.1.1 /bin/mustpl ./bin/mustpl
|
||||
COPY 3proxy.cfg.json ./etc/3proxy/3proxy.cfg.json
|
||||
COPY 3proxy.cfg.mustach ./etc/3proxy/3proxy.cfg.mustach
|
||||
|
||||
|
||||
39
README.md
39
README.md
@@ -32,17 +32,30 @@ TCP ports:
|
||||
|
||||
All supported image tags [can be found here][link_docker_tags].
|
||||
|
||||
Since v1.8.2 architecture `arm64` (and `amd64` of course) is supported:
|
||||
|
||||
```shell
|
||||
$ docker run --rm mplatform/mquery ghcr.io/tarampampam/3proxy:1.8.2
|
||||
Image: ghcr.io/tarampampam/3proxy:1.8.2
|
||||
* Manifest List: Yes (Image type: application/vnd.docker.distribution.manifest.list.v2+json)
|
||||
* Supported platforms:
|
||||
- linux/amd64
|
||||
- linux/arm64
|
||||
```
|
||||
|
||||
## Supported environment variables
|
||||
|
||||
| Variable name | Description | Example |
|
||||
|----------------------|-----------------------------------------------------------|------------------------|
|
||||
| `PROXY_LOGIN` | Authorization login (empty by default) | `username` |
|
||||
| `PROXY_PASSWORD` | Authorization password (empty by default) | `password` |
|
||||
| `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` |
|
||||
| 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` |
|
||||
| `EXTRA_CONFIG` | Additional 3proxy configuration (will be added to the **end** of the config file) | `log /dev/stdout` |
|
||||
|
||||
## How can I use this?
|
||||
|
||||
@@ -52,7 +65,7 @@ For example:
|
||||
$ docker run --rm -d \
|
||||
-p "3128:3128/tcp" \
|
||||
-p "1080:1080/tcp" \
|
||||
tarampampam/3proxy:latest
|
||||
ghcr.io/tarampampam/3proxy:latest
|
||||
```
|
||||
|
||||
Or with auth & resolver settings:
|
||||
@@ -64,7 +77,7 @@ $ docker run --rm -d \
|
||||
-e "PROXY_LOGIN=evil" \
|
||||
-e "PROXY_PASSWORD=live" \
|
||||
-e "PRIMARY_RESOLVER=2001:4860:4860::8888" \
|
||||
tarampampam/3proxy:latest
|
||||
ghcr.io/tarampampam/3proxy:latest
|
||||
```
|
||||
|
||||
## Releasing
|
||||
@@ -93,8 +106,8 @@ If you find any errors, please, [make an issue][link_create_issue] in current re
|
||||
|
||||
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?logo=github&label=release
|
||||
[badge_build_status]:https://img.shields.io/github/actions/workflow/status/tarampampam/3proxy-docker/tests.yml?branch=master&logo=github&label=build
|
||||
[badge_release_status]:https://img.shields.io/github/actions/workflow/status/tarampampam/3proxy-docker/release.yml?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
|
||||
|
||||
Reference in New Issue
Block a user