Skip to main content

FAQ

Common questions and answers about gTunnel.

General Questions​

What is gTunnel?

gTunnel is a fast, secure, and lightweight HTTP tunneling solution written in Go. It allows you to expose local services to the internet securely through WebSocket connections.

How does gTunnel work?

gTunnel consists of two components:

  • Server: Runs on a public server and handles incoming HTTP requests
  • Client: Runs locally and forwards traffic from the server to your local services

The client establishes a WebSocket connection to the server, and all HTTP traffic is tunneled through this connection.

Is gTunnel free to use?

Yes, gTunnel is open source and free to use. You can run your own server or use community-provided servers.

Does gTunnel support WebSockets?

not yet, we are working on it.

Installation & Setup​

How do I install gTunnel?

See our Installation Guide for detailed instructions. Quick options:

Do I need to run my own server?

You can either:

  • Run your own gTunnel server for full control
  • Use a community-provided server (if available)
  • Use a cloud service that supports gTunnel
How do I configure authentication?

gTunnel (v0.0.0) basic token-based authentication:

# Server config
auth_token: "your-secret-token"

# Client config  
auth_token: "your-secret-token"
Should I expose sensitive services?

Best practices:

  • Only expose services that need external access
  • Use authentication on both gTunnel and your services
  • Monitor access logs regularly
  • Use HTTPS for sensitive data
Docker deployment

gTunnel provides official Docker images:

# Run server
docker run -p 8080:8080 gtunnel/server

# Run client
docker run gtunnel/client connect --server wss://tunnel.example.com --port 3000

Contributing & Community​

Where can I get support?
How do I report bugs?
  1. Check existing issues first
  2. Gather relevant information:
    • gTunnel version
    • Operating system
    • Configuration files (remove sensitive data)
    • Error messages and logs
  3. Create a detailed issue report
How can I contribute?

See our Contributing Guide for information about:

  • Code contributions
  • Documentation improvements
  • Bug reports
  • Feature suggestions
How many tunnels can I run?

as many as your server can handle, depending on its resources and configuration.

Still have questions? Ask in GitHub Discussions.