rathole-org/rathole

Binding to unix sockets

Open

#343 opened on Mar 12, 2024

View on GitHub
 (0 comments) (10 reactions) (0 assignees)Rust (800 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (13,949 stars)
PR merge metrics
 (Avg merge 7d 11h) (8 merged PRs in 30d)

Description

Feature Proposed Ability to bind to unix domain sockets,

[server.services.foo1]
type = "unix"
bind_addr = "./one.sock"

Use Case For putting behind reverse proxies where you don't want to use a port and want a easier name to remember. Benefits:

  • Better Permission control
  • (maybe) Better performance
  • You don't have to designate a port to it

I am willing to help implement this feature

Contributor guide

Research direction
Inspect the server and config modules to understand how TCP listeners are created and how bind addr is currently used. Then design a 'unix' service type that creates a Unix domain socket listener, and update config parsing and tests accordingly.
Tech stack
rust
Domain
backendnetworking
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60