Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

bore (server)

Lightweight tunneling server built on frp. Supports HTTP (wildcard subdomains), TCP, and UDP tunnels with optional OAuth authentication via Indiko.

Domain: bore.dunkirk.sh · frp port: 7000

This is a custom module — it does not use mkService.

Options

OptionTypeDefaultDescription
enableboolfalseEnable bore server
domainstringBase domain for wildcard subdomains
bindAddrstring"0.0.0.0"frps bind address
bindPortport7000frps bind port
vhostHTTPPortport7080Virtual host HTTP port
allowedTCPPortslist of ports20000–20099Ports available for TCP tunnels
allowedUDPPortslist of ports20000–20099Ports available for UDP tunnels
authTokenstring or nullnullfrp auth token (use authTokenFile instead)
authTokenFilepath or nullnullPath to file containing frp auth token
enableCaddybooltrueAuto-configure Caddy wildcard vhost

Authentication

When enabled, all HTTP tunnels are gated behind Indiko OAuth. Users must sign in before accessing tunneled services.

OptionTypeDefaultDescription
auth.enableboolfalseEnable bore-auth OAuth middleware
auth.indikoURLstring"https://indiko.dunkirk.sh"Indiko server URL
auth.clientIDstringOAuth client ID from Indiko
auth.clientSecretFilepathPath to OAuth client secret
auth.cookieHashKeyFilepath32-byte cookie signing key
auth.cookieBlockKeyFilepath32-byte cookie encryption key

After authentication, these headers are passed to tunneled services:

  • X-Auth-User — user's profile URL
  • X-Auth-Name — display name
  • X-Auth-Email — email address

See bore (client) for the home-manager client module.