Files
drip/README.md
Gouryella 37d1bfc089 feat(client): Support predefined tunnel configuration and management commands
Added predefined tunnel functionality, allowing users to define multiple tunnels in the configuration file and start them by name, including the following improvements:
- Added --all flag to start all configured tunnels
- Added parameterless start command to list available tunnels
- Support configuration of multiple tunnel types (http, https, tcp)
- Support advanced configurations such as subdomains, transport protocols, and IP allowlists

refactor(deployments): Refactor Docker deployment configuration

Removed old Dockerfile and Compose configurations, added new deployment files:
- Removed .env.example and old Docker build files
- Added Caddy reverse proxy configuration file
- Added two deployment modes: standard and Caddy reverse proxy
- Added detailed server configuration example files

docs: Update documentation to include tunnel configuration and deployment guide

Updated Chinese and English README documents:
- Added usage instructions and configuration examples for predefined tunnels
- Expanded server deployment section to include direct TLS and reverse proxy modes
- Added server configuration reference table with detailed configuration item descriptions
- Added specific configuration methods for Caddy and Nginx reverse proxies
2026-01-15 17:18:27 +08:00

70 lines
1.9 KiB
Markdown

<p align="center">
<img src="assets/logo.png" alt="Drip Logo" width="200" />
</p>
<h1 align="center">Drip</h1>
<h3 align="center">Your Tunnel, Your Domain, Anywhere</h3>
<p align="center">
A self-hosted tunneling solution to securely expose your services to the internet.
</p>
<p align="center">
<a href="https://driptunnel.app/en/docs">Documentation</a>
<span> | </span>
<a href="https://driptunnel.app/docs">中文文档</a>
</p>
<div align="center">
[![Go](https://img.shields.io/badge/Go-1.21+-00ADD8?style=flat&logo=go)](https://golang.org/)
[![License](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](LICENSE)
[![TLS](https://img.shields.io/badge/TLS-1.3-green.svg)](https://tools.ietf.org/html/rfc8446)
</div>
> Drip is a quiet, disciplined tunnel.
> You light a small lamp on your network, and it carries that light outward—through your own infrastructure, on your own terms.
## Why Drip?
- **Control your data** - No third-party servers, traffic stays between your client and server
- **No limits** - Unlimited tunnels, bandwidth, and requests
- **Actually free** - Use your own domain, no paid tiers or feature restrictions
- **Open source** - BSD 3-Clause License
## Quick Start
### Install
```bash
bash <(curl -sL https://raw.githubusercontent.com/Gouryella/drip/main/scripts/install.sh)
```
### Basic Usage
```bash
# Configure (first time only)
drip config init
# Expose local HTTP server
drip http 3000
# With custom subdomain
drip http 3000 -n myapp
# → https://myapp.your-domain.com
```
## Documentation
For complete documentation, visit **[driptunnel.app/en/docs](https://driptunnel.app/en/docs)**
- [Installation Guide](https://driptunnel.app/en/docs/installation)
- [Client Usage](https://driptunnel.app/en/docs/client)
- [Server Deployment](https://driptunnel.app/en/docs/server)
- [Configuration Reference](https://driptunnel.app/en/docs/configuration)
## License
BSD 3-Clause License - see [LICENSE](LICENSE) for details