vripper-project/README.md

# VRipper!

This is my spin for a cross-platform gallery ripper for [vipergirls.to](https://vipergirls.to)

![GitHub Image](/image.png)

## Donation
To support this project, you can make a donation to its current maintainer

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoffee.com/devclaw)

Or with Cryptocurrency

ETH: 0xDdac82B16dC5E3D742fc915ffF583D8548A301cA

BTC: bc1qcqudnkrndwyadsjwrxww42svkf8trnzx3c8vlr

## 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

<img src="https://github.com/stashapp/stash/raw/develop/docs/readme_assets/windows_logo.svg" width="100%" height="75"> Windows | <img src="https://github.com/stashapp/stash/raw/develop/docs/readme_assets/mac_logo.svg" width="100%" height="75"> macOS (Intel) | <img src="https://github.com/stashapp/stash/raw/develop/docs/readme_assets/mac_logo.svg" width="100%" height="75"> macOS (Apple silicon) | <img src="https://github.com/stashapp/stash/raw/develop/docs/readme_assets/linux_logo.svg" width="100%" height="75"> Linux  | <img src="https://images.vexels.com/media/users/3/166401/isolated/preview/b82aa7ac3f736dd78570dd3fa3fa9e24-java-programming-language-icon-by-vexels.png" width="100%" height="75"> Java
:---:|:---:|:---:|:---:|:---:
[Installer (EXE)](https://github.com/dev-claw/vripper-project/releases/download/6.5.8/vripper-windows-installer-6.5.8.exe) <br /> [Installer (MSI)](https://github.com/dev-claw/vripper-project/releases/download/6.5.8/vripper-windows-installer-6.5.8.msi) <br /> [Portable (ZIP)](https://github.com/dev-claw/vripper-project/releases/download/6.5.8/vripper-windows-portable-6.5.8.zip) | [Installer (DMG)](https://github.com/dev-claw/vripper-project/releases/download/6.5.8/vripper-macos-6.5.8.x86_64.dmg) <br /> [Installer (PKG)](https://github.com/dev-claw/vripper-project/releases/download/6.5.8/vripper-macos-6.5.8.x86_64.pkg) <br /> [Portable (ZIP)](https://github.com/dev-claw/vripper-project/releases/download/6.5.8/vripper-macos-portable-6.5.8.x86_64.zip) | [Installer (DMG)](https://github.com/dev-claw/vripper-project/releases/download/6.5.8/vripper-macos-6.5.8.arm64.dmg) <br /> [Installer (PKG)](https://github.com/dev-claw/vripper-project/releases/download/6.5.8/vripper-macos-6.5.8.arm64.pkg) <br /> [Portable (ZIP)](https://github.com/dev-claw/vripper-project/releases/download/6.5.8/vripper-macos-portable-6.5.8.arm64.zip)  | [Linux (amd64) (DEB)](https://github.com/dev-claw/vripper-project/releases/download/6.5.8/vripper-linux-6.5.3_amd64.deb) <br /> [Linux (x86_64) (RPM)](https://github.com/dev-claw/vripper-project/releases/download/6.5.8/vripper-linux-6.5.8.x86_64.rpm) <br /> [Portable (ZIP)](https://github.com/dev-claw/vripper-project/releases/download/6.5.8/vripper-linux-portable-6.5.8.zip) | [Java GUI (noarch)](https://github.com/dev-claw/vripper-project/releases/download/6.5.8/vripper-noarch-gui-6.5.8.jar) <br /> [Java Web (noarch)](https://github.com/dev-claw/vripper-project/releases/download/6.5.8/vripper-noarch-web-6.5.8.jar)

Source code and previous versions are available on
the [Releases page](https://github.com/dev-claw/vripper-project/releases).

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

The project is supplied as a container image and can be run locally or in production using Docker. By default:

- **gRPC server/client** uses port **30000**
- **Web UI** runs on port **8080**

### Run with `docker run`

```bash
docker run -d \
  -p 30000:30000 \
  -p 8080:8080 \
  -e GRPC_ENABLED=true \
  -e GRPC_PASSPHRASE=my-secure-secret \
  ghcr.io/dev-claw/vripper-web: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"
      - "8080:8080"
```

> **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"
```

## Default Ports

- **gRPC server/client:** `30000`
- **Web UI:** `8080`

You can map these ports when running the container. The application supports overriding these defaults with environment
variables (`GRPC_PORT`, `SERVER_PORT`), configure them as needed.

## Important Note About Proxies
The use of proxies within VRipper is worthless, please stop using them **for now**. You will get **403 error** codes.  

**403** is a response code coming from Cloudflare to block VRipper from accessing the site, Cloudflare is doing the job it is supposed to do, which is blocking automated requests from accessing the site. 

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.

## Instructions to run from Jar file
You need Java 21+, you can download from https://adoptium.net/

Download the latest jar file from the Release page, open a command prompt and run the jar file using the following command

For the GUI app

    javaw -jar vripper-gui.jar

For the WEB app

    java -jar vripper-web.jar

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

You need JDK 21 and a recent version of maven 3.8.x+

To build, run the following command:

    mvn clean install

Build artifact is located under

    vripper-project\vripper-gui\target\vripper-gui-{{version}}-jar-with-dependencies.jar

Copy the artifact into any other folder and run:

    java -jar vripper-gui-{{version}}-jar-with-dependencies.jar