meele/rathole repository overview

⁠rathole Docker Image

⁠About rathole⁠

A lightweight and high-performance reverse proxy for NAT traversal, written in Rust. An alternative to frp and ngrok.

⁠rathole Documentation⁠⁠

If you need to install docker by yourself, follow the official installation guide⁠⁠.

If you need to install Docker Compose by yourself,follow the official installation guide⁠⁠.

For more information on docker and containerization technologies, refer to official document⁠⁠.

⁠eg.

version: '3.8'

services:
  rathole:
    image: meele/rathole:latest
    container_name: rathole
    volumes:
      - ./config:/app/config
    ports:
      - "2333:2333"
    restart: unless-stopped
    command: ["/app/rathole", "-c", "/app/config/config.toml"]

⁠Create a config directory in your project directory and create a config.toml file in that directory.

[server]
bind_addr = "0.0.0.0:2333"
default_token = "your_token_here"

[server.transport]
type = "tcp"

[client]
token = "your_token_here"

[[client.servers]]
bind_addr = "127.0.0.1:8080"
remote_addr = "server_address:port"

⁠Run the following command in the project directory to start Rathole:

docker-compose up -d

⁠Run the following command to view the running status of the container:

docker-compose ps

⁠You can view the logs of the Rathole container with the following command:

docker-compose logs -f rathole

⁠This way you can easily manage and deploy.

docker-compose down
docker-compose up -d