• Gnar
  • Install
  • Usage
  • Client
  • Server
    • Server admin panel
  • Simple Start
  • Deploy at fly.io
  • Subdomain proxy
  • Trubleshooting

Gnar

Do not destroy the server!!!

frp-like Tool with AutoHTTPs Subdomain Proxy

Features:

• Simple implementation with minimal third-party dependencies
• Support TCP/UDP traffic forward
• Support for subdomain proxy using Caddy server
• Can be run via command-line flags or a configuration file
• Supports forwarding from multiple clients
• Includes token-based authentication for added security
• Server-side admin panel (currently, it's simple)
• Integration of yamux for multiplexing connections
• Can deploy at fly.io

Future Plans:

• Daemon mode for background execution
• Smooth upgrade (upgrade client/server version)
• Add metrics (bandwidths/upward and downward)
• Integration of yamux for multiplexing connections
• Support UDP traffic forward
• Can deploy at fly.io

Install

git clone https://github.com/abcdlsj/gnar
make

Usage

gnar is a proxy tool.

Usage:
  gnar [flags]
  gnar [command]

Available Commands:
  client      
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  server      

Flags:
  -h, --help      help for gnar
  -v, --version   version for gnar

Use "gnar [command] --help" for more information about a command.

Client

Usage:
  gnar client [flags]

Flags:
  -c, --config string        config file
  -h, --help                 help for client
  -l, --local-port int       local port
  -m, --multiplex            multiplex client/server control connection
  -n, --proxy-name string    proxy name
  -y, --proxy-type string    proxy transport protocol type (default "tcp")
  -u, --remote-port int      proxy port
  -s, --server-addr string   server addr (default "localhost:8910")
      --speed-limit string   speed limit
  -d, --subdomain string     subdomain
  -t, --token string         token

Server

Usage:
  gnar server [flags]

Flags:
  -a, --admin-port int   admin server port
  -c, --config string    config file
  -D, --domain string    domain name
  -d, --domain-tunnel    enable domain tunnel
  -h, --help             help for server
  -m, --multiplex        multiplex client/server control connection
  -p, --port int         server port (default 8910)
  -t, --token string     token

Server admin panel

Simple Start

Server

gnar server -p 8910

Client

# start a service
python3 -m http.server 3000
# start proxy
gnar client -s localhost:8910 -l 3000 -u 9001

view host:9001 and you will see the service.

Deploy at fly.io

You can edit entrypoint.sh to start your own server you need to special set forward port.

Example:

# See https://fly.io/docs/reference/configuration/ for information about how to use this file.
app = "xxxx"
primary_region = "hkg"

[build]

# Control
[[services]]
  internal_port = 8910
  protocol = "tcp"

  [[services.ports]]
    port = 8910
  
# Admin
[[services]]
  internal_port = 8911
  protocol = "tcp"

  [[services.ports]]
    handlers = ["http"]
    port = 80

  [[services.ports]]
    handlers = ["tls", "http"]
    port = 443

# Forward TCP
[[services]]
  internal_port = 9000
  protocol = "tcp"

  [[services.ports]]
    handlers = ["tls", "http"]
    port = 9000

This can view xxxx.fly.dev:9000 and then view your own internal server.

Subdomain proxy

1. make sure you have a domain and set the dns record to your server ip.

A *.example.com <your server ip>
A example.com <your server ip> (`@` is ok too)

2. start caddy server

[sudo] caddy run --config <gnar path>/server/caddy.json

1. start server server with domain-tunnel flag

gnar server -a 8911 -D <example.com> -d -p 8910

1. start client

gnar client -s localhost:8910 -l 3000 -u 9001

You also can custom the subdomain gnar client -s localhost:8910 -l 3000 -u 9001 -d <subdomain>

1. now you can find the subdomain in logs, like this

2023/07/02 09:50:16 INF Tunnel created successfully, id: 3ec8f1b-9001, host: 3ec8f1b.xxx.xxx

1. visit 3ec8f1b.xxx.xxx and you will see the service.

Trubleshooting

1. subdomain proxy not work make sure you have set the dns record to your server ip. if you use cloudflare, need to set dns_key in caddy.json.