61 lines
2.8 KiB
Markdown
61 lines
2.8 KiB
Markdown
# Reverse Proxy
|
|
|
|
A comprehensive and automated solution for deploying Reverse Proxy. This system simplifies the provisioning of entire environments through a single configuration file or guided interactive setup on target computers.
|
|
|
|
## Overview
|
|
|
|
This project provides an automated deployment script (`deploy-rvs-prxy.sh`) that sets up Traefik as a reverse proxy for your existing Docker applications. The script runs directly on the target server where your application is hosted.
|
|
|
|
## Key Features
|
|
|
|
> **Refer to:** [`Design_Doc/Spec.md` → Key Features](Design_Doc/Spec.md) for detailed capabilities, configuration file structure, and system requirements.
|
|
|
|
## Quick Start
|
|
|
|
> **Refer to:** [`Design_Doc/Operations.md` → Quick Start](Design_Doc/Operations.md) for complete setup instructions including interactive wizard, configuration file options, and automatic mode detection.
|
|
|
|
## Documentation Overview
|
|
|
|
The documentation is organized to serve different user needs:
|
|
|
|
### End-User Documentation
|
|
- **[Specifications](Design_Doc/Spec.md)** — Understanding features, capabilities, and system requirements
|
|
- **[Operations Guide](Design_Doc/Operations.md)** — Getting started, installation, and day-to-day management
|
|
|
|
### Technical Documentation
|
|
- **[Technical Description](Design_Doc/Tech_Desc.md)** — Internal architecture, implementation details, and advanced configuration
|
|
|
|
### Quick Reference
|
|
- **README.md** (this document) — Project introduction, benefits, and documentation roadmap
|
|
- **Qwen.md** — Technical reference guide
|
|
|
|
This structured approach ensures that both novice users and technical personnel can find relevant information tailored to their needs.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the details below:
|
|
|
|
```
|
|
MIT License
|
|
|
|
Copyright (c) 2026 Reverse Proxy Project
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
SOFTWARE.
|
|
```
|