Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@

---

## 📋 Security, Billing & Leaderboard Documentation

This directory contains comprehensive documentation for three core New-API modules:

### Available Reports
1. **[SECURITY_BILLING_LEADERBOARD_REPORT.md](./SECURITY_BILLING_LEADERBOARD_REPORT.md)** - Full technical documentation (887 lines)
- Detailed security center architecture and features
- Complete billing system design and implementation
- Leaderboard functionality and integration points
- API endpoints, data models, and best practices
- Troubleshooting and extension guidelines

2. **[SECURITY_BILLING_LEADERBOARD_SUMMARY.md](./SECURITY_BILLING_LEADERBOARD_SUMMARY.md)** - Quick reference guide (234 lines)
- Quick API lookup tables
- Core concepts and configuration
- Common troubleshooting
- Resource links

### Key Topics

#### 🔒 Security Center
- Violation detection and recording
- User ban management
- Model redirection configuration
- Automatic ban mechanism
- Dashboard statistics

#### 💰 Billing System
- Token counting and quota management
- Top-up (recharge) functionality
- Payment gateway integration (EPay, Stripe)
- Subscription plans
- Voucher system
- New Billing Engine architecture

#### 🏆 Leaderboard
- User statistics and rankings
- Multi-window time support
- Token IP usage tracking
- Performance optimization

### Quick Links
- [Full Report](./SECURITY_BILLING_LEADERBOARD_REPORT.md)
- [Quick Reference](./SECURITY_BILLING_LEADERBOARD_SUMMARY.md)

---
Loading