rvs-prxy/README.md

33 lines
1.6 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.