KNELProductionContainers/CloudronPackages/Rathole/README.md

Rathole (Cloudron Package)

Rathole is a reverse proxy that provides secure tunnels for local services. Upstream project: https://github.com/rathole-org/rathole

This Cloudron package runs Rathole and a lightweight HTTP health endpoint.

Defaults

• Mode: server (server-only package)
• Config path: /app/data/rathole.toml
• Health port: 3000 (Cloudron httpPort)

Configuration

• Put your Rathole TOML config at /app/data/rathole.toml, or provide it via the RATHOLE_CONFIG environment variable on first start.
• Example minimal server config is auto-generated if none exists.

Build (inside packaging container)

scripts/packaging-up.sh
scripts/packaging-exec.sh "docker build -t rathole:dev CloudronPackages/Rathole"

Run locally (inside packaging container)

scripts/packaging-exec.sh "docker run --rm -p 3000:3000 -p 2333:2333 -v rathole-data:/app/data rathole:dev"

Note: expose additional service ports as needed per your TOML. Container exposes 2333 by default.

Deploy to Cloudron

Use Cloudron CLI from inside the packaging container:

scripts/packaging-enter.sh
cloudron login
cloudron install --image rathole:dev