add to github

Author: pcmehrdad

.dockerignore

@@ -0,0 +1,35 @@
+# Git
+.git
+.gitignore
+.github
+
+# IDE
+.idea
+.vscode
+
+# Build
+./api-proxy
+
+# Docker
+docker-compose.yml
+
+# Config
+config.json
+
+# Env
+.env
+
+# README
+README.md
+
+# LICENSE
+LICENSE
+
+# .github
+.github
+
+# .gitignore
+.gitignore
+
+# .dockerignore
+.dockerignore

.env.example

@@ -0,0 +1,5 @@
+COMPOSE_PROJECT_NAME=api-proxy
+UID=1000
+GID=1000
+
+DC_HTTP_PORT=3003

.github/workflows/build.yml

@@ -0,0 +1,49 @@
+name: Build and Push Docker image to GHCR
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    # runs-on: [self-hosted, personal,ubuntu-latest]
+    permissions:
+      packages: write
+      contents: read
+
+    steps:
+      # Step 1: Checkout the repository
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Step 2: Log in to GitHub Container Registry (GHCR)
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Step 3: Define dynamic image name and tag based on repo name
+      - name: Set dynamic image name and tag
+        id: vars
+        run: |
+          REPO_NAME=$(basename "${{ github.repository }}") # Extract the repository name
+          IMAGE_NAME="ghcr.io/${{ github.repository_owner }}/$REPO_NAME"
+          GIT_SHA="${{ github.sha }}"
+          TAG="main-${GIT_SHA:0:7}" # Example: Use first 7 characters of commit SHA
+          echo "IMAGE_NAME=$IMAGE_NAME" >> $GITHUB_ENV
+          echo "IMAGE_TAG=$TAG" >> $GITHUB_ENV
+
+      # Step 4: Build the Docker image with both tags
+      - name: Build Docker image
+        run: |
+          docker build -t $IMAGE_NAME:$IMAGE_TAG -t $IMAGE_NAME:latest .
+
+      # Step 5: Push both Docker image tags to GHCR
+      - name: Push Docker image to GHCR
+        run: |
+          docker push $IMAGE_NAME:$IMAGE_TAG
+          docker push $IMAGE_NAME:latest

.gitignore

@@ -0,0 +1,7 @@
+.env
+.idea/
+.vscode/
+
+# Env
+.env
+config.json

Dockerfile

@@ -0,0 +1,43 @@
+FROM golang:1.22.5-alpine AS builder
+
+# Install required system packages and update certificates
+RUN apk update && \
+    apk upgrade && \
+    apk add --no-cache ca-certificates && \
+    update-ca-certificates
+
+# Add Maintainer Info to the Image
+LABEL maintainer="Mehrdad Amini <pcmehrdad@gmail.com>"
+LABEL description="API Proxy Service"
+
+# Set the Current Working Directory inside the container
+WORKDIR /build/api-proxy
+
+# Copy go mod files
+COPY go.mod go.sum ./
+
+# Download all dependencies
+RUN go mod download
+
+# Copy the source code
+COPY main.go .
+
+# Build the binary with optimizations
+RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o api-proxy .
+
+# Start a new stage for final image
+#FROM scratch
+FROM gcr.io/distroless/static-debian11
+
+WORKDIR /app
+
+# Copy binary and configuration
+COPY --from=builder /build/api-proxy/api-proxy .
+COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
+COPY config.json.example ./config.json
+
+# Expose port
+EXPOSE 3000
+
+# Command to run
+CMD ["./api-proxy"]

README.md

@@ -0,0 +1,130 @@
+# API Proxy Service
+
+A lightweight API proxy service written in Go that supports multiple endpoints, rate limiting, and proxy rotation.
+
+## Features
+
+- Multiple site/endpoint support
+- API key rotation
+- Rate limiting
+- SOCKS5 and HTTP proxy support
+- Detailed logging system
+- Docker support
+- CORS enabled
+- Customizable base path
+
+## Quick Start
+
+### Using Docker Compose
+
+1. Clone the repository
+2. Configure your settings:
+   - Copy `.env.example` to `.env`
+   - Copy `config.json.example` to `config.json`
+3. Run the service:
+   ```bash
+   docker-compose up -d
+   ```
+
+### Manual Setup
+
+1. Install Go 1.22 or later
+2. Configure your settings in `config.json`
+3. Run the service:
+   ```bash
+   go run main.go
+   ```
+
+## Configuration
+
+### Environment Variables
+
+- `PORT`: Server port (default: 3003)
+- `LOG_LEVEL`: Logging level (debug, info, warn, error)
+- `COMPOSE_PROJECT_NAME`: Docker compose project name
+- `UID`: User ID for Docker
+- `GID`: Group ID for Docker
+- `DC_HTTP_PORT`: Docker container HTTP port
+
+### Config.json Structure
+
+```json
+{
+  "GLOBAL_SETTINGS": {
+    "DIRECT_ACCESS": false,
+    "BASE_PATH": "/proxy",
+    "PROXIES": [
+      "socks5://user:pass@host:port",
+      "http://user:pass@host:port"
+    ]
+  },
+  "SITES": {
+    "site-name": {
+      "domain": "https://api.example.com",
+      "PROXY_TYPE": "header|query|path|direct",
+      "KEY": "X-Api-Key",
+      "VALUES": [
+        {"key1": 3},
+        {"key2": 3}
+      ]
+    }
+  }
+}
+```
+
+#### Configuration Fields
+
+- `BASE_PATH`: Base URL path for all proxy endpoints (default: "/proxy")
+- `PROXY_TYPE`: How the proxy should handle requests
+  - Supported types: `header`, `query`, `path`, or `direct`
+  - For `direct` type, `VALUES` should contain full target URLs
+- `KEY`: API key header name or query parameter name
+- `VALUES`: API keys with their rate limits
+
+## Usage
+
+### Making Requests
+
+The proxy service accepts requests in the following format:
+
+```
+http://localhost:{PORT}{BASE_PATH}/{site-name}/{endpoint}
+```
+
+Examples:
+```bash
+# Default configuration
+curl http://localhost:3003/proxy/myip4/
+
+# Custom base path configuration
+curl http://localhost:3003/api/myip4/
+```
+
+### Logs
+
+Logs are written to both console and `proxy.log` file. View Docker container logs using:
+
+```bash
+docker-compose logs api-proxy
+```
+
+## Development
+
+### Prerequisites
+
+- Go 1.22+
+- Docker and Docker Compose (for containerized deployment)
+
+### Building
+
+```bash
+# Build locally
+go build -o api-proxy
+
+# Build Docker image
+docker-compose build
+```
+
+## License
+
+MIT License