From 398220d5186607c8dd75ea778083decc348982bf Mon Sep 17 00:00:00 2001
From: dev-claw <53543762+dev-claw@users.noreply.github.com>
Date: Fri, 19 Sep 2025 20:03:52 +0100
Subject: [PATCH] update README.md

---
 README.md | 120 +++++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 101 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index 005f350..b9872a8 100644
--- a/README.md
+++ b/README.md
@@ -15,8 +15,29 @@ ETH: 0xDdac82B16dC5E3D742fc915ffF583D8548A301cA
 
 BTC: bc1qcqudnkrndwyadsjwrxww42svkf8trnzx3c8vlr
 
-## Requirements
-Direct access to `vipergirls.to` domain.
+---
+
+## Supported Image Hosts
+
+The following hosts are supported:
+
+* acidimg.cc
+* imagetwist.com
+* imagezilla.com
+* imgspice.com
+* imagebam.com
+* imgbox.com
+* imx.to
+* pimpandhost.com
+* pixhost.to
+* pixxxels.cc
+* turboimagehost.com
+* postimg.cc
+* imagevenue.com
+* pixroute.to
+* vipr.im
+
+---
 
 ## Installing VRipper
 
@@ -31,6 +52,82 @@ Application data (application logs, settings and persisted data) is stored in:
 * Windows --> `C:\USERS\<your Windows username>\vripper` 
 * Linux and macOS --> `HOME_FOLDER/.config/vripper`
 
+---
+
+## Docker Support
+
+This project is fully compatible with **Docker** and can be run as a container.  
+The provided Docker image exposes the service and allows you to configure runtime behavior via environment variables.
+
+### Run with `docker run`
+
+```bash
+docker run -d \
+  -p 30000:30000 \
+  -e GRPC_ENABLED=true \
+  -e GRPC_PASSPHRASE=my-secure-secret \
+  ghcr.io/OWNER/IMAGE_NAME:latest
+```
+
+### Run with Docker Compose
+
+```yaml
+services:
+  app:
+    image: ghcr.io/dev-claw/vripper-web:latest
+    environment:
+      - GRPC_ENABLED=true
+      - GRPC_PASSPHRASE=super-secret-passphrase
+    ports:
+      - "30000:30000"
+```
+
+> **Tip:** For production, prefer storing the passphrase as a secret (see `Security Notes` below) rather than writing it
+> directly in the Compose file.
+
+### Environment Variables
+
+The container supports these environment variables for enabling and securing the gRPC server.
+
+### `GRPC_ENABLED`
+
+- **Type:** String (interpreted as Boolean)
+- **Accepted values:** `true` (case-insensitive) to enable; any other value or unset → disabled
+- **Default:** `false` (gRPC disabled)
+- **Behavior:**
+    - When `GRPC_ENABLED=true`, the application will attempt to start the gRPC server (default port: `30000`).
+    - When absent or set to anything other than `true`, the gRPC server will not be started.
+- **Example (shell):**
+
+```bash
+export GRPC_ENABLED=true
+```
+
+- **Example (Docker Compose):**
+
+```yaml
+environment:
+  - GRPC_ENABLED=true
+```
+
+- **Notes / Best practices:**
+    - Treat the value as a simple on/off toggle. To avoid ambiguity, set explicitly to `true` or `false`.
+    - If you enable gRPC, make sure any required authentication (see `GRPC_PASSPHRASE`) is also configured.
+
+---
+
+### `GRPC_PASSPHRASE`
+
+- **Type:** String
+- **Default:** *no default* (empty / unset)
+- **Required if:** `GRPC_ENABLED=true`
+- **Purpose:** Shared secret used to authenticate gRPC clients. The application should validate that the passphrase is
+  present when gRPC is enabled and use it to verify client connections.
+- **Example (shell):**
+
+```bash
+export GRPC_PASSPHRASE="my-very-strong-passphrase"
+```
 
 ## Important Note About Proxies
 The use of proxies within VRipper is worthless, please stop using them **for now**. You will get **403 error** codes.  
@@ -39,23 +136,7 @@ The use of proxies within VRipper is worthless, please stop using them **for now
 
 If your ISP is blocking access to `vipergirls.to` domain, consider using a VPN or [Cloudflare WARP](https://one.one.one.one/) to bypass the block.
 
-## Supported Image Hosts
-The following hosts are supported:
-* acidimg.cc  
-* imagetwist.com  
-* imagezilla.com  
-* imgspice.com  
-* imagebam.com  
-* imgbox.com  
-* imx.to  
-* pimpandhost.com  
-* pixhost.to  
-* pixxxels.cc  
-* turboimagehost.com  
-* postimg.cc  
-* imagevenue.com  
-* pixroute.to  
-* vipr.im  
+---
 
 ## Instructions to run from Jar file
 You need Java 21+, you can download from https://adoptium.net/
@@ -72,6 +153,7 @@ For the WEB app
 
 Application data (application logs, settings and persisted data) is stored in the location where you launched the jar for both GUI and WEB
 
+---
 
 ## How to build