federicofantini · Apr 30, 2025 · May 2, 2025 · May 2, 2025 · May 2, 2025 · May 2, 2025
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,12 +2,15 @@ name: CI
 
 on:
   push:
+    branches:
+      - main
+      - develop
   pull_request:
 
 jobs:
   PHPUnit:
     name: PHPUnit (PHP ${{ matrix.php }})
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         php:
@@ -20,7 +23,7 @@ jobs:
           - 5.5
           - 5.4
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,63 @@
+name: RELEASE
+
+on:
+  push:
+    tags: [ 'v*.*.*' ]
+
+
+jobs:
+  healthcheck:
+    runs-on: ubuntu-latest
+    services:
+      docker:
+        image: docker
+        options: --privileged
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Compose
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y docker-compose
+
+      - name: Launch Docker Compose
+        working-directory: .
+        run: |
+          docker-compose up -d
+          echo "Waiting healthcheck..."
+          sleep 20
+          docker-compose ps
+          for container_id in $(docker-compose ps -q); do
+            status=$(docker inspect --format='{{json .State.Health.Status}}' "$container_id")
+            echo "Container $container_id health status: $status"
+            if [ "$status" != "\"healthy\"" ]; then
+              echo "ERROR: Container $container_id is not healthy"
+              exit 1
+            fi
+          done
+
+  push-image:
+    needs: healthcheck
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Log in to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v6
+        with:
+          context: ./
+          file: ./docker/Dockerfile
+          push: true
+          tags: |
+            ${{ secrets.DOCKERHUB_USERNAME }}/leproxy:${{ github.ref_name }}
+            ${{ secrets.DOCKERHUB_USERNAME }}/leproxy:latest
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 /vendor/
 /leproxy-*.php
+.idea
diff --git a/README.md b/README.md
@@ -32,6 +32,8 @@ accepting both common HTTP and SOCKS proxy protocols on a single listening port.
 
 ## Install
 
+### PHP
+
 LeProxy requires only PHP.
 *PHP 7+ is highly recommended*, but it runs on any system that uses PHP 5.4+ or
 HHVM.
@@ -60,6 +62,9 @@ You did it!! Really simple, huh?
   If you're interested in the more technical details of this file, you may want
   to check out the [development instructions](#development) below.
 
+### Docker
+To start the project, just give the command `docker compose up`. Instead, to configure new listening services, just customize the `docker-compose.yml` file following the options supported in the documentation.
+
 ## Usage
 
 Once [installed](#install), you can start LeProxy by simply running:

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,60 @@
+x-defaults:
+  service: &service-defaults
+    network_mode: host
+    image: leproxy
+    build:
+      context: .
+      dockerfile: docker/Dockerfile
+    command: sh -c 'php leproxy.php "$${LISTENING}"'
+    healthcheck:
+      test: ["CMD", "bash", "/app/docker/healthcheck.sh"]
+      interval: 10s
+      timeout: 3s
+      retries: 5
+
+services:
+  leproxy-ipv4-unprotected:
+    <<: *service-defaults
+    container_name: leproxy-ipv4-unprotected
+    expose:
+      - 1080
+    volumes:
+      - logs-leproxy-ipv4-unprotected:/var/log
+    environment:
+      LISTENING: "0.0.0.0:1080"
+
+  leproxy-ipv4-protected:
+    <<: *service-defaults
+    container_name: leproxy-ipv4-protected
+    expose:
+      - 1081
+    volumes:
+      - logs-leproxy-ipv4-protected:/var/log
+    environment:
+      LISTENING: "username:password@0.0.0.0:1081"
+
+  leproxy-ipv6-unprotected:
+    <<: *service-defaults
+    container_name: leproxy-ipv6-unprotected
+    expose:
+      - 1082
+    volumes:
+      - logs-leproxy-ipv6-unprotected:/var/log
+    environment:
+      LISTENING: "[::]:1082"
+
+  leproxy-ipv6-protected:
+    <<: *service-defaults
+    container_name: leproxy-ipv6-protected
+    expose:
+      - 1083
+    volumes:
+      - logs-leproxy-ipv6-protected:/var/log
+    environment:
+      LISTENING: "username:password@[::]:1083"
+
+volumes:
+  logs-leproxy-ipv4-unprotected:
+  logs-leproxy-ipv4-protected:
+  logs-leproxy-ipv6-unprotected:
+  logs-leproxy-ipv6-protected:
diff --git a/docker/Dockerfile b/docker/Dockerfile
@@ -0,0 +1,19 @@
+FROM php:7.4.33-zts-alpine
+
+# apt dependencies
+RUN apk add --no-cache --upgrade bash shadow curl zip unzip git libzip-dev net-tools
+
+# install php extensions provided by docker image
+RUN docker-php-ext-install zip sockets
+
+# install composer
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+
+# composer need to run as user
+RUN addgroup -S appgroup && adduser -S appuser -G appgroup -s $(which bash)
+USER appuser
+WORKDIR /app
+COPY . /app
+
+# application install
+RUN composer install --no-dev --optimize-autoloader && composer clear-cache
diff --git a/docker/healthcheck.sh b/docker/healthcheck.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+
+PORT="${LISTENING##*:}"
+
+netstat -an | grep ":$PORT" > /dev/null
+if [ $? -ne 0 ]; then
+  echo "Port $PORT not listening"
+  exit 1
+fi
+
+exit 0