From 3100015157e3f7bbfa34f3f78083634197c97046 Mon Sep 17 00:00:00 2001
From: thuanle <thuanle@hcmut.edu.vn>
Date: Fri, 11 Jul 2025 12:10:47 +0700
Subject: [PATCH] Add README.md for Privoxy Docker setup

---
 README.md          | 52 ++++++++++++++++++++++++++++++++++++++++++++++
 docker-compose.yml |  8 -------
 2 files changed, 52 insertions(+), 8 deletions(-)
 create mode 100644 README.md
 delete mode 100644 docker-compose.yml

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..da6292d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# Privoxy Docker
+
+Dự án này cung cấp một Docker image cho Privoxy, có thể triển khai dễ dàng bằng Docker Compose.
+
+## Nội dung `docker-compose.yml`
+
+```yaml
+services:
+  privoxy:
+    image: git.thuanle.me/public/privoxy-docker:latest
+    container_name: privoxy
+    ports:
+      - "8118:8118"
+    volumes:
+      - ./privoxy:/etc/privoxy
+    restart: unless-stopped
+    labels:
+      - "com.centurylinklabs.watchtower.enable=true" # Cho phép Watchtower tự động cập nhật container này
+```
+
+## Hướng dẫn cấu hình
+
+1. **Tạo thư mục cấu hình:**
+   
+   Tạo thư mục `privoxy` trong cùng thư mục với file `docker-compose.yml` để lưu cấu hình tùy chỉnh của Privoxy.
+
+   ```sh
+   mkdir -p privoxy
+   ```
+
+2. **Chỉnh sửa cấu hình Privoxy:**
+   
+   - Copy file cấu hình mẫu từ container (nếu cần):
+     ```sh
+     docker cp privoxy:/etc/privoxy/config ./privoxy/config
+     ```
+   - Hoặc tự tạo file `config` trong thư mục `privoxy`.
+
+3. **Chạy dịch vụ:**
+   
+   ```sh
+   docker-compose up -d
+   ```
+
+4. **Truy cập proxy:**
+   
+   - Proxy sẽ lắng nghe tại `localhost:8118`.
+   - Cấu hình trình duyệt hoặc thiết bị sử dụng HTTP Proxy với địa chỉ trên.
+
+## Thông tin thêm
+- Image được build định kỳ hàng tuần và hỗ trợ đa kiến trúc (amd64, arm64).
+- Để build hoặc push image, xem file `.gitea/workflows/build-docker.yml`.
diff --git a/docker-compose.yml b/docker-compose.yml
deleted file mode 100644
index 7d2c80a..0000000
--- a/docker-compose.yml
+++ /dev/null
@@ -1,8 +0,0 @@
-services:
-  privoxy:
-    image: git.thuanle.me/public/privoxy-docker:latest  
-    restart: unless-stopped
-    ports:
-      - "8118:8118" 
-    volumes:
-      - ./config:/etc/privoxy
\ No newline at end of file