portmux

README

portmux

Port multiplexer: a reverse proxy that exposes HTTP / WS endpoints with UI on a single PORT

Install

$ go install github.com/btwiuse/portmux/cmd/portmux@latest

Examples

Host your Substrate node-template with frontend on http://127.0.0.1:8000

• / => https://redirect.subshell.xyz
• /rpc/ws => 127.0.0.1:9944
• /rpc/http => 127.0.0.1:9933

set listening port (optional, default: 8000)
$ export PORT=8000

set upstream UI url for reverse proxy (optional)
$ export PORTMUX_UI=https://redirect.subshell.xyz

set upstream HTTP endpoint for reverse proxy (optional)
$ export PORTMUX_HTTP=http://127.0.0.1:9933

set upstream WS endpoint for reverse proxy (optional)
$ export PORTMUX_WS=ws://127.0.0.1:8080

$ portmux ./target/release/node-template --dev
2022/09/09 06:33:20 main.go:74: UI(/): https://redirect.subshell.xyz
2022/09/09 06:33:20 main.go:77: WS(/rpc/ws): ws://127.0.0.1:9944
2022/09/09 06:33:20 main.go:80: HTTP(/rpc/http): http://127.0.0.1:9933
2022/09/09 06:33:20 main.go:82: Args: [node-template --dev]
2022/09/09 06:33:20 main.go:141: listening on http://127.0.0.1:8000
2022-09-09 06:33:20 Substrate Node
2022-09-09 06:33:20 ✌️  version 4.0.0-dev-unknown
2022-09-09 06:33:20 ❤️  by Substrate DevHub <https://github.com/substrate-developer-hub>;, 2017-2022
2022-09-09 06:33:20 📋 Chain specification: Development
2022-09-09 06:33:20 🏷  Node name: slippery-event-2476
2022-09-09 06:33:20 👤 Role: AUTHORITY
2022-09-09 06:33:20 💾 Database: RocksDb at /tmp/substrateWahtYW/chains/dev/db/full
2022-09-09 06:33:20 ⛓  Native runtime: node-template-100 (node-template-1.tx1.au1)
2022-09-09 06:33:20 🔨 Initializing Genesis block/state (state: 0xf2fd…fb5a, header-hash: 0x975b…a001)
2022-09-09 06:33:20 👴 Loading GRANDPA authority set from genesis on what appears to be first startup.
2022-09-09 06:33:21 Using default protocol ID "sup" because none is configured in the chain specs
2022-09-09 06:33:21 🏷  Local node identity is: 12D3KooWGLmTk9tVCCpx3j9rCqzTHZeTg9nWMdNm7j5TzPBJntNy
2022-09-09 06:33:21 💻 Operating system: linux
2022-09-09 06:33:21 💻 CPU architecture: x86_64
2022-09-09 06:33:21 💻 Target environment: gnu
2022-09-09 06:33:21 💻 CPU: Intel(R) Xeon(R) CPU @ 2.00GHz
2022-09-09 06:33:21 💻 CPU cores: 48
2022-09-09 06:33:21 💻 Memory: 362775MB
2022-09-09 06:33:21 💻 Kernel: 4.19.0-20-cloud-amd64
2022-09-09 06:33:21 💻 Linux distribution: Arch Linux
2022-09-09 06:33:21 💻 Virtual machine: yes
2022-09-09 06:33:21 📦 Highest known block at #0
2022-09-09 06:33:21 〽️ Prometheus exporter started at 127.0.0.1:9615
2022-09-09 06:33:21 Running JSON-RPC HTTP server: addr=127.0.0.1:9933, allowed origins=None
2022-09-09 06:33:21 Running JSON-RPC WS server: addr=127.0.0.1:9944, allowed origins=None
2022-09-09 06:33:24 🙌 Starting consensus session on top of parent 0x975b2ef86216b39214643c1560a81910f9d8c29133f6ef80881731c1d14ba001
2022-09-09 06:33:24 🎁 Prepared block for proposing at 1 (2 ms) [hash: 0x420256c5d7dd30c467ea68eb69c013b18086a7ebdb55ef60b160e06a8c2e8c20; parent_hash: 0x975b…a001; extrinsics (1): [0xd2a2…7e45]]
2022-09-09 06:33:24 🔖 Pre-sealed block for proposal at 1. Hash now 0xaad0e623edb381f249c196a4146e42cc153563ca1d0a0d5fb36719ad91f2c0cb, previously 0x420256c5d7dd30c467ea68eb69c013b18086a7ebdb55ef60b160e06a8c2e8c20.
2022-09-09 06:33:24 ✨ Imported #1 (0xaad0…c0cb)
2022-09-09 06:33:26 💤 Idle (0 peers), best: #1 (0xaad0…c0cb), finalized #0 (0x975b…a001), ⬇ 0 ⬆ 0
2022-09-09 06:33:30 🙌 Starting consensus session on top of parent 0xaad0e623edb381f249c196a4146e42cc153563ca1d0a0d5fb36719ad91f2c0cb
2022-09-09 06:33:30 🎁 Prepared block for proposing at 2 (0 ms) [hash: 0x3f02abd410546c3b8f699bc195d36684730a9ba32bebab97c1e553990b419bad; parent_hash: 0xaad0…c0cb; extrinsics (1): [0x0baf…aec4]]
2022-09-09 06:33:30 🔖 Pre-sealed block for proposal at 2. Hash now 0x79b33de71ad3a28b31e44d71e065f8e1d150af14e17b009673ccf1fcc55a4d22, previously 0x3f02abd410546c3b8f699bc195d36684730a9ba32bebab97c1e553990b419bad.
2022-09-09 06:33:30 ✨ Imported #2 (0x79b3…4d22)
...

Documentation

Index

• Variables
• func Run(args []string) error
• type Options
• type PortMux
  • func NewPortMux(opts *Options) *PortMux
  • func (p *PortMux) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (p *PortMux) SpawnCmd()

Variables

var DefaultUpgrader = &websocket.Upgrader{
	ReadBufferSize:  1024,
	WriteBufferSize: 1024,
	CheckOrigin: func(*http.Request) bool {
		return true
	},
}

Functions

func Run

func Run(args []string) error

Types

type Options

type Options struct {
	// contains filtered or unexported fields
}

type PortMux

type PortMux struct {
	UI          *string
	WS          *string
	HTTP        *string
	Argv        []string
	HandlerUI   http.Handler
	HandlerWS   http.Handler
	HandlerHTTP http.Handler
}

func NewPortMux

func NewPortMux(opts *Options) *PortMux

func (*PortMux) ServeHTTP

func (p *PortMux) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*PortMux) SpawnCmd

func (p *PortMux) SpawnCmd()