boring
A simple command-line SSH tunnel manager that supports local, remote, and dynamic port forwarding with automatic reconnection.
What is boring?
boring is a lightweight SSH tunnel manager that simplifies creating and managing secure tunnels through a straightforward command-line interface. It provides reliable port forwarding and SOCKS5 proxy establishment, making remote service access and secure browsing effortless.
Developers and system administrators who regularly need to manage multiple SSH tunnels for tasks like accessing remote services, setting up SOCKS5 proxies for secure browsing, or forwarding ports across networks. It's particularly useful for those working across macOS, Linux, and Windows who prefer a simple, configuration-driven tool.
Developers choose boring for its simplicity, reliability, and seamless integration with existing SSH configurations and ssh-agent. Its human-friendly TOML configuration, automatic reconnection, and cross-platform support offer a no-fuss alternative to manual SSH tunneling commands.
Overview
The boring SSH tunnel manager
Use Cases
Best For
- Managing multiple SSH tunnels with a simple configuration file instead of complex command-line arguments.
- Setting up SOCKS5 proxies for secure web browsing or accessing remote network resources.
- Forwarding local or remote ports to access services on servers behind firewalls or in private networks.
- Automating tunnel reconnection and keep-alives to maintain stable connections without manual intervention.
- Integrating with existing SSH config files and ssh-agent for streamlined authentication.
- Using a cross-platform tool that works consistently on macOS, Linux, and Windows for tunnel management.
Not Ideal For
- Projects requiring graphical user interfaces or web dashboards for SSH tunnel management
- Environments that need advanced SSH features like X11 forwarding, jump hosts, or proxy commands
- Teams using infrastructure-as-code tools that rely on YAML or JSON configurations exclusively
Pros & Cons
Pros
Leverages existing SSH config files and ssh-agent for authentication, reducing setup overhead as mentioned in the README's feature list.
Includes automatic re-connection and configurable keep-alives to ensure tunnels remain active without manual intervention, enhancing reliability.
Uses a simple TOML file with clear aliases, making it easy to define and manage multiple tunnels, as demonstrated in the configuration example.
Runs on macOS, Linux, and Windows with consistent behavior, though Windows requires building from source, which is noted in the installation section.
Cons
Unlike macOS with Homebrew, Windows users must build from source using Go, adding complexity for non-developers or those seeking quick setup.
Focuses on basic tunneling modes; lacks native support for advanced SSH options like jump hosts or X11 forwarding, which might be needed in complex networks.
Forces use of TOML format, which may not integrate well with teams preferring YAML or JSON for infrastructure as code, limiting flexibility.
Frequently Asked Questions
Related Projects
fzf:cherry_blossom: A command-line fuzzy finder
diveA tool for exploring each layer in a docker image
HubA command-line tool that makes git easier to use with GitHub.
lo💥 A Lodash-style Go library based on Go 1.18+ Generics (map, filter, contains, find...)
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.