docs: 文档修改优化
This commit is contained in:
1 parent
7cd5b4fb66
commit
609698be81
5 files changed
+178
-97
No files matched your search
+88
-11
@@ -21,8 +21,8 @@ License Manager is an independent software licensing platform that provides lice
|
||||
## Technical Stack
|
||||
|
||||
- **Frontend**: Vue.js 3+ with modern UI components
|
||||
- **Backend**: Go 1.23+ with Gorilla Mux router and Logrus logging
|
||||
- **Database**: PostgreSQL 12+ / MySQL 12+
|
||||
- **Backend**: Go 1.23+ with Gin framework, GORM, Viper configuration and Logrus logging
|
||||
- **Database**: PostgreSQL 12+ / MySQL 8+
|
||||
- **Configuration**: YAML format configuration files
|
||||
- **Deployment**: Docker, single machine, or system service
|
||||
|
||||
@@ -39,16 +39,31 @@ GET /tools/{tool} - Tool download
|
||||
|
||||
## Security & Performance
|
||||
|
||||
- **Security**: HMAC-SHA256 signing, hardware fingerprint binding, HTTPS encryption
|
||||
- **Performance**: Supports 100+ concurrent users with <2s API response time
|
||||
- **Reliability**: Comprehensive error handling and logging
|
||||
- **Security Features**:
|
||||
- JWT authentication and authorization
|
||||
- HMAC-SHA256 signature verification
|
||||
- Hardware fingerprint binding for anti-piracy
|
||||
- HTTPS transport encryption
|
||||
- Multi-language error message support (Chinese/English/Japanese)
|
||||
|
||||
- **Performance**:
|
||||
- **High Concurrency**: Go native goroutines support, theoretically supports 10,000+ concurrent connections
|
||||
- **Low Latency**: Average API response time < 50ms
|
||||
- **Memory Optimized**: Go GC optimization, memory usage < 100MB
|
||||
- **Database Connection Pool**: Connection reuse for maximum database performance
|
||||
|
||||
- **Reliability**:
|
||||
- Comprehensive error handling with multi-language error messages
|
||||
- Structured logging and monitoring
|
||||
- Automatic database migrations
|
||||
- Graceful shutdown and resource cleanup
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone <repository-url>
|
||||
cd license-manager
|
||||
git clone https://github.com/cedar-v/license-manager.git
|
||||
cd license-manager/backend/cmd
|
||||
|
||||
# Build the application
|
||||
go build -o license-manager
|
||||
@@ -64,16 +79,78 @@ cp config.example.yaml config.yaml
|
||||
## Docker Deployment
|
||||
|
||||
```bash
|
||||
# Build Docker image
|
||||
# Build Docker image (multi-stage build with frontend and backend)
|
||||
docker build -t license-manager .
|
||||
|
||||
# Create configuration file
|
||||
cp backend/configs/config.example.yaml config.yaml
|
||||
# Edit config.yaml to configure database and other settings
|
||||
|
||||
# Run with Docker
|
||||
docker run -p 8080:8080 -v $(pwd)/config.yaml:/app/config.yaml license-manager
|
||||
docker run -d \
|
||||
--name license-manager \
|
||||
-p 18888:18888 \
|
||||
-v $(pwd)/config.yaml:/app/config.yaml \
|
||||
license-manager
|
||||
|
||||
# Check running status
|
||||
docker logs license-manager
|
||||
|
||||
# Health check
|
||||
curl http://localhost:18888/health
|
||||
```
|
||||
|
||||
## License
|
||||
### Docker Compose Deployment (Recommended)
|
||||
|
||||
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
|
||||
```yaml
|
||||
# docker-compose.yml
|
||||
version: '3.8'
|
||||
services:
|
||||
license-manager:
|
||||
build: .
|
||||
ports:
|
||||
- "18888:18888"
|
||||
volumes:
|
||||
- ./config.yaml:/app/config.yaml
|
||||
environment:
|
||||
- GIN_MODE=release
|
||||
restart: unless-stopped
|
||||
|
||||
mysql:
|
||||
image: mysql:8.0
|
||||
environment:
|
||||
MYSQL_ROOT_PASSWORD: root@123
|
||||
MYSQL_DATABASE: license_manager
|
||||
ports:
|
||||
- "3306:3306"
|
||||
volumes:
|
||||
- mysql_data:/var/lib/mysql
|
||||
restart: unless-stopped
|
||||
|
||||
volumes:
|
||||
mysql_data:
|
||||
```
|
||||
|
||||
## Open Source License
|
||||
|
||||
This project is licensed under the **GNU General Public License v3.0 (GPL-3.0)**.
|
||||
|
||||
### License Description
|
||||
|
||||
- **Free Use**: You are free to use, study, modify, and distribute this software
|
||||
- **Open Source Requirement**: If you distribute modified versions, they must also be open source under GPL-3.0 license
|
||||
- **Copyright Protection**: Derivative works using this software must retain the original copyright notice
|
||||
- **No Warranty**: The software is provided "as is" without any express or implied warranty
|
||||
|
||||
### Commercial Use
|
||||
|
||||
- Commercial use is permitted, but derivative works must also be open source
|
||||
- For proprietary licensing or commercial support, please contact the project maintainers
|
||||
|
||||
### Full License Text
|
||||
|
||||
For detailed license terms, please see the [LICENSE](LICENSE) file in the project root directory, or visit:
|
||||
https://www.gnu.org/licenses/gpl-3.0.html
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in new issue
Block a user