bun-reverse-proxy v0.0.1
A Better Developer Experience
A zero-config reverse proxy for local development with SSL support, custom domains, and more.
Features
- Reverse Proxy
- SSL Support (HTTPS by default)
- Custom Domains (with wildcard support)
- Auto HTTP-to-HTTPS Redirection
/etc/hosts
Management (auto-updating)- Dependency-Free Binary
- Zero-Config Setup
Install
bun install -d bun-reverse-proxy
Alternatively, you can install:
brew install reverse-proxy # wip
pkgx install reverse-proxy # wip
Get Started
There are two ways of using this reverse proxy: as a library or as a CLI.
Library
Given the npm package is installed:
import { startProxy } from 'bun-reverse-proxy'
startProxy({
from: 'localhost:3000',
to: 'my-project.localhost' // or try 'my-project.test'
})
CLI
reverse-proxy --from localhost:3000 --to my-project.localhost
reverse-proxy --from localhost:8080 --to my-project.test --keyPath ./key.pem --certPath ./cert.pem
reverse-proxy --help
reverse-proxy --version
Configuration
The Reverse Proxy can be configured using a reverse-proxy.config.ts
(or reverse-proxy.config.js
) file and it will be automatically loaded when running the reverse-proxy
command.
// reverse-proxy.config.ts (or reverse-proxy.config.js)
export default {
'localhost:3000': 'stacks.localhost'
}
Then run:
reverse-proxy start
To learn more, head over to the documentation.
Testing
bun test
Changelog
Please see our releases page for more information on what has changed recently.
Contributing
Please review the Contributing Guide for details.
Community
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
For casual chit-chat with others using this package:
Join the Stacks Discord Server
Postcardware
Two things are true: Stacks OSS will always stay open-source, and we do love to receive postcards from wherever Stacks is used! 🌍 We also publish them on our website. And thank you, Spatie
Our address: Stacks.js, 5710 Crescent Park #107, Playa Vista 90094, CA.
Sponsors
We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.
Credits
License
The MIT License (MIT). Please see LICENSE for more information.
Made with 💙
10 months ago