📝 docs: Add documentation
This commit is contained in:
web@ppanel
@@ -0,0 +1,380 @@
|
||||
# Announcement Management
|
||||
|
||||
The Announcement Management module publishes and manages system announcements to communicate important information to users.
|
||||
|
||||
## Overview
|
||||
|
||||
### Announcement List
|
||||
|
||||
View and manage all announcements:
|
||||
|
||||
- **Title**: Announcement topic
|
||||
- **Type**: System/Maintenance/Activity/Update
|
||||
- **Status**: Draft/Published/Offline
|
||||
- **Publish Time**: Publication datetime
|
||||
- **Display Position**: Homepage/User Center/Admin
|
||||
- **Priority**: High/Medium/Low
|
||||
- **Views**: View count
|
||||
|
||||
### Create Announcement
|
||||
|
||||
Publish new announcement:
|
||||
|
||||
#### Basic Info
|
||||
|
||||
- **Title**: Concise title
|
||||
- **Type**: Select type
|
||||
- **Content**: Detailed content (rich text)
|
||||
- **Summary**: Brief summary (list display)
|
||||
|
||||
#### Display Settings
|
||||
|
||||
- **Display Position**: Choose locations
|
||||
- Homepage Banner
|
||||
- Announcement Bar
|
||||
- User Center
|
||||
- Admin Panel
|
||||
- Popup Alert
|
||||
|
||||
- **Display Style**: Configure style
|
||||
- Banner style
|
||||
- List style
|
||||
- Popup style
|
||||
- Floating alert
|
||||
|
||||
#### Publish Settings
|
||||
|
||||
- **Publish Time**:
|
||||
- Publish now
|
||||
- Scheduled publish
|
||||
- Specific datetime
|
||||
|
||||
- **Offline Time**:
|
||||
- Permanent display
|
||||
- Specific offline time
|
||||
- Manual offline
|
||||
|
||||
- **Priority**: Set display priority
|
||||
|
||||
#### Target Users
|
||||
|
||||
- **All Users**: Show to everyone
|
||||
- **New Users**: New registrations only
|
||||
- **Existing Users**: Existing users only
|
||||
- **Specific Groups**: Designated groups
|
||||
- **VIP Users**: VIP users only
|
||||
|
||||
### Edit Announcement
|
||||
|
||||
Modify published announcement:
|
||||
|
||||
- Update content
|
||||
- Adjust display settings
|
||||
- Modify publish time
|
||||
- Change target users
|
||||
|
||||
::: tip Tip
|
||||
Modifying published announcements affects live display. Use caution.
|
||||
:::
|
||||
|
||||
### Delete Announcement
|
||||
|
||||
Remove announcement:
|
||||
|
||||
- **Offline**: Stop display but keep data
|
||||
- **Delete**: Permanently remove
|
||||
- Reading records retained for stats
|
||||
|
||||
## Announcement Types
|
||||
|
||||
### System Announcement
|
||||
|
||||
Important system notifications:
|
||||
|
||||
**Use Cases**:
|
||||
- System upgrade notice
|
||||
- Terms of service changes
|
||||
- Policy adjustments
|
||||
- Major feature launches
|
||||
|
||||
**Examples**:
|
||||
- System maintenance at XX time
|
||||
- Service agreement update
|
||||
- New feature announcement
|
||||
|
||||
### Maintenance Announcement
|
||||
|
||||
System maintenance notices:
|
||||
|
||||
**Use Cases**:
|
||||
- Scheduled maintenance
|
||||
- Incident explanation
|
||||
- Service recovery notice
|
||||
|
||||
**Examples**:
|
||||
- Regular maintenance notice
|
||||
- Emergency incident alert
|
||||
- Service restored notification
|
||||
|
||||
### Activity Announcement
|
||||
|
||||
Marketing activity notices:
|
||||
|
||||
**Use Cases**:
|
||||
- Promotion preview
|
||||
- Discount information
|
||||
- Activity rules
|
||||
|
||||
**Examples**:
|
||||
- Double 11 sale preview
|
||||
- Limited-time offer
|
||||
- New user exclusive
|
||||
|
||||
### Update Announcement
|
||||
|
||||
Product update notes:
|
||||
|
||||
**Use Cases**:
|
||||
- Feature updates
|
||||
- Product optimization
|
||||
- Bug fix notes
|
||||
|
||||
**Examples**:
|
||||
- v2.0 update notes
|
||||
- New XX feature
|
||||
- Performance optimization
|
||||
|
||||
## Announcement Display
|
||||
|
||||
### Banner
|
||||
|
||||
Homepage carousel banner:
|
||||
|
||||
- Large image, strong visual impact
|
||||
- Multi-image carousel
|
||||
- Click to detail page
|
||||
- Suitable for major campaigns
|
||||
|
||||
### List
|
||||
|
||||
Announcement list display:
|
||||
|
||||
- Title list format
|
||||
- Category filtering
|
||||
- Click for details
|
||||
- Suitable for regular announcements
|
||||
|
||||
### Popup
|
||||
|
||||
Popup alert:
|
||||
|
||||
- Display on login
|
||||
- Mandatory reading
|
||||
- Close after confirmation
|
||||
- Suitable for important notices
|
||||
|
||||
### Floating Bar
|
||||
|
||||
Floating alert bar:
|
||||
|
||||
- Float at page top
|
||||
- Manually closable
|
||||
- Non-intrusive
|
||||
- Suitable for tips
|
||||
|
||||
## Announcement Push
|
||||
|
||||
### On-site Push
|
||||
|
||||
Push within system:
|
||||
|
||||
- **Homepage Display**: Prominent position
|
||||
- **Message Center**: Push to message center
|
||||
- **Popup Alert**: Login popup
|
||||
- **Email Push**: Send email
|
||||
|
||||
### Targeted Push
|
||||
|
||||
Push to specific users:
|
||||
|
||||
- Push by user group
|
||||
- Push by user tags
|
||||
- Push by user behavior
|
||||
- Personalized content
|
||||
|
||||
### Push Timing
|
||||
|
||||
Choose optimal timing:
|
||||
|
||||
- **Immediate**: Urgent announcements
|
||||
- **Scheduled**: Optimal time
|
||||
- **Event Triggered**: Specific events
|
||||
- **Periodic**: Regular push
|
||||
|
||||
## Statistics
|
||||
|
||||
### Reading Stats
|
||||
|
||||
Track reading:
|
||||
|
||||
- **Views**: View count
|
||||
- **Read Rate**: Reading user ratio
|
||||
- **Readers**: User list
|
||||
- **Time Distribution**: Reading time
|
||||
|
||||
### Click Stats
|
||||
|
||||
Track clicks:
|
||||
|
||||
- **Clicks**: Click count
|
||||
- **Click Rate**: Click/impression ratio
|
||||
- **Link Tracking**: External link clicks
|
||||
- **Conversion**: Announcement conversions
|
||||
|
||||
### Effect Analysis
|
||||
|
||||
Analyze effectiveness:
|
||||
|
||||
- **Reach Rate**: Push reach rate
|
||||
- **Engagement**: User engagement
|
||||
- **Conversion**: Conversion effects
|
||||
- **User Feedback**: Feedback opinions
|
||||
|
||||
## Templates
|
||||
|
||||
### Common Templates
|
||||
|
||||
Preset templates:
|
||||
|
||||
- **Maintenance Template**: Standard format
|
||||
- **Campaign Template**: Activity format
|
||||
- **Update Template**: Update notes format
|
||||
- **Urgent Template**: Emergency format
|
||||
|
||||
### Custom Templates
|
||||
|
||||
Create custom templates:
|
||||
|
||||
- Design announcement style
|
||||
- Define content structure
|
||||
- Save as template
|
||||
- Reuse templates
|
||||
|
||||
## Approval
|
||||
|
||||
### Approval Flow
|
||||
|
||||
Announcement approval:
|
||||
|
||||
1. **Create Draft**: Edit content
|
||||
2. **Submit**: Submit for review
|
||||
3. **Review**: Reviewer checks
|
||||
4. **Publish**: Publish after approval
|
||||
5. **Monitor**: Track after publish
|
||||
|
||||
### Approval Permissions
|
||||
|
||||
Set permissions:
|
||||
|
||||
- **Create**: Who can create
|
||||
- **Review**: Who can review
|
||||
- **Publish**: Who can publish
|
||||
- **Delete**: Who can delete
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Content Writing
|
||||
|
||||
- Clear, concise title highlighting key points
|
||||
- Accurate, complete content avoiding ambiguity
|
||||
- Plain language, user-friendly
|
||||
- Bold important information
|
||||
- Provide contact information
|
||||
|
||||
### Publish Timing
|
||||
|
||||
- Choose active user periods
|
||||
- Avoid holidays for important notices
|
||||
- Urgent announcements publish immediately
|
||||
- Regular announcements schedule ahead
|
||||
|
||||
### Frequency Control
|
||||
|
||||
- Avoid over-notification
|
||||
- Control announcement quantity
|
||||
- Prioritize important announcements
|
||||
- Clean up expired announcements
|
||||
|
||||
### Effect Tracking
|
||||
|
||||
- Monitor reading data
|
||||
- Collect user feedback
|
||||
- Analyze effectiveness
|
||||
- Continuous optimization
|
||||
|
||||
## Scenario Examples
|
||||
|
||||
### Maintenance Notice
|
||||
|
||||
**Title**: System Maintenance Notice
|
||||
|
||||
**Content**:
|
||||
- Time: 2024-01-01 02:00-06:00
|
||||
- Content: System upgrade and optimization
|
||||
- Impact: All services temporarily unavailable
|
||||
- Compensation: 1 day membership extension
|
||||
|
||||
### Campaign Preview
|
||||
|
||||
**Title**: Double 11 Festival
|
||||
|
||||
**Content**:
|
||||
- Time: Nov 11 00:00-23:59
|
||||
- Content: 50% off sitewide
|
||||
- Coupons: $20 off $100
|
||||
- How to Join: Click for details
|
||||
|
||||
### Feature Launch
|
||||
|
||||
**Title**: New Feature Launch
|
||||
|
||||
**Content**:
|
||||
- Feature: Traffic statistics
|
||||
- Description: Real-time traffic tracking
|
||||
- How to Use: User Center - Traffic Stats
|
||||
- Feedback: Welcome suggestions
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Announcement Not Showing
|
||||
|
||||
Check:
|
||||
|
||||
1. Is announcement published
|
||||
2. Is publish time correct
|
||||
3. Is target user setting correct
|
||||
4. Is display position correct
|
||||
|
||||
### Display Anomaly
|
||||
|
||||
Possible causes:
|
||||
|
||||
1. Content format issues
|
||||
2. Image link broken
|
||||
3. Style conflicts
|
||||
4. Browser compatibility
|
||||
|
||||
### Push Failed
|
||||
|
||||
Check:
|
||||
|
||||
1. Is push config correct
|
||||
2. Is user contact valid
|
||||
3. Is push service working
|
||||
4. Reached push limits
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Marketing Management](/admin/commerce/marketing) - Plan campaigns
|
||||
- [User Management](/admin/users-support/users) - Manage target users
|
||||
- [System Config](/admin/system/config) - Configure announcement system
|
||||
@@ -0,0 +1,176 @@
|
||||
<div v-pre>
|
||||
|
||||
# Coupon Management
|
||||
|
||||
Manage coupons in the system, including creating, editing, and enabling/disabling functions. Coupons provide purchase discounts for users.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Enable
|
||||
Switch button to control whether the coupon is available. When off, users cannot use this coupon.
|
||||
|
||||
### Name
|
||||
Coupon name for management identification.
|
||||
|
||||
### Code
|
||||
Coupon redemption code that users enter during purchase to apply the coupon.
|
||||
|
||||
### Type
|
||||
Coupon discount type:
|
||||
- **Percentage** - Discount by percentage (e.g., 10%)
|
||||
- **Amount** - Fixed amount discount (e.g., $50)
|
||||
|
||||
### Discount
|
||||
Discount value:
|
||||
- Percentage type shows percentage (e.g., 10%)
|
||||
- Amount type shows currency amount (e.g., $50)
|
||||
|
||||
### Count
|
||||
Displays three lines of information:
|
||||
- **Count** - Total available usage count (0 = unlimited)
|
||||
- **Remaining** - Remaining usage count
|
||||
- **Usage Times** - Times already used
|
||||
|
||||
### Validity Period
|
||||
Coupon's valid time range:
|
||||
- Shows start time and end time
|
||||
- If only start time, shows single time
|
||||
- No restriction shows "--"
|
||||
|
||||
## Table Operations
|
||||
|
||||
### Edit
|
||||
Opens side drawer form to modify coupon information.
|
||||
|
||||
### Delete
|
||||
Deletes coupon (requires confirmation), used coupons can also be deleted.
|
||||
|
||||
### Batch Delete
|
||||
Deletes multiple selected coupons.
|
||||
|
||||
## Coupon Form
|
||||
|
||||
### Name (Required)
|
||||
Management name for the coupon, not displayed to users.
|
||||
|
||||
### Custom Coupon Code (Optional)
|
||||
Custom redemption code, leave blank for system auto-generation.
|
||||
|
||||
### Coupon Type (Required)
|
||||
Radio button to select type:
|
||||
- **Percentage Discount** - Discount by order amount percentage
|
||||
- **Amount Discount** - Fixed amount reduction
|
||||
|
||||
### Discount Value (Required)
|
||||
Input based on type:
|
||||
- **Percentage**: Enter number 1-100 with % suffix
|
||||
- **Amount**: Enter currency amount
|
||||
|
||||
### Specified Subscription (Optional)
|
||||
Multi-select dropdown to choose applicable product plans:
|
||||
- Leave blank for all products
|
||||
- Select specific products for those only
|
||||
|
||||
### Start Time (Optional)
|
||||
Coupon activation time:
|
||||
- Use date picker
|
||||
- Cannot select past dates (before yesterday)
|
||||
- Leave blank for immediate effect
|
||||
|
||||
### Expire Time (Optional)
|
||||
Coupon expiration time:
|
||||
- Use date picker
|
||||
- Leave blank for never expires
|
||||
|
||||
### Max Usage Count (Optional)
|
||||
Total times the coupon can be used:
|
||||
- 0 or blank for unlimited
|
||||
- Automatically expires when count reached
|
||||
|
||||
### Max Usage Count per User (Optional)
|
||||
Times a single user can use this coupon:
|
||||
- 0 or blank for unlimited
|
||||
- Prevents repeated use by single user
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Subscribe Filter
|
||||
Select product plan to view exclusive coupons for that product.
|
||||
|
||||
### Keyword Search
|
||||
Search coupons by name or code.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: Create New User Registration Coupon
|
||||
|
||||
**Form Configuration**:
|
||||
- Name: New User Discount
|
||||
- Code: NEWUSER2024 (custom)
|
||||
- Type: Percentage Discount
|
||||
- Discount: 20%
|
||||
- Specified Subscription: Leave blank (all products)
|
||||
- Start Time: 2024-01-01
|
||||
- Expire Time: 2024-12-31
|
||||
- Max Usage Count: 0 (unlimited)
|
||||
- Max Usage Count per User: 1
|
||||
|
||||
**Effect**: Each new user can use once, valid all year, 20% off all products.
|
||||
|
||||
### Scenario 2: Create Limited-Time Promotion Coupon
|
||||
|
||||
**Form Configuration**:
|
||||
- Name: Double 11 Promotion
|
||||
- Code: Leave blank (auto-generate)
|
||||
- Type: Amount Discount
|
||||
- Discount: $50
|
||||
- Specified Subscription: Select "Annual Plan"
|
||||
- Start Time: 2024-11-11 00:00
|
||||
- Expire Time: 2024-11-11 23:59
|
||||
- Max Usage Count: 100
|
||||
- Max Usage Count per User: 1
|
||||
|
||||
**Effect**: First 100 users on Double 11 get $50 off annual plan, one per user.
|
||||
|
||||
### Scenario 3: Create Exclusive VIP Coupon
|
||||
|
||||
**Form Configuration**:
|
||||
- Name: VIP Exclusive
|
||||
- Code: VIP888 (custom)
|
||||
- Type: Percentage Discount
|
||||
- Discount: 30%
|
||||
- Specified Subscription: Select "Premium Plan"
|
||||
- Start Time: Leave blank
|
||||
- Expire Time: Leave blank
|
||||
- Max Usage Count: 0 (unlimited)
|
||||
- Max Usage Count per User: 0 (unlimited)
|
||||
|
||||
**Effect**: VIP users can use unlimited times, 30% off premium plan.
|
||||
|
||||
### Scenario 4: Create One-Time Coupon Code
|
||||
|
||||
**Form Configuration**:
|
||||
- Name: Thank You Gift
|
||||
- Code: THANKS100 (custom)
|
||||
- Type: Amount Discount
|
||||
- Discount: $100
|
||||
- Specified Subscription: Leave blank (all products)
|
||||
- Start Time: Leave blank
|
||||
- Expire Time: Leave blank
|
||||
- Max Usage Count: 1
|
||||
- Max Usage Count per User: 1
|
||||
|
||||
**Effect**: Single-use thank you coupon, first come first served.
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Enable Control**: New coupons default to disabled, must manually enable for users
|
||||
2. **Code Uniqueness**: Custom codes must be unique, duplicates will fail
|
||||
3. **Auto-Generation**: Leave code blank for system to auto-generate random code
|
||||
4. **Product Restriction**: Specified subscriptions apply only to selected products
|
||||
5. **Time Range**: Start time cannot be in past, expire time can be blank
|
||||
6. **Usage Count**: 0 or blank means unlimited
|
||||
7. **User Limit**: Per-user limit prevents abuse
|
||||
8. **Delete Impact**: Deleting coupons doesn't affect already-used orders
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,354 @@
|
||||
# Coupon Management
|
||||
|
||||
The Coupon Management module creates and manages various coupons, which is an important tool for promotional activities.
|
||||
|
||||
## Overview
|
||||
|
||||
### Coupon List
|
||||
|
||||
View and manage all coupons:
|
||||
|
||||
- **Coupon Name**: Display name
|
||||
- **Coupon Type**: Spend threshold/Discount/Voucher
|
||||
- **Discount Amount**: Reduction or discount percentage
|
||||
- **Usage Conditions**: Minimum spend required
|
||||
- **Distribution**: Total and remaining quantity
|
||||
- **Validity**: Valid time range
|
||||
- **Applicable Scope**: Applicable products or users
|
||||
- **Status**: Active/Ended/Paused
|
||||
|
||||
### Create Coupon
|
||||
|
||||
Create new coupon:
|
||||
|
||||
#### Basic Info
|
||||
|
||||
- **Coupon Name**: Identifiable name
|
||||
- **Description**: Detailed discount description
|
||||
- **Coupon Code**: Redemption code (auto-generate)
|
||||
- **Coupon Type**: Select discount type
|
||||
|
||||
#### Discount Settings
|
||||
|
||||
**Spend Threshold Coupon**
|
||||
- Spend X get Y off
|
||||
- Multi-tier thresholds
|
||||
|
||||
**Discount Coupon**
|
||||
- Discount percentage (e.g., 20% off)
|
||||
- Maximum discount cap
|
||||
|
||||
**Voucher**
|
||||
- Direct fixed amount deduction
|
||||
- Or redeem specific product
|
||||
|
||||
#### Usage Conditions
|
||||
|
||||
- **Minimum Spend**: Order threshold
|
||||
- **Applicable Products**: Specified products
|
||||
- **Applicable Users**: New/Existing/All
|
||||
- **Usage Limit**: Times per person
|
||||
- **Stacking Rules**: Combine with other offers
|
||||
|
||||
#### Distribution Settings
|
||||
|
||||
- **Distribution Method**:
|
||||
- Public claim: Everyone can claim
|
||||
- Targeted: Specific users
|
||||
- Redemption code: Enter code to claim
|
||||
- Auto-distribution: Auto-grant on conditions
|
||||
|
||||
- **Distribution Quantity**: Total limit
|
||||
- **Claim Limit**: Per-person claim limit
|
||||
|
||||
#### Validity Settings
|
||||
|
||||
- **Fixed Time**: Specific start/end dates
|
||||
- **Days After Claim**: Valid N days after claim
|
||||
- **Permanent**: No expiration
|
||||
|
||||
### Edit Coupon
|
||||
|
||||
Modify coupon config:
|
||||
|
||||
- Adjust discount amount and conditions
|
||||
- Increase distribution quantity
|
||||
- Extend validity period
|
||||
- Modify applicable scope
|
||||
|
||||
::: tip Tip
|
||||
Config changes don't affect coupons already claimed by users.
|
||||
:::
|
||||
|
||||
### Delete Coupon
|
||||
|
||||
Delete coupon:
|
||||
|
||||
- **Soft Delete**: Deactivate but keep data
|
||||
- **Hard Delete**: Permanently delete
|
||||
- Used coupon records are retained
|
||||
|
||||
## Coupon Types
|
||||
|
||||
### Spend Threshold
|
||||
|
||||
Discount after meeting amount:
|
||||
|
||||
**Use Cases**:
|
||||
- Promote large orders
|
||||
- Increase AOV
|
||||
- Clearance sales
|
||||
|
||||
**Examples**:
|
||||
- $10 off $100
|
||||
- $30 off $200
|
||||
- $100 off $500
|
||||
|
||||
### Discount
|
||||
|
||||
Percentage discount:
|
||||
|
||||
**Use Cases**:
|
||||
- Holiday promotions
|
||||
- Member exclusive
|
||||
- New product launch
|
||||
|
||||
**Examples**:
|
||||
- 10% off
|
||||
- 20% off (max $50)
|
||||
- 30% off (new users only)
|
||||
|
||||
### Voucher
|
||||
|
||||
Direct amount deduction:
|
||||
|
||||
**Use Cases**:
|
||||
- User compensation
|
||||
- Promotion rewards
|
||||
- Points redemption
|
||||
|
||||
**Examples**:
|
||||
- $10 no-threshold voucher
|
||||
- $50 trial voucher
|
||||
- $100 cash voucher
|
||||
|
||||
### Product Voucher
|
||||
|
||||
Redeem specific product:
|
||||
|
||||
**Use Cases**:
|
||||
- Gift distribution
|
||||
- Event rewards
|
||||
- Points store
|
||||
|
||||
**Examples**:
|
||||
- 1-month package voucher
|
||||
- 100GB traffic voucher
|
||||
|
||||
## Coupon Distribution
|
||||
|
||||
### Batch Distribution
|
||||
|
||||
Distribute coupons to multiple users:
|
||||
|
||||
1. Select coupon to distribute
|
||||
2. Select target user group
|
||||
3. Set distribution quantity
|
||||
4. Confirm distribution
|
||||
|
||||
**Target Recipients**:
|
||||
- All users
|
||||
- Specific user groups
|
||||
- Newly registered
|
||||
- High-value users
|
||||
- At-risk churners
|
||||
|
||||
### Redemption Code
|
||||
|
||||
Generate coupon codes:
|
||||
|
||||
- **Batch Generate**: Generate multiple codes
|
||||
- **Custom Prefix**: Set code prefix
|
||||
- **Export Codes**: Export Excel file
|
||||
- **Code Management**: View usage status
|
||||
|
||||
### Auto-Distribution
|
||||
|
||||
Configure auto-distribution rules:
|
||||
|
||||
**Trigger Conditions**:
|
||||
- On user registration
|
||||
- After first purchase
|
||||
- Before subscription expiry
|
||||
- On spending milestone
|
||||
- On birthday
|
||||
|
||||
**Distribution Content**:
|
||||
- Specific coupon
|
||||
- Random coupon
|
||||
- Tiered coupons
|
||||
|
||||
## Coupon Usage
|
||||
|
||||
### Usage Flow
|
||||
|
||||
User coupon usage process:
|
||||
|
||||
1. **Claim Coupon**: User claims or receives coupon
|
||||
2. **View Coupons**: Check available coupons in account
|
||||
3. **Order Usage**: Select coupon when placing order
|
||||
4. **System Validation**: Verify usage conditions
|
||||
5. **Calculate Discount**: Auto-calculate discount
|
||||
6. **Complete Payment**: Pay discounted price
|
||||
|
||||
### Usage Restrictions
|
||||
|
||||
Control coupon usage:
|
||||
|
||||
- **Single Use**: Limit coupons per order
|
||||
- **Time Restriction**: Specific time periods
|
||||
- **Product Restriction**: Specific products
|
||||
- **User Restriction**: Specific user groups
|
||||
- **Device Restriction**: Limit devices
|
||||
|
||||
### Usage Rules
|
||||
|
||||
Coupon usage rule settings:
|
||||
|
||||
- **Priority**: Order of multiple coupons
|
||||
- **Stacking**: Combine with other offers
|
||||
- **Partial Refund**: Coupon handling on refund
|
||||
- **Expiry Reminder**: Notify before expiration
|
||||
|
||||
## Coupon Statistics
|
||||
|
||||
### Distribution Stats
|
||||
|
||||
Track coupon distribution:
|
||||
|
||||
- **Total Distributed**: Distributed quantity
|
||||
- **Claim Rate**: Claim rate and users
|
||||
- **Stock Remaining**: Available quantity
|
||||
- **Distribution Trend**: Daily distribution changes
|
||||
|
||||
### Usage Stats
|
||||
|
||||
Analyze coupon usage:
|
||||
|
||||
- **Usage Rate**: Used/Distributed ratio
|
||||
- **Discount Amount**: Total discount given
|
||||
- **Orders with Coupons**: Order count
|
||||
- **Users with Coupons**: User count
|
||||
|
||||
### Effect Analysis
|
||||
|
||||
Evaluate coupon effectiveness:
|
||||
|
||||
- **Conversion Rate**: Purchase conversion after claim
|
||||
- **AOV**: Average order value with coupons
|
||||
- **ROI Analysis**: Return on investment
|
||||
- **User Distribution**: User profile
|
||||
|
||||
## Coupon Promotion
|
||||
|
||||
### Promotion Channels
|
||||
|
||||
Promote coupons through channels:
|
||||
|
||||
- **On-site**: Homepage banner, popups
|
||||
- **Email**: Send coupon emails
|
||||
- **SMS**: SMS notifications
|
||||
- **Social Media**: Share to social platforms
|
||||
- **Referral Links**: Generate exclusive links
|
||||
|
||||
### Promotion Activities
|
||||
|
||||
Plan coupon campaigns:
|
||||
|
||||
- **Limited Flash**: Limited-time coupon grab
|
||||
- **Share to Claim**: Get coupons after sharing
|
||||
- **Check-in**: Daily check-in rewards
|
||||
- **Referral Bonus**: Refer friends get coupons
|
||||
- **Purchase Rebate**: Get coupons after purchase
|
||||
|
||||
## Coupon Templates
|
||||
|
||||
### Common Templates
|
||||
|
||||
Preset common coupon templates:
|
||||
|
||||
- New user exclusive
|
||||
- Member birthday coupon
|
||||
- Holiday promotion
|
||||
- Spend threshold coupon
|
||||
- Repurchase coupon
|
||||
|
||||
### Custom Templates
|
||||
|
||||
Create custom templates:
|
||||
|
||||
- Save common configs
|
||||
- Quick create similar coupons
|
||||
- Copy and edit templates
|
||||
|
||||
## Risk Control
|
||||
|
||||
### Anti-fraud
|
||||
|
||||
Prevent malicious coupon abuse:
|
||||
|
||||
- **Claim Limits**: IP, device restrictions
|
||||
- **Identity Verification**: Require verification
|
||||
- **Usage Monitoring**: Monitor abnormal usage
|
||||
- **Blacklist**: Block fraudulent users
|
||||
|
||||
### Risk Alerts
|
||||
|
||||
Coupon risk warnings:
|
||||
|
||||
- Abnormal claiming alerts
|
||||
- Low stock reminders
|
||||
- Budget overrun warnings
|
||||
- Fraud behavior alerts
|
||||
|
||||
## Best Practices
|
||||
|
||||
- Set reasonable thresholds to avoid losses
|
||||
- Control total distribution and budget
|
||||
- Regularly analyze coupon effectiveness
|
||||
- Target different user groups
|
||||
- Coordinate with marketing campaigns
|
||||
- Clean up expired and invalid coupons
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Cannot Use Coupon
|
||||
|
||||
Check:
|
||||
|
||||
1. Are usage conditions met
|
||||
2. Is coupon expired
|
||||
3. Is product in applicable scope
|
||||
4. Is minimum spend reached
|
||||
|
||||
### Incorrect Discount
|
||||
|
||||
Possible reasons:
|
||||
|
||||
1. Coupon config error
|
||||
2. Multiple coupon stacking issues
|
||||
3. Threshold tier settings
|
||||
|
||||
### Distribution Failed
|
||||
|
||||
Check:
|
||||
|
||||
1. Is stock sufficient
|
||||
2. Does user meet claim conditions
|
||||
3. Is system configured correctly
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Marketing Management](/admin/commerce/marketing) - Create campaigns
|
||||
- [Order Management](/admin/commerce/orders) - View coupon usage
|
||||
- [User Management](/admin/users-support/users) - Distribute coupons
|
||||
@@ -0,0 +1,354 @@
|
||||
# Marketing Management
|
||||
|
||||
The Marketing Management module plans and executes various marketing campaigns to boost user growth and revenue.
|
||||
|
||||
## Overview
|
||||
|
||||
### Campaign List
|
||||
|
||||
View and manage all campaigns:
|
||||
|
||||
- **Campaign Name**: Marketing campaign title
|
||||
- **Campaign Type**: Promotion/Acquisition/Retention/Conversion
|
||||
- **Status**: Not started/Active/Ended
|
||||
- **Duration**: Start and end time
|
||||
- **Participants**: Number of participating users
|
||||
- **Conversion**: Conversion rate and revenue
|
||||
- **Budget**: Budget and actual spending
|
||||
|
||||
### Create Campaign
|
||||
|
||||
Plan new marketing campaign:
|
||||
|
||||
#### Campaign Info
|
||||
|
||||
- **Campaign Name**: Theme name
|
||||
- **Campaign Type**: Select type
|
||||
- **Description**: Detailed explanation
|
||||
- **Tags**: For categorization
|
||||
|
||||
#### Campaign Duration
|
||||
|
||||
- **Start Time**: Campaign start datetime
|
||||
- **End Time**: Campaign end datetime
|
||||
- **Pre-launch**: Campaign teaser period
|
||||
- **Cool-down**: Post-campaign handling period
|
||||
|
||||
#### Campaign Rules
|
||||
|
||||
- **Participation**: User eligibility
|
||||
- **Rewards**: Reward content and rules
|
||||
- **Restrictions**: Participation limits
|
||||
- **Calculation**: Points, ranking calculations
|
||||
|
||||
#### Marketing Materials
|
||||
|
||||
- **Campaign Images**: Posters, banners
|
||||
- **Campaign Copy**: Promotional content
|
||||
- **Social Assets**: Social media shares
|
||||
- **Landing Page**: Campaign page link
|
||||
|
||||
## Campaign Types
|
||||
|
||||
### Acquisition
|
||||
|
||||
Attract new user registration:
|
||||
|
||||
**Campaign Forms**:
|
||||
- New user registration rewards
|
||||
- First purchase discount
|
||||
- Referral rewards
|
||||
- New user exclusive packages
|
||||
|
||||
**KPIs**:
|
||||
- New user registrations
|
||||
- New user conversion rate
|
||||
- Customer acquisition cost (CAC)
|
||||
- New user quality
|
||||
|
||||
### Promotion
|
||||
|
||||
Stimulate purchases:
|
||||
|
||||
**Campaign Forms**:
|
||||
- Limited-time discount
|
||||
- Spend threshold discount
|
||||
- Buy one get one
|
||||
- Bundle offers
|
||||
|
||||
**KPIs**:
|
||||
- Sales growth
|
||||
- Order quantity
|
||||
- AOV change
|
||||
- ROI
|
||||
|
||||
### Retention
|
||||
|
||||
Improve user retention:
|
||||
|
||||
**Campaign Forms**:
|
||||
- Daily check-in rewards
|
||||
- Consecutive login bonuses
|
||||
- Member day specials
|
||||
- Renewal discounts
|
||||
|
||||
**KPIs**:
|
||||
- User activity
|
||||
- Retention rate improvement
|
||||
- Churn rate reduction
|
||||
- Lifetime value
|
||||
|
||||
### Conversion
|
||||
|
||||
Promote user payment:
|
||||
|
||||
**Campaign Forms**:
|
||||
- Trial to paid discount
|
||||
- Upgrade package discount
|
||||
- First order discount
|
||||
- Flash sale
|
||||
|
||||
**KPIs**:
|
||||
- Payment conversion rate
|
||||
- Upgrade conversion rate
|
||||
- Average payment amount
|
||||
- Paying user growth
|
||||
|
||||
## Promotion Channels
|
||||
|
||||
### On-site Promotion
|
||||
|
||||
Promote within system:
|
||||
|
||||
- **Homepage Banner**: Carousel display
|
||||
- **Popup**: Login popup reminders
|
||||
- **Push Notifications**: In-app messages
|
||||
- **Campaign Zone**: Campaign hub page
|
||||
|
||||
### Email Promotion
|
||||
|
||||
Email marketing:
|
||||
|
||||
- **Marketing Emails**: Send campaign emails
|
||||
- **Email Templates**: Beautiful templates
|
||||
- **Segmented Sending**: Target user groups
|
||||
- **Effectiveness Tracking**: Open, click rates
|
||||
|
||||
### SMS Promotion
|
||||
|
||||
SMS marketing:
|
||||
|
||||
- **SMS Notifications**: Send campaign SMS
|
||||
- **SMS Templates**: Preset content
|
||||
- **Scheduled Sending**: Set send time
|
||||
- **Effect Statistics**: Delivery rate
|
||||
|
||||
### Social Media
|
||||
|
||||
Social platform promotion:
|
||||
|
||||
- **Social Sharing**: User shares
|
||||
- **Community Operations**: WeChat, QQ groups
|
||||
- **KOL Collaboration**: Influencer partnerships
|
||||
- **Content Marketing**: Publish content
|
||||
|
||||
## User Segmentation
|
||||
|
||||
### User Profiling
|
||||
|
||||
Segment by characteristics:
|
||||
|
||||
- **Basic Attributes**: Age, region, gender
|
||||
- **Behavioral**: Activity, usage frequency
|
||||
- **Consumption**: Spending, purchase frequency
|
||||
- **Lifecycle**: New, active, dormant, churned
|
||||
|
||||
### Precision Marketing
|
||||
|
||||
Target different segments:
|
||||
|
||||
- **New Users**: Welcome, onboarding
|
||||
- **Active Users**: Payment conversion, upgrades
|
||||
- **High-Value Users**: VIP privileges, exclusives
|
||||
- **Dormant Users**: Reactivation, return rewards
|
||||
- **Churn Risk**: Retention offers, exclusive service
|
||||
|
||||
## Campaign Execution
|
||||
|
||||
### Campaign Launch
|
||||
|
||||
Officially start:
|
||||
|
||||
1. **Final Confirmation**: Check configuration
|
||||
2. **Resource Preparation**: Prepare coupons, prizes
|
||||
3. **Channel Notification**: Start promotion
|
||||
4. **Real-time Monitoring**: Monitor data
|
||||
|
||||
### Campaign Monitoring
|
||||
|
||||
Real-time progress tracking:
|
||||
|
||||
- **Participation Data**: Live participant count
|
||||
- **Conversion Data**: Conversion rate, orders
|
||||
- **Budget Consumption**: Spending tracking
|
||||
- **Anomaly Alerts**: Warning notifications
|
||||
|
||||
### Campaign Adjustment
|
||||
|
||||
Optimize based on data:
|
||||
|
||||
- **Rule Adjustment**: Optimize rules
|
||||
- **Budget Adjustment**: Increase/decrease budget
|
||||
- **Channel Optimization**: Adjust channels
|
||||
- **Material Updates**: Refresh assets
|
||||
|
||||
### Campaign End
|
||||
|
||||
Wrap-up work:
|
||||
|
||||
- **Stop Promotion**: Close channels
|
||||
- **Data Settlement**: Statistics
|
||||
- **Reward Distribution**: Distribute prizes
|
||||
- **Effect Evaluation**: Assess results
|
||||
|
||||
## Data Analysis
|
||||
|
||||
### Participation Data
|
||||
|
||||
Analyze participation:
|
||||
|
||||
- **Participants**: Total user count
|
||||
- **Participation Rate**: Target user ratio
|
||||
- **Channel Mix**: Channel distribution
|
||||
- **Time Distribution**: Participation timing
|
||||
|
||||
### Conversion Data
|
||||
|
||||
Analyze conversion:
|
||||
|
||||
- **Conversion Rate**: Participation to purchase
|
||||
- **Orders**: Orders generated
|
||||
- **Sales**: Revenue generated
|
||||
- **AOV**: Average order value
|
||||
|
||||
### ROI Analysis
|
||||
|
||||
Calculate return on investment:
|
||||
|
||||
- **Total Input**: Total campaign cost
|
||||
- **Total Output**: Total revenue
|
||||
- **ROI**: Return on investment
|
||||
- **Break-even**: Time to break-even
|
||||
|
||||
### User Analysis
|
||||
|
||||
Analyze participants:
|
||||
|
||||
- **User Mix**: New vs existing ratio
|
||||
- **User Quality**: Retention, repurchase
|
||||
- **User Value**: Lifetime value
|
||||
- **User Feedback**: Satisfaction
|
||||
|
||||
## A/B Testing
|
||||
|
||||
### Test Design
|
||||
|
||||
Design A/B test:
|
||||
|
||||
- **Test Goal**: Clear objective
|
||||
- **Test Variable**: Determine variable
|
||||
- **Control Group**: Set control
|
||||
- **Experiment Group**: Set experiment
|
||||
|
||||
### Test Execution
|
||||
|
||||
Execute A/B test:
|
||||
|
||||
- **Random Assignment**: Random user allocation
|
||||
- **Simultaneous Start**: Start together
|
||||
- **Data Collection**: Collect test data
|
||||
- **Result Analysis**: Analyze results
|
||||
|
||||
### Apply Results
|
||||
|
||||
Apply findings:
|
||||
|
||||
- **Select Approach**: Choose best option
|
||||
- **Full Rollout**: Promote to all users
|
||||
- **Continuous Optimization**: Keep iterating
|
||||
|
||||
## Marketing Automation
|
||||
|
||||
### Automated Workflows
|
||||
|
||||
Set automated flows:
|
||||
|
||||
**Triggers**:
|
||||
- User registration
|
||||
- First login
|
||||
- Subscription expiry
|
||||
- Long inactive
|
||||
- Purchase complete
|
||||
|
||||
**Auto Actions**:
|
||||
- Send welcome email
|
||||
- Push coupons
|
||||
- Send reminders
|
||||
- Recommend products
|
||||
|
||||
### Lifecycle Marketing
|
||||
|
||||
Lifecycle-based automation:
|
||||
|
||||
- **Acquisition**: Registration guide, first purchase
|
||||
- **Growth**: Usage guide, upgrade recommendation
|
||||
- **Maturity**: VIP service, renewal discount
|
||||
- **Decline**: Reactivation, retention offers
|
||||
- **Churn**: Return rewards, reactivation
|
||||
|
||||
## Best Practices
|
||||
|
||||
- Define clear goals and KPIs
|
||||
- Understand target user needs
|
||||
- Design attractive rules
|
||||
- Choose right channels
|
||||
- Monitor and adjust quickly
|
||||
- Analyze data thoroughly
|
||||
- Establish marketing SOPs
|
||||
|
||||
## Campaign Examples
|
||||
|
||||
### Double 11 Sale
|
||||
|
||||
**Goal**: Boost sales
|
||||
|
||||
**Content**:
|
||||
- 50% off sitewide
|
||||
- Spend threshold coupons
|
||||
- Flash sales
|
||||
- Share lottery
|
||||
|
||||
**Results**:
|
||||
- 300% sales increase
|
||||
- 200% new user growth
|
||||
- ROI of 3.5
|
||||
|
||||
### Referral Campaign
|
||||
|
||||
**Goal**: User acquisition
|
||||
|
||||
**Content**:
|
||||
- Invite friends get coupons
|
||||
- First purchase rewards both
|
||||
- Referral leaderboard
|
||||
|
||||
**Results**:
|
||||
- 5000+ new users
|
||||
- 40% lower CAC
|
||||
- Viral coefficient 1.8
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Coupon Management](/admin/commerce/coupons) - Configure coupons
|
||||
- [Announcement Management](/admin/commerce/announcements) - Publish announcements
|
||||
- [User Management](/admin/users-support/users) - Analyze user data
|
||||
@@ -0,0 +1,148 @@
|
||||
<div v-pre>
|
||||
|
||||
# Order Management
|
||||
|
||||
View all user orders in the system with support for order status modification and detailed information viewing. This is primarily a read-only order query page, mainly used for order information viewing and exception handling.
|
||||
|
||||
## Page Functions
|
||||
|
||||
The Order Management page is a simple order query and status management tool, providing the following features:
|
||||
|
||||
1. **Order List Viewing** - Display all orders in a table
|
||||
2. **Status Modification** - Modify orders with specific statuses
|
||||
3. **Amount Details** - View price breakdown via hover card
|
||||
4. **Filter & Search** - Quickly locate target orders
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Order Number
|
||||
System-generated unique order identifier for order tracking and querying.
|
||||
|
||||
### Type
|
||||
Business type of the order:
|
||||
- **New Purchase** - User's first purchase of a plan
|
||||
- **Renewal** - Extends time for existing subscription
|
||||
- **Reset Traffic** - Separately purchase traffic reset
|
||||
- **Recharge** - Recharge account balance
|
||||
|
||||
### Subscribe
|
||||
Displays associated product information:
|
||||
- New Purchase/Renewal/Reset Traffic orders: Shows `Product Name × Quantity`
|
||||
- Recharge orders: Shows "Recharge"
|
||||
|
||||
### Amount
|
||||
Total order amount, click to view detailed price breakdown.
|
||||
|
||||
### User
|
||||
Order user information, click to view user details.
|
||||
|
||||
### Update Time
|
||||
Last order status change time.
|
||||
|
||||
### Status
|
||||
Current order status, some statuses support modification:
|
||||
- **Pending** (Orange) - Modifiable
|
||||
- **Paid** (Green) - Read-only
|
||||
- **Cancelled** (Gray) - Modifiable
|
||||
- **Closed** (Red) - Modifiable
|
||||
- **Completed** (Green) - Read-only
|
||||
|
||||
## Core Functions
|
||||
|
||||
### 1. Order Status Modification
|
||||
|
||||
**Modifiable Status**: Pending, Cancelled, Closed
|
||||
|
||||
Steps:
|
||||
1. Find the order to modify
|
||||
2. Click the dropdown selector in status column
|
||||
3. Select new status
|
||||
4. System auto-saves and refreshes
|
||||
|
||||
**Non-modifiable Status**: Paid, Completed
|
||||
|
||||
These two statuses display as read-only badges and cannot be modified.
|
||||
|
||||
**Common Operations**:
|
||||
- Pending → Paid: Manually mark payment complete
|
||||
- Pending → Cancelled: Cancel timeout orders
|
||||
- Pending → Closed: Close abnormal orders
|
||||
- Cancelled → Pending: Restore misoperated orders
|
||||
|
||||
### 2. View Amount Details
|
||||
|
||||
Hover mouse over amount to display complete price breakdown:
|
||||
|
||||
**Price Composition**:
|
||||
- Subscribe Price - Product original price
|
||||
- Discount - Bulk purchase discount
|
||||
- Coupon Discount - Coupon used
|
||||
- Fee Amount - Payment platform fee
|
||||
- Total - Actual payment amount
|
||||
|
||||
**Other Information**:
|
||||
- Trade No - Third-party payment transaction number
|
||||
- Payment Method - Payment platform used
|
||||
|
||||
### 3. Filter and Search
|
||||
|
||||
**Status Filter**: Select order status to view corresponding orders
|
||||
|
||||
**Product Filter**: Select product plan to view related orders
|
||||
|
||||
**User Filter**: Input user ID to view all orders for that user
|
||||
|
||||
**Keyword Search**: Input order number for exact search
|
||||
|
||||
Multiple filter conditions can be used simultaneously.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: Manually Mark Payment Complete
|
||||
|
||||
User payment successful but order status not auto-updated:
|
||||
|
||||
1. Search for order using order number
|
||||
2. Click amount to view trade number
|
||||
3. Confirm payment received on third-party platform
|
||||
4. Click status dropdown and select "Paid"
|
||||
5. System auto-processes and allocates benefits
|
||||
|
||||
### Scenario 2: Cancel Timeout Orders
|
||||
|
||||
Regularly clean up timeout unpaid orders:
|
||||
|
||||
1. Filter "Pending" status
|
||||
2. Check update time to determine timeout
|
||||
3. Click status and select "Cancelled"
|
||||
4. Order marked as cancelled
|
||||
|
||||
### Scenario 3: User Order Query
|
||||
|
||||
User inquires about order issue:
|
||||
|
||||
1. Input user ID in user filter
|
||||
2. View all orders for that user
|
||||
3. Find corresponding order and check status
|
||||
4. Click amount to view detailed information
|
||||
5. Handle issue based on situation
|
||||
|
||||
### Scenario 4: Product Sales Query
|
||||
|
||||
View sales for a specific product:
|
||||
|
||||
1. Select plan in product filter
|
||||
2. View all orders for that product
|
||||
3. Check order counts by different statuses
|
||||
4. Analyze sales trends
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Partial Status Modification** - Only Pending, Cancelled, Closed can be modified
|
||||
2. **Paid Cannot Change** - Paid and Completed orders cannot be modified
|
||||
3. **Modify Carefully** - Status changes trigger benefit updates
|
||||
4. **Verify Payment** - Confirm actual payment before marking as Paid
|
||||
5. **Price Details** - Verify price calculation via amount hover card
|
||||
6. **User Issues** - Use user filter to quickly query user orders
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,291 @@
|
||||
# Order Management
|
||||
|
||||
The Order Management module processes user purchase orders, which is the core of system revenue and business processes.
|
||||
|
||||
## Overview
|
||||
|
||||
### Order List
|
||||
|
||||
View and manage all orders:
|
||||
|
||||
- **Order Number**: Unique order identifier
|
||||
- **User Info**: Buyer name and email
|
||||
- **Product Info**: Purchased product name and specs
|
||||
- **Amount**: Paid amount and original price
|
||||
- **Payment Method**: Alipay/WeChat/Crypto, etc.
|
||||
- **Status**: Pending/Paid/Completed/Canceled/Refunded
|
||||
- **Created**: Order creation time
|
||||
- **Paid**: Payment completion time
|
||||
|
||||
### Order Filtering
|
||||
|
||||
Quickly find specific orders:
|
||||
|
||||
- **By Status**: Pending/Paid/Completed, etc.
|
||||
- **By Date Range**: Today/This week/This month/Custom
|
||||
- **By Payment**: Filter by payment channel
|
||||
- **By User**: View specific user's orders
|
||||
- **By Product**: View specific product sales
|
||||
- **By Amount**: Filter by order amount range
|
||||
|
||||
### Create Order
|
||||
|
||||
Manually create order for user:
|
||||
|
||||
#### Select User
|
||||
|
||||
- Search existing user
|
||||
- Or create new user
|
||||
- Fill in user basic info
|
||||
|
||||
#### Select Product
|
||||
|
||||
- Choose package from product list
|
||||
- Set purchase quantity
|
||||
- View price details
|
||||
|
||||
#### Discount Settings
|
||||
|
||||
- Apply coupons
|
||||
- Manual discount
|
||||
- Balance deduction
|
||||
- Points deduction
|
||||
|
||||
#### Order Notes
|
||||
|
||||
- Add order notes
|
||||
- Mark special orders
|
||||
- Record communications
|
||||
|
||||
### Order Details
|
||||
|
||||
View complete order information:
|
||||
|
||||
#### Basic Info
|
||||
|
||||
- Order number and creation time
|
||||
- User info and contact
|
||||
- Product details and specs
|
||||
- Order amount breakdown
|
||||
|
||||
#### Payment Info
|
||||
|
||||
- Payment method and transaction number
|
||||
- Payment time and status
|
||||
- Third-party platform order number
|
||||
- Payment proof (if any)
|
||||
|
||||
#### Order Status
|
||||
|
||||
- Current order status
|
||||
- Status change history
|
||||
- Operation log records
|
||||
|
||||
#### After-sales Info
|
||||
|
||||
- Refund request records
|
||||
- Customer service communications
|
||||
- Issue resolution progress
|
||||
|
||||
## Order Operations
|
||||
|
||||
### Order Review
|
||||
|
||||
Review pending orders:
|
||||
|
||||
- **Auto Review**: Online payment auto-complete
|
||||
- **Manual Review**: Bank transfer needs confirmation
|
||||
- **Approve**: Activate service and notify user
|
||||
- **Reject**: Reject order with reason
|
||||
|
||||
### Order Processing
|
||||
|
||||
Process paid orders:
|
||||
|
||||
- **Auto Activation**: Auto-activate after payment
|
||||
- **Manual Activation**: Admin manually activates
|
||||
- **Delayed Activation**: Set future activation time
|
||||
- **Batch Processing**: Process multiple orders
|
||||
|
||||
### Order Cancellation
|
||||
|
||||
Cancel unpaid or abnormal orders:
|
||||
|
||||
- **User Cancel**: User actively cancels
|
||||
- **Timeout Cancel**: Not paid within time limit
|
||||
- **Admin Cancel**: Admin manually cancels
|
||||
- **System Cancel**: Auto-cancel on anomaly detection
|
||||
|
||||
### Order Refund
|
||||
|
||||
Process refund requests:
|
||||
|
||||
#### Refund Review
|
||||
|
||||
- Review refund reason
|
||||
- Evaluate refund validity
|
||||
- Decide whether to approve
|
||||
|
||||
#### Refund Processing
|
||||
|
||||
- **Full Refund**: Return full order amount
|
||||
- **Partial Refund**: Return partial amount
|
||||
- **Refund to Balance**: Refund to user account
|
||||
- **Original Return**: Refund to original payment method
|
||||
|
||||
#### Post-refund
|
||||
|
||||
- Revoke activated services
|
||||
- Update user account status
|
||||
- Record refund reason and result
|
||||
|
||||
## Payment Management
|
||||
|
||||
### Payment Methods
|
||||
|
||||
Support multiple payment channels:
|
||||
|
||||
- **Alipay**: QR code/Face-to-face payment
|
||||
- **WeChat Pay**: QR code/H5 payment
|
||||
- **Cryptocurrency**: USDT/BTC, etc.
|
||||
- **Bank Transfer**: Offline transfer
|
||||
- **Balance Payment**: Use account balance
|
||||
|
||||
### Payment Config
|
||||
|
||||
Configure payment channel parameters:
|
||||
|
||||
- **Merchant Info**: Merchant ID/Key
|
||||
- **Payment Callback**: Async notification URL
|
||||
- **Payment Limits**: Min/Max payment amount
|
||||
- **Transaction Fees**: Fee rate and bearer
|
||||
|
||||
### Payment Callback
|
||||
|
||||
Handle payment platform callbacks:
|
||||
|
||||
- **Verify Signature**: Verify callback data authenticity
|
||||
- **Update Status**: Update order payment status
|
||||
- **Activate Service**: Auto-activate purchased service
|
||||
- **Send Notification**: Notify user of successful payment
|
||||
|
||||
## Order Statistics
|
||||
|
||||
### Sales Statistics
|
||||
|
||||
Analyze order sales data:
|
||||
|
||||
- **Order Count**: Total orders and growth trend
|
||||
- **Order Amount**: Total sales and average order value
|
||||
- **Conversion Rate**: Order conversion analysis
|
||||
- **Repurchase Rate**: User repurchase situation
|
||||
|
||||
### Payment Statistics
|
||||
|
||||
Analyze payment method usage:
|
||||
|
||||
- **Payment Method Share**: Alipay/WeChat share
|
||||
- **Payment Success Rate**: Success rate per channel
|
||||
- **Payment Duration**: Time from order to payment
|
||||
|
||||
### Product Statistics
|
||||
|
||||
Analyze product sales:
|
||||
|
||||
- **Best Sellers**: Top-selling products
|
||||
- **Revenue Contribution**: Revenue share per product
|
||||
- **Stock Alert**: Low-stock products
|
||||
|
||||
## Order Export
|
||||
|
||||
Export order data for analysis:
|
||||
|
||||
### Export Options
|
||||
|
||||
- **Export Format**: Excel/CSV/PDF
|
||||
- **Export Range**: All/Filtered results
|
||||
- **Export Fields**: Custom export fields
|
||||
- **Data Masking**: Mask sensitive information
|
||||
|
||||
### Export Purposes
|
||||
|
||||
- **Financial Reconciliation**: Verify revenue data
|
||||
- **Data Analysis**: Conduct business analysis
|
||||
- **Report Generation**: Generate sales reports
|
||||
- **Backup Archive**: Data backup and archive
|
||||
|
||||
## Abnormal Order Handling
|
||||
|
||||
### Anomaly Types
|
||||
|
||||
- **Duplicate Payment**: Same order paid multiple times
|
||||
- **Payment Not Received**: Paid but system didn't receive
|
||||
- **Amount Mismatch**: Payment amount differs from order
|
||||
- **Malicious Orders**: Fraud or fake orders
|
||||
|
||||
### Handling Process
|
||||
|
||||
1. **Identify Anomaly**: System auto-marks or manual detection
|
||||
2. **Investigate**: Check payment records and logs
|
||||
3. **Contact User**: Communicate to confirm situation
|
||||
4. **Resolution**: Refund/Resend/Manual handling
|
||||
5. **Record**: Document process and result
|
||||
|
||||
## Order Security
|
||||
|
||||
### Risk Control
|
||||
|
||||
- **Identity Verification**: Require user verification
|
||||
- **Payment Limits**: Set per-transaction limits
|
||||
- **Anomaly Detection**: Detect abnormal payment behavior
|
||||
- **Blacklist**: Block malicious users
|
||||
|
||||
### Anti-fraud
|
||||
|
||||
- **Rate Limiting**: Limit order frequency
|
||||
- **IP Detection**: Detect abnormal IP behavior
|
||||
- **Device Fingerprint**: Identify duplicate devices
|
||||
- **Manual Review**: Review suspicious orders
|
||||
|
||||
## Best Practices
|
||||
|
||||
- Process pending orders promptly
|
||||
- Ensure payment callback stability
|
||||
- Regularly reconcile financial data
|
||||
- Respond quickly to refund requests
|
||||
- Maintain complete operation logs
|
||||
- Analyze order data to optimize operations
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Payment Successful But Not Received
|
||||
|
||||
Steps:
|
||||
|
||||
1. Check payment platform order status
|
||||
2. Review payment callback logs
|
||||
3. Manually trigger callback processing
|
||||
4. Contact payment platform support
|
||||
|
||||
### Cannot Cancel Order
|
||||
|
||||
Possible reasons:
|
||||
|
||||
1. Order already paid
|
||||
2. Service already activated
|
||||
3. Insufficient system permissions
|
||||
|
||||
### Refund Failed
|
||||
|
||||
Check:
|
||||
|
||||
1. Is refund API configured correctly
|
||||
2. Is account balance sufficient
|
||||
3. Is refund info complete
|
||||
4. Has refund deadline passed
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Coupon Management](/admin/commerce/coupons) - Create promotions
|
||||
- [User Management](/admin/users-support/users) - Manage user accounts
|
||||
- [Financial Statistics](/admin/logs/balance) - View transaction details
|
||||
@@ -0,0 +1,203 @@
|
||||
<div v-pre>
|
||||
|
||||
# Product Management
|
||||
|
||||
Manage subscription plan products in the system, including pricing, traffic quotas, and node permissions. Products are the basic units that users purchase.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Show
|
||||
Switch button to control whether the product displays on the frontend. When off, users cannot see this product.
|
||||
|
||||
### Sell
|
||||
Switch button to control whether the product is available for purchase. Can display without selling (announcement mode).
|
||||
|
||||
### Name
|
||||
Product plan name.
|
||||
|
||||
### Unit Price
|
||||
Displays price and billing cycle, format like `$10/Month`.
|
||||
|
||||
### Replacement
|
||||
Promotional price or one-time purchase price.
|
||||
|
||||
### Traffic
|
||||
Traffic quota per cycle, 0 displays as "Unlimited".
|
||||
|
||||
### Device Limit
|
||||
Simultaneous device connection limit, 0 displays as "Unlimited".
|
||||
|
||||
### Inventory
|
||||
Remaining quantity available for sale, 0 displays as "Unlimited".
|
||||
|
||||
### Quota
|
||||
Total sales limit, 0 displays as "Unlimited".
|
||||
|
||||
### Language
|
||||
Language restriction for the product, used for multilingual sites.
|
||||
|
||||
### Sold
|
||||
Quantity sold statistics.
|
||||
|
||||
## Table Operations
|
||||
|
||||
### Edit
|
||||
Opens side drawer form to modify product information.
|
||||
|
||||
### Delete
|
||||
Deletes product (requires confirmation), products with existing subscriptions may not be deletable.
|
||||
|
||||
### Copy
|
||||
Quickly duplicates product to create new plan, automatically set to not showing and not selling.
|
||||
|
||||
### Batch Delete
|
||||
Deletes multiple selected products.
|
||||
|
||||
### Drag & Drop Sort
|
||||
Drag product rows to adjust display order, affects frontend display order.
|
||||
|
||||
## Product Form
|
||||
|
||||
Form contains three tabs:
|
||||
|
||||
### Basic Tab
|
||||
|
||||
**Name and Language**:
|
||||
- **Name** (Required) - Product plan name
|
||||
- **Language** (Optional) - Language restriction, e.g. `zh-CN` or `en`
|
||||
|
||||
**Traffic and Limits**:
|
||||
- **Traffic** - Traffic quota per cycle (GB), 0 = unlimited
|
||||
- **Speed Limit** - Bandwidth limit (Mbps), 0 = no limit
|
||||
- **Device Limit** - Simultaneous online devices, 0 = unlimited
|
||||
|
||||
**Inventory and Quota**:
|
||||
- **Inventory** - Remaining quantity for sale, 0 = unlimited
|
||||
- **Quota** - Total sales limit, 0 = unlimited
|
||||
|
||||
**Product Description** (JSON Editor):
|
||||
```json
|
||||
{
|
||||
"description": "Product description text",
|
||||
"features": [
|
||||
{
|
||||
"type": "default",
|
||||
"icon": "uil:shield-check",
|
||||
"label": "Feature description"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Pricing Tab
|
||||
|
||||
**Basic Pricing**:
|
||||
- **Unit Price** (Required) - Base price
|
||||
- **Billing Cycle** (Required) - Options:
|
||||
- NoLimit (No time limit)
|
||||
- Year
|
||||
- Month
|
||||
- Day
|
||||
- Hour
|
||||
- Minute
|
||||
- **Replacement** - Promotional price
|
||||
- **Reset Cycle** - Traffic reset method:
|
||||
- No reset
|
||||
- Reset on 1st of month
|
||||
- Monthly reset
|
||||
- Annual reset
|
||||
|
||||
**Bulk Discounts**:
|
||||
Dynamic array supporting multiple discount tiers:
|
||||
- **Quantity** - Number of billing cycles
|
||||
- **Discount** - Discount percentage (1-100%)
|
||||
- **Price** - Discounted price
|
||||
|
||||
Auto-calculation: Modify any two values, the third auto-calculates.
|
||||
|
||||
**Deduction Settings**:
|
||||
- **Deduction Ratio** - Node traffic multiplier (0-100%), leave blank for auto
|
||||
- **Renewal Reset** - Switch, whether to reset traffic on renewal
|
||||
- **Purchase with Discount** - Switch, whether to allow coupon usage
|
||||
|
||||
### Servers Tab
|
||||
|
||||
**Node Tag Selection**:
|
||||
Accordion-style list showing all tags and their nodes:
|
||||
- Check tags to automatically include all nodes under that tag
|
||||
- Shows node count
|
||||
- Expand to view node details (name, address, protocol)
|
||||
|
||||
**Individual Node Selection**:
|
||||
Select nodes without tags:
|
||||
- Check nodes individually
|
||||
- Shows node name, address:port, protocol
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: Create Basic Monthly Plan
|
||||
|
||||
**Basic Tab**:
|
||||
- Name: Standard Monthly
|
||||
- Traffic: 100 GB
|
||||
- Speed Limit: 0 (no limit)
|
||||
- Device Limit: 3
|
||||
- Inventory: 0 (unlimited)
|
||||
|
||||
**Pricing Tab**:
|
||||
- Unit Price: 30
|
||||
- Billing Cycle: Month
|
||||
- Reset Cycle: Monthly reset
|
||||
- Bulk Discounts:
|
||||
- 3 months, 10% discount, $81
|
||||
- 6 months, 15% discount, $153
|
||||
- 12 months, 20% discount, $288
|
||||
|
||||
**Servers Tab**:
|
||||
- Check "Basic Nodes" tag
|
||||
|
||||
### Scenario 2: Create Traffic Package
|
||||
|
||||
**Basic Tab**:
|
||||
- Name: 500GB Traffic Pack
|
||||
- Traffic: 500 GB
|
||||
- Device Limit: 0 (unlimited)
|
||||
|
||||
**Pricing Tab**:
|
||||
- Unit Price: 50
|
||||
- Billing Cycle: NoLimit
|
||||
- Reset Cycle: No reset
|
||||
- Renewal Reset: Off
|
||||
|
||||
**Servers Tab**:
|
||||
- Check all high-speed node tags
|
||||
|
||||
### Scenario 3: Create Premium Annual Plan
|
||||
|
||||
**Basic Tab**:
|
||||
- Name: Premium Annual
|
||||
- Traffic: 0 (unlimited)
|
||||
- Speed Limit: 200 Mbps
|
||||
- Device Limit: 10
|
||||
|
||||
**Pricing Tab**:
|
||||
- Unit Price: 300
|
||||
- Billing Cycle: Year
|
||||
- Reset Cycle: Monthly reset
|
||||
- Renewal Reset: On
|
||||
|
||||
**Servers Tab**:
|
||||
- Check all node tags
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Display Control**: New products default to not showing and not selling, must manually enable
|
||||
2. **Node Configuration**: Must configure nodes, otherwise users cannot use
|
||||
3. **Bulk Discounts**: After modifying unit price or cycle, discount prices auto-recalculate
|
||||
4. **Inventory Quota**: 0 means unlimited, non-zero limits sales quantity
|
||||
5. **Language Restriction**: Leave blank for all languages
|
||||
6. **Drag Sort**: Sorting saves immediately and affects frontend display
|
||||
7. **Copy Function**: Copied products don't auto-publish
|
||||
8. **Sold Products**: Modifying sold product configurations affects existing subscriptions
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,225 @@
|
||||
# Dashboard
|
||||
|
||||
Dashboard is the homepage of the admin panel, displaying real-time system core data and operational status.
|
||||
|
||||
## Page Overview
|
||||
|
||||
Dashboard consists of three main areas:
|
||||
|
||||
1. **Key Metrics Cards** - 6 core business indicators
|
||||
2. **Statistics Charts** - Revenue, user, and traffic statistics
|
||||
3. **Sponsor Display** - Shows PPanel sponsors
|
||||
|
||||
## Key Metrics Cards
|
||||
|
||||
Top section displays 6 key business metric cards:
|
||||
|
||||
### Online Users
|
||||
- **Display**: Current number of online users
|
||||
- **Subtitle**: "Currently Online"
|
||||
- **Click Action**: Jump to `/dashboard/user` user management page
|
||||
- **Icon**: Blue user icon
|
||||
|
||||
### Today's Traffic
|
||||
- **Display**: Today's total upload + download traffic
|
||||
- **Subtitle**: Shows upload/download traffic breakdown
|
||||
- ↑ Upload traffic
|
||||
- ↓ Download traffic
|
||||
- **Icon**: Purple exchange icon
|
||||
- **Format**: Auto-converts to appropriate units (KB/MB/GB/TB)
|
||||
|
||||
### Monthly Traffic
|
||||
- **Display**: This month's total upload + download traffic
|
||||
- **Subtitle**: Shows monthly upload/download traffic breakdown
|
||||
- **Icon**: Orange cloud data icon
|
||||
- **Format**: Auto-converts to appropriate units
|
||||
|
||||
### Total Servers
|
||||
- **Display**: Online servers + Offline servers
|
||||
- **Subtitle**: Shows online/offline server count breakdown
|
||||
- "Online X Offline Y"
|
||||
- **Click Action**: Jump to `/dashboard/servers` server management page
|
||||
- **Icon**: Green server icon
|
||||
|
||||
### Pending Tickets
|
||||
- **Display**: Number of tickets awaiting admin reply
|
||||
- **Subtitle**: "Pending"
|
||||
- **Click Action**: Jump to `/dashboard/ticket` ticket management page
|
||||
- **Icon**: Red ticket icon
|
||||
|
||||
### System Version Info
|
||||
- **Display**:
|
||||
- Backend service version number
|
||||
- Web admin version number
|
||||
- Version update status
|
||||
- **Operations**:
|
||||
- Check for updates
|
||||
- One-click update (if new version available)
|
||||
- Restart system
|
||||
- View update logs
|
||||
|
||||
::: tip Tip
|
||||
Click cards with links to quickly jump to the corresponding management page.
|
||||
:::
|
||||
|
||||
## Statistics Charts
|
||||
|
||||
### Revenue Statistics Chart
|
||||
|
||||
Displays system revenue data with three time dimensions:
|
||||
|
||||
**Time Dimensions**:
|
||||
- **Today**: Today's revenue data
|
||||
- **Month**: Daily revenue trend for this month
|
||||
- **Total**: Historical cumulative revenue data
|
||||
|
||||
**Today's Data** - Pie Chart:
|
||||
- **New Purchase**: Revenue from new user orders
|
||||
- **Renewal**: Revenue from renewal orders
|
||||
- **Center Number**: Today's total revenue
|
||||
|
||||
**Month Data** - Bar Chart:
|
||||
- X-axis: Daily dates
|
||||
- Y-axis: Revenue amount
|
||||
- Shows daily revenue bars for the month
|
||||
- Hover to view detailed data
|
||||
|
||||
**Total Data** - Area Chart:
|
||||
- **New Purchase Orders**: Cumulative new purchase order count
|
||||
- **Renewal Orders**: Cumulative renewal order count
|
||||
- **Total Orders**: Total cumulative orders
|
||||
- Area chart showing long-term trends
|
||||
|
||||
**Bottom Summary**:
|
||||
- New purchase amount / order count
|
||||
- Renewal amount / order count
|
||||
- Total amount / total order count
|
||||
|
||||
### User Statistics Chart
|
||||
|
||||
Displays user-related data with three time dimensions:
|
||||
|
||||
**Time Dimensions**:
|
||||
- **Today**: Today's user data
|
||||
- **Month**: Daily user trend for this month
|
||||
- **Total**: Historical cumulative user data
|
||||
|
||||
**Today's Data** - Pie Chart:
|
||||
- **Register**: Today's new registered users
|
||||
- **New Purchase**: Today's first-time buyers
|
||||
- **Repurchase**: Today's renewal users
|
||||
- **Center Number**: Today's total users (register + new purchase + repurchase)
|
||||
|
||||
**Month Data** - Bar Chart:
|
||||
- X-axis: Daily dates
|
||||
- Y-axis: User count
|
||||
- Three colored bars:
|
||||
- Registered users (blue)
|
||||
- New purchase users (green)
|
||||
- Renewal users (orange)
|
||||
|
||||
**Total Data** - Area Chart:
|
||||
- **Registered Users**: Cumulative registration trend
|
||||
- **New Purchase Users**: Cumulative new purchase trend
|
||||
- **Renewal Users**: Cumulative renewal trend
|
||||
- Three area curves showing long-term changes
|
||||
|
||||
**Bottom Summary**:
|
||||
- Total registered users
|
||||
- Total new purchase users
|
||||
- Total renewal users
|
||||
|
||||
### Traffic Ranking Chart
|
||||
|
||||
Displays node or user traffic usage ranking:
|
||||
|
||||
**Time Toggle** (top-right tabs):
|
||||
- **Today**: Today's traffic ranking
|
||||
- **Yesterday**: Yesterday's traffic ranking
|
||||
|
||||
**Type Selection** (dropdown):
|
||||
- **Node Traffic (Nodes)**: Shows server node traffic consumption ranking
|
||||
- **User Traffic (Users)**: Shows user traffic usage ranking
|
||||
|
||||
**Chart Display** - Horizontal Bar Chart:
|
||||
- Y-axis: Ranking number (1, 2, 3...)
|
||||
- X-axis: Traffic size (auto-converts units)
|
||||
- Bars: Traffic size visualization
|
||||
- Bar Labels: Shows node name or user ID
|
||||
|
||||
**Interactions**:
|
||||
- Hover: Display detailed traffic data
|
||||
- Node Mode: Shows node name and traffic
|
||||
- User Mode: Shows user subscription details (ID, package, expiry, etc.)
|
||||
|
||||
**Empty State**:
|
||||
- Shows empty state message when no data
|
||||
|
||||
::: tip Traffic Calculation
|
||||
Traffic = Upload traffic + Download traffic, automatically converted to KB/MB/GB/TB units.
|
||||
:::
|
||||
|
||||
## Sponsor Display
|
||||
|
||||
Bottom of page shows sponsors supporting the PPanel project:
|
||||
|
||||
**Display Content**:
|
||||
- Sponsor logo
|
||||
- Sponsor name
|
||||
- Brief description
|
||||
|
||||
**Data Source**:
|
||||
- Fetches latest sponsor list from GitHub repository
|
||||
- CDN accelerated access
|
||||
- Auto-filters expired sponsors
|
||||
|
||||
**Interaction**:
|
||||
- Click card to visit sponsor website
|
||||
- Opens in new window
|
||||
|
||||
::: tip Support PPanel
|
||||
Sponsoring helps PPanel continue releasing updates! Click sponsor cards to visit their services.
|
||||
:::
|
||||
|
||||
## Data Refresh
|
||||
|
||||
- **Auto Refresh**: Page data updates automatically based on query configuration
|
||||
- **Manual Refresh**: Refresh browser to immediately update all data
|
||||
- **Real-time**: Key metrics fetch latest data in real-time
|
||||
|
||||
## Usage Recommendations
|
||||
|
||||
1. **Daily Review**: Check Dashboard daily to understand operational status
|
||||
2. **Monitor Metrics**: Focus on real-time indicators like online users and pending tickets
|
||||
3. **Trend Analysis**: Regularly review chart trends to analyze business changes
|
||||
4. **Handle Anomalies**: Click cards to jump and handle issues when detecting data anomalies
|
||||
5. **Version Updates**: Update system promptly when new version is available
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Inaccurate Data?
|
||||
|
||||
1. Refresh browser page to re-fetch data
|
||||
2. Check if server time is correct
|
||||
3. Review system logs for errors
|
||||
|
||||
### Chart Showing Empty?
|
||||
|
||||
Possible causes:
|
||||
- No data in the time period
|
||||
- Data statistics service issue
|
||||
- Try refreshing the page
|
||||
|
||||
### Sponsors Not Showing?
|
||||
|
||||
Possible causes:
|
||||
- Network connection issue, cannot access CDN
|
||||
- No valid sponsors in current period
|
||||
- Browser blocking external resources
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [User Management](/admin/users-support/users) - View user details and traffic usage
|
||||
- [Ticket Management](/admin/users-support/tickets) - Handle pending tickets
|
||||
- [Server Management](/admin/maintenance/servers) - Manage server nodes
|
||||
- [Order Management](/admin/commerce/orders) - View revenue and order details
|
||||
@@ -0,0 +1,136 @@
|
||||
<div v-pre>
|
||||
|
||||
# Balance Log
|
||||
|
||||
View user balance change records including recharges, consumption, rewards, and all balance operations.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### User
|
||||
User with balance change (clickable for details).
|
||||
|
||||
### Amount
|
||||
Balance change amount:
|
||||
- Positive for increase
|
||||
- Negative for decrease
|
||||
|
||||
### Order No.
|
||||
Associated order number (clickable for order details).
|
||||
|
||||
### Balance
|
||||
User balance after change.
|
||||
|
||||
### Type
|
||||
Balance change type (displayed as Badge):
|
||||
|
||||
**Traffic Reset (23x)**:
|
||||
- Auto Reset (231)
|
||||
- Advance Reset (232)
|
||||
- Paid Reset (233)
|
||||
|
||||
**Recharge/Withdrawal (32x)**:
|
||||
- Recharge (321)
|
||||
- Withdraw (322)
|
||||
- Payment (323)
|
||||
- Refund (324)
|
||||
- Reward (325)
|
||||
- Admin Adjust (326)
|
||||
|
||||
**Purchase (33x)**:
|
||||
- Purchase (331)
|
||||
- Renewal (332)
|
||||
- Refund (333)
|
||||
- Withdraw (334)
|
||||
- Admin Adjust (335)
|
||||
|
||||
**Adjustment (34x)**:
|
||||
- Increase (341)
|
||||
- Reduce (342)
|
||||
|
||||
### Time
|
||||
Balance change time.
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Date Filter
|
||||
Select date to view balance records, defaults to today.
|
||||
|
||||
### User ID Filter
|
||||
Input user ID to view that user's balance changes.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: View Today's Recharges
|
||||
|
||||
1. Shows today's balance records by default
|
||||
2. Filter by "Recharge" type
|
||||
3. Calculate total recharge amount
|
||||
4. Analyze recharging users
|
||||
|
||||
### Scenario 2: Track User Balance
|
||||
|
||||
**View User Consumption**:
|
||||
1. Filter by user ID
|
||||
2. View all balance changes
|
||||
3. Analyze spending habits
|
||||
4. Verify billing accuracy
|
||||
|
||||
### Scenario 3: Investigate Abnormal Transactions
|
||||
|
||||
**Check Large Amounts**:
|
||||
1. Browse balance records
|
||||
2. Focus on large recharges/expenses
|
||||
3. Click order number for details
|
||||
4. Verify transaction legitimacy
|
||||
|
||||
### Scenario 4: Admin Balance Adjustment
|
||||
|
||||
**Verify After Manual Adjustment**:
|
||||
1. Filter "Admin Adjust" type
|
||||
2. View adjustment records
|
||||
3. Verify adjustment correctness
|
||||
4. Notify user (if needed)
|
||||
|
||||
## Balance Type Description
|
||||
|
||||
### Recharge Related
|
||||
- **Recharge**: User recharges via payment channel
|
||||
- **Reward**: Referral reward, event reward
|
||||
- **Refund**: Order refund to balance
|
||||
|
||||
### Consumption Related
|
||||
- **Purchase**: Buy new plan
|
||||
- **Renewal**: Renew existing plan
|
||||
- **Payment**: Other payment operations
|
||||
|
||||
### Adjustment Related
|
||||
- **Admin Adjust**: Manually increase or decrease balance
|
||||
- **Withdraw**: User requests withdrawal (deducts balance)
|
||||
|
||||
## Financial Reconciliation
|
||||
|
||||
### Daily Reconciliation
|
||||
Check daily:
|
||||
1. Total recharge matches payment platform
|
||||
2. Total consumption matches order total
|
||||
3. No abnormal large changes
|
||||
4. Refund records complete
|
||||
|
||||
### Monthly Reconciliation
|
||||
Monthly summary:
|
||||
1. Total recharge amount
|
||||
2. Total consumption amount
|
||||
3. Total balance change
|
||||
4. Transaction fee expenses
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Log Retention**: Retention time per system config
|
||||
2. **Amount Sign**: Pay attention to positive/negative meaning
|
||||
3. **Order Association**: Can trace source with order number
|
||||
4. **Type Recognition**: Quickly identify operations by type code
|
||||
5. **Balance Snapshot**: Records balance after change
|
||||
6. **Admin Operations**: Admin adjustments are recorded
|
||||
7. **Regular Reconciliation**: Recommended daily financial verification
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,80 @@
|
||||
<div v-pre>
|
||||
|
||||
# Commission Log
|
||||
|
||||
View user referral commission records including commission sources and amounts.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### User
|
||||
User receiving commission (clickable for details).
|
||||
|
||||
### Amount
|
||||
Commission amount.
|
||||
|
||||
### Order No.
|
||||
Order that generated commission (clickable for order details).
|
||||
|
||||
### Type
|
||||
Commission type (displayed as Badge):
|
||||
- Referral commission
|
||||
- Cashback commission
|
||||
- Reward commission
|
||||
- Other types
|
||||
|
||||
### Time
|
||||
Commission issued time.
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Date Filter
|
||||
Select date to view commission records, defaults to today.
|
||||
|
||||
### User ID Filter
|
||||
Input user ID to view that user's commission records.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: View Today's Commissions
|
||||
|
||||
1. Shows today's commission records by default
|
||||
2. Calculate total commission amount
|
||||
3. Analyze referral effectiveness
|
||||
|
||||
### Scenario 2: Track User Commissions
|
||||
|
||||
**View Referral Earnings**:
|
||||
1. Filter by user ID
|
||||
2. View all commission records
|
||||
3. Calculate cumulative earnings
|
||||
4. Verify commission accuracy
|
||||
|
||||
### Scenario 3: Analyze Referral Performance
|
||||
|
||||
**Calculate Referral Data**:
|
||||
1. Select time range
|
||||
2. View commission records
|
||||
3. Identify top referrers
|
||||
4. Optimize referral strategy
|
||||
|
||||
## Commission Rules
|
||||
|
||||
### Commission Sources
|
||||
- **Referral Commission**: Generated from referred user purchases
|
||||
- **Cashback Commission**: Cashback from own purchases
|
||||
- **Reward Commission**: Activity rewards
|
||||
|
||||
### Commission Calculation
|
||||
- Percentage of order amount
|
||||
- Real-time or periodic settlement
|
||||
- Linked to original order
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Log Retention**: Retention per system config
|
||||
2. **Order Association**: Can trace commission source
|
||||
3. **Type Recognition**: Quick categorization by type
|
||||
4. **Real-time Stats**: View referral effectiveness
|
||||
5. **Regular Reconciliation**: Verify commission issuance accuracy
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,149 @@
|
||||
<div v-pre>
|
||||
|
||||
# Email Log
|
||||
|
||||
View all email records sent by the system including sending status and content.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Platform
|
||||
Email sending platform (displayed as Badge):
|
||||
- SMTP
|
||||
- SendGrid
|
||||
- Mailgun
|
||||
- AWS SES
|
||||
- Other email providers
|
||||
|
||||
### To
|
||||
Recipient email address.
|
||||
|
||||
### Subject
|
||||
Email subject.
|
||||
|
||||
### Content
|
||||
Email content (displayed as JSON):
|
||||
- Plain text content
|
||||
- HTML content
|
||||
- Template variables
|
||||
- Max width 480px
|
||||
|
||||
### Status
|
||||
Email sending status (displayed as Badge):
|
||||
- **Sent** (Green) - Successfully sent
|
||||
- **Failed** (Red) - Send failed
|
||||
- **Unknown** (Gray) - Unknown status
|
||||
|
||||
### Time
|
||||
Email sending time.
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Keyword Search
|
||||
Search recipient address or email subject.
|
||||
|
||||
### Date Filter
|
||||
Select date to view email records, defaults to today.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: View Today's Emails
|
||||
|
||||
1. Shows today's email records by default
|
||||
2. Check sending quantity
|
||||
3. Check sending status
|
||||
4. Calculate success rate
|
||||
|
||||
### Scenario 2: Investigate Send Failures
|
||||
|
||||
**Check Failed Emails**:
|
||||
1. Filter "Failed" status
|
||||
2. View recipient addresses
|
||||
3. Check email content
|
||||
4. Analyze failure reasons
|
||||
5. Resend or fix configuration
|
||||
|
||||
### Scenario 3: Verify Email Content
|
||||
|
||||
**Check Email Templates**:
|
||||
1. Search specific subject
|
||||
2. View email content
|
||||
3. Verify variable replacement
|
||||
4. Confirm format correctness
|
||||
|
||||
### Scenario 4: Track User Emails
|
||||
|
||||
**View User Received Emails**:
|
||||
1. Search user email
|
||||
2. View all emails
|
||||
3. Confirm delivery
|
||||
4. Verify email types
|
||||
|
||||
## Email Types
|
||||
|
||||
### System Emails
|
||||
- Registration verification
|
||||
- Password reset
|
||||
- Login verification code
|
||||
- Account notifications
|
||||
|
||||
### Marketing Emails
|
||||
- Promotional emails
|
||||
- Activity notifications
|
||||
- Offer information
|
||||
- Product updates
|
||||
|
||||
### Transactional Emails
|
||||
- Order confirmation
|
||||
- Payment success
|
||||
- Invoice notification
|
||||
- Expiration reminder
|
||||
|
||||
## Sending Monitoring
|
||||
|
||||
### Success Rate Monitoring
|
||||
Watch metrics:
|
||||
- Daily total sent
|
||||
- Send success rate
|
||||
- Failure rate trends
|
||||
- Platform-specific performance
|
||||
|
||||
### Exception Handling
|
||||
When issues found:
|
||||
1. Check SMTP configuration
|
||||
2. Verify email provider status
|
||||
3. Check rate limits
|
||||
4. Review error logs
|
||||
|
||||
## Email Content Description
|
||||
|
||||
### JSON Format
|
||||
Content field contains:
|
||||
```json
|
||||
{
|
||||
"text": "Plain text content",
|
||||
"html": "<p>HTML content</p>",
|
||||
"variables": {
|
||||
"username": "Username",
|
||||
"code": "Verification code"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Variable Replacement
|
||||
- {{username}}: Username
|
||||
- {{code}}: Verification code
|
||||
- {{link}}: Link address
|
||||
- {{expire}}: Expiration time
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Log Retention**: Retention per system config
|
||||
2. **Content Truncation**: Long content may be truncated
|
||||
3. **JSON Display**: Content shown as JSON format
|
||||
4. **Platform Recognition**: Identify sending channel by platform field
|
||||
5. **Status Monitoring**: Watch for failed send records
|
||||
6. **Privacy Protection**: Email content may contain sensitive info
|
||||
7. **Regular Checks**: Daily sending status review
|
||||
8. **Quota Management**: Mind email provider quota limits
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,129 @@
|
||||
<div v-pre>
|
||||
|
||||
# Gift Log
|
||||
|
||||
View traffic, duration, balance gift records including gift sources and remarks.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### User
|
||||
User receiving gift (clickable for details).
|
||||
|
||||
### Subscribe
|
||||
Associated subscription ID (clickable for subscription details).
|
||||
|
||||
### Order No.
|
||||
Associated order number (clickable for order details).
|
||||
|
||||
### Amount
|
||||
Gift amount (shown for balance gifts).
|
||||
|
||||
### Balance
|
||||
User balance after gift.
|
||||
|
||||
### Type
|
||||
Gift type (displayed as Badge):
|
||||
- Traffic gift
|
||||
- Duration gift
|
||||
- Balance gift
|
||||
- Activity gift
|
||||
- Admin gift
|
||||
|
||||
### Remark
|
||||
Gift remark description.
|
||||
|
||||
### Time
|
||||
Gift time.
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Date Filter
|
||||
Select date to view gift records, defaults to today.
|
||||
|
||||
### User ID Filter
|
||||
Input user ID to view that user's gift records.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: View Today's Gifts
|
||||
|
||||
1. Shows today's gift records by default
|
||||
2. Calculate gift quantity
|
||||
3. Analyze gift costs
|
||||
|
||||
### Scenario 2: Track User Gifts
|
||||
|
||||
**View User Received**:
|
||||
1. Filter by user ID
|
||||
2. View all gift records
|
||||
3. Verify gifts credited
|
||||
4. Check gift sources
|
||||
|
||||
### Scenario 3: Verify Activity Gifts
|
||||
|
||||
**Verify Activity Distribution**:
|
||||
1. Filter by activity time
|
||||
2. View gift records
|
||||
3. Check distribution quantity
|
||||
4. Verify remark information
|
||||
|
||||
### Scenario 4: Admin Gift Records
|
||||
|
||||
**View Manual Gifts**:
|
||||
1. Filter "Admin Gift" type
|
||||
2. View gift records
|
||||
3. Verify operation correctness
|
||||
4. Check remark reasons
|
||||
|
||||
## Gift Type Description
|
||||
|
||||
### Traffic Gift
|
||||
- Gift traffic package
|
||||
- Increase subscription traffic
|
||||
- Shown in subscription details
|
||||
|
||||
### Duration Gift
|
||||
- Extend subscription time
|
||||
- Add valid days
|
||||
- Shown in subscription details
|
||||
|
||||
### Balance Gift
|
||||
- Gift account balance
|
||||
- Can be used to buy plans
|
||||
- Shows amount and balance
|
||||
|
||||
### Activity Gift
|
||||
- Marketing activity rewards
|
||||
- Batch distribution
|
||||
- With activity remarks
|
||||
|
||||
### Admin Gift
|
||||
- Manual gift operation
|
||||
- Requires reason remark
|
||||
- For compensation or rewards
|
||||
|
||||
## Cost Analysis
|
||||
|
||||
### Gift Statistics
|
||||
Daily/monthly stats:
|
||||
1. Total traffic gifted
|
||||
2. Total days gifted
|
||||
3. Total balance gifted
|
||||
4. Statistics by type
|
||||
|
||||
### Effect Evaluation
|
||||
- User retention after gifts
|
||||
- User payment after gifts
|
||||
- ROI analysis
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Log Retention**: Retention per system config
|
||||
2. **Subscription Association**: Traffic and duration gifts linked to subscriptions
|
||||
3. **Balance Records**: Balance gifts record amount changes
|
||||
4. **Remark Important**: Manual gifts must have remarks
|
||||
5. **Type Recognition**: Distinguish gift sources by type
|
||||
6. **Cost Statistics**: Regularly analyze gift costs
|
||||
7. **Prevent Abuse**: Watch for abnormally large gifts
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,93 @@
|
||||
<div v-pre>
|
||||
|
||||
# Login Log
|
||||
|
||||
View user login records including login methods, IP addresses, and device information.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### User
|
||||
Logged in user, displays:
|
||||
- Login method Badge (Email/Phone/Google etc.)
|
||||
- User ID (clickable for details)
|
||||
|
||||
### IP Address
|
||||
Login IP address (clickable to view IP info).
|
||||
|
||||
### User Agent
|
||||
User device and browser information:
|
||||
- Hover to show full content
|
||||
- Truncated to avoid excessive length
|
||||
|
||||
### Success Status
|
||||
Whether login succeeded:
|
||||
- **Success** (Green Badge)
|
||||
- **Failed** (Red Badge)
|
||||
|
||||
### Time
|
||||
Login time.
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Date Filter
|
||||
Select date to view login records, defaults to today.
|
||||
|
||||
### User ID Filter
|
||||
Input user ID to view that user's login records.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: View Today's Logins
|
||||
|
||||
1. Shows today's login records by default
|
||||
2. Check login frequency
|
||||
3. Analyze active users
|
||||
|
||||
### Scenario 2: Investigate Abnormal Logins
|
||||
|
||||
**Check Failed Logins**:
|
||||
1. Filter failed login records
|
||||
2. View IP addresses
|
||||
3. Analyze failure reasons
|
||||
4. Ban IPs if necessary
|
||||
|
||||
**Check Remote Logins**:
|
||||
1. View user login IPs
|
||||
2. Click IP to view geolocation
|
||||
3. Compare with historical locations
|
||||
4. Notify user if anomalies found
|
||||
|
||||
### Scenario 3: Track User Logins
|
||||
|
||||
**View Specific User**:
|
||||
1. Filter by user ID
|
||||
2. View login history
|
||||
3. Analyze login devices
|
||||
4. Verify account security
|
||||
|
||||
## Security Monitoring
|
||||
|
||||
### Abnormal Patterns
|
||||
Watch for:
|
||||
- High volume of failed logins in short time
|
||||
- Multiple accounts from same IP
|
||||
- Logins from unusual countries/regions
|
||||
- Logins from rare device types
|
||||
|
||||
### Protection Measures
|
||||
When anomalies detected:
|
||||
1. Temporarily ban IP
|
||||
2. Force user password reset
|
||||
3. Send security notification
|
||||
4. Enable two-factor authentication
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Log Retention**: Auto-cleaned per system config
|
||||
2. **IP Query**: Click IP to view geolocation
|
||||
3. **User Agent**: Contains OS and browser info
|
||||
4. **Privacy Protection**: Sensitive info only for admins
|
||||
5. **Failed Records**: Focus on failed login anomalies
|
||||
6. **Regular Checks**: Recommended daily login review
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,165 @@
|
||||
<div v-pre>
|
||||
|
||||
# SMS Log
|
||||
|
||||
View all SMS records sent by the system including sending status and content.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Platform
|
||||
SMS sending platform (displayed as Badge):
|
||||
- Alibaba Cloud SMS
|
||||
- Tencent Cloud SMS
|
||||
- Twilio
|
||||
- AWS SNS
|
||||
- Other SMS providers
|
||||
|
||||
### To
|
||||
Recipient phone number.
|
||||
|
||||
### Subject
|
||||
SMS subject/type.
|
||||
|
||||
### Content
|
||||
SMS content (displayed as JSON):
|
||||
- SMS text
|
||||
- Template variables
|
||||
- Signature info
|
||||
- Max width 480px
|
||||
|
||||
### Status
|
||||
SMS sending status (displayed as Badge):
|
||||
- **Sent** (Green) - Successfully sent
|
||||
- **Failed** (Red) - Send failed
|
||||
- **Unknown** (Gray) - Unknown status
|
||||
|
||||
### Time
|
||||
SMS sending time.
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Keyword Search
|
||||
Search recipient phone number or SMS subject.
|
||||
|
||||
### Date Filter
|
||||
Select date to view SMS records, defaults to today.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: View Today's SMS
|
||||
|
||||
1. Shows today's SMS records by default
|
||||
2. Check sending quantity
|
||||
3. Check sending status
|
||||
4. Calculate success rate
|
||||
|
||||
### Scenario 2: Investigate Send Failures
|
||||
|
||||
**Check Failed SMS**:
|
||||
1. Filter "Failed" status
|
||||
2. View recipient numbers
|
||||
3. Check SMS content
|
||||
4. Analyze failure reasons (invalid number/insufficient balance/provider issues)
|
||||
5. Resend or fix configuration
|
||||
|
||||
### Scenario 3: Verify SMS Content
|
||||
|
||||
**Check SMS Templates**:
|
||||
1. Search specific subject
|
||||
2. View SMS content
|
||||
3. Verify variable replacement
|
||||
4. Confirm signature correctness
|
||||
|
||||
### Scenario 4: Track User SMS
|
||||
|
||||
**View User Received SMS**:
|
||||
1. Search user phone number
|
||||
2. View all SMS
|
||||
3. Confirm delivery
|
||||
4. Verify SMS types
|
||||
|
||||
## SMS Types
|
||||
|
||||
### Verification Code SMS
|
||||
- Registration verification code
|
||||
- Login verification code
|
||||
- Password reset code
|
||||
- Phone binding code
|
||||
|
||||
### Notification SMS
|
||||
- Order notifications
|
||||
- Payment success
|
||||
- Expiration reminders
|
||||
- System announcements
|
||||
|
||||
### Marketing SMS
|
||||
- Promotional SMS
|
||||
- Activity notifications
|
||||
- Offer information
|
||||
|
||||
## Sending Monitoring
|
||||
|
||||
### Success Rate Monitoring
|
||||
Watch metrics:
|
||||
- Daily total sent
|
||||
- Send success rate
|
||||
- Failure rate trends
|
||||
- Platform-specific performance
|
||||
|
||||
### Exception Handling
|
||||
When issues found:
|
||||
1. Check SMS provider configuration
|
||||
2. Verify API key validity
|
||||
3. Check balance and quota
|
||||
4. Review error logs
|
||||
5. Contact provider technical support
|
||||
|
||||
## SMS Content Description
|
||||
|
||||
### JSON Format
|
||||
Content field contains:
|
||||
```json
|
||||
{
|
||||
"template_id": "SMS_123456",
|
||||
"sign_name": "Brand Name",
|
||||
"params": {
|
||||
"code": "123456",
|
||||
"minutes": "5"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Template Variables
|
||||
- {{code}}: Verification code
|
||||
- {{minutes}}: Valid time
|
||||
- {{product}}: Product name
|
||||
- {{amount}}: Amount
|
||||
|
||||
## Cost Management
|
||||
|
||||
### Cost Statistics
|
||||
- Daily SMS count
|
||||
- Unit price calculation
|
||||
- Monthly expenses
|
||||
- Type distribution
|
||||
|
||||
### Cost Optimization
|
||||
- Control verification code frequency
|
||||
- Optimize SMS templates
|
||||
- Choose cost-effective providers
|
||||
- Avoid invalid sending
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Log Retention**: Retention per system config
|
||||
2. **Content Truncation**: Long content may be truncated
|
||||
3. **JSON Display**: Content shown as JSON format
|
||||
4. **Platform Recognition**: Identify sending channel by platform field
|
||||
5. **Status Monitoring**: Watch for failed send records
|
||||
6. **Number Privacy**: Phone numbers are sensitive info
|
||||
7. **Regular Checks**: Daily sending status review
|
||||
8. **Quota Management**: Mind SMS provider quota and balance
|
||||
9. **Rate Limiting**: Prevent SMS flooding
|
||||
10. **Compliance**: Follow SMS sending laws and regulations
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,152 @@
|
||||
<div v-pre>
|
||||
|
||||
# Register Log
|
||||
|
||||
View user registration records including registration methods, IP addresses, and device information.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### User
|
||||
Registered user (clickable for details).
|
||||
|
||||
### Identifier
|
||||
Account identifier used for registration:
|
||||
- Registration method Badge (Email/Phone/Google etc.)
|
||||
- Specific account (email address/phone number etc.)
|
||||
|
||||
### IP Address
|
||||
Registration IP address (clickable to view IP info).
|
||||
|
||||
### User Agent
|
||||
Registration device and browser information:
|
||||
- Hover to show full content
|
||||
- Truncated to avoid excessive length
|
||||
|
||||
### Time
|
||||
Registration time.
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Date Filter
|
||||
Select date to view registration records, defaults to today.
|
||||
|
||||
### User ID Filter
|
||||
Input user ID to view that user's registration info.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: View Today's Registrations
|
||||
|
||||
1. Shows today's registration records by default
|
||||
2. Count registration quantity
|
||||
3. Analyze registration sources
|
||||
4. Identify registration method distribution
|
||||
|
||||
### Scenario 2: Track User Source
|
||||
|
||||
**View Registration Info**:
|
||||
1. View user registration record
|
||||
2. Confirm registration time
|
||||
3. Check registration IP location
|
||||
4. Analyze registration channel
|
||||
|
||||
### Scenario 3: Investigate Abnormal Registrations
|
||||
|
||||
**Check Suspicious Registrations**:
|
||||
1. View registration logs
|
||||
2. Focus on multiple registrations from same IP
|
||||
3. Check unusual countries/regions
|
||||
4. Identify batch registration behavior
|
||||
5. Limit registration if necessary
|
||||
|
||||
### Scenario 4: Analyze Registration Trends
|
||||
|
||||
**Calculate Registration Data**:
|
||||
1. Select time range
|
||||
2. Count total registrations
|
||||
3. Analyze registration peaks
|
||||
4. Evaluate promotion effectiveness
|
||||
|
||||
## Registration Methods
|
||||
|
||||
### Email Registration
|
||||
- Shows email address
|
||||
- Requires email verification
|
||||
- Most common method
|
||||
|
||||
### Phone Registration
|
||||
- Shows phone number
|
||||
- Requires SMS verification
|
||||
- Common in domestic market
|
||||
|
||||
### Social Account Registration
|
||||
- **Google**: Google account
|
||||
- **GitHub**: GitHub account
|
||||
- **Facebook**: Facebook account
|
||||
- **Apple**: Apple ID
|
||||
- **Telegram**: Telegram account
|
||||
|
||||
## Security Monitoring
|
||||
|
||||
### Abnormal Patterns
|
||||
Watch for:
|
||||
- High volume registrations in short time
|
||||
- Multiple registrations from same IP
|
||||
- Registrations from unusual countries/regions
|
||||
- Batch email/phone registrations
|
||||
- Temporary email registrations
|
||||
|
||||
### Protection Measures
|
||||
When anomalies detected:
|
||||
1. Enable registration CAPTCHA
|
||||
2. Limit registration rate per IP
|
||||
3. Ban suspicious IPs
|
||||
4. Enable email/phone verification
|
||||
5. Enable invitation code mechanism
|
||||
|
||||
## Registration Source Analysis
|
||||
|
||||
### Geographic Distribution
|
||||
- Country/region statistics
|
||||
- City distribution
|
||||
- Identify main markets
|
||||
|
||||
### Device Analysis
|
||||
From User Agent:
|
||||
- OS distribution
|
||||
- Browser types
|
||||
- Device types (PC/Mobile)
|
||||
- Identify user habits
|
||||
|
||||
### Registration Channels
|
||||
- Direct access
|
||||
- Search engines
|
||||
- Promotional links
|
||||
- Social media
|
||||
|
||||
## Data Statistics
|
||||
|
||||
### Daily Statistics
|
||||
- Daily new registrations
|
||||
- Registration conversion rate
|
||||
- Registration method ratio
|
||||
- Geographic distribution
|
||||
|
||||
### Promotion Evaluation
|
||||
- Registration volume during campaigns
|
||||
- Channel effectiveness
|
||||
- Post-registration retention
|
||||
- Post-registration payment rate
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Log Retention**: Retention per system config
|
||||
2. **IP Tracking**: Can view IP geolocation
|
||||
3. **Device Recognition**: User Agent contains device info
|
||||
4. **Privacy Protection**: Registration info sensitive, keep confidential
|
||||
5. **Abnormal Monitoring**: Watch for batch and remote registrations
|
||||
6. **Method Distribution**: Understand user preferred registration methods
|
||||
7. **Regular Analysis**: Weekly registration trend analysis
|
||||
8. **Anti-fraud**: Prevent malicious batch registrations
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,145 @@
|
||||
<div v-pre>
|
||||
|
||||
# Reset Subscribe Log
|
||||
|
||||
View subscription traffic reset records including reset types and associated orders.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### User
|
||||
User owning the subscription (clickable for details).
|
||||
|
||||
### Subscribe ID
|
||||
Reset subscription ID (clickable for subscription details, hover for card).
|
||||
|
||||
### Type
|
||||
Reset type (displayed as Badge):
|
||||
- **Auto Reset** - Automatically reset by cycle
|
||||
- **Advance Reset** - User manually resets in advance
|
||||
- **Paid Reset** - Purchase traffic reset service
|
||||
|
||||
### Order No.
|
||||
Associated order number (shown for paid resets, clickable for order details).
|
||||
|
||||
### Time
|
||||
Reset time.
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Date Filter
|
||||
Select date to view reset records, defaults to today.
|
||||
|
||||
### Subscribe ID Filter
|
||||
Input subscription ID to view that subscription's reset records.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: View Today's Resets
|
||||
|
||||
1. Shows today's reset records by default
|
||||
2. Count reset quantity
|
||||
3. Analyze reset type distribution
|
||||
4. Identify high-frequency reset users
|
||||
|
||||
### Scenario 2: Track Subscription Resets
|
||||
|
||||
**View Subscription History**:
|
||||
1. Filter by subscription ID
|
||||
2. View all reset records
|
||||
3. Analyze reset frequency
|
||||
4. Verify resets are normal
|
||||
|
||||
### Scenario 3: Analyze Paid Resets
|
||||
|
||||
**Calculate Paid Data**:
|
||||
1. Filter "Paid Reset" type
|
||||
2. Count paid reset quantity
|
||||
3. Calculate paid reset revenue
|
||||
4. Analyze user demand
|
||||
|
||||
### Scenario 4: Investigate Abnormal Resets
|
||||
|
||||
**Check Suspicious Resets**:
|
||||
1. View reset logs
|
||||
2. Focus on high-frequency advance resets
|
||||
3. Identify abnormal reset behavior
|
||||
4. Verify order associations
|
||||
|
||||
## Reset Type Description
|
||||
|
||||
### Auto Reset
|
||||
- Automatically resets by subscription cycle
|
||||
- Monthly/weekly/daily reset
|
||||
- Executed by system scheduled task
|
||||
- Most common reset method
|
||||
|
||||
### Advance Reset
|
||||
- User manually resets in advance
|
||||
- Consumes reset count
|
||||
- Or purchase reset with payment
|
||||
- Suitable for traffic exhaustion
|
||||
|
||||
### Paid Reset
|
||||
- User purchases traffic reset service
|
||||
- Generates order record
|
||||
- Resets immediately after payment
|
||||
- Has associated order number
|
||||
|
||||
## Reset Rules
|
||||
|
||||
### Auto Reset Time
|
||||
- **Monthly Reset**: 1st of month at 00:00
|
||||
- **Weekly Reset**: Monday at 00:00
|
||||
- **Daily Reset**: Every day at 00:00
|
||||
|
||||
### Reset Count Limit
|
||||
- Plan includes reset count
|
||||
- Exceeding count requires payment
|
||||
- Count resets each cycle
|
||||
|
||||
### Paid Reset Pricing
|
||||
- Based on plan traffic config
|
||||
- Generally 20-30% of plan price
|
||||
- Configurable in product management
|
||||
|
||||
## Traffic Management
|
||||
|
||||
### Reset Strategy
|
||||
- Set reasonable reset cycle
|
||||
- Configure reset count limit
|
||||
- Price paid reset service
|
||||
- Notify users of reset rules
|
||||
|
||||
### User Reminders
|
||||
- Traffic near exhaustion reminder
|
||||
- Reset time reminder
|
||||
- Paid reset recommendation
|
||||
- Upgrade plan suggestion
|
||||
|
||||
## Data Statistics
|
||||
|
||||
### Reset Analysis
|
||||
Daily/monthly stats:
|
||||
- Auto reset count
|
||||
- Advance reset count
|
||||
- Paid reset count
|
||||
- Paid reset revenue
|
||||
|
||||
### User Behavior
|
||||
- High-frequency reset users
|
||||
- Paid reset conversion rate
|
||||
- Traffic usage after reset
|
||||
- Upgrade plan conversion
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Log Retention**: Retention per system config
|
||||
2. **Subscription Association**: Each record linked to subscription ID
|
||||
3. **Type Recognition**: Distinguish reset method by type
|
||||
4. **Order Association**: Paid resets have order number
|
||||
5. **Time Accuracy**: Records precise reset time
|
||||
6. **Count Management**: Track user reset counts
|
||||
7. **Regular Analysis**: Weekly reset data analysis
|
||||
8. **Strategy Optimization**: Optimize reset rules based on data
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,149 @@
|
||||
<div v-pre>
|
||||
|
||||
# Server Traffic Log
|
||||
|
||||
View daily traffic statistics for each server with detailed traffic consumption breakdown.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Server
|
||||
Server information display:
|
||||
- Server ID (displayed as Badge)
|
||||
- Server name
|
||||
|
||||
### Upload
|
||||
Daily upload traffic, auto-converts units (B/KB/MB/GB/TB).
|
||||
|
||||
### Download
|
||||
Daily download traffic, auto-converts units.
|
||||
|
||||
### Total
|
||||
Daily total traffic (upload + download).
|
||||
|
||||
### Date
|
||||
Traffic statistics date.
|
||||
|
||||
## Table Operations
|
||||
|
||||
### View Detail
|
||||
Click "Detail" button to jump to detailed traffic records page:
|
||||
- View detailed traffic for that date and server
|
||||
- Grouped by users
|
||||
- Aggregated by subscriptions
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Date Filter
|
||||
Select date to view traffic records, defaults to today.
|
||||
|
||||
### Server ID Filter
|
||||
Input server ID to view that server's traffic records.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: View Today's Traffic
|
||||
|
||||
1. Shows today's traffic records by default
|
||||
2. View traffic consumption per server
|
||||
3. Identify high-traffic servers
|
||||
4. Analyze traffic distribution
|
||||
|
||||
### Scenario 2: Track Server Load
|
||||
|
||||
**View Server Usage**:
|
||||
1. Filter by server ID
|
||||
2. View historical traffic records
|
||||
3. Analyze traffic trends
|
||||
4. Evaluate server load
|
||||
|
||||
### Scenario 3: Investigate Traffic Anomalies
|
||||
|
||||
**Check Abnormal Consumption**:
|
||||
1. Browse traffic records
|
||||
2. Focus on abnormally high-traffic servers
|
||||
3. Click "Detail" for breakdown
|
||||
4. Analyze traffic distribution by user
|
||||
5. Check for abuse
|
||||
|
||||
### Scenario 4: Traffic Statistics Analysis
|
||||
|
||||
**Generate Reports**:
|
||||
1. Select date range
|
||||
2. Export traffic data
|
||||
3. Analyze traffic peak times
|
||||
4. Optimize server resource allocation
|
||||
5. Plan capacity expansion
|
||||
|
||||
## Traffic Detail Page
|
||||
|
||||
After clicking "Detail" shows:
|
||||
|
||||
### User Traffic Breakdown
|
||||
- Traffic consumption per user
|
||||
- Subscription traffic statistics
|
||||
- Connection duration records
|
||||
|
||||
### Node Traffic Statistics
|
||||
- Total traffic per node
|
||||
- Traffic proportion analysis
|
||||
- User distribution
|
||||
|
||||
## Traffic Monitoring
|
||||
|
||||
### Normal Pattern
|
||||
- Evenly distributed traffic
|
||||
- Matches user count
|
||||
- Regular peak/valley patterns
|
||||
|
||||
### Abnormal Patterns
|
||||
Watch for:
|
||||
- Sudden traffic surge on single server
|
||||
- Severely uneven traffic distribution
|
||||
- High traffic in unusual time periods
|
||||
- Excessive traffic from single user
|
||||
|
||||
## Server Management
|
||||
|
||||
### Load Balancing
|
||||
Based on traffic data:
|
||||
- Identify high-load servers
|
||||
- Distribute users to other servers
|
||||
- Adjust server weights
|
||||
- Optimize node configuration
|
||||
|
||||
### Capacity Planning
|
||||
Based on traffic trends:
|
||||
- Predict traffic growth
|
||||
- Plan server expansion
|
||||
- Optimize bandwidth configuration
|
||||
- Control operating costs
|
||||
|
||||
## Data Analysis
|
||||
|
||||
### Traffic Statistics
|
||||
Daily/monthly stats:
|
||||
- Total traffic consumption
|
||||
- Server proportion
|
||||
- Traffic growth trends
|
||||
- Bandwidth utilization rate
|
||||
|
||||
### Cost Analysis
|
||||
- Traffic cost calculation
|
||||
- Server ROI analysis
|
||||
- Optimization opportunity identification
|
||||
- Cost control recommendations
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Log Retention**: Retention per system config
|
||||
2. **Unit Conversion**: Auto-converts to readable units
|
||||
3. **Server Association**: Can view single server history
|
||||
4. **Detail Jump**: Click detail for user-level breakdown
|
||||
5. **Real-time**: Traffic data may have delay
|
||||
6. **Total Accuracy**: Total includes upload and download
|
||||
7. **Regular Analysis**: Recommended weekly traffic trend analysis
|
||||
8. **Load Monitoring**: Watch server load situation
|
||||
9. **Expansion Alert**: Expand when traffic nears limit
|
||||
10. **Cost Optimization**: Optimize config based on traffic data
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,120 @@
|
||||
<div v-pre>
|
||||
|
||||
# Subscribe Traffic Log
|
||||
|
||||
View daily traffic usage statistics for user subscriptions with detailed traffic consumption breakdown.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### User
|
||||
User consuming traffic (clickable for details).
|
||||
|
||||
### Subscribe
|
||||
Associated subscription ID (clickable for details, hover for card).
|
||||
|
||||
### Upload
|
||||
Daily upload traffic, auto-converts units (B/KB/MB/GB/TB).
|
||||
|
||||
### Download
|
||||
Daily download traffic, auto-converts units.
|
||||
|
||||
### Total
|
||||
Daily total traffic (upload + download).
|
||||
|
||||
### Date
|
||||
Traffic statistics date.
|
||||
|
||||
## Table Operations
|
||||
|
||||
### View Detail
|
||||
Click "Detail" button to jump to detailed traffic records page:
|
||||
- View detailed traffic for that date and subscription
|
||||
- Grouped by nodes
|
||||
- Aggregated by servers
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Date Filter
|
||||
Select date to view traffic records, defaults to today.
|
||||
|
||||
### User ID Filter
|
||||
Input user ID to view that user's traffic records.
|
||||
|
||||
### Subscribe ID Filter
|
||||
Input subscription ID to view that subscription's traffic records.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: View Today's Traffic
|
||||
|
||||
1. Shows today's traffic records by default
|
||||
2. View total traffic consumption
|
||||
3. Identify high-traffic users
|
||||
4. Analyze traffic trends
|
||||
|
||||
### Scenario 2: Track User Traffic
|
||||
|
||||
**View User Usage**:
|
||||
1. Filter by user ID
|
||||
2. View all subscription traffic
|
||||
3. Analyze usage habits
|
||||
4. Predict traffic needs
|
||||
|
||||
### Scenario 3: Investigate Traffic Anomalies
|
||||
|
||||
**Check Abnormal Consumption**:
|
||||
1. Browse traffic records
|
||||
2. Focus on unusually high traffic
|
||||
3. Click "Detail" for breakdown
|
||||
4. Analyze traffic distribution by node
|
||||
5. Check for abuse
|
||||
|
||||
### Scenario 4: Traffic Statistics Analysis
|
||||
|
||||
**Generate Reports**:
|
||||
1. Select date range
|
||||
2. Export traffic data
|
||||
3. Analyze traffic peak times
|
||||
4. Optimize node resource allocation
|
||||
|
||||
## Traffic Detail Page
|
||||
|
||||
After clicking "Detail" shows:
|
||||
|
||||
### Node Traffic Breakdown
|
||||
- Traffic consumption per node
|
||||
- Upload/download separately counted
|
||||
- Connection duration records
|
||||
|
||||
### Server Traffic Statistics
|
||||
- Total traffic per server
|
||||
- Traffic proportion analysis
|
||||
- Load situation assessment
|
||||
|
||||
## Traffic Monitoring
|
||||
|
||||
### Abnormal Patterns
|
||||
Watch for:
|
||||
- Sudden daily traffic surge
|
||||
- Traffic far exceeding plan limit
|
||||
- High traffic in unusual time periods
|
||||
- Single node excessive traffic
|
||||
|
||||
### Handling Measures
|
||||
When anomalies detected:
|
||||
1. View traffic details
|
||||
2. Confirm if abuse
|
||||
3. Throttle or suspend subscription
|
||||
4. Notify user for verification
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Log Retention**: Retention time per system config
|
||||
2. **Unit Conversion**: Auto-converts to readable units
|
||||
3. **Subscription Association**: Can cross-query user's multiple subscriptions
|
||||
4. **Detail Jump**: Click detail for node-level breakdown
|
||||
5. **Real-time**: Traffic data may have delay
|
||||
6. **Total Accuracy**: Total includes upload and download
|
||||
7. **Regular Analysis**: Recommended weekly traffic trend analysis
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,127 @@
|
||||
<div v-pre>
|
||||
|
||||
# Subscribe Log
|
||||
|
||||
View user subscription link request records including IP, device, and time information.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### User
|
||||
User requesting subscription (clickable for details).
|
||||
|
||||
### Subscribe ID
|
||||
Requested subscription ID (clickable for subscription details, hover for card).
|
||||
|
||||
### IP Address
|
||||
Request IP address (clickable to view IP info).
|
||||
|
||||
### User Agent
|
||||
Client device and system information:
|
||||
- Hover to show full content
|
||||
- Truncated to avoid excessive length
|
||||
|
||||
### Time
|
||||
Request time.
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Date Filter
|
||||
Select date to view subscription records, defaults to today.
|
||||
|
||||
### User ID Filter
|
||||
Input user ID to view that user's subscription requests.
|
||||
|
||||
### Subscribe ID Filter
|
||||
Input subscription ID to view that subscription's request records.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: View Today's Requests
|
||||
|
||||
1. Shows today's subscription records by default
|
||||
2. Check request frequency
|
||||
3. Analyze active subscriptions
|
||||
4. Identify abnormal requests
|
||||
|
||||
### Scenario 2: Track User Requests
|
||||
|
||||
**View User Activity**:
|
||||
1. Filter by user ID
|
||||
2. View all subscription requests
|
||||
3. Analyze usage frequency
|
||||
4. Verify device types
|
||||
|
||||
### Scenario 3: Investigate Subscription Anomalies
|
||||
|
||||
**Check Abnormal Requests**:
|
||||
1. View subscription logs
|
||||
2. Focus on IP address changes
|
||||
3. Check User Agent
|
||||
4. Identify suspicious devices
|
||||
5. Ban subscription if necessary
|
||||
|
||||
### Scenario 4: Analyze Client Distribution
|
||||
|
||||
**Calculate Client Types**:
|
||||
1. View User Agent information
|
||||
2. Count client distribution
|
||||
3. Understand user habits
|
||||
4. Optimize client support
|
||||
|
||||
## Subscription Request Monitoring
|
||||
|
||||
### Normal Pattern
|
||||
- Periodic subscription link requests
|
||||
- Update node information
|
||||
- Sync configuration changes
|
||||
|
||||
### Abnormal Patterns
|
||||
Watch for:
|
||||
- High-frequency requests in short time
|
||||
- Multiple subscriptions from same IP
|
||||
- Access from unusual countries/regions
|
||||
- Unfamiliar client types
|
||||
|
||||
## Security Protection
|
||||
|
||||
### Detection Measures
|
||||
- Request rate limiting
|
||||
- IP whitelist/blacklist
|
||||
- Subscription token verification
|
||||
- Device count limit
|
||||
|
||||
### Handling Measures
|
||||
When abuse detected:
|
||||
1. Limit request rate
|
||||
2. Temporarily ban IP
|
||||
3. Reset subscription token
|
||||
4. Notify user for confirmation
|
||||
|
||||
## User Agent Analysis
|
||||
|
||||
### Common Clients
|
||||
- **Clash**: Clash for Windows/Mac/Android
|
||||
- **Shadowrocket**: iOS client
|
||||
- **V2rayN**: Windows client
|
||||
- **Quantumult**: iOS client
|
||||
- **Surfboard**: Android client
|
||||
|
||||
### Identification Info
|
||||
From User Agent:
|
||||
- Client name and version
|
||||
- OS type
|
||||
- Device model
|
||||
- System version
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Log Retention**: Retention per system config
|
||||
2. **IP Tracking**: Can view IP geolocation
|
||||
3. **Device Recognition**: User Agent contains client info
|
||||
4. **Request Frequency**: Normal clients request periodically
|
||||
5. **Abnormal Monitoring**: Watch for high-frequency and remote requests
|
||||
6. **Privacy Protection**: IP and device info sensitive
|
||||
7. **Regular Analysis**: Weekly subscription request trend analysis
|
||||
8. **Prevent Leakage**: Subscription links should not be publicly shared
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,172 @@
|
||||
<div v-pre>
|
||||
|
||||
# Traffic Details Log
|
||||
|
||||
View detailed traffic consumption records with multi-dimensional filtering by server, user, and subscription.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Server
|
||||
Server generating traffic:
|
||||
- Server name
|
||||
- Server ID
|
||||
|
||||
### User
|
||||
User consuming traffic (clickable for details).
|
||||
|
||||
### Subscribe
|
||||
Associated subscription ID (clickable for subscription details, hover for card).
|
||||
|
||||
### Upload
|
||||
Upload traffic, auto-converts units (B/KB/MB/GB/TB).
|
||||
|
||||
### Download
|
||||
Download traffic, auto-converts units.
|
||||
|
||||
### Time
|
||||
Traffic generation time.
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Date Filter
|
||||
Select date to view traffic details, defaults to today.
|
||||
|
||||
### Server ID Filter
|
||||
Input server ID to view that server's traffic details.
|
||||
|
||||
### User ID Filter
|
||||
Input user ID to view that user's traffic details.
|
||||
|
||||
### Subscribe ID Filter
|
||||
Input subscription ID to view that subscription's traffic details.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: View Server Traffic Breakdown
|
||||
|
||||
Enter from server traffic log by clicking "Detail":
|
||||
1. Auto-fills date and server ID
|
||||
2. View all user traffic on that server
|
||||
3. Sort by user
|
||||
4. Identify high-traffic users
|
||||
|
||||
### Scenario 2: View User Traffic Details
|
||||
|
||||
Enter from subscribe traffic log by clicking "Detail":
|
||||
1. Auto-fills date, user ID, and subscription ID
|
||||
2. View that user's subscription traffic
|
||||
3. View distribution by server
|
||||
4. Analyze usage habits
|
||||
|
||||
### Scenario 3: Investigate Traffic Anomalies
|
||||
|
||||
**Detailed Investigation**:
|
||||
1. Select anomaly date
|
||||
2. Input relevant filter conditions
|
||||
3. View detailed traffic records
|
||||
4. Sort by time for analysis
|
||||
5. Identify abnormal traffic sources
|
||||
|
||||
### Scenario 4: Traffic Statistics Analysis
|
||||
|
||||
**Multi-dimensional Analysis**:
|
||||
1. Select time range
|
||||
2. Combine different filter conditions
|
||||
3. Export detailed data
|
||||
4. Generate traffic reports
|
||||
5. Develop optimization strategies
|
||||
|
||||
## Data Association
|
||||
|
||||
### Jump from Server Traffic
|
||||
- Brings server ID and date
|
||||
- View all traffic on that server
|
||||
- Can further filter by user
|
||||
|
||||
### Jump from Subscribe Traffic
|
||||
- Brings user ID, subscription ID, and date
|
||||
- View all traffic for that subscription
|
||||
- Can view different servers
|
||||
|
||||
## Traffic Analysis
|
||||
|
||||
### Time Distribution
|
||||
- View traffic time distribution
|
||||
- Identify usage peak times
|
||||
- Analyze user active hours
|
||||
- Optimize server scheduling
|
||||
|
||||
### Server Distribution
|
||||
- Count traffic proportion per server
|
||||
- Analyze load distribution
|
||||
- Identify popular servers
|
||||
- Optimize load balancing
|
||||
|
||||
### User Distribution
|
||||
- Identify high-traffic users
|
||||
- Analyze user usage habits
|
||||
- Check for abuse
|
||||
- Optimize plan configuration
|
||||
|
||||
## Traffic Monitoring
|
||||
|
||||
### Normal Pattern
|
||||
- Evenly distributed traffic
|
||||
- Time regularity
|
||||
- Matches user count
|
||||
- No abnormal peaks
|
||||
|
||||
### Abnormal Patterns
|
||||
Watch for:
|
||||
- Abnormally large single traffic
|
||||
- Traffic in unusual time periods
|
||||
- High-frequency requests from single user
|
||||
- Unreasonable traffic distribution
|
||||
|
||||
## Investigation Steps
|
||||
|
||||
### Discover Anomaly
|
||||
1. Find anomaly from statistics log
|
||||
2. Click detail to enter
|
||||
3. View detailed records
|
||||
|
||||
### Locate Problem
|
||||
1. Sort by time
|
||||
2. Identify abnormal records
|
||||
3. View user information
|
||||
4. Confirm subscription status
|
||||
|
||||
### Handling Measures
|
||||
1. Verify if normal usage
|
||||
2. Check for abuse
|
||||
3. Throttle or suspend subscription
|
||||
4. Notify user for confirmation
|
||||
|
||||
## Data Export
|
||||
|
||||
### Export Purpose
|
||||
- Generate traffic reports
|
||||
- Financial reconciliation
|
||||
- User analysis
|
||||
- Capacity planning
|
||||
|
||||
### Export Content
|
||||
- All column data
|
||||
- Filtered data
|
||||
- CSV or Excel format
|
||||
- Supports batch export
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Log Retention**: Retention per system config
|
||||
2. **Unit Conversion**: Auto-converts to readable units
|
||||
3. **Multi-filter**: Supports multiple condition combinations
|
||||
4. **Jump with Params**: Jumps from stats logs auto-fill parameters
|
||||
5. **Real-time**: Traffic data may have delay
|
||||
6. **Detail Level**: Most detailed traffic records
|
||||
7. **Performance**: Consider filtering with large data volumes
|
||||
8. **Regular Cleanup**: Detail logs consume more storage
|
||||
9. **Export Limits**: Single export may have quantity limits
|
||||
10. **Privacy Protection**: Detailed records contain user behavior info
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,187 @@
|
||||
# Node Management
|
||||
|
||||
Manage user-facing proxy nodes, configure node-server associations, entry addresses, and tags. Nodes are the actual endpoints users connect to, and one server can correspond to multiple nodes.
|
||||
|
||||
## Page Components
|
||||
|
||||
### Node List
|
||||
|
||||
Display all node configuration information in table format.
|
||||
|
||||
**Column Information:**
|
||||
- **Enabled**: Toggle switch to control whether the node is visible to users in real-time
|
||||
- On: Node appears in subscriptions, users can connect
|
||||
- Off: Node is hidden, users cannot connect
|
||||
- Takes effect immediately without restart
|
||||
- **Name**: Node display name, shown in user's client
|
||||
- **Address:Port**: Entry address and port for user connections
|
||||
- **Server**: Shows associated server name and IP address
|
||||
- Format: `Server Name:Server IP`
|
||||
- **Protocol:Port**: Proxy protocol type and server listening port
|
||||
- Format: `Protocol Type:Server Port`
|
||||
- Examples: `vless:443`, `vmess:80`, `trojan:8443`
|
||||
- **Tags**: Node grouping tags, displayed as badges
|
||||
- Used for permission grouping and plan binding
|
||||
- Used for traffic distribution policies
|
||||
- Supports multiple tags
|
||||
|
||||
**Operation Features:**
|
||||
- **Search**: Quickly filter nodes by keyword
|
||||
- **Sorting**: Adjust node display order by dragging rows, affects node order in user subscriptions
|
||||
- **Pagination**: Support paging for large number of nodes
|
||||
- **Batch Delete**: Delete multiple selected nodes
|
||||
|
||||
**Individual Node Operations:**
|
||||
- **Edit**: Modify node configuration
|
||||
- **Delete**: Delete node
|
||||
- **Copy**: Copy node configuration to create new node (new node disabled by default)
|
||||
|
||||
## Node Form
|
||||
|
||||
A sidebar form that opens when clicking "Create" or "Edit".
|
||||
|
||||
### Form Fields
|
||||
|
||||
**1. Server** - Required
|
||||
- Select the physical server associated with the node
|
||||
- Dropdown shows: `Server Name (Server IP)`
|
||||
- Triggers smart autofill upon selection
|
||||
|
||||
**2. Protocol** - Required
|
||||
- Select the proxy protocol to use
|
||||
- Dropdown only shows protocols enabled on selected server
|
||||
- Format: `Protocol Type (Port Number)`
|
||||
- Supported protocols: shadowsocks, vmess, vless, trojan, hysteria, tuic, anytls, naive, http, socks, mieru
|
||||
- Automatically fills corresponding port upon selection
|
||||
|
||||
**3. Name** - Required
|
||||
- Display name of the node
|
||||
- Shown in user's proxy client
|
||||
- Supports autofill (from server name)
|
||||
|
||||
**4. Address** - Required
|
||||
- Entry address for user connections
|
||||
- Can be domain name or IP address
|
||||
- Supports autofill (from server address)
|
||||
- Can be manually changed to CDN domain or other entry
|
||||
|
||||
**5. Port** - Required
|
||||
- Entry port number for user connections
|
||||
- Range: 1-65535
|
||||
- Supports autofill (from protocol port)
|
||||
- Can be manually changed to different port (e.g., when using port forwarding)
|
||||
|
||||
**6. Tags** - Optional
|
||||
- Node grouping tags, supports multiple tags
|
||||
- Can select from existing tags or enter new tags
|
||||
- Use Enter key or comma (,) to add multiple tags
|
||||
- Purpose:
|
||||
- **Permission Grouping**: Bind with plans to control visible nodes for different plan users
|
||||
- **Traffic Strategy**: Used for node traffic distribution and load balancing
|
||||
|
||||
### Smart Autofill Mechanism
|
||||
|
||||
The form has smart autofill functionality to improve configuration efficiency:
|
||||
|
||||
**Trigger Conditions:**
|
||||
1. When selecting server
|
||||
2. When selecting protocol
|
||||
|
||||
**Fill Rules:**
|
||||
- **After selecting server**:
|
||||
- Name autofills with server name
|
||||
- Address autofills with server IP
|
||||
- Protocol automatically selects first available protocol
|
||||
- Port autofills with corresponding protocol port
|
||||
|
||||
- **After selecting protocol**:
|
||||
- Port autofills with the protocol's port number
|
||||
|
||||
**Manual Modification:**
|
||||
- After manually modifying any field, that field will no longer autofill
|
||||
- Reselecting server or protocol refreshes autofill status
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Scenario 1: Create Basic Node
|
||||
1. Click "Create" button
|
||||
2. Select server (other fields autofill)
|
||||
3. Confirm or adjust autofilled configuration
|
||||
4. Click "Confirm"
|
||||
|
||||
### Scenario 2: Create CDN Node
|
||||
1. Click "Create" button
|
||||
2. Select server
|
||||
3. Change name to: `Hong Kong 01 [CDN]`
|
||||
4. Change address to CDN domain: `hk01.cdn.example.com`
|
||||
5. Change port to CDN port: `443` or `80`
|
||||
6. Click "Confirm"
|
||||
|
||||
### Scenario 3: Tag Group Management
|
||||
**For Plan Binding:**
|
||||
- Premium plan nodes: Add tags `premium`, `vip`
|
||||
- Standard plan nodes: Add tag `standard`
|
||||
- Trial plan nodes: Add tag `trial`
|
||||
- Bind tags in product management to show different nodes for different plans
|
||||
|
||||
**For Region Classification:**
|
||||
- Hong Kong nodes: Add tags `hk`, `asia`
|
||||
- US nodes: Add tags `us`, `americas`
|
||||
- Japan nodes: Add tags `jp`, `asia`
|
||||
|
||||
### Scenario 4: Batch Management
|
||||
1. Use search to filter specific nodes
|
||||
2. Check multiple nodes
|
||||
3. Click batch delete or batch operations
|
||||
4. Confirm operation
|
||||
|
||||
## Relationship Between Nodes and Servers
|
||||
|
||||
**Server:**
|
||||
- Physical server or VPS
|
||||
- Runs proxy service programs
|
||||
- Configures listening protocols and ports
|
||||
- One server can configure multiple protocols
|
||||
|
||||
**Node:**
|
||||
- User-visible connection endpoint
|
||||
- Associated with a specific protocol on a server
|
||||
- Configures user connection entry address (can differ from server address)
|
||||
- One server can create multiple nodes
|
||||
|
||||
**Example:**
|
||||
```
|
||||
Server: Hong Kong-HK01 (192.168.1.100)
|
||||
├── Protocol: vless:443
|
||||
├── Protocol: vmess:80
|
||||
└── Protocol: trojan:8443
|
||||
|
||||
Node Configuration:
|
||||
1. Node Name: Hong Kong 01 [Direct]
|
||||
- Server: Hong Kong-HK01
|
||||
- Protocol: vless:443
|
||||
- Address: 192.168.1.100
|
||||
- Port: 443
|
||||
|
||||
2. Node Name: Hong Kong 01 [CDN]
|
||||
- Server: Hong Kong-HK01
|
||||
- Protocol: vmess:80
|
||||
- Address: hk01.cdn.example.com
|
||||
- Port: 443 (CDN port)
|
||||
|
||||
3. Node Name: Hong Kong 01 [VIP]
|
||||
- Server: Hong Kong-HK01
|
||||
- Protocol: trojan:8443
|
||||
- Address: 192.168.1.100
|
||||
- Port: 8443
|
||||
- Tags: premium, vip
|
||||
```
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Protocol Must Be Enabled**: Can only select protocols already enabled on the server; disabled protocols won't appear in dropdown
|
||||
2. **Delete Impact**: Deleting a node will cause users using that node to be unable to connect, proceed with caution
|
||||
3. **Disable vs Delete**: For temporarily taking a node offline, use "disable" instead of delete for easy restoration
|
||||
4. **Tag Planning**: Recommend planning tag system in advance for easier batch management of plans and nodes
|
||||
5. **Address Configuration**: When using CDN, ensure CDN is correctly configured to origin to server address
|
||||
6. **Port Mapping**: If entry port differs from server listening port (e.g., using port forwarding), ensure network layer is configured correctly
|
||||
@@ -0,0 +1,261 @@
|
||||
# Product Management
|
||||
|
||||
The Product Management module creates and manages subscription packages, which is the core of business operations.
|
||||
|
||||
## Overview
|
||||
|
||||
### Product List
|
||||
|
||||
View and manage all product packages:
|
||||
|
||||
- **Product Name**: Package display name
|
||||
- **Product Type**: Period/Traffic/Pay-as-you-go
|
||||
- **Price**: Product price and discount price
|
||||
- **Traffic Quota**: Total/Monthly traffic
|
||||
- **Validity**: Package duration (month/quarter/year)
|
||||
- **Node Groups**: Included node groups
|
||||
- **Status**: Active/Inactive/Sold out
|
||||
- **Sales**: Product sales quantity
|
||||
|
||||
### Create Product
|
||||
|
||||
Create new subscription package:
|
||||
|
||||
#### Basic Info
|
||||
|
||||
- **Product Name**: Package name users see
|
||||
- **Description**: Detailed product description
|
||||
- **Category**: Basic/Advanced/Premium
|
||||
- **Sort Order**: Product display order
|
||||
|
||||
#### Pricing
|
||||
|
||||
- **Original Price**: Product original price
|
||||
- **Sale Price**: Actual selling price
|
||||
- **Discount**: Discount percentage
|
||||
- **Currency**: CNY/USD, etc.
|
||||
- **Billing Cycle**: Monthly/Quarterly/Yearly
|
||||
|
||||
#### Traffic Config
|
||||
|
||||
- **Total Traffic**: Package total traffic quota
|
||||
- **Traffic Cycle**: One-time/Monthly reset
|
||||
- **Traffic Rate**: Traffic billing multiplier
|
||||
- **Overage**: Handling for traffic overage
|
||||
|
||||
#### Duration
|
||||
|
||||
- **Validity**: Package usage period
|
||||
- **Billing Cycle**: Monthly/Quarterly/Yearly
|
||||
- **Auto-renewal**: Support auto-renewal
|
||||
- **Renewal Discount**: Discount on renewal
|
||||
|
||||
#### Node Config
|
||||
|
||||
- **Included Groups**: Select node groups in package
|
||||
- **Device Limit**: Simultaneous device connection limit
|
||||
- **Speed Limit**: Per-user speed cap
|
||||
- **Available Regions**: Geographic restrictions
|
||||
|
||||
#### Advanced Options
|
||||
|
||||
- **Inventory**: Set product stock quantity
|
||||
- **Purchase Limit**: Per-person purchase limit
|
||||
- **New User Only**: Only new users can buy
|
||||
- **Trial Settings**: Provide free trial
|
||||
|
||||
### Edit Product
|
||||
|
||||
Modify existing product configuration:
|
||||
|
||||
- Adjust price and discount
|
||||
- Update traffic quota
|
||||
- Modify node range
|
||||
- Change product status
|
||||
|
||||
::: warning Note
|
||||
Product config changes don't affect existing users, only new orders.
|
||||
:::
|
||||
|
||||
### Delete Product
|
||||
|
||||
Confirm before deleting:
|
||||
|
||||
- Are users currently using it
|
||||
- Are there pending orders
|
||||
- Should historical data be kept
|
||||
|
||||
Recommend deactivating first, then delete after confirmation.
|
||||
|
||||
## Product Categories
|
||||
|
||||
### By Period
|
||||
|
||||
#### Monthly
|
||||
|
||||
- High flexibility for short-term users
|
||||
- Relatively higher price
|
||||
- Easy for users to try service
|
||||
|
||||
#### Quarterly
|
||||
|
||||
- Moderate price and duration
|
||||
- Balance flexibility and discount
|
||||
- Suitable for most users
|
||||
|
||||
#### Yearly
|
||||
|
||||
- Large discount
|
||||
- For long-term users
|
||||
- Reduce user churn
|
||||
|
||||
#### Lifetime
|
||||
|
||||
- One-time payment for permanent use
|
||||
- High price but good value
|
||||
- For loyal users
|
||||
|
||||
### By Traffic
|
||||
|
||||
#### Traffic Package
|
||||
|
||||
- Fixed traffic quota
|
||||
- Stop when used up
|
||||
- For users with clear needs
|
||||
|
||||
#### Unlimited
|
||||
|
||||
- No traffic limit
|
||||
- May limit speed
|
||||
- For heavy users
|
||||
|
||||
#### Pay-as-you-go
|
||||
|
||||
- Pay for what you use
|
||||
- Flexible but potentially costly
|
||||
- For occasional users
|
||||
|
||||
### By Tier
|
||||
|
||||
#### Basic
|
||||
|
||||
- Affordable price
|
||||
- Basic node groups
|
||||
- For light usage
|
||||
|
||||
#### Advanced
|
||||
|
||||
- Good value
|
||||
- More node options
|
||||
- For daily use
|
||||
|
||||
#### Premium
|
||||
|
||||
- Full node access
|
||||
- Highest speed and stability
|
||||
- For professional users
|
||||
|
||||
## Pricing Strategy
|
||||
|
||||
### Pricing Principles
|
||||
|
||||
- **Cost-based**: Cover server and bandwidth costs
|
||||
- **Competition-based**: Reference industry pricing
|
||||
- **Value-based**: Price by value provided
|
||||
- **Psychological**: Use pricing psychology
|
||||
|
||||
### Promotion Strategy
|
||||
|
||||
#### Limited Time
|
||||
|
||||
- Holiday promotions
|
||||
- Anniversary sales
|
||||
- New product launch discounts
|
||||
|
||||
#### Coupons
|
||||
|
||||
- Spend threshold coupons
|
||||
- Discount coupons
|
||||
- New user coupons
|
||||
|
||||
#### Member Discounts
|
||||
|
||||
- VIP user exclusive discounts
|
||||
- Cumulative purchase rebates
|
||||
- Referral rewards
|
||||
|
||||
#### Bundle Packages
|
||||
|
||||
- Multi-product combo discounts
|
||||
- Package upgrade discounts
|
||||
- Renewal discounts
|
||||
|
||||
## Product Display
|
||||
|
||||
### Product Page
|
||||
|
||||
Optimize display to improve conversion:
|
||||
|
||||
- **Clear Title**: Highlight features
|
||||
- **Detailed Description**: Explain advantages
|
||||
- **Price Comparison**: Show discount magnitude
|
||||
- **User Reviews**: Show real feedback
|
||||
- **Purchase Guide**: Clear buy button
|
||||
|
||||
### Product Comparison
|
||||
|
||||
Help users choose suitable package:
|
||||
|
||||
- **Comparison Table**: Side-by-side comparison
|
||||
- **Recommendation Badge**: Mark popular/recommended
|
||||
- **Differentiation**: Highlight differences
|
||||
- **Use Cases**: Explain suitable scenarios
|
||||
|
||||
## Product Analysis
|
||||
|
||||
### Sales Data
|
||||
|
||||
Analyze product sales:
|
||||
|
||||
- **Sales Stats**: Product sales quantity
|
||||
- **Revenue Stats**: Revenue per product
|
||||
- **Conversion Rate**: Visit to purchase
|
||||
- **User Profile**: Buyer characteristics
|
||||
|
||||
### Optimization
|
||||
|
||||
Optimize products based on data:
|
||||
|
||||
- **Price Adjustment**: Optimize pricing
|
||||
- **Config Optimization**: Adjust traffic and nodes
|
||||
- **Promotion Optimization**: Improve promotions
|
||||
- **Experience Optimization**: Enhance purchase flow
|
||||
|
||||
## Inventory Management
|
||||
|
||||
### Inventory Settings
|
||||
|
||||
- **Stock Quantity**: Set product inventory
|
||||
- **Stock Alert**: Low stock reminder
|
||||
- **Restocking**: Auto-restock rules
|
||||
|
||||
### Inventory Monitoring
|
||||
|
||||
- **Real-time Stock**: View current inventory
|
||||
- **Stock Flow**: Inventory change records
|
||||
- **Sales Forecast**: Predict inventory needs
|
||||
|
||||
## Best Practices
|
||||
|
||||
- Offer multiple price tiers for different needs
|
||||
- Set clear product features and advantages
|
||||
- Regularly analyze sales data to optimize
|
||||
- Keep product info updated
|
||||
- Use promotions reasonably to boost sales
|
||||
- Collect user feedback for improvement
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Order Management](/admin/commerce/orders) - Process product orders
|
||||
- [Coupon Management](/admin/commerce/coupons) - Create promotions
|
||||
- [Marketing Management](/admin/commerce/marketing) - Promote products
|
||||
@@ -0,0 +1,214 @@
|
||||
# Server Management
|
||||
|
||||
Manage proxy servers' basic information, protocol configuration, and runtime status, as well as configure global node parameters.
|
||||
|
||||
## Page Components
|
||||
|
||||
The Server Management page consists of the following modules:
|
||||
|
||||
### 1. Dynamic Multiplier
|
||||
|
||||
A card at the top of the page for defining traffic billing multipliers for different time periods.
|
||||
|
||||
**Features:**
|
||||
- **Time Slot Management**: Define multiple time periods, each containing:
|
||||
- Start time: Format HH:MM:SS
|
||||
- End time: Format HH:MM:SS
|
||||
- Multiplier: Traffic billing multiplier for this period
|
||||
- **Dynamic Billing**: Apply different multipliers at different times, e.g., higher rates during peak hours
|
||||
- **Flexible Configuration**: Support adding, editing, and deleting time periods
|
||||
- **Immediate Effect**: Applied to traffic statistics immediately after saving
|
||||
|
||||
**Use Cases:**
|
||||
- Peak/off-peak time-based billing
|
||||
- Holiday special billing
|
||||
- Limit traffic usage during peak hours
|
||||
|
||||
### 2. Node Configuration
|
||||
|
||||
A card at the top of the page for configuring node communication and global policies.
|
||||
|
||||
**Basic Configuration:**
|
||||
- **Node Secret**: Authentication key for node-server communication
|
||||
- **Node Pull Interval**: Time interval (seconds) for nodes to pull configuration from server
|
||||
- **Node Push Interval**: Time interval (seconds) for nodes to push status to server
|
||||
- **Traffic Report Threshold**: Byte threshold for triggering traffic reports
|
||||
- **IP Strategy**: Choose prefer_ipv4 or prefer_ipv6
|
||||
|
||||
**DNS Configuration:**
|
||||
- **Protocol**: tcp, udp, tls, https, quic
|
||||
- **Address**: DNS server address
|
||||
- **Domains**: List of domains to be resolved using this DNS
|
||||
- Support configuring multiple DNS servers
|
||||
|
||||
**Outbound Rules:**
|
||||
Configure outbound proxies for specific traffic:
|
||||
- **Name**: Rule identifier
|
||||
- **Protocol**: Proxy protocol type
|
||||
- **Address**: Proxy server address
|
||||
- **Port**: Proxy server port
|
||||
- **Cipher**: Encryption method for protocols like Shadowsocks
|
||||
- **Password**: Proxy authentication password
|
||||
- **Rules**: Matching rules, such as domain names or IP ranges
|
||||
|
||||
**Block Rules:**
|
||||
Configure list of domains or IPs to block, supporting wildcards and regex.
|
||||
|
||||
### 3. Server List
|
||||
|
||||
The main body of the page displays all servers in a table format.
|
||||
|
||||
**Column Information:**
|
||||
- **ID**: Server unique identifier, displayed as a badge
|
||||
- **Name**: Server custom name
|
||||
- **Address**: Displays country/city/IP address using badge components
|
||||
- **Protocols**: Displays list of enabled protocols, each showing:
|
||||
- Multiplier (e.g., 1.00x)
|
||||
- Protocol type (e.g., vless, vmess, trojan, shadowsocks)
|
||||
- Port number
|
||||
- **Status**: Online/offline status with dot indicator
|
||||
- Green dot: Online
|
||||
- Gray dot: Offline
|
||||
- **CPU**: CPU usage percentage, displayed as a progress bar
|
||||
- **Memory**: Memory usage percentage, displayed as a progress bar
|
||||
- **Disk**: Disk usage percentage, displayed as a progress bar
|
||||
- **Online Users**: Number of currently connected users
|
||||
|
||||
**Operation Features:**
|
||||
- **Search**: Quickly filter servers by keyword
|
||||
- **Sorting**: Adjust server display order by dragging rows, sorting is saved to database
|
||||
- **Pagination**: Support paging for large number of servers
|
||||
- **Batch Delete**: Delete multiple selected servers (servers referenced by nodes cannot be deleted)
|
||||
|
||||
**Individual Server Operations:**
|
||||
- **Edit**: Modify server configuration
|
||||
- **Connect**: Display one-click installation script
|
||||
- **Delete**: Delete server (disabled when referenced by nodes)
|
||||
- **Copy**: Copy server configuration to create a new server
|
||||
|
||||
## Server Form
|
||||
|
||||
A sidebar form that opens when clicking "Create" or "Edit".
|
||||
|
||||
**Basic Information:**
|
||||
- **Name**: Required, server identifier name
|
||||
- **Country**: Server country code (e.g., CN, US, JP)
|
||||
- **City**: Server city
|
||||
- **Address**: Server IP address or domain
|
||||
|
||||
**Protocol Configuration:**
|
||||
|
||||
Support configuration of multiple proxy protocols, each expanded in accordion format. Protocol types used in nodes cannot be disabled.
|
||||
|
||||
**Common Protocol Fields:**
|
||||
- **Enable**: Toggle switch to control whether to enable the protocol
|
||||
- **Port**: Listening port number
|
||||
- **Ratio**: Traffic billing multiplier, e.g., 1.5 means 1.5 times actual traffic
|
||||
- **Encryption/Security**: Varies depending on protocol type
|
||||
|
||||
**Supported Protocol Types:**
|
||||
|
||||
1. **Shadowsocks**
|
||||
- Cipher: Encryption method (e.g., aes-256-gcm, chacha20-poly1305)
|
||||
- Password: Authentication password, supports generating random password
|
||||
|
||||
2. **Trojan**
|
||||
- Password: Authentication password, supports generating random password
|
||||
|
||||
3. **Vmess**
|
||||
- UUID: User identifier, supports auto-generation
|
||||
- Alter ID: Number of additional IDs
|
||||
|
||||
4. **Vless**
|
||||
- UUID: User identifier, supports auto-generation
|
||||
- Flow: Flow control mode (e.g., xtls-rprx-vision)
|
||||
|
||||
5. **Hysteria**
|
||||
- Up/Down Speed: Upload/download speed limits
|
||||
- Obfs Password: Obfuscation password
|
||||
|
||||
6. **Hysteria2**
|
||||
- Password: Authentication password
|
||||
- Obfs Password: Obfuscation password
|
||||
|
||||
7. **TUIC**
|
||||
- UUID: User identifier
|
||||
- Password: Authentication password
|
||||
- Congestion Control: Congestion control algorithm (e.g., bbr, cubic)
|
||||
- UDP Relay Mode: UDP relay mode
|
||||
|
||||
**Transport Configuration:**
|
||||
|
||||
Each protocol can be configured with different transport layers:
|
||||
- **TCP**: Basic TCP transport
|
||||
- **WS (WebSocket)**: WebSocket transport
|
||||
- Path: WebSocket path
|
||||
- Host: WebSocket Host header
|
||||
- **gRPC**: gRPC transport
|
||||
- Service Name: gRPC service name
|
||||
- **HTTP/2**: HTTP/2 transport
|
||||
- Path: Request path
|
||||
- Host: Host header
|
||||
- **QUIC**: QUIC protocol transport
|
||||
- **HTTPUpgrade**: HTTP upgrade transport
|
||||
- **SplitHTTP**: Split HTTP transport
|
||||
- **XHTTP**: Extended HTTP transport
|
||||
|
||||
**TLS Configuration:**
|
||||
- **TLS**: Whether to enable TLS
|
||||
- **Server Name**: SNI server name
|
||||
- **ALPN**: Application-Layer Protocol Negotiation (e.g., h2, http/1.1)
|
||||
- **Fingerprint**: TLS fingerprint (e.g., chrome, firefox, safari)
|
||||
- **Reality**: Reality protocol configuration
|
||||
- Public Key: Public key
|
||||
- Short ID: Short ID
|
||||
- Spider X: Spider X parameter
|
||||
|
||||
**Advanced Configuration:**
|
||||
- **Multiplex**: Multiplexing settings
|
||||
- **Encryption**: Additional encryption layer
|
||||
- **Flow Control**: Flow control parameters
|
||||
|
||||
**Field Generation:**
|
||||
|
||||
Some fields support auto-generation with a key icon:
|
||||
- **UUID**: Generate random UUID
|
||||
- **Password**: Generate random strong password
|
||||
- **Reality Key Pair**: Generate Public Key and Private Key
|
||||
- **Short ID**: Generate random short ID
|
||||
|
||||
## One-Click Installation
|
||||
|
||||
Click the "Connect" button to display the server node installation script.
|
||||
|
||||
**Configuration:**
|
||||
- **API Host**: API address of the management panel (automatically obtained from current domain, can be manually modified)
|
||||
- **Server ID**: Unique ID of the current server (auto-filled)
|
||||
- **Secret Key**: Automatically obtained from node configuration
|
||||
|
||||
**Install Command:**
|
||||
The generated bash script contains:
|
||||
```bash
|
||||
wget -N https://raw.githubusercontent.com/perfect-panel/ppanel-node/master/scripts/install.sh && bash install.sh --api-host [domain] --server-id [ID] --secret-key [key]
|
||||
```
|
||||
|
||||
**Operations:**
|
||||
- Click "Copy and Close" to copy the script with one click and close the popup
|
||||
- Execute the script on the server to automatically install and connect the node
|
||||
|
||||
## Online Users Viewing
|
||||
|
||||
Click the "Online Users" number to view details of currently online users on the server.
|
||||
|
||||
**Display Information:**
|
||||
- **User Account**: Link to user detail page
|
||||
- **Subscribe ID**: Subscription record ID
|
||||
- **Subscribe Name**: Plan name being used
|
||||
- **Traffic Usage**: Used traffic / Total traffic (displays "Unlimited" if unlimited)
|
||||
- **Expire Time**: Subscription expiration time, expired shows red "Expired" badge
|
||||
- **IP Address**: User connection IP, clickable to view IP information
|
||||
- **Connection Time**: Time when user established connection
|
||||
|
||||
## Data Refresh
|
||||
|
||||
Server status (CPU, Memory, Disk, Online Users) is updated in real-time according to the "Node Push Interval" set in "Node Configuration".
|
||||
@@ -0,0 +1,59 @@
|
||||
# Template Variable Reference
|
||||
|
||||
## Proxy Object Fields
|
||||
|
||||
### Basic Fields
|
||||
- `Name` - Node name
|
||||
- `Server` - Server address
|
||||
- `Port` - Server port
|
||||
- `Type` - Protocol type
|
||||
- `Tags` - Tag array
|
||||
- `Sort` - Sort order
|
||||
|
||||
### Security Options
|
||||
- `Security` - Security protocol
|
||||
- `SNI` - TLS server name
|
||||
- `AllowInsecure` - Allow insecure connections
|
||||
- `Fingerprint` - Client fingerprint
|
||||
- `RealityServerAddr` - Reality server address
|
||||
- `RealityPublicKey` - Reality public key
|
||||
- `RealityShortId` - Reality short ID
|
||||
|
||||
### Transport Options
|
||||
- `Transport` - Transport protocol (ws, http, grpc)
|
||||
- `Host` - Host for WebSocket/HTTP
|
||||
- `Path` - Path for HTTP/HTTPS
|
||||
- `ServiceName` - gRPC service name
|
||||
|
||||
### Protocol-Specific Fields
|
||||
|
||||
#### Shadowsocks
|
||||
- `Method` - Encryption method
|
||||
- `Cipher` - Cipher algorithm
|
||||
- `ServerKey` - Server key
|
||||
|
||||
#### Vmess/Vless
|
||||
- `UUID` - User ID
|
||||
- `Flow` - Flow control mode
|
||||
- `Encryption` - Encryption type
|
||||
|
||||
#### Trojan
|
||||
- `Password` - Password
|
||||
|
||||
#### Hysteria2
|
||||
- `UpMbps` - Upload bandwidth
|
||||
- `DownMbps` - Download bandwidth
|
||||
- `ObfsPassword` - Obfuscation password
|
||||
|
||||
#### TUIC
|
||||
- `CongestionController` - Congestion control algorithm
|
||||
- `UDPRelayMode` - UDP relay mode
|
||||
|
||||
## UserInfo Fields
|
||||
|
||||
- `Password` - User password
|
||||
- `ExpiredAt` - Expiration time
|
||||
- `Download` - Downloaded traffic
|
||||
- `Upload` - Uploaded traffic
|
||||
- `Traffic` - Total traffic
|
||||
- `SubscribeURL` - Subscription link
|
||||
@@ -0,0 +1,284 @@
|
||||
<div v-pre>
|
||||
|
||||
# Subscribe Configuration
|
||||
|
||||
Configure global subscription settings and manage subscription templates for client applications. Subscription configuration determines how users retrieve and use proxy node information.
|
||||
|
||||
## Page Components
|
||||
|
||||
The Subscribe Configuration page is divided into two main modules:
|
||||
|
||||
### 1. Subscription Configuration
|
||||
|
||||
A card at the top of the page for configuring global subscription system settings.
|
||||
|
||||
**Configuration Options:**
|
||||
|
||||
**Single Subscription Mode**
|
||||
- Type: Toggle switch
|
||||
- Function: Limit users to one active subscription
|
||||
- Note: Does not affect existing subscriptions, only applies to new ones
|
||||
- Use Case: Control subscription count, prevent account sharing
|
||||
|
||||
**Wildcard Resolution**
|
||||
- Type: Toggle switch
|
||||
- Function: Enable wildcard domain resolution for subscriptions
|
||||
- Note: Allows using wildcard domains to access subscription links
|
||||
- Example: `*.example.com` can match `sub1.example.com`, `sub2.example.com`
|
||||
|
||||
**Subscription Path**
|
||||
- Type: Text input
|
||||
- Function: Customize URL path for subscription endpoints
|
||||
- Format: `/your-custom-path`
|
||||
- Note: Better performance after system restart
|
||||
- Example: `/api/v1/subscribe` or `/sub`
|
||||
|
||||
**Subscription Domain**
|
||||
- Type: Multi-line text
|
||||
- Function: Customize domains for subscription links
|
||||
- Format: One domain per line
|
||||
- Example:
|
||||
```
|
||||
example.com
|
||||
www.example.com
|
||||
sub.example.com
|
||||
```
|
||||
- Use Cases:
|
||||
- Use CDN domains
|
||||
- Multi-domain load balancing
|
||||
- Domain backup
|
||||
|
||||
**User-Agent Restriction**
|
||||
- Type: Toggle switch
|
||||
- Function: Enable User-Agent based access control
|
||||
- Note: Only allow whitelisted clients to access subscriptions
|
||||
- Use Case: Prevent crawlers, restrict unauthorized access
|
||||
|
||||
**User-Agent Whitelist**
|
||||
- Type: Multi-line text
|
||||
- Function: Configure allowed User-Agent list for subscription access
|
||||
- Format: One User-Agent per line
|
||||
- Example:
|
||||
```
|
||||
ClashX
|
||||
ClashForAndroid
|
||||
Clash-verge
|
||||
```
|
||||
- Note: Configured application User-Agents are automatically included
|
||||
|
||||
### 2. Client Management
|
||||
|
||||
Manage subscription templates and download links for different proxy clients.
|
||||
|
||||
**Table Column Information:**
|
||||
- **Default**: Toggle switch to set as default client
|
||||
- Default client is prioritized on subscription page
|
||||
- Only one default client at a time
|
||||
- **Client Name**: Displays client icon and name
|
||||
- **User-Agent**: Client identifier for distinguishing different clients
|
||||
- **Output Format**: Format type of subscription content
|
||||
- Base64: Base64 encoded format
|
||||
- YAML: YAML configuration file format
|
||||
- JSON: JSON data format
|
||||
- CONF: Configuration file format
|
||||
- Plain Text: Plain text format
|
||||
- **Supported Platforms**: Shows operating systems supported by this client
|
||||
- Windows, macOS, Linux, iOS, Android, HarmonyOS
|
||||
- **Description**: Detailed client description
|
||||
|
||||
**Operation Features:**
|
||||
- **Preview**: View generated subscription template content
|
||||
- Base64 format shows both original and decoded content
|
||||
- Other formats display content directly
|
||||
- Supports syntax highlighting
|
||||
- **Edit**: Modify client configuration
|
||||
- **Delete**: Delete client configuration
|
||||
- **Batch Delete**: Delete multiple selected clients
|
||||
|
||||
**Top Toolbar:**
|
||||
- **Template Repo Link**: Jump to GitHub template repository
|
||||
- URL: https://github.com/perfect-panel/subscription-template
|
||||
- Provides subscription template examples and documentation
|
||||
- **Add**: Create new client configuration
|
||||
|
||||
## Client Form
|
||||
|
||||
A sidebar form that opens when clicking "Add" or "Edit", divided into three tabs.
|
||||
|
||||
### Basic Info
|
||||
|
||||
**Icon**
|
||||
- Type: URL input + Upload button
|
||||
- Format: Image URL or Base64 encoding
|
||||
- Example: `https://example.com/icon.png`
|
||||
- Function: Supports direct image upload, auto-converts to Base64
|
||||
|
||||
**Name** - Required
|
||||
- Type: Text input
|
||||
- Function: Client display name
|
||||
- Example: `Clash for Windows`, `V2rayN`
|
||||
|
||||
**User-Agent** - Required
|
||||
- Type: Text input
|
||||
- Function: Client identifier for distinguishing different clients
|
||||
- Example: `Clash`, `V2rayN`, `ClashX`
|
||||
- Important: Must match the actual User-Agent sent by the client
|
||||
|
||||
**Description** - Optional
|
||||
- Type: Multi-line text
|
||||
- Function: Detailed client description
|
||||
- Content: Client features, usage instructions, etc.
|
||||
|
||||
### Templates
|
||||
|
||||
**Output Format** - Required
|
||||
- Type: Dropdown selection
|
||||
- Options:
|
||||
- **Base64**: Traditional subscription format, suitable for most clients
|
||||
- **YAML**: Clash series client configuration format
|
||||
- **JSON**: JSON format configuration for clients supporting JSON
|
||||
- **CONF**: Configuration file format, like Shadowrocket
|
||||
- **Plain Text**: Plain text format
|
||||
|
||||
**Scheme** - Optional
|
||||
- Type: Text input
|
||||
- Function: Custom URL Scheme
|
||||
- Example: `clash://`, `vmess://`
|
||||
- Purpose: One-click subscription import
|
||||
|
||||
**Template** - Required
|
||||
- Type: Go Template editor
|
||||
- Function: Write subscription content using Go template syntax
|
||||
- Supports: Syntax highlighting, code completion
|
||||
- Variables:
|
||||
- `{{.SiteName}}`: Site name
|
||||
- `{{.SubscribeName}}`: Subscription name
|
||||
- `{{.Proxies}}`: Node array
|
||||
- `{{.UserInfo}}`: User information
|
||||
|
||||
**Template Variable Reference**
|
||||
|
||||
For detailed template variable reference, see: [Template Variable Reference](./subscribe-variables.md)
|
||||
|
||||
UserInfo Fields:
|
||||
|
||||
- `Password` - User password
|
||||
- `ExpiredAt` - Expiration time
|
||||
- `Download` - Downloaded traffic
|
||||
- `Upload` - Uploaded traffic
|
||||
- `Traffic` - Total traffic
|
||||
- `SubscribeURL` - Subscription link
|
||||
|
||||
### Downloads
|
||||
|
||||
Configure client download URLs for multiple platforms:
|
||||
|
||||
- **Windows**: Windows platform download link
|
||||
- **macOS**: macOS platform download link
|
||||
- **Linux**: Linux platform download link
|
||||
- **iOS**: iOS platform download link
|
||||
- **Android**: Android platform download link
|
||||
- **HarmonyOS**: HarmonyOS download link
|
||||
|
||||
Each platform is optional. When filled, corresponding platform badges will be displayed in the client list.
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Scenario 1: Configure Clash Client
|
||||
|
||||
1. Click "Add"
|
||||
2. Basic Info:
|
||||
- Name: `Clash for Windows`
|
||||
- User-Agent: `Clash`
|
||||
- Icon: Upload Clash icon
|
||||
3. Templates:
|
||||
- Output Format: Select `YAML`
|
||||
- Template: Write Clash YAML configuration template
|
||||
4. Downloads:
|
||||
- Windows: `https://github.com/Fndroid/clash_for_windows_pkg/releases`
|
||||
- macOS: `https://github.com/yichengchen/clashX/releases`
|
||||
5. Click "Confirm"
|
||||
|
||||
### Scenario 2: Configure Traditional Base64 Subscription
|
||||
|
||||
1. Click "Add"
|
||||
2. Basic Info:
|
||||
- Name: `Universal`
|
||||
- User-Agent: `*`
|
||||
3. Templates:
|
||||
- Output Format: Select `Base64`
|
||||
- Template: Write standard vmess/vless URI list
|
||||
4. Set as default client
|
||||
5. Click "Confirm"
|
||||
|
||||
### Scenario 3: Restrict Subscription Access
|
||||
|
||||
1. Open "Subscription Configuration"
|
||||
2. Enable "User-Agent Restriction"
|
||||
3. Add to "User-Agent Whitelist":
|
||||
```
|
||||
Clash
|
||||
V2rayN
|
||||
ClashX
|
||||
Quantumult
|
||||
```
|
||||
4. Save configuration
|
||||
5. Only whitelisted clients can access subscriptions
|
||||
|
||||
### Scenario 4: Use Custom Domain
|
||||
|
||||
1. Open "Subscription Configuration"
|
||||
2. Add to "Subscription Domain":
|
||||
```
|
||||
sub.example.com
|
||||
cdn.example.com
|
||||
```
|
||||
3. Configure "Subscription Path": `/api/sub`
|
||||
4. Save configuration
|
||||
5. Users can access subscriptions via `https://sub.example.com/api/sub/{token}`
|
||||
|
||||
## Template Writing Guide
|
||||
|
||||
### Base64 Format Example
|
||||
```go
|
||||
{{range .Proxies}}{{.Type}}://{{.UUID}}@{{.Server}}:{{.Port}}?security={{.Security}}&sni={{.SNI}}#{{.Name}}
|
||||
{{end}}
|
||||
```
|
||||
|
||||
### Clash YAML Format Example
|
||||
```yaml
|
||||
proxies:
|
||||
{{range .Proxies}}
|
||||
- name: {{.Name}}
|
||||
type: {{.Type}}
|
||||
server: {{.Server}}
|
||||
port: {{.Port}}
|
||||
{{if eq .Type "vless"}}uuid: {{.UUID}}{{end}}
|
||||
{{if eq .Type "vmess"}}uuid: {{.UUID}}{{end}}
|
||||
{{if eq .Type "trojan"}}password: {{.Password}}{{end}}
|
||||
{{end}}
|
||||
```
|
||||
|
||||
### Conditional Logic Example
|
||||
```go
|
||||
{{range .Proxies}}
|
||||
{{if eq .Type "vless"}}
|
||||
vless://{{.UUID}}@{{.Server}}:{{.Port}}
|
||||
{{else if eq .Type "vmess"}}
|
||||
vmess://{{.UUID}}@{{.Server}}:{{.Port}}
|
||||
{{end}}
|
||||
{{end}}
|
||||
```
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **User-Agent Matching**: Must exactly match the User-Agent sent by the client, otherwise cannot be correctly identified
|
||||
2. **Template Syntax**: Uses Go Template syntax, syntax errors will cause subscription generation failure
|
||||
3. **Output Format**: Ensure template output matches selected format, e.g., YAML format requires correct indentation
|
||||
4. **Default Client**: Only one default client at a time, setting new default will cancel the old one
|
||||
5. **Domain Configuration**: Custom domains need to be correctly configured in DNS and web server
|
||||
6. **Path Changes**: After changing subscription path, system restart recommended for best performance
|
||||
7. **Preview Function**: Use preview to test if template generates correctly
|
||||
8. **Template Repository**: Refer to GitHub template repository for more examples and best practices
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,131 @@
|
||||
<div v-pre>
|
||||
|
||||
# Announcement Management
|
||||
|
||||
Create and manage system announcements with display control, pinning, and popup features.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Show
|
||||
Switch button to control whether the announcement displays on the frontend.
|
||||
|
||||
### Pinned
|
||||
Switch button to control whether the announcement is pinned to top.
|
||||
|
||||
### Popup
|
||||
Switch button to control whether to show announcement as popup when users visit.
|
||||
|
||||
### Title
|
||||
Announcement title.
|
||||
|
||||
### Content
|
||||
Announcement body content (supports Markdown).
|
||||
|
||||
### Updated At
|
||||
Last update time.
|
||||
|
||||
## Table Operations
|
||||
|
||||
### Edit
|
||||
Opens side drawer form to modify announcement information.
|
||||
|
||||
### Delete
|
||||
Deletes announcement (requires confirmation), cannot be recovered.
|
||||
|
||||
### Batch Delete
|
||||
Deletes multiple selected announcements.
|
||||
|
||||
## Announcement Form
|
||||
|
||||
### Title (Required)
|
||||
Announcement title text.
|
||||
|
||||
### Content (Required)
|
||||
Announcement body content, supports Markdown format:
|
||||
- Headings: # ## ###
|
||||
- Bold: **text**
|
||||
- Italic: *text*
|
||||
- Lists: - item
|
||||
- Links: [text](url)
|
||||
- Code: `code`
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Enable Filter
|
||||
- Show: View displayed announcements
|
||||
- Hide: View hidden announcements
|
||||
|
||||
### Keyword Search
|
||||
Search announcements by title or content.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: Create Important Notice
|
||||
|
||||
**Form Config**:
|
||||
- Title: System Maintenance Notice
|
||||
- Content:
|
||||
```
|
||||
# System Maintenance Notice
|
||||
|
||||
The system will undergo maintenance upgrade on **Jan 1, 2024 02:00-04:00**.
|
||||
|
||||
## Affected Scope
|
||||
- Website temporarily unavailable
|
||||
- Services unaffected
|
||||
|
||||
Thank you for your understanding!
|
||||
```
|
||||
- Show: On
|
||||
- Pinned: On
|
||||
- Popup: On
|
||||
|
||||
### Scenario 2: Create Activity Announcement
|
||||
|
||||
**Form Config**:
|
||||
- Title: Double 11 Sale
|
||||
- Content:
|
||||
```
|
||||
## 🎉 Double 11 Sale
|
||||
|
||||
- All plans **20% OFF**
|
||||
- Annual plans get extra **30 days**
|
||||
- Period: 11.11-11.13
|
||||
|
||||
[Buy Now](/subscribe)
|
||||
```
|
||||
- Show: On
|
||||
- Pinned: On
|
||||
- Popup: No
|
||||
|
||||
### Scenario 3: Create Usage Guide
|
||||
|
||||
**Form Config**:
|
||||
- Title: Beginner's Guide
|
||||
- Content:
|
||||
```
|
||||
# Beginner's Guide
|
||||
|
||||
## 1. Purchase Plan
|
||||
Go to [Subscribe Page](/subscribe) and select a plan
|
||||
|
||||
## 2. Download Client
|
||||
Visit [Documentation](/docs) to download client
|
||||
|
||||
## 3. Import Config
|
||||
Copy subscription link to client
|
||||
```
|
||||
- Show: On
|
||||
- Pinned: No
|
||||
- Popup: No
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Markdown Support**: Content supports Markdown for beautiful formatting
|
||||
2. **Popup Feature**: When enabled, users see popup on every visit
|
||||
3. **Pinned Display**: Pinned announcements appear at top of list
|
||||
4. **Display Control**: Can create first, then enable display later
|
||||
5. **Batch Delete**: Delete operation irreversible, use carefully
|
||||
6. **Update Time**: Timestamp updates on every edit
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,155 @@
|
||||
<div v-pre>
|
||||
|
||||
# Marketing Management
|
||||
|
||||
Provides two major marketing functions: email marketing and quota services for batch user outreach and benefit distribution.
|
||||
|
||||
## Function Modules
|
||||
|
||||
### Email Marketing
|
||||
|
||||
Contains two functions:
|
||||
|
||||
#### 1. Email Broadcast
|
||||
|
||||
Send marketing emails to users in bulk.
|
||||
|
||||
**Form Fields**:
|
||||
|
||||
- **Email Subject** (Required) - Email title
|
||||
- **Email Content** (Required) - Supports HTML editor for rich text emails
|
||||
- **Send Scope** - Select target user group:
|
||||
- All users
|
||||
- Users with subscriptions
|
||||
- Users without subscriptions
|
||||
- Filter by registration time
|
||||
- **Registration Time Range** (Optional) - Filter users registered in specific period
|
||||
- **Additional Emails** (Optional) - Manually input extra email addresses, one per line
|
||||
- **Scheduled Send** (Optional) - Set future send time
|
||||
- **Send Interval** (Optional) - Seconds between each email (minimum 0.1s)
|
||||
- **Daily Limit** (Optional) - Maximum sends per day (minimum 1)
|
||||
|
||||
**Recipient Statistics**:
|
||||
Form displays in real-time:
|
||||
- System users count
|
||||
- Additional emails count
|
||||
- Total recipients count
|
||||
|
||||
#### 2. Email Task Manager
|
||||
|
||||
View and manage email sending tasks.
|
||||
|
||||
**Task List Shows**:
|
||||
- Task ID
|
||||
- Subject
|
||||
- Send status
|
||||
- Sent count
|
||||
- Total count
|
||||
- Creation time
|
||||
|
||||
**Task Operations**:
|
||||
- View details
|
||||
- Pause/Resume
|
||||
- Delete task
|
||||
|
||||
### Quota Service
|
||||
|
||||
Batch gift traffic, days, or balance to users.
|
||||
|
||||
#### 1. Quota Broadcast
|
||||
|
||||
Batch gift benefits to subscribed users.
|
||||
|
||||
**Form Fields**:
|
||||
|
||||
- **Select Packages** (Required) - Multi-select target product plans
|
||||
- **Subscription Status** - Filter condition:
|
||||
- Active subscriptions only
|
||||
- Include expired subscriptions
|
||||
- **Subscription Time Range** (Optional) - Filter users subscribed in specific period
|
||||
- **Reset Traffic** - Switch, whether to reset user traffic when gifting
|
||||
- **Gift Type** (Required) - Radio:
|
||||
- Traffic (GB)
|
||||
- Days
|
||||
- Balance
|
||||
- **Gift Value** (Required) - Specific gift amount
|
||||
|
||||
**Recipient Statistics**:
|
||||
Form displays qualifying user count in real-time.
|
||||
|
||||
#### 2. Quota Task Manager
|
||||
|
||||
View and manage quota distribution tasks.
|
||||
|
||||
**Task List Shows**:
|
||||
- Task ID
|
||||
- Package names
|
||||
- Gift type and amount
|
||||
- Processing status
|
||||
- Processed/Total
|
||||
- Creation time
|
||||
|
||||
**Task Operations**:
|
||||
- View details
|
||||
- Delete task
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: New User Welcome Email
|
||||
|
||||
**Email Broadcast Config**:
|
||||
- Subject: Welcome!
|
||||
- Content: Design welcome email (HTML)
|
||||
- Scope: All users
|
||||
- Registration: Last 7 days
|
||||
- Interval: 1 second
|
||||
- Daily Limit: 1000
|
||||
|
||||
### Scenario 2: Promotion Notification
|
||||
|
||||
**Email Broadcast Config**:
|
||||
- Subject: Limited Time! 20% Off Annual Plans
|
||||
- Content: Activity details (HTML)
|
||||
- Scope: Users with subscriptions
|
||||
- Scheduled: 1 hour before activity
|
||||
|
||||
### Scenario 3: Gift Traffic Benefit
|
||||
|
||||
**Quota Broadcast Config**:
|
||||
- Packages: Standard Monthly
|
||||
- Status: Active only
|
||||
- Subscription Time: Past 30 days
|
||||
- Reset Traffic: No
|
||||
- Gift Type: Traffic
|
||||
- Gift Value: 10 GB
|
||||
|
||||
### Scenario 4: Gift Membership Duration
|
||||
|
||||
**Quota Broadcast Config**:
|
||||
- Packages: All packages
|
||||
- Status: Active only
|
||||
- Reset Traffic: No
|
||||
- Gift Type: Days
|
||||
- Gift Value: 7
|
||||
|
||||
### Scenario 5: Balance Cashback
|
||||
|
||||
**Quota Broadcast Config**:
|
||||
- Packages: Premium Plan
|
||||
- Status: Active only
|
||||
- Subscription Time: Past 7 days
|
||||
- Gift Type: Balance
|
||||
- Gift Value: $10
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Email Sending**: Watch interval and limits to avoid spam classification
|
||||
2. **HTML Content**: Emails support rich text for beautiful marketing content
|
||||
3. **Scheduled Tasks**: Can set future time for automatic sending
|
||||
4. **Real-time Stats**: Recipient count calculated in real-time, preview before submit
|
||||
5. **Task Management**: Can view task execution progress and status
|
||||
6. **Quota Gifting**: Quotas distributed immediately, cannot be revoked
|
||||
7. **Traffic Reset**: Checking will reset user's current traffic
|
||||
8. **Package Filtering**: Can precisely select target user groups
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,172 @@
|
||||
<div v-pre>
|
||||
|
||||
# Ads Management
|
||||
|
||||
Create and manage platform advertisements with multiple ad types and validity period control.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Status
|
||||
Switch button to control whether ad is displayed.
|
||||
|
||||
### Title
|
||||
Ad title.
|
||||
|
||||
### Type
|
||||
Ad type (displayed as Badge):
|
||||
- Banner
|
||||
- Popup
|
||||
- Sidebar
|
||||
- Notice
|
||||
|
||||
### Target URL
|
||||
Link to redirect when ad is clicked.
|
||||
|
||||
### Description
|
||||
Ad description text.
|
||||
|
||||
### Validity Period
|
||||
Ad display time range:
|
||||
- Start time
|
||||
- End time
|
||||
|
||||
## Table Operations
|
||||
|
||||
### Edit
|
||||
Opens side drawer to modify ad.
|
||||
|
||||
### Delete
|
||||
Deletes ad (requires confirmation), cannot be recovered.
|
||||
|
||||
### Create Ad
|
||||
Adds new advertisement.
|
||||
|
||||
## Ad Form
|
||||
|
||||
### Title (Required)
|
||||
Ad title displayed to users.
|
||||
|
||||
### Type (Required)
|
||||
Select ad type:
|
||||
- **Banner**: Top or bottom banner ad
|
||||
- **Popup**: Page popup ad
|
||||
- **Sidebar**: Fixed sidebar ad
|
||||
- **Notice**: Scrolling notice bar ad
|
||||
|
||||
### Target URL (Optional)
|
||||
URL to redirect when ad is clicked:
|
||||
- External link: https://example.com
|
||||
- Internal page: /pricing
|
||||
- Leave empty for non-clickable
|
||||
|
||||
### Description (Optional)
|
||||
Ad description or detailed content.
|
||||
|
||||
### Image URL (Optional, required for some types)
|
||||
Ad image address:
|
||||
- Banner and Popup usually need images
|
||||
- Use external image links
|
||||
- Recommended sizes: Banner 1920x200, Popup 800x600
|
||||
|
||||
### Validity Period (Required)
|
||||
Set ad display time range:
|
||||
- Start Time: When ad starts displaying
|
||||
- End Time: When ad stops displaying
|
||||
- Can create scheduled ads in advance
|
||||
|
||||
### Status (Default disabled)
|
||||
Control whether ad displays immediately:
|
||||
- Disabled by default when created
|
||||
- Displays during validity period when enabled
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Status Filter
|
||||
Select "Enabled" or "Disabled" to view corresponding ads.
|
||||
|
||||
### Keyword Search
|
||||
Search ad titles.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: Create Promotional Banner
|
||||
|
||||
**Form Config**:
|
||||
- Title: Double 11 Special Sale
|
||||
- Type: Banner
|
||||
- Target URL: /pricing
|
||||
- Description: 20% off all plans
|
||||
- Image URL: https://cdn.example.com/banner-1111.jpg
|
||||
- Validity Period:
|
||||
- Start: 2024-11-11 00:00
|
||||
- End: 2024-11-11 23:59
|
||||
- Status: Enabled
|
||||
|
||||
### Scenario 2: Create Popup Announcement
|
||||
|
||||
**Form Config**:
|
||||
- Title: Important System Upgrade Notice
|
||||
- Type: Popup
|
||||
- Target URL: /announcement/123
|
||||
- Description: System maintenance tonight 22:00-23:00...
|
||||
- Image URL: https://cdn.example.com/popup-upgrade.jpg
|
||||
- Validity Period:
|
||||
- Start: 2024-01-15 08:00
|
||||
- End: 2024-01-15 23:00
|
||||
- Status: Enabled
|
||||
|
||||
### Scenario 3: Create Sidebar Promotion
|
||||
|
||||
**Form Config**:
|
||||
- Title: Refer Friends for Commission
|
||||
- Type: Sidebar
|
||||
- Target URL: /invite
|
||||
- Description: Invite friends to register, get 10% commission
|
||||
- Image URL: https://cdn.example.com/sidebar-invite.jpg
|
||||
- Validity Period:
|
||||
- Start: 2024-01-01 00:00
|
||||
- End: 2024-12-31 23:59
|
||||
- Status: Enabled
|
||||
|
||||
### Scenario 4: Create Notice Ticker
|
||||
|
||||
**Form Config**:
|
||||
- Title: New Node Online
|
||||
- Type: Notice
|
||||
- Target URL: /nodes
|
||||
- Description: New Los Angeles high-speed node, try it now!
|
||||
- Validity Period:
|
||||
- Start: 2024-01-20 00:00
|
||||
- End: 2024-01-27 23:59
|
||||
- Status: Enabled
|
||||
|
||||
## Ad Display Rules
|
||||
|
||||
### Display Conditions
|
||||
Ad must satisfy all:
|
||||
1. Status is "Enabled"
|
||||
2. Current time within validity period
|
||||
3. Corresponding page supports the type
|
||||
|
||||
### Display Position
|
||||
- **Banner**: Top or bottom of page
|
||||
- **Popup**: Pops up on page load
|
||||
- **Sidebar**: Fixed on right side of page
|
||||
- **Notice**: Scrolling bar at top of page
|
||||
|
||||
### Display Frequency
|
||||
- Popup type: Once per user per day
|
||||
- Other types: Continuous display
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Validity Period**: Expired ads auto-hide, no manual disabling needed
|
||||
2. **External Images**: Use CDN links for fast loading
|
||||
3. **Link Testing**: Test target link before creation
|
||||
4. **Size Standards**: Different ad types need different image sizes
|
||||
5. **Content Compliance**: Ad content must comply with laws
|
||||
6. **Create in Advance**: Can create scheduled ads ahead of time
|
||||
7. **Popup Frequency**: Don't show popups too frequently
|
||||
8. **Mobile Adaptation**: Ensure images display properly on mobile
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,114 @@
|
||||
# Auth Control
|
||||
|
||||
>`System → Auth Control` focuses on **how** users log in and verify their identity. Configure email, SMS, social sign-in, and device authentication in one place, with built-in testing tools so every change can be validated instantly.
|
||||
|
||||
## Module Overview
|
||||
|
||||
- **Communication methods**: Email + SMS login, complete with verification flows, whitelists, and message templates.
|
||||
- **Social accounts**: Apple, Google, Facebook, GitHub, and Telegram can be toggled independently.
|
||||
- **Device authentication**: Hardens device-based login with VM detection and communication keys.
|
||||
|
||||
The following sections mirror the cards you see in the admin panel—work through them in order, test, then save.
|
||||
|
||||
## Communication Methods
|
||||
|
||||
### Email authentication
|
||||
|
||||
1. **Basic switches**
|
||||
- `Enable email sign-in`: Controls whether the login form shows the email path.
|
||||
- `Email verification`: Forces new users or sensitive actions to complete email OTP first.
|
||||
- `Domain whitelist`: Only allow addresses from specific domains (one suffix per line, e.g. `gmail.com`).
|
||||
|
||||
2. **SMTP platform**
|
||||
- `Server` & `Port`: SMTP host/port (most providers use 25/465/587).
|
||||
- `SSL/TLS`: Match the encryption required by your provider.
|
||||
- `Account / Password`: SMTP credentials (app passwords recommended).
|
||||
- `From address`: What recipients see in their inbox; must match an allowed sender.
|
||||
- `Send test email`: Enter any inbox and send immediately to confirm deliverability.
|
||||
|
||||
3. **Template tabs** (`Verify / Expiration / Maintenance / Traffic`)
|
||||
- Templates are HTML-capable and support variables:
|
||||
- `{{.Type}}`: Email type (1 register, 2 reset password); combine with `{{if eq .Type 1}}` for conditions.
|
||||
- `{{.SiteLogo}}` / `{{.SiteName}}`: Branding assets.
|
||||
- `{{.Expire}}`: OTP expiration; `{{.ExpireDate}}`: Subscription expiration.
|
||||
- `{{.Code}}`: Verification code.
|
||||
- `{{.MaintenanceDate}}`, `{{.MaintenanceTime}}`: Maintenance notice specifics.
|
||||
- The embedded editor is WYSIWYG—save to apply instantly to new outbound mail.
|
||||
|
||||
### SMS authentication
|
||||
|
||||
1. **Login policy**
|
||||
- `Enable SMS sign-in`: Turns the phone-number OTP entry on/off.
|
||||
- `Whitelist area codes`: When enabled, only listed codes (e.g. `1, 852, 886`) are accepted.
|
||||
|
||||
2. **Platform & dynamic fields**
|
||||
- Select an SMS provider; the form reveals the exact fields that provider requires and offers a shortcut link to apply for service.
|
||||
- Common fields include `Access Key`, `Secret Key`, `Endpoint`, `Template Code`, `Sign Name`, and dedicated sender numbers.
|
||||
- If the provider expects custom templates, paste the body that contains `{{code}}` (or its vendor-specific variable).
|
||||
|
||||
3. **Test SMS**
|
||||
- Choose an area code, enter a number, and click “Test SMS” to call the gateway immediately.
|
||||
- Most failures trace back to invalid credentials, pending template review, or a mismatched signature—verify inside the vendor console.
|
||||
|
||||
## Social Authentication
|
||||
|
||||
All social options share the same drawer layout: toggle the method, fill in the credentials, then save to expose the login button to end users.
|
||||
|
||||
### Apple Sign-In
|
||||
- **Team ID / Key ID**: From Apple Developer.
|
||||
- **Service ID (Client ID)**: Created under Apple Developer → Identifiers.
|
||||
- **Private Key**: Contents of the `.p8` key file (keep the `BEGIN/END` markers).
|
||||
- **Redirect URL**: API endpoint the user returns to after Apple auth; omit trailing `/`.
|
||||
|
||||
### Google Sign-In
|
||||
- **Client ID / Client Secret**: OAuth credentials created in Google Cloud Console (Web application type).
|
||||
- Add your site’s callback—for example `/api/auth/google/callback`—to the authorized redirect URIs.
|
||||
|
||||
### Facebook Login
|
||||
- **App ID / App Secret**: From the Facebook Developer portal. Make sure your domain is listed under “Valid OAuth Redirect URIs”.
|
||||
|
||||
### GitHub Login
|
||||
- **Client ID / Client Secret**: From GitHub Developer Settings → OAuth Apps.
|
||||
- Set the callback to something like `https://your-domain.com/api/auth/github/callback` and require HTTPS.
|
||||
|
||||
### Telegram Login
|
||||
- **Bot ID / Bot Token**: Generated via @BotFather (enable the Login Widget permission).
|
||||
- Users authorize by interacting with your bot; once configured the official Telegram dialog will pop up automatically.
|
||||
|
||||
## Device Authentication
|
||||
|
||||
Best for client/TV apps that exchange a one-time device code.
|
||||
|
||||
- `Enable device sign-in`: Allows devices to authenticate via code or QR pairing.
|
||||
- `Show ads`: Toggles advertising surfaces on the device experience.
|
||||
- `Block virtual machine`: Rejects requests coming from emulators/VMs.
|
||||
- `Enable security`: Forces every device request to include a shared communication key.
|
||||
- `Communication key`: Paste your own or click the dice icon to auto-generate a 32-character GUID; create one per channel and keep it secret.
|
||||
|
||||
## Operational Tips
|
||||
|
||||
- Snapshot SMTP/SMS credentials before switching providers so you can roll back quickly.
|
||||
- Always use “Send test email” or “Test SMS” after editing settings—production users should never be the first to try a new config.
|
||||
- Provider-specific SMS fields change dynamically; if a required field is missing, define it in the vendor console via template variables.
|
||||
- For OAuth flows (Apple/Google/etc.), rehearse the entire login in a sandbox account to confirm the redirect URI and scopes are correct.
|
||||
- Treat the communication key as a secret—share it only with trusted client apps and never commit it to version control.
|
||||
|
||||
## FAQs
|
||||
|
||||
### Email sends but users still see “verification failed”
|
||||
- Confirm the domain whitelist includes the user’s email suffix.
|
||||
- Some enterprise SMTP vendors require the From address to exactly match the authenticated account—otherwise the message is dropped.
|
||||
|
||||
### SMS keeps failing
|
||||
- Ensure the template is approved and that the placeholder name (e.g., `{{code}}`) matches what the vendor expects.
|
||||
- Verify the destination area code is whitelisted.
|
||||
- Still failing? Inspect the API error code in DevTools and cross reference it with the SMS provider documentation.
|
||||
|
||||
### OAuth redirect mismatch errors
|
||||
- Facebook, Google, and GitHub demand an exact match on the redirect URI, including protocol and trailing path—copy the admin value verbatim into the vendor console.
|
||||
|
||||
## Related Docs
|
||||
|
||||
- [System Config](/admin/system/config): Branding, SMTP defaults, and other site-wide settings.
|
||||
- [Payment Config](/admin/system/payment): Configure gateways after your login flows are working.
|
||||
- [Ads Config](/admin/system/ads): Pairs with the “Show ads” option in device authentication.
|
||||
@@ -0,0 +1,556 @@
|
||||
# System Configuration
|
||||
|
||||
The System Configuration module manages global settings and parameters, controlling overall system behavior.
|
||||
|
||||
## Overview
|
||||
|
||||
### Basic Settings
|
||||
|
||||
System basic configuration:
|
||||
|
||||
- **Site Name**: System display name
|
||||
- **Site Logo**: Website logo image
|
||||
- **Site Icon**: Browser tab icon (Favicon)
|
||||
- **Site Description**: Site intro and SEO description
|
||||
- **Keywords**: SEO keywords
|
||||
- **Contact Info**: Customer service contact
|
||||
|
||||
### System Info
|
||||
|
||||
View system runtime information:
|
||||
|
||||
- **System Version**: Current version number
|
||||
- **Environment**: Server environment info
|
||||
- **Uptime**: System uptime
|
||||
- **Status**: Current running status
|
||||
- **Database**: Database configuration
|
||||
- **Cache**: Cache configuration and status
|
||||
|
||||
## Site Configuration
|
||||
|
||||
### Site Information
|
||||
|
||||
Configure site basics:
|
||||
|
||||
- **Site Name**: Display name on pages
|
||||
- **Tagline**: Subtitle or slogan
|
||||
- **Logo**: Upload website logo
|
||||
- **Favicon**: Upload favicon
|
||||
- **Copyright**: Footer copyright info
|
||||
- **ICP Registration**: Site registration number
|
||||
|
||||
### SEO Settings
|
||||
|
||||
Search engine optimization:
|
||||
|
||||
- **Page Title**: Default page title
|
||||
- **Keywords**: SEO keyword settings
|
||||
- **Description**: Site description
|
||||
- **robots.txt**: Search crawler rules
|
||||
- **sitemap**: Sitemap configuration
|
||||
|
||||
### Contact Information
|
||||
|
||||
Set contact methods:
|
||||
|
||||
- **Support Email**: Customer service email
|
||||
- **Phone**: Customer service phone
|
||||
- **Live Chat**: Live chat link
|
||||
- **Ticket System**: Ticket submission URL
|
||||
- **Social Media**: Social media links
|
||||
|
||||
## Email Configuration
|
||||
|
||||
### SMTP Settings
|
||||
|
||||
Configure email service:
|
||||
|
||||
- **SMTP Server**: Mail server address
|
||||
- **SMTP Port**: Server port (25/465/587)
|
||||
- **From Address**: Sender email address
|
||||
- **From Name**: Display sender name
|
||||
- **SMTP Username**: SMTP auth username
|
||||
- **SMTP Password**: SMTP auth password
|
||||
- **Encryption**: SSL/TLS encryption
|
||||
|
||||
### Email Templates
|
||||
|
||||
Configure email content:
|
||||
|
||||
- **Registration Email**: Registration verification
|
||||
- **Password Reset**: Password reset email
|
||||
- **Order Notification**: Order-related notices
|
||||
- **System Notification**: System messages
|
||||
- **Marketing Email**: Marketing campaigns
|
||||
|
||||
### Email Testing
|
||||
|
||||
Test email configuration:
|
||||
|
||||
- Send test email
|
||||
- Verify configuration
|
||||
- Check delivery rate
|
||||
- View send logs
|
||||
|
||||
## SMS Configuration
|
||||
|
||||
### SMS Provider
|
||||
|
||||
Configure SMS service:
|
||||
|
||||
- **Provider**: Alibaba Cloud/Tencent Cloud/Other
|
||||
- **AccessKey**: API access key
|
||||
- **AccessSecret**: API secret
|
||||
- **SMS Signature**: SMS sender signature
|
||||
- **SMS Template**: SMS content template
|
||||
|
||||
### SMS Templates
|
||||
|
||||
Configure SMS content:
|
||||
|
||||
- **Verification Code**: Login/register verification
|
||||
- **Notification SMS**: Order, renewal notices
|
||||
- **Marketing SMS**: Campaign promotions
|
||||
|
||||
### SMS Testing
|
||||
|
||||
Test SMS functionality:
|
||||
|
||||
- Send test SMS
|
||||
- Verify configuration
|
||||
- View send records
|
||||
|
||||
## Storage Configuration
|
||||
|
||||
### Local Storage
|
||||
|
||||
Local file storage:
|
||||
|
||||
- **Storage Path**: File storage directory
|
||||
- **Access URL**: File access address
|
||||
- **Max Size**: Single file size limit
|
||||
- **Allowed Types**: Allowed file types
|
||||
|
||||
### Cloud Storage
|
||||
|
||||
Object storage service:
|
||||
|
||||
**Alibaba Cloud OSS**:
|
||||
- Endpoint
|
||||
- AccessKey ID
|
||||
- AccessKey Secret
|
||||
- Bucket name
|
||||
- CDN domain
|
||||
|
||||
**Tencent Cloud COS**:
|
||||
- SecretId
|
||||
- SecretKey
|
||||
- Bucket
|
||||
- Region
|
||||
- CDN domain
|
||||
|
||||
**AWS S3**:
|
||||
- Access Key
|
||||
- Secret Key
|
||||
- Bucket
|
||||
- Region
|
||||
- CDN
|
||||
|
||||
### CDN Configuration
|
||||
|
||||
CDN acceleration:
|
||||
|
||||
- **CDN Domain**: Acceleration domain
|
||||
- **Cache Rules**: Cache policy
|
||||
- **Hotlink Protection**: Anti-hotlinking
|
||||
- **HTTPS**: HTTPS configuration
|
||||
|
||||
## Security Configuration
|
||||
|
||||
### Access Control
|
||||
|
||||
Control system access:
|
||||
|
||||
- **Maintenance Mode**: Enable maintenance
|
||||
- **IP Whitelist**: Allowed IPs
|
||||
- **IP Blacklist**: Blocked IPs
|
||||
- **Rate Limiting**: API rate limits
|
||||
- **Login Limits**: Failed login attempts
|
||||
|
||||
### Password Policy
|
||||
|
||||
Set password security policy:
|
||||
|
||||
- **Min Length**: Minimum password length
|
||||
- **Complexity**: Must include letters/numbers/symbols
|
||||
- **Expiration**: Password validity period
|
||||
- **History**: Cannot reuse old passwords
|
||||
- **Initial Password**: Default password rules
|
||||
|
||||
### Two-Factor Authentication
|
||||
|
||||
Two-step verification:
|
||||
|
||||
- **Enable 2FA**: Mandatory or optional
|
||||
- **Auth Method**: SMS/Email/TOTP
|
||||
- **Valid Time**: Verification code validity
|
||||
- **Backup Method**: Alternative verification
|
||||
|
||||
### SSL/TLS
|
||||
|
||||
HTTPS security:
|
||||
|
||||
- **Force HTTPS**: Enforce HTTPS
|
||||
- **SSL Certificate**: Upload SSL certificate
|
||||
- **HSTS**: HTTP Strict Transport Security
|
||||
- **Certificate Renewal**: Auto-renewal
|
||||
|
||||
## Cache Configuration
|
||||
|
||||
### Cache Type
|
||||
|
||||
Select cache method:
|
||||
|
||||
- **File Cache**: Use file system
|
||||
- **Redis Cache**: Use Redis
|
||||
- **Memcached**: Use Memcached
|
||||
|
||||
### Redis Settings
|
||||
|
||||
Redis cache configuration:
|
||||
|
||||
- **Redis Host**: Redis server address
|
||||
- **Redis Port**: Default 6379
|
||||
- **Redis Password**: Auth password
|
||||
- **Database**: Redis database number
|
||||
- **Prefix**: Cache key prefix
|
||||
|
||||
### Cache Management
|
||||
|
||||
Manage system cache:
|
||||
|
||||
- **Clear Cache**: Clear all cache
|
||||
- **Refresh Cache**: Refresh specific cache
|
||||
- **Cache Stats**: View cache usage
|
||||
- **Warm Cache**: Preload common data
|
||||
|
||||
## Queue Configuration
|
||||
|
||||
### Queue Driver
|
||||
|
||||
Configure task queue:
|
||||
|
||||
- **Sync**: Synchronous execution
|
||||
- **Database**: Use database queue
|
||||
- **Redis**: Use Redis queue
|
||||
- **Other**: RabbitMQ etc.
|
||||
|
||||
### Queue Settings
|
||||
|
||||
Queue configuration:
|
||||
|
||||
- **Queue Name**: Queue identifier
|
||||
- **Retry**: Retry attempts on failure
|
||||
- **Timeout**: Task execution timeout
|
||||
- **Concurrency**: Concurrent execution count
|
||||
|
||||
### Queue Monitoring
|
||||
|
||||
Monitor queue status:
|
||||
|
||||
- **Queue Length**: Pending tasks
|
||||
- **Running**: Tasks in progress
|
||||
- **Failed**: Failed tasks
|
||||
- **History**: Execution history
|
||||
|
||||
## Log Configuration
|
||||
|
||||
### Log Settings
|
||||
|
||||
Configure system logs:
|
||||
|
||||
- **Log Level**: DEBUG/INFO/WARNING/ERROR
|
||||
- **Log Channel**: File/Database/Cloud
|
||||
- **Retention**: Log retention days
|
||||
- **Rotation**: Log file rotation policy
|
||||
|
||||
### Log Types
|
||||
|
||||
Different log types:
|
||||
|
||||
- **System Logs**: System runtime logs
|
||||
- **Error Logs**: Errors and exceptions
|
||||
- **Access Logs**: HTTP access logs
|
||||
- **Operation Logs**: User operation logs
|
||||
- **Security Logs**: Security-related logs
|
||||
|
||||
### Log Viewing
|
||||
|
||||
View and analyze logs:
|
||||
|
||||
- **Real-time Logs**: Live log viewing
|
||||
- **Log Search**: Search log content
|
||||
- **Log Filtering**: Filter by conditions
|
||||
- **Log Export**: Export log files
|
||||
|
||||
## Scheduled Tasks
|
||||
|
||||
### Task Configuration
|
||||
|
||||
Configure scheduled tasks:
|
||||
|
||||
- **Task Name**: Task identifier
|
||||
- **Schedule**: Cron expression
|
||||
- **Task Type**: Task execution type
|
||||
- **Parameters**: Task parameters
|
||||
- **Status**: Enable or disable
|
||||
|
||||
### Task Management
|
||||
|
||||
Manage scheduled tasks:
|
||||
|
||||
- **Enable/Disable**: Control execution
|
||||
- **Run Now**: Manual trigger
|
||||
- **History**: View execution records
|
||||
- **Task Logs**: View execution logs
|
||||
|
||||
### Common Tasks
|
||||
|
||||
System preset tasks:
|
||||
|
||||
- **Data Statistics**: Daily statistics
|
||||
- **Data Cleanup**: Clean expired data
|
||||
- **Email Sending**: Batch email sending
|
||||
- **Order Check**: Check order status
|
||||
- **Auto Renewal**: Automatic renewal
|
||||
- **Backup**: Data backup tasks
|
||||
|
||||
## Notification Configuration
|
||||
|
||||
### Notification Channels
|
||||
|
||||
Configure notification methods:
|
||||
|
||||
- **In-app**: System messages
|
||||
- **Email**: Email push
|
||||
- **SMS**: SMS push
|
||||
- **Webhook**: HTTP callbacks
|
||||
- **Push Service**: App push
|
||||
|
||||
### Notification Events
|
||||
|
||||
Configure notification events:
|
||||
|
||||
- **User Registration**: New user registration
|
||||
- **Order Payment**: Order payment notice
|
||||
- **Subscription Expiry**: Expiry reminder
|
||||
- **Ticket Created**: New ticket notice
|
||||
- **System Alert**: System anomalies
|
||||
|
||||
### Notification Templates
|
||||
|
||||
Configure notification content:
|
||||
|
||||
- **Template Management**: Manage templates
|
||||
- **Variable Substitution**: Dynamic variables
|
||||
- **Multi-language**: Multi-language templates
|
||||
- **Template Testing**: Test templates
|
||||
|
||||
## API Configuration
|
||||
|
||||
### API Settings
|
||||
|
||||
API interface configuration:
|
||||
|
||||
- **API Toggle**: Enable or disable API
|
||||
- **API Keys**: Generate API keys
|
||||
- **API Domain**: API access domain
|
||||
- **Version Control**: API versioning
|
||||
- **Documentation**: API docs link
|
||||
|
||||
### API Restrictions
|
||||
|
||||
API access control:
|
||||
|
||||
- **Rate Limiting**: Requests per minute
|
||||
- **Concurrency**: Concurrent requests
|
||||
- **IP Restrictions**: IP access control
|
||||
- **Signature Verification**: API signatures
|
||||
|
||||
### Webhook
|
||||
|
||||
Webhook configuration:
|
||||
|
||||
- **Callback URL**: Webhook URL
|
||||
- **Event Subscription**: Subscribed events
|
||||
- **Secret Key**: Signature verification
|
||||
- **Retry Policy**: Retry on failure
|
||||
|
||||
## Third-party Integration
|
||||
|
||||
### Payment Integration
|
||||
|
||||
Integrate payment services:
|
||||
|
||||
- Alipay
|
||||
- WeChat Pay
|
||||
- PayPal
|
||||
- Stripe
|
||||
- Cryptocurrency
|
||||
|
||||
### Analytics Integration
|
||||
|
||||
Integrate analytics tools:
|
||||
|
||||
- Google Analytics
|
||||
- Baidu Analytics
|
||||
- Umeng Analytics
|
||||
- Custom tracking code
|
||||
|
||||
### Support Integration
|
||||
|
||||
Integrate support systems:
|
||||
|
||||
- Live chat
|
||||
- Zendesk
|
||||
- Intercom
|
||||
- Custom support system
|
||||
|
||||
## Maintenance Mode
|
||||
|
||||
### Enable Maintenance
|
||||
|
||||
System maintenance mode:
|
||||
|
||||
- **Maintenance Toggle**: Enable maintenance
|
||||
- **Maintenance Message**: Display message
|
||||
- **Whitelist**: Accessible IPs during maintenance
|
||||
- **Estimated Time**: Completion time
|
||||
|
||||
### Maintenance Settings
|
||||
|
||||
Maintenance configuration:
|
||||
|
||||
- **Maintenance Page**: Custom maintenance page
|
||||
- **Allow Access**: Accessible paths
|
||||
- **Redirect**: Redirect during maintenance
|
||||
- **Scheduled**: Schedule maintenance
|
||||
|
||||
## System Optimization
|
||||
|
||||
### Performance Optimization
|
||||
|
||||
Optimize system performance:
|
||||
|
||||
- **Enable Cache**: Enable various caches
|
||||
- **Static Assets**: CDN acceleration
|
||||
- **Database**: Database optimization
|
||||
- **Image Optimization**: Compression and lazy loading
|
||||
- **Code Optimization**: Minification and bundling
|
||||
|
||||
### Database Optimization
|
||||
|
||||
Database performance:
|
||||
|
||||
- **Index Optimization**: Add appropriate indexes
|
||||
- **Query Optimization**: Optimize slow queries
|
||||
- **Data Archiving**: Archive historical data
|
||||
- **Data Cleanup**: Clean unused data
|
||||
|
||||
## Backup & Recovery
|
||||
|
||||
### Data Backup
|
||||
|
||||
Data backup configuration:
|
||||
|
||||
- **Auto Backup**: Scheduled automatic backup
|
||||
- **Backup Content**: Database/Files
|
||||
- **Backup Location**: Local/Cloud storage
|
||||
- **Retention**: Retention count and time
|
||||
- **Notification**: Backup completion notice
|
||||
|
||||
### Data Recovery
|
||||
|
||||
Data recovery operations:
|
||||
|
||||
- **Select Backup**: Choose backup file
|
||||
- **Confirm Recovery**: Confirm operation
|
||||
- **Execute Recovery**: Perform recovery
|
||||
- **Verify**: Verify data integrity
|
||||
|
||||
## System Monitoring
|
||||
|
||||
### Server Monitoring
|
||||
|
||||
Monitor server status:
|
||||
|
||||
- **CPU Usage**: CPU utilization
|
||||
- **Memory Usage**: Memory utilization
|
||||
- **Disk Space**: Disk usage
|
||||
- **Network Traffic**: Network usage
|
||||
- **Process Status**: Process status
|
||||
|
||||
### Application Monitoring
|
||||
|
||||
Monitor application status:
|
||||
|
||||
- **Online Users**: Current online users
|
||||
- **Request Rate**: Requests per second
|
||||
- **Response Time**: Average response time
|
||||
- **Error Rate**: Error occurrence rate
|
||||
- **Queue Status**: Queue task status
|
||||
|
||||
### Alert Settings
|
||||
|
||||
Configure monitoring alerts:
|
||||
|
||||
- **Alert Rules**: Set alert conditions
|
||||
- **Alert Methods**: Email/SMS/Webhook
|
||||
- **Alert Levels**: Warning/Error/Critical
|
||||
- **Recipients**: Alert recipients
|
||||
|
||||
## Best Practices
|
||||
|
||||
- Regular data backups
|
||||
- Timely system updates
|
||||
- Reasonable cache strategy
|
||||
- Monitor system status
|
||||
- Regular data cleanup
|
||||
- Database optimization
|
||||
- Security measures
|
||||
- Log important operations
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Email Send Failure
|
||||
|
||||
Check:
|
||||
|
||||
1. Is SMTP config correct
|
||||
2. Is email service enabled
|
||||
3. Is network connection ok
|
||||
4. Marked as spam
|
||||
|
||||
### Cache Not Working
|
||||
|
||||
Possible causes:
|
||||
|
||||
1. Cache config error
|
||||
2. Redis connection failed
|
||||
3. Cache key issues
|
||||
4. Cache cleared
|
||||
|
||||
### Scheduled Task Not Running
|
||||
|
||||
Check:
|
||||
|
||||
1. Is task enabled
|
||||
2. Is cron expression correct
|
||||
3. Is server time accurate
|
||||
4. Is queue service running
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Auth Control](/admin/system/auth-control) - Configure permissions
|
||||
- [Payment Config](/admin/system/payment) - Configure payments
|
||||
- [Log Management](/admin/logs/login-logs) - View system logs
|
||||
@@ -0,0 +1,180 @@
|
||||
<div v-pre>
|
||||
|
||||
# Payment Management
|
||||
|
||||
Manage platform supported payment methods and view payment channel statistics.
|
||||
|
||||
## Payment Method Table
|
||||
|
||||
### Table Column Description
|
||||
|
||||
#### Status
|
||||
Switch button to control whether payment method is enabled.
|
||||
|
||||
#### Name
|
||||
Payment method name.
|
||||
|
||||
#### Type
|
||||
Payment channel type:
|
||||
- Alipay
|
||||
- WeChat Pay
|
||||
- PayPal
|
||||
- Stripe
|
||||
- Cryptocurrency
|
||||
|
||||
#### Configuration
|
||||
View payment method configuration status.
|
||||
|
||||
#### Updated At
|
||||
Last update time.
|
||||
|
||||
### Table Operations
|
||||
|
||||
#### Edit
|
||||
Opens side drawer to modify payment config:
|
||||
- API keys
|
||||
- Merchant ID
|
||||
- Callback URL
|
||||
- Transaction fee rate
|
||||
- Min/Max amount
|
||||
|
||||
#### Delete
|
||||
Deletes payment method (requires confirmation).
|
||||
|
||||
#### Create Payment Method
|
||||
Adds new payment channel.
|
||||
|
||||
## Payment Statistics Panel
|
||||
|
||||
Displays statistics for each payment method:
|
||||
|
||||
### Total Transaction Amount
|
||||
Cumulative transaction amount for each method.
|
||||
|
||||
### Transaction Count
|
||||
Number of transactions per method.
|
||||
|
||||
### Success Rate
|
||||
Payment success rate statistics.
|
||||
|
||||
### Transaction Fees
|
||||
Fees generated by each method.
|
||||
|
||||
## Payment Configuration Form
|
||||
|
||||
### Basic Information
|
||||
- Payment method name
|
||||
- Payment type
|
||||
- Display icon
|
||||
- Display order
|
||||
|
||||
### API Configuration
|
||||
Different payment methods require different configs:
|
||||
|
||||
**Alipay**:
|
||||
- App ID
|
||||
- Merchant Private Key
|
||||
- Alipay Public Key
|
||||
- Callback URL
|
||||
|
||||
**WeChat Pay**:
|
||||
- Merchant ID
|
||||
- API Key
|
||||
- App ID
|
||||
- App Secret
|
||||
- Certificate files
|
||||
|
||||
**PayPal**:
|
||||
- Client ID
|
||||
- Client Secret
|
||||
- Sandbox mode
|
||||
|
||||
**Stripe**:
|
||||
- Publishable Key
|
||||
- Secret Key
|
||||
- Webhook Secret
|
||||
|
||||
**Cryptocurrency**:
|
||||
- Wallet address
|
||||
- API key
|
||||
- Confirmation blocks
|
||||
|
||||
### Transaction Settings
|
||||
- Minimum payment amount
|
||||
- Maximum payment amount
|
||||
- Transaction fee rate
|
||||
- Payment timeout
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: Configure Alipay
|
||||
|
||||
**Create Payment Method**:
|
||||
- Name: Alipay
|
||||
- Type: Alipay
|
||||
- App ID: 2021xxx
|
||||
- Merchant Private Key: [key content]
|
||||
- Alipay Public Key: [key content]
|
||||
- Callback URL: https://myvpn.com/callback/alipay
|
||||
- Min Amount: ¥1
|
||||
- Max Amount: ¥10000
|
||||
- Fee Rate: 0.6%
|
||||
- Status: Enabled
|
||||
|
||||
### Scenario 2: Configure Stripe
|
||||
|
||||
**Create Payment Method**:
|
||||
- Name: Credit Card Payment
|
||||
- Type: Stripe
|
||||
- Publishable Key: pk_live_xxx
|
||||
- Secret Key: sk_live_xxx
|
||||
- Webhook Secret: whsec_xxx
|
||||
- Callback URL: https://myvpn.com/callback/stripe
|
||||
- Min Amount: $1
|
||||
- Max Amount: $1000
|
||||
- Fee Rate: 2.9% + $0.30
|
||||
- Status: Enabled
|
||||
|
||||
### Scenario 3: Configure Cryptocurrency
|
||||
|
||||
**Create Payment Method**:
|
||||
- Name: USDT Payment
|
||||
- Type: Crypto
|
||||
- Currency: USDT (TRC-20)
|
||||
- Wallet Address: TXxx...
|
||||
- API Key: [optional]
|
||||
- Confirmation Blocks: 1
|
||||
- Min Amount: 10 USDT
|
||||
- Exchange Rate API: Real-time fetch
|
||||
- Status: Enabled
|
||||
|
||||
## Payment Callback
|
||||
|
||||
### Callback Handling
|
||||
Platform auto-handles payment callbacks:
|
||||
1. Verify callback signature
|
||||
2. Update order status
|
||||
3. Credit user balance
|
||||
4. Send notification email
|
||||
|
||||
### Callback Logs
|
||||
View payment callback logs:
|
||||
- Callback time
|
||||
- Payment status
|
||||
- Order information
|
||||
- Error messages (if any)
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Key Security**: Protect API keys and certificates
|
||||
2. **Callback Verification**: Must verify callback signature to prevent forgery
|
||||
3. **Test Environment**: Validate config in test environment first
|
||||
4. **HTTPS Required**: Callback URLs must use HTTPS
|
||||
5. **Transaction Fees**: Calculate fees properly to avoid losses
|
||||
6. **Amount Limits**: Set reasonable min/max payment amounts
|
||||
7. **Timeout Handling**: Set reasonable payment timeout
|
||||
8. **Exchange Rates**: Crypto requires real-time rates
|
||||
9. **Certificate Updates**: Regularly update payment certificates
|
||||
10. **Backup Channels**: Configure multiple payment methods for availability
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,468 @@
|
||||
# Document Management
|
||||
|
||||
The Document Management module creates and maintains help documentation and knowledge base for self-service user support.
|
||||
|
||||
## Overview
|
||||
|
||||
### Document List
|
||||
|
||||
View and manage all documents:
|
||||
|
||||
- **Title**: Document name
|
||||
- **Category**: Document category
|
||||
- **Status**: Draft/Published/Offline
|
||||
- **Author**: Document creator
|
||||
- **Created**: Creation date
|
||||
- **Updated**: Last modified time
|
||||
- **Views**: View count
|
||||
- **Rating**: User ratings and reviews
|
||||
|
||||
### Create Document
|
||||
|
||||
Create new help document:
|
||||
|
||||
#### Basic Info
|
||||
|
||||
- **Title**: Clear and specific title
|
||||
- **Category**: Select category
|
||||
- **Tags**: Add keyword tags
|
||||
- **Summary**: Brief content summary
|
||||
|
||||
#### Document Content
|
||||
|
||||
- **WYSIWYG Editor**: Visual editor
|
||||
- **Markdown Support**: Markdown format
|
||||
- **Code Highlighting**: Syntax highlighting
|
||||
- **Image Upload**: Insert images and screenshots
|
||||
- **Video Embed**: Embed video tutorials
|
||||
- **Tables**: Insert table data
|
||||
|
||||
#### Document Settings
|
||||
|
||||
- **Access Control**: Public/Members/Specific groups
|
||||
- **Display Order**: Set priority
|
||||
- **Related Docs**: Link related documents
|
||||
- **SEO Settings**: Set SEO keywords
|
||||
|
||||
### Edit Document
|
||||
|
||||
Modify existing documents:
|
||||
|
||||
- Update content
|
||||
- Optimize structure
|
||||
- Add new information
|
||||
- Fix errors
|
||||
|
||||
::: tip Tip
|
||||
Documents support version control. View history and restore previous versions.
|
||||
:::
|
||||
|
||||
### Delete Document
|
||||
|
||||
Remove unneeded documents:
|
||||
|
||||
- **Soft Delete**: Offline but keep data
|
||||
- **Hard Delete**: Permanently remove
|
||||
- Retain view records for statistics
|
||||
|
||||
## Document Categories
|
||||
|
||||
### Getting Started
|
||||
|
||||
Help new users onboard:
|
||||
|
||||
**Includes**:
|
||||
- Account registration
|
||||
- First-time usage
|
||||
- Basic configuration
|
||||
- Common questions
|
||||
|
||||
### Tutorials
|
||||
|
||||
Detailed feature guides:
|
||||
|
||||
**Includes**:
|
||||
- Feature explanation
|
||||
- Step-by-step instructions
|
||||
- Configuration methods
|
||||
- Best practices
|
||||
|
||||
### FAQ
|
||||
|
||||
Frequently asked questions:
|
||||
|
||||
**Includes**:
|
||||
- Common issues
|
||||
- Quick answers
|
||||
- Troubleshooting
|
||||
- Solutions
|
||||
|
||||
### Technical Docs
|
||||
|
||||
Technical documentation:
|
||||
|
||||
**Includes**:
|
||||
- API documentation
|
||||
- Protocol specifications
|
||||
- Technical parameters
|
||||
- Developer guides
|
||||
|
||||
### Policies & Terms
|
||||
|
||||
Legal documents:
|
||||
|
||||
**Includes**:
|
||||
- Service agreement
|
||||
- Privacy policy
|
||||
- Terms of use
|
||||
- Refund policy
|
||||
|
||||
## Document Organization
|
||||
|
||||
### Category Management
|
||||
|
||||
Manage categories:
|
||||
|
||||
- **Create Category**: Add new category
|
||||
- **Edit Category**: Modify category info
|
||||
- **Sort**: Adjust category order
|
||||
- **Delete Category**: Remove empty categories
|
||||
|
||||
### Tag Management
|
||||
|
||||
Manage tags:
|
||||
|
||||
- **Add Tag**: Create new tag
|
||||
- **Edit Tag**: Modify tag name
|
||||
- **Merge Tags**: Merge similar tags
|
||||
- **Delete Tag**: Remove unused tags
|
||||
|
||||
### Directory Structure
|
||||
|
||||
Organize document tree:
|
||||
|
||||
- **Multi-level**: Support nested categories
|
||||
- **Tree Structure**: Clear hierarchy
|
||||
- **Drag & Sort**: Drag to reorder
|
||||
- **Quick Navigation**: Tree navigation
|
||||
|
||||
## Document Editing
|
||||
|
||||
### Rich Text Editor
|
||||
|
||||
Powerful editing features:
|
||||
|
||||
- **Formatting**: Text formatting
|
||||
- **Lists**: Ordered/unordered lists
|
||||
- **Quotes**: Blockquotes
|
||||
- **Code**: Code blocks
|
||||
- **Links**: Hyperlinks
|
||||
- **Images**: Image insertion
|
||||
- **Tables**: Table editing
|
||||
- **Videos**: Video embedding
|
||||
|
||||
### Markdown Editing
|
||||
|
||||
Support Markdown syntax:
|
||||
|
||||
```markdown
|
||||
# Heading
|
||||
## Subheading
|
||||
|
||||
- List item
|
||||
- List item
|
||||
|
||||
**Bold** *Italic*
|
||||
|
||||
[Link](url)
|
||||
|
||||
\`code\`
|
||||
|
||||
\`\`\`language
|
||||
code block
|
||||
\`\`\`
|
||||
```
|
||||
|
||||
### Version Control
|
||||
|
||||
Document versioning:
|
||||
|
||||
- **Auto-save**: Auto-save drafts
|
||||
- **Version History**: Record changes
|
||||
- **Version Diff**: Compare versions
|
||||
- **Rollback**: Restore previous version
|
||||
|
||||
## Document Publishing
|
||||
|
||||
### Publish Settings
|
||||
|
||||
Configure publishing:
|
||||
|
||||
- **Publish Now**: Show immediately
|
||||
- **Schedule**: Set publish time
|
||||
- **Save Draft**: Save as draft
|
||||
- **Preview**: Preview before publish
|
||||
|
||||
### Access Control
|
||||
|
||||
Control document access:
|
||||
|
||||
- **Public**: Everyone can access
|
||||
- **Members**: Members only
|
||||
- **VIP**: VIP only
|
||||
- **Internal**: Staff only
|
||||
|
||||
### Multi-language Support
|
||||
|
||||
Multi-language documents:
|
||||
|
||||
- **Language Versions**: Create language versions
|
||||
- **Language Switch**: User switches language
|
||||
- **Translation Management**: Manage translations
|
||||
- **Sync Updates**: Sync across languages
|
||||
|
||||
## Document Search
|
||||
|
||||
### Search Features
|
||||
|
||||
Help users find documents:
|
||||
|
||||
- **Full-text Search**: Search content
|
||||
- **Title Search**: Search by title
|
||||
- **Tag Search**: Filter by tags
|
||||
- **Category Filter**: Filter by category
|
||||
- **Search Suggestions**: Smart suggestions
|
||||
|
||||
### Search Optimization
|
||||
|
||||
Optimize search experience:
|
||||
|
||||
- **Ranking**: Sort by relevance
|
||||
- **Highlighting**: Highlight keywords
|
||||
- **Search History**: Record history
|
||||
- **Popular Searches**: Show trending
|
||||
|
||||
## Document Interaction
|
||||
|
||||
### User Ratings
|
||||
|
||||
Collect feedback:
|
||||
|
||||
- **Helpful/Not**: Simple rating
|
||||
- **Star Rating**: Star ratings
|
||||
- **Comments**: Text reviews
|
||||
- **Suggestions**: Improvement ideas
|
||||
|
||||
### Document Feedback
|
||||
|
||||
User feedback:
|
||||
|
||||
- **Report Error**: Report errors
|
||||
- **Suggestions**: Propose improvements
|
||||
- **Request Update**: Request updates
|
||||
- **Live Chat**: Contact support
|
||||
|
||||
### Social Sharing
|
||||
|
||||
Share documents:
|
||||
|
||||
- **Share Link**: Generate link
|
||||
- **Social Media**: Share to platforms
|
||||
- **QR Code**: Generate QR code
|
||||
- **Embed Code**: Embed in websites
|
||||
|
||||
## Statistics
|
||||
|
||||
### View Statistics
|
||||
|
||||
Track views:
|
||||
|
||||
- **Views**: Total view count
|
||||
- **Unique Visitors**: Unique users
|
||||
- **View Trend**: View changes
|
||||
- **Popular Docs**: Most viewed
|
||||
|
||||
### User Behavior
|
||||
|
||||
Analyze behavior:
|
||||
|
||||
- **Reading Time**: Average time
|
||||
- **Bounce Rate**: Quick exit ratio
|
||||
- **Search Keywords**: User queries
|
||||
- **Click Path**: User navigation
|
||||
|
||||
### Effectiveness
|
||||
|
||||
Evaluate effectiveness:
|
||||
|
||||
- **Helpful Rate**: Helpful rating ratio
|
||||
- **Resolution Rate**: Problem solved ratio
|
||||
- **Ticket Reduction**: Related ticket decrease
|
||||
- **User Satisfaction**: Overall satisfaction
|
||||
|
||||
## Knowledge Base
|
||||
|
||||
### KB Structure
|
||||
|
||||
Build systematic knowledge base:
|
||||
|
||||
- **Product Knowledge**: Features and usage
|
||||
- **Technical Knowledge**: Principles and methods
|
||||
- **Business Knowledge**: Processes and standards
|
||||
- **Problem Knowledge**: Common issues and solutions
|
||||
|
||||
### Knowledge Accumulation
|
||||
|
||||
Accumulate knowledge:
|
||||
|
||||
- **Ticket Conversion**: Convert tickets to docs
|
||||
- **Experience Summary**: Summarize cases
|
||||
- **Best Practices**: Record best practices
|
||||
- **Expert Contribution**: Expert shares
|
||||
|
||||
### Knowledge Updates
|
||||
|
||||
Keep KB current:
|
||||
|
||||
- **Regular Review**: Periodic review
|
||||
- **Timely Updates**: Update promptly
|
||||
- **Deprecation Marks**: Mark outdated
|
||||
- **Version Management**: Manage versions
|
||||
|
||||
## Document Templates
|
||||
|
||||
### Common Templates
|
||||
|
||||
Preset templates:
|
||||
|
||||
- **Tutorial Template**: Tutorial format
|
||||
- **FAQ Template**: Q&A format
|
||||
- **Troubleshooting Template**: Troubleshooting format
|
||||
- **API Doc Template**: API documentation format
|
||||
|
||||
### Custom Templates
|
||||
|
||||
Create custom templates:
|
||||
|
||||
- Design document structure
|
||||
- Define content format
|
||||
- Save as template
|
||||
- Reuse templates
|
||||
|
||||
## Collaboration
|
||||
|
||||
### Team Collaboration
|
||||
|
||||
Collaborative editing:
|
||||
|
||||
- **Permission Management**: Assign edit rights
|
||||
- **Co-editing**: Multiple editors
|
||||
- **Comments**: Add comments
|
||||
- **Review Process**: Document review
|
||||
|
||||
### Review & Publish
|
||||
|
||||
Review mechanism:
|
||||
|
||||
1. **Create Draft**: Edit content
|
||||
2. **Submit**: Submit for review
|
||||
3. **Review**: Reviewer checks
|
||||
4. **Publish**: Publish after approval
|
||||
5. **Monitor**: Track effectiveness
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Content Writing
|
||||
|
||||
- Clear and specific titles
|
||||
- Accurate and detailed content
|
||||
- Clear and easy steps
|
||||
- Supporting images
|
||||
- Regular updates
|
||||
|
||||
### Organization
|
||||
|
||||
- Reasonable categorization
|
||||
- Clear hierarchy
|
||||
- Consistent naming
|
||||
- Complete indexing
|
||||
|
||||
### User Experience
|
||||
|
||||
- Simple interface
|
||||
- Fast search
|
||||
- Easy navigation
|
||||
- Mobile-friendly
|
||||
|
||||
### Continuous Optimization
|
||||
|
||||
- Collect feedback
|
||||
- Analyze usage data
|
||||
- Optimize content
|
||||
- Improve knowledge system
|
||||
|
||||
## Document Examples
|
||||
|
||||
### Getting Started Example
|
||||
|
||||
**Title**: How to Get Started
|
||||
|
||||
**Structure**:
|
||||
1. Register account
|
||||
2. Choose package
|
||||
3. Configure usage
|
||||
4. Common questions
|
||||
|
||||
### Tutorial Example
|
||||
|
||||
**Title**: XX Feature Tutorial
|
||||
|
||||
**Structure**:
|
||||
1. Feature introduction
|
||||
2. Use cases
|
||||
3. Step-by-step guide
|
||||
4. Important notes
|
||||
5. FAQ
|
||||
|
||||
### FAQ Example
|
||||
|
||||
**Title**: Connection Issues FAQ
|
||||
|
||||
**Structure**:
|
||||
- Q: Cannot connect, what to do?
|
||||
- A: Detailed solution steps...
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Cannot Save Document
|
||||
|
||||
Check:
|
||||
|
||||
1. Is network connection ok
|
||||
2. Do you have edit permission
|
||||
3. Is content too large
|
||||
4. Is browser compatible
|
||||
|
||||
### Search Cannot Find
|
||||
|
||||
Possible causes:
|
||||
|
||||
1. Document not published
|
||||
2. Insufficient access rights
|
||||
3. Keyword mismatch
|
||||
4. Search index not updated
|
||||
|
||||
### Format Issues
|
||||
|
||||
Solutions:
|
||||
|
||||
1. Use standard format
|
||||
2. Clean copied format
|
||||
3. Use templates
|
||||
4. Check HTML code
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Ticket Management](/admin/users-support/tickets) - Handle user issues
|
||||
- [User Management](/admin/users-support/users) - Analyze user needs
|
||||
- [System Config](/admin/system/config) - Configure document system
|
||||
@@ -0,0 +1,479 @@
|
||||
# Ticket Management
|
||||
|
||||
The Ticket Management module handles user-submitted issues and requests, providing efficient customer support services.
|
||||
|
||||
## Overview
|
||||
|
||||
### Ticket List
|
||||
|
||||
View and manage all tickets:
|
||||
|
||||
- **Ticket ID**: Unique identifier
|
||||
- **Title**: Issue summary
|
||||
- **Type**: Technical/Account/Complaint/Suggestion
|
||||
- **Priority**: Urgent/High/Medium/Low
|
||||
- **Status**: Pending/In Progress/Resolved/Closed
|
||||
- **Submitter**: Ticket creator
|
||||
- **Assignee**: Handler
|
||||
- **Created**: Submission time
|
||||
- **Updated**: Last update time
|
||||
- **Response Time**: First response duration
|
||||
- **Resolution Time**: Problem resolution duration
|
||||
|
||||
### Ticket Details
|
||||
|
||||
View complete ticket information:
|
||||
|
||||
- **Basic Info**: Title, type, priority
|
||||
- **Content**: Detailed description
|
||||
- **Attachments**: Screenshots, files
|
||||
- **Communication**: Complete conversation history
|
||||
- **Processing Log**: Ticket workflow records
|
||||
- **User Info**: Submitter details
|
||||
- **Related Orders**: Associated order info
|
||||
|
||||
## Ticket Types
|
||||
|
||||
### Technical Support
|
||||
|
||||
Technical issues:
|
||||
|
||||
**Common Issues**:
|
||||
- Connection problems
|
||||
- Configuration issues
|
||||
- Performance issues
|
||||
- Compatibility issues
|
||||
- Usage tutorials
|
||||
|
||||
**Handling Points**:
|
||||
- Quick diagnosis
|
||||
- Provide solutions
|
||||
- Remote assistance if needed
|
||||
- Follow up until resolved
|
||||
|
||||
### Account Issues
|
||||
|
||||
Account-related problems:
|
||||
|
||||
**Common Issues**:
|
||||
- Login problems
|
||||
- Password reset
|
||||
- Account security
|
||||
- Info modification
|
||||
- Account deletion
|
||||
|
||||
**Handling Points**:
|
||||
- Verify identity
|
||||
- Protect account security
|
||||
- Process promptly
|
||||
- Log operations
|
||||
|
||||
### Order Issues
|
||||
|
||||
Order-related problems:
|
||||
|
||||
**Common Issues**:
|
||||
- Order inquiry
|
||||
- Payment issues
|
||||
- Refund requests
|
||||
- Invoice issuance
|
||||
- Order modification
|
||||
|
||||
**Handling Points**:
|
||||
- Verify order info
|
||||
- Follow procedures
|
||||
- Update progress
|
||||
- Ensure satisfaction
|
||||
|
||||
### Product Inquiry
|
||||
|
||||
Product-related questions:
|
||||
|
||||
**Common Issues**:
|
||||
- Product features
|
||||
- Package selection
|
||||
- Usage recommendations
|
||||
- Upgrade options
|
||||
- Pricing policies
|
||||
|
||||
**Handling Points**:
|
||||
- Professional answers
|
||||
- Recommend suitable options
|
||||
- Provide detailed materials
|
||||
- Promote conversions
|
||||
|
||||
### Complaints & Suggestions
|
||||
|
||||
User feedback:
|
||||
|
||||
**Common Content**:
|
||||
- Service complaints
|
||||
- Product suggestions
|
||||
- Feature requests
|
||||
- Experience feedback
|
||||
|
||||
**Handling Points**:
|
||||
- Listen carefully
|
||||
- Respond promptly
|
||||
- Handle appropriately
|
||||
- Track improvements
|
||||
|
||||
## Ticket Workflow
|
||||
|
||||
### Ticket Creation
|
||||
|
||||
User submits ticket:
|
||||
|
||||
1. **Select Type**: Choose ticket type
|
||||
2. **Enter Title**: Brief description
|
||||
3. **Detailed Description**: Explain situation
|
||||
4. **Upload Attachments**: Add screenshots
|
||||
5. **Submit**: Submit for processing
|
||||
|
||||
### Ticket Assignment
|
||||
|
||||
Auto or manual assignment:
|
||||
|
||||
**Auto Assignment**:
|
||||
- By ticket type
|
||||
- By workload
|
||||
- By expertise
|
||||
|
||||
**Manual Assignment**:
|
||||
- Admin assigns
|
||||
- Agent claims
|
||||
- By priority
|
||||
|
||||
### Ticket Processing
|
||||
|
||||
Agent handles ticket:
|
||||
|
||||
1. **Receive**: View details
|
||||
2. **Analyze**: Understand issue
|
||||
3. **Communicate**: Discuss with user
|
||||
4. **Provide Solution**: Offer resolution
|
||||
5. **Execute**: Perform actions
|
||||
6. **Confirm Resolution**: Verify solved
|
||||
7. **Close**: Close resolved ticket
|
||||
|
||||
### Ticket Escalation
|
||||
|
||||
Escalate when needed:
|
||||
|
||||
- **Level 1**: Submit to senior support
|
||||
- **Level 2**: Submit to tech team
|
||||
- **Urgent**: Submit to management
|
||||
- **Cross-department**: Multi-team collaboration
|
||||
|
||||
### Ticket Closure
|
||||
|
||||
Close after completion:
|
||||
|
||||
- **Resolved**: Successfully solved
|
||||
- **User Confirmed**: User satisfied
|
||||
- **Auto-close**: Timeout auto-close
|
||||
- **No Action Needed**: Invalid ticket close
|
||||
|
||||
## Status Management
|
||||
|
||||
### Pending
|
||||
|
||||
Newly submitted:
|
||||
|
||||
- Awaiting assignment
|
||||
- Needs quick response
|
||||
- Sorted by priority
|
||||
- SLA timer starts
|
||||
|
||||
### In Progress
|
||||
|
||||
Being handled:
|
||||
|
||||
- Agent assigned
|
||||
- Actively resolving
|
||||
- May take time
|
||||
- Regular updates
|
||||
|
||||
### Awaiting User
|
||||
|
||||
Waiting for feedback:
|
||||
|
||||
- Need user information
|
||||
- Awaiting confirmation
|
||||
- Pause SLA timer
|
||||
- Auto-reminder on timeout
|
||||
|
||||
### Resolved
|
||||
|
||||
Problem solved:
|
||||
|
||||
- Solution provided
|
||||
- Issue resolved
|
||||
- Awaiting user confirmation
|
||||
- May reopen
|
||||
|
||||
### Closed
|
||||
|
||||
Ticket closed:
|
||||
|
||||
- Process complete
|
||||
- Archived
|
||||
- Viewable history
|
||||
- No further modification
|
||||
|
||||
## Priority Management
|
||||
|
||||
### Urgent
|
||||
|
||||
Highest priority:
|
||||
|
||||
**Scenarios**:
|
||||
- Service down
|
||||
- Security vulnerability
|
||||
- Data loss
|
||||
- Critical bug
|
||||
|
||||
**Requirements**:
|
||||
- Immediate response
|
||||
- Priority handling
|
||||
- Quick resolution
|
||||
- Full tracking
|
||||
|
||||
### High
|
||||
|
||||
High priority:
|
||||
|
||||
**Scenarios**:
|
||||
- Core function failure
|
||||
- Affects multiple users
|
||||
- VIP customer issues
|
||||
|
||||
**Requirements**:
|
||||
- 2-hour response
|
||||
- Same-day resolution
|
||||
- Timely feedback
|
||||
|
||||
### Medium
|
||||
|
||||
Normal priority:
|
||||
|
||||
**Scenarios**:
|
||||
- General function issues
|
||||
- Usage inquiries
|
||||
- Regular requests
|
||||
|
||||
**Requirements**:
|
||||
- 24-hour response
|
||||
- 3-day resolution
|
||||
- Follow standard process
|
||||
|
||||
### Low
|
||||
|
||||
Low priority:
|
||||
|
||||
**Scenarios**:
|
||||
- Feature suggestions
|
||||
- Experience optimization
|
||||
- Documentation issues
|
||||
|
||||
**Requirements**:
|
||||
- 3-day response
|
||||
- Reasonable scheduling
|
||||
- Planned resolution
|
||||
|
||||
## Communication
|
||||
|
||||
### Reply
|
||||
|
||||
Communicate with user:
|
||||
|
||||
- **Public Reply**: User-visible response
|
||||
- **Internal Note**: Internal communication
|
||||
- **Attachments**: Upload files, screenshots
|
||||
- **Templates**: Use quick reply templates
|
||||
|
||||
### Quick Replies
|
||||
|
||||
Preset templates:
|
||||
|
||||
- FAQ answers
|
||||
- Standard responses
|
||||
- Operation guides
|
||||
- One-click send
|
||||
|
||||
### Communication Tips
|
||||
|
||||
Effective communication:
|
||||
|
||||
- Friendly and professional tone
|
||||
- Clear and specific replies
|
||||
- Provide concrete solutions
|
||||
- Timely follow-up
|
||||
- Confirm satisfaction
|
||||
|
||||
## Statistics
|
||||
|
||||
### Ticket Volume
|
||||
|
||||
Track quantity:
|
||||
|
||||
- **Total Tickets**: All tickets
|
||||
- **New Tickets**: Daily new tickets
|
||||
- **Pending**: Unresolved tickets
|
||||
- **Resolved**: Resolved tickets
|
||||
- **Trend**: Volume changes
|
||||
|
||||
### Efficiency
|
||||
|
||||
Analyze performance:
|
||||
|
||||
- **Avg Response Time**: First response duration
|
||||
- **Avg Resolution Time**: Problem resolution duration
|
||||
- **Resolution Rate**: Success ratio
|
||||
- **Timeout Rate**: SLA breach ratio
|
||||
|
||||
### Agent Performance
|
||||
|
||||
Staff statistics:
|
||||
|
||||
- **Handled**: Tickets per agent
|
||||
- **Resolution Rate**: Success ratio
|
||||
- **User Satisfaction**: User ratings
|
||||
- **Response Speed**: Avg response time
|
||||
|
||||
### Issue Analysis
|
||||
|
||||
Analyze common issues:
|
||||
|
||||
- **Categorization**: Issue distribution
|
||||
- **Frequent Issues**: Most common
|
||||
- **Difficult Issues**: Hard to resolve
|
||||
- **Improvements**: Optimization directions
|
||||
|
||||
## SLA Management
|
||||
|
||||
### SLA Standards
|
||||
|
||||
Service level agreement:
|
||||
|
||||
**Response Time**:
|
||||
- Urgent: Within 15 minutes
|
||||
- High: Within 2 hours
|
||||
- Medium: Within 24 hours
|
||||
- Low: Within 3 days
|
||||
|
||||
**Resolution Time**:
|
||||
- Urgent: Within 4 hours
|
||||
- High: Within 1 day
|
||||
- Medium: Within 3 days
|
||||
- Low: Within 7 days
|
||||
|
||||
### SLA Monitoring
|
||||
|
||||
Track SLA compliance:
|
||||
|
||||
- Real-time SLA monitoring
|
||||
- Alert on approaching timeout
|
||||
- Track SLA achievement rate
|
||||
- Analyze timeout causes
|
||||
|
||||
## Automation
|
||||
|
||||
### Auto-assignment
|
||||
|
||||
Automatic ticket assignment:
|
||||
|
||||
- By type
|
||||
- Load balancing
|
||||
- Round-robin
|
||||
- Smart assignment
|
||||
|
||||
### Auto-reply
|
||||
|
||||
Auto-respond to common issues:
|
||||
|
||||
- FAQ auto-answers
|
||||
- Receipt confirmation
|
||||
- Status change notifications
|
||||
|
||||
### Auto-escalation
|
||||
|
||||
Auto-escalate overdue tickets:
|
||||
|
||||
- Timeout auto-escalate
|
||||
- Urgent auto-escalate
|
||||
- Repeat issue auto-escalate
|
||||
|
||||
### Auto-closure
|
||||
|
||||
Auto-close tickets:
|
||||
|
||||
- Resolved timeout auto-close
|
||||
- No response auto-close
|
||||
- Duplicate auto-merge
|
||||
|
||||
## Knowledge Base Integration
|
||||
|
||||
### FAQ
|
||||
|
||||
Build FAQ knowledge base:
|
||||
|
||||
- Compile common questions
|
||||
- Provide standard answers
|
||||
- Self-service lookup
|
||||
- Reduce ticket volume
|
||||
|
||||
### Solution Library
|
||||
|
||||
Document solutions:
|
||||
|
||||
- Record typical cases
|
||||
- Summarize resolution methods
|
||||
- Team knowledge sharing
|
||||
- Improve efficiency
|
||||
|
||||
## Best Practices
|
||||
|
||||
- Respond promptly to tickets
|
||||
- Accurately understand issues
|
||||
- Provide professional solutions
|
||||
- Maintain friendly communication
|
||||
- Follow up until resolved
|
||||
- Build comprehensive knowledge base
|
||||
- Regularly analyze ticket data
|
||||
- Continuously optimize processes
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Slow Response
|
||||
|
||||
Possible causes:
|
||||
|
||||
1. High ticket volume
|
||||
2. Insufficient staff
|
||||
3. Poor assignment
|
||||
4. Priority issues
|
||||
|
||||
### Poor Handling Quality
|
||||
|
||||
Improvements:
|
||||
|
||||
1. Enhance training
|
||||
2. Improve knowledge base
|
||||
3. Optimize workflow
|
||||
4. Establish assessment
|
||||
|
||||
### Low Satisfaction
|
||||
|
||||
Improvements:
|
||||
|
||||
1. Improve response speed
|
||||
2. Better service attitude
|
||||
3. Enhance resolution capability
|
||||
4. Strengthen communication
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [User Management](/admin/users-support/users) - View user info
|
||||
- [Document Management](/admin/users-support/documents) - Improve help docs
|
||||
- [System Config](/admin/system/config) - Configure ticket system
|
||||
@@ -0,0 +1,335 @@
|
||||
# User Management
|
||||
|
||||
The User Management module manages all user accounts in the system, which is the foundation of system operations.
|
||||
|
||||
## Overview
|
||||
|
||||
### User List
|
||||
|
||||
View and manage all users:
|
||||
|
||||
- **User Info**: Username, email, phone
|
||||
- **User Group**: VIP/Regular/Trial, etc.
|
||||
- **Account Status**: Active/Disabled/Expired
|
||||
- **Balance**: Account balance
|
||||
- **Traffic**: Used/Total traffic
|
||||
- **Validity**: Subscription expiry date
|
||||
- **Registration**: Account registration date
|
||||
- **Last Login**: Last login time
|
||||
|
||||
### User Filtering
|
||||
|
||||
Quickly find users:
|
||||
|
||||
- **By Status**: Active/Disabled/Expired
|
||||
- **By Group**: VIP/Regular users
|
||||
- **By Registration**: Date range filter
|
||||
- **By Traffic**: Filter by traffic usage
|
||||
- **By Device**: Online/Offline users
|
||||
- **Search**: Username/Email/Phone search
|
||||
|
||||
### Add User
|
||||
|
||||
Manually create new user account:
|
||||
|
||||
#### Basic Info
|
||||
|
||||
- **Username**: Login username (unique)
|
||||
- **Email**: User email address
|
||||
- **Phone**: Contact phone (optional)
|
||||
- **Password**: Initial password
|
||||
|
||||
#### Subscription Info
|
||||
|
||||
- **User Group**: Select user group
|
||||
- **Traffic Quota**: Set traffic allowance
|
||||
- **Validity**: Set expiry date
|
||||
- **Speed Limit**: Set rate cap
|
||||
- **Device Limit**: Concurrent device count
|
||||
|
||||
#### Account Settings
|
||||
|
||||
- **Balance**: Initial account balance
|
||||
- **Points**: Initial points
|
||||
- **Referral Code**: Custom invite code
|
||||
- **Notes**: User notes
|
||||
|
||||
### Edit User
|
||||
|
||||
Modify user info and config:
|
||||
|
||||
- **Update Basic Info**: Change email, phone, etc.
|
||||
- **Adjust Subscription**: Modify traffic, validity
|
||||
- **Balance Operations**: Top-up or deduct balance
|
||||
- **Reset Password**: Reset password for user
|
||||
- **Change Group**: Upgrade or downgrade group
|
||||
|
||||
### Delete User
|
||||
|
||||
Delete user account:
|
||||
|
||||
- **Soft Delete**: Mark deleted but keep data
|
||||
- **Hard Delete**: Permanently delete user and data
|
||||
- **Batch Delete**: Delete multiple users
|
||||
|
||||
::: warning Warning
|
||||
Deleting a user will clear all subscriptions and usage records. Proceed with caution.
|
||||
:::
|
||||
|
||||
## User Operations
|
||||
|
||||
### Disable/Enable
|
||||
|
||||
Control user account status:
|
||||
|
||||
- **Disable Account**: Suspend service access
|
||||
- **Enable Account**: Restore normal usage
|
||||
- **Disable Reason**: Record reason
|
||||
- **Auto Unban**: Set auto-unban time
|
||||
|
||||
### Traffic Operations
|
||||
|
||||
Manage user traffic:
|
||||
|
||||
- **Add Traffic**: Add traffic for user
|
||||
- **Deduct Traffic**: Deduct user traffic
|
||||
- **Reset Traffic**: Reset to initial value
|
||||
- **Traffic Log**: View traffic change history
|
||||
|
||||
### Duration Operations
|
||||
|
||||
Manage subscription duration:
|
||||
|
||||
- **Extend Time**: Extend validity period
|
||||
- **Shorten Time**: Reduce duration
|
||||
- **Set Expiry**: Set specific expiry date
|
||||
- **Lifetime**: Set to never expire
|
||||
|
||||
### Balance Operations
|
||||
|
||||
Manage user balance:
|
||||
|
||||
- **Top-up**: Recharge user account
|
||||
- **Deduct**: Deduct from account
|
||||
- **Transfer**: Transfer between users
|
||||
- **Balance Log**: View balance changes
|
||||
|
||||
## User Details
|
||||
|
||||
### Basic Info
|
||||
|
||||
View complete user information:
|
||||
|
||||
- Account basic profile
|
||||
- Subscription status and quota
|
||||
- Balance and points
|
||||
- Referral information
|
||||
|
||||
### Subscription Info
|
||||
|
||||
View user subscription details:
|
||||
|
||||
- Current subscription package
|
||||
- Traffic usage
|
||||
- Remaining validity
|
||||
- Node access permissions
|
||||
|
||||
### Usage Statistics
|
||||
|
||||
Analyze user usage data:
|
||||
|
||||
- **Traffic Stats**: Daily/Weekly/Monthly traffic
|
||||
- **Online Duration**: Usage time statistics
|
||||
- **Node Preference**: Common node analysis
|
||||
- **Device Stats**: Device count statistics
|
||||
|
||||
### Order Records
|
||||
|
||||
View user purchase history:
|
||||
|
||||
- Historical order list
|
||||
- Order amount statistics
|
||||
- Purchase frequency analysis
|
||||
- Renewal status
|
||||
|
||||
### Login Records
|
||||
|
||||
View user login history:
|
||||
|
||||
- Login time
|
||||
- Login IP
|
||||
- Login device
|
||||
- Login location
|
||||
|
||||
### Online Devices
|
||||
|
||||
View user online devices:
|
||||
|
||||
- Device type and OS
|
||||
- Connected node
|
||||
- Online duration
|
||||
- Force offline function
|
||||
|
||||
## User Grouping
|
||||
|
||||
### Group Management
|
||||
|
||||
Create and manage user groups:
|
||||
|
||||
- **Group Name**: User group display name
|
||||
- **Permissions**: Node access permissions
|
||||
- **Traffic Quota**: Default group traffic
|
||||
- **Speed Limit**: Group rate cap
|
||||
- **Other Limits**: Devices, concurrency, etc.
|
||||
|
||||
### Batch Grouping
|
||||
|
||||
Batch set user groups:
|
||||
|
||||
- Select multiple users
|
||||
- Specify target group
|
||||
- Batch update groups
|
||||
- Keep or reset quotas
|
||||
|
||||
## User Search
|
||||
|
||||
### Advanced Search
|
||||
|
||||
Search users with multiple conditions:
|
||||
|
||||
- **Combined Conditions**: Multiple criteria
|
||||
- **Range Search**: Traffic, balance ranges
|
||||
- **Time Range**: Registration, expiry
|
||||
- **Custom Fields**: Notes and other fields
|
||||
|
||||
### Save Search
|
||||
|
||||
Save frequently used search criteria:
|
||||
|
||||
- Quick apply search
|
||||
- Manage saved searches
|
||||
- Share search criteria
|
||||
|
||||
## User Export
|
||||
|
||||
Export user data:
|
||||
|
||||
### Export Options
|
||||
|
||||
- **Export Format**: Excel/CSV
|
||||
- **Export Fields**: Custom export fields
|
||||
- **Data Range**: All or filtered results
|
||||
- **Data Masking**: Handle sensitive info
|
||||
|
||||
### Batch Import
|
||||
|
||||
Batch import users:
|
||||
|
||||
- Download import template
|
||||
- Fill user data
|
||||
- Upload Excel file
|
||||
- Validate and import
|
||||
|
||||
## User Notification
|
||||
|
||||
### Send Notification
|
||||
|
||||
Send messages to users:
|
||||
|
||||
- **Internal Message**: System notifications
|
||||
- **Email**: Send email notifications
|
||||
- **SMS**: Send SMS notifications
|
||||
- **Batch Notify**: Send messages in batch
|
||||
|
||||
### Notification Templates
|
||||
|
||||
Manage notification templates:
|
||||
|
||||
- Create message templates
|
||||
- Use variable substitution
|
||||
- Multi-language templates
|
||||
- Scheduled sending
|
||||
|
||||
## User Analysis
|
||||
|
||||
### User Profile
|
||||
|
||||
Analyze user characteristics:
|
||||
|
||||
- **Basic Attributes**: Age, region distribution
|
||||
- **Behavioral**: Usage habits, activity
|
||||
- **Consumption**: AOV, repurchase rate
|
||||
- **Churn Risk**: Churn prediction
|
||||
|
||||
### User Value
|
||||
|
||||
Evaluate user value:
|
||||
|
||||
- **RFM Analysis**: Recency, Frequency, Monetary
|
||||
- **Lifecycle**: User lifecycle stage
|
||||
- **Contribution**: Revenue contribution ranking
|
||||
- **Activity**: Usage activity level
|
||||
|
||||
## User Security
|
||||
|
||||
### Security Settings
|
||||
|
||||
Enhance account security:
|
||||
|
||||
- **Force 2FA**: Require two-factor auth
|
||||
- **IP Whitelist**: Restrict login IPs
|
||||
- **Device Management**: Manage authorized devices
|
||||
- **Anomaly Detection**: Detect abnormal logins
|
||||
|
||||
### Risk Control
|
||||
|
||||
Prevent malicious users:
|
||||
|
||||
- **Behavior Monitoring**: Monitor abnormal behavior
|
||||
- **Risk Scoring**: User risk level
|
||||
- **Auto Ban**: Auto-disable on rule trigger
|
||||
- **Blacklist**: Permanently block users
|
||||
|
||||
## Best Practices
|
||||
|
||||
- Regularly review user account status
|
||||
- Process expired user renewals promptly
|
||||
- Focus on high-value user needs
|
||||
- Analyze churn user reasons
|
||||
- Protect user privacy data
|
||||
- Establish tiered user service
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Cannot Login
|
||||
|
||||
Check:
|
||||
|
||||
1. Is account disabled
|
||||
2. Is password correct
|
||||
3. Are security restrictions triggered
|
||||
4. Is system service normal
|
||||
|
||||
### Traffic Anomaly
|
||||
|
||||
Possible reasons:
|
||||
|
||||
1. Statistics service failure
|
||||
2. Node reporting anomaly
|
||||
3. User device issues
|
||||
4. Malicious usage
|
||||
|
||||
### Batch Operation Failed
|
||||
|
||||
Check:
|
||||
|
||||
1. Number of users selected
|
||||
2. Operation permissions
|
||||
3. Is data format correct
|
||||
4. Are system resources sufficient
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Ticket Management](/admin/users-support/tickets) - Handle user tickets
|
||||
- [Order Management](/admin/commerce/orders) - View user orders
|
||||
- [Login Logs](/admin/logs/login) - View login records
|
||||
@@ -0,0 +1,144 @@
|
||||
<div v-pre>
|
||||
|
||||
# Document Management
|
||||
|
||||
Create and manage help documents with Markdown format and tag classification.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Show
|
||||
Switch button to control whether document displays on frontend.
|
||||
|
||||
### Title
|
||||
Document title.
|
||||
|
||||
### Tags
|
||||
Document classification tags, multiple tags separated by commas.
|
||||
|
||||
### Updated At
|
||||
Last update time.
|
||||
|
||||
## Table Operations
|
||||
|
||||
### Edit
|
||||
Opens side drawer form to modify document.
|
||||
|
||||
### Delete
|
||||
Deletes document (requires confirmation), cannot be recovered.
|
||||
|
||||
### Batch Delete
|
||||
Deletes multiple selected documents.
|
||||
|
||||
## Document Form
|
||||
|
||||
### Title (Required)
|
||||
Document title.
|
||||
|
||||
### Tags (Required)
|
||||
Document classification tags, supports multiple tags:
|
||||
- Common tags: Beginner Guide, Tutorial, FAQ, Technical Support
|
||||
- Press Enter after inputting tag to add
|
||||
- Click tag to delete
|
||||
|
||||
### Content (Required)
|
||||
Document body, supports Markdown format:
|
||||
- Headings: # ## ### ####
|
||||
- Bold: **text**
|
||||
- Italic: *text*
|
||||
- Code blocks: ```language
|
||||
- Images: 
|
||||
- Links: [text](url)
|
||||
- Lists: - or 1.
|
||||
- Quotes: >
|
||||
- Tables: | Col1 | Col2 |
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Keyword Search
|
||||
Search documents by title.
|
||||
|
||||
### Tag Filter
|
||||
Input tag to find documents in that category.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: Create Beginner Guide
|
||||
|
||||
**Form Config**:
|
||||
- Title: Quick Start Guide
|
||||
- Tags: Beginner Guide, Tutorial
|
||||
- Content:
|
||||
```markdown
|
||||
# Quick Start Guide
|
||||
|
||||
## 1. Register Account
|
||||
Visit website to register...
|
||||
|
||||
## 2. Purchase Plan
|
||||
Go to subscribe page...
|
||||
|
||||
## 3. Download Client
|
||||
Supported platforms:
|
||||
- Windows
|
||||
- macOS
|
||||
- Android
|
||||
- iOS
|
||||
```
|
||||
- Show: On
|
||||
|
||||
### Scenario 2: Create FAQ
|
||||
|
||||
**Form Config**:
|
||||
- Title: Frequently Asked Questions
|
||||
- Tags: FAQ, Common Issues
|
||||
- Content:
|
||||
```markdown
|
||||
# FAQ
|
||||
|
||||
## How to reset password?
|
||||
A: Click "Forgot Password" on login page...
|
||||
|
||||
## How to check traffic usage?
|
||||
A: View in profile after login...
|
||||
|
||||
## What to do after subscription expires?
|
||||
A: Can renew or purchase new plan...
|
||||
```
|
||||
- Show: On
|
||||
|
||||
### Scenario 3: Create Platform Tutorial
|
||||
|
||||
**Form Config**:
|
||||
- Title: Windows Client Tutorial
|
||||
- Tags: Tutorial, Windows
|
||||
- Content:
|
||||
```markdown
|
||||
# Windows Client Tutorial
|
||||
|
||||
## Download & Install
|
||||
1. Download client
|
||||
2. Run installer
|
||||
3. Complete installation
|
||||
|
||||
## Configure Subscription
|
||||
1. Copy subscription link
|
||||
2. Open client
|
||||
3. Import subscription
|
||||
|
||||
## Connect Service
|
||||
Select node and click connect
|
||||
```
|
||||
- Show: On
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Markdown Support**: Content supports full Markdown syntax
|
||||
2. **Tag Management**: Proper tags help users find content
|
||||
3. **Display Control**: Can create first, enable display later
|
||||
4. **Image Links**: Use external URLs for images
|
||||
5. **Code Highlighting**: Code blocks support syntax highlighting
|
||||
6. **Batch Operations**: Can batch delete outdated documents
|
||||
7. **Search Optimization**: Titles and tags are search indexed
|
||||
8. **Update Indicator**: Update time changes after modification
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,103 @@
|
||||
<div v-pre>
|
||||
|
||||
# Ticket Management
|
||||
|
||||
View and handle user-submitted tickets with reply and close functions.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Title
|
||||
Ticket title.
|
||||
|
||||
### User
|
||||
User who submitted the ticket.
|
||||
|
||||
### Status
|
||||
Current ticket status (with color indicator):
|
||||
- **Pending Follow-up** (Red) - Newly submitted, awaiting admin
|
||||
- **Pending Reply** (Yellow) - Admin replied, awaiting user
|
||||
- **Resolved** (Green) - Issue resolved
|
||||
- **Closed** (Gray) - Ticket closed
|
||||
|
||||
### Updated At
|
||||
Last update time.
|
||||
|
||||
## Table Operations
|
||||
|
||||
### Reply
|
||||
Opens ticket conversation drawer:
|
||||
- View complete ticket conversation
|
||||
- Input reply content
|
||||
- After sending, status changes to "Pending Reply"
|
||||
|
||||
### Close
|
||||
Closes ticket (requires confirmation):
|
||||
- Status becomes "Closed"
|
||||
- Cannot operate after closure
|
||||
- User can still view
|
||||
|
||||
### Check
|
||||
View closed ticket conversation (read-only).
|
||||
|
||||
## Ticket Conversation
|
||||
|
||||
After opening ticket, shows conversation interface:
|
||||
|
||||
**Conversation Messages**:
|
||||
- Ticket description (user's first message)
|
||||
- All follow-up records
|
||||
- Shows timestamps
|
||||
- Distinguishes user/admin messages
|
||||
|
||||
**Reply Ticket**:
|
||||
1. Input reply in bottom text box
|
||||
2. Click send button
|
||||
3. Message displays immediately
|
||||
4. Status auto-updates to "Pending Reply"
|
||||
|
||||
**Auto Refresh**:
|
||||
- Auto-refreshes every 5 seconds
|
||||
- Gets latest messages
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Status Filter
|
||||
Select "Closed" to view closed tickets.
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: Handle New Ticket
|
||||
|
||||
1. View "Pending Follow-up" tickets
|
||||
2. Click "Reply" button
|
||||
3. Read user's question
|
||||
4. Input solution
|
||||
5. Send reply
|
||||
6. User receives notification
|
||||
|
||||
### Scenario 2: Close After Resolution
|
||||
|
||||
1. Open ticket conversation
|
||||
2. Confirm issue resolved
|
||||
3. Click "Close" button
|
||||
4. Confirm close operation
|
||||
5. Ticket marked as closed
|
||||
|
||||
### Scenario 3: Multiple Rounds of Conversation
|
||||
|
||||
1. Open ticket
|
||||
2. View conversation history
|
||||
3. Reply with new message
|
||||
4. Continue following up until resolved
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Timely Reply**: Pending tickets should be handled promptly
|
||||
2. **Conversation Records**: All messages permanently saved
|
||||
3. **Auto Refresh**: Conversation auto-updates every 5 seconds
|
||||
4. **Close Restriction**: Cannot reply after closure
|
||||
5. **Status Change**: Auto-changes to "Pending Reply" after replying
|
||||
6. **User Notification**: User receives notification after reply
|
||||
7. **View Closed**: Closed tickets viewable but not replyable
|
||||
|
||||
</div>
|
||||
@@ -0,0 +1,146 @@
|
||||
<div v-pre>
|
||||
|
||||
# User Management
|
||||
|
||||
Manage all users in the system, including user information editing, subscription management, balance management, and more.
|
||||
|
||||
## Table Column Description
|
||||
|
||||
### Enable
|
||||
Switch button to control whether user account is active. Disabled users cannot login.
|
||||
|
||||
### ID
|
||||
User unique identifier ID.
|
||||
|
||||
### Username
|
||||
Shows authentication method (EMAIL/GITHUB etc) and auth identifier (email/username). Checkmark after identifier indicates verified.
|
||||
|
||||
### Balance
|
||||
User account balance.
|
||||
|
||||
### Gift Amount
|
||||
Amount gifted by system.
|
||||
|
||||
### Commission
|
||||
Commission earned through user referrals.
|
||||
|
||||
### Invite Code
|
||||
User's exclusive invite code.
|
||||
|
||||
### Referer
|
||||
Referrer who invited this user to register.
|
||||
|
||||
### Created At
|
||||
User registration time.
|
||||
|
||||
## Table Operations
|
||||
|
||||
### Edit (Profile)
|
||||
Opens user profile side drawer with three tabs:
|
||||
|
||||
**Basic Info**:
|
||||
- Enable status
|
||||
- Balance
|
||||
- Gift amount
|
||||
- Commission
|
||||
- Invite code
|
||||
- Referer ID
|
||||
|
||||
**Notify Settings**:
|
||||
- Balance change notification
|
||||
- Login notification
|
||||
- Subscription notification
|
||||
- Trade notification
|
||||
|
||||
**Auth Methods**:
|
||||
- View and manage user login methods
|
||||
- Email, GitHub, etc.
|
||||
|
||||
### Subscription
|
||||
Opens subscription management side drawer to view and manage user subscriptions:
|
||||
- Subscription list
|
||||
- Subscription status
|
||||
- Expiry time
|
||||
- Traffic usage
|
||||
- Subscription operations
|
||||
|
||||
### Delete
|
||||
Deletes user (requires confirmation), cannot be recovered.
|
||||
|
||||
### More
|
||||
Dropdown menu for quick navigation to:
|
||||
- Order list
|
||||
- Login logs
|
||||
- Balance logs
|
||||
- Commission logs
|
||||
- Gift logs
|
||||
|
||||
## Filter Functions
|
||||
|
||||
### Subscription Filter
|
||||
Select product plan to view users who purchased that plan.
|
||||
|
||||
### Keyword Search
|
||||
Search users by email, username, etc.
|
||||
|
||||
### User ID Filter
|
||||
Direct input of user ID for precise search.
|
||||
|
||||
### Subscription ID Filter
|
||||
Input subscription ID to find corresponding user.
|
||||
|
||||
## Create User
|
||||
|
||||
Click "Create" button to open form:
|
||||
|
||||
**Required Fields**:
|
||||
- Auth Type: EMAIL/GITHUB etc
|
||||
- Auth Identifier: Email address or username
|
||||
- Password: User login password
|
||||
|
||||
**Optional Fields**:
|
||||
- Balance: Initial balance
|
||||
- Referer ID: Bind referral relationship
|
||||
|
||||
## Usage Scenarios
|
||||
|
||||
### Scenario 1: Disable Violating User
|
||||
|
||||
1. Find target user
|
||||
2. Turn off "Enable" switch
|
||||
3. User immediately cannot login
|
||||
|
||||
### Scenario 2: Top Up User Balance
|
||||
|
||||
1. Click "Edit" button
|
||||
2. Enter "Basic Info" tab
|
||||
3. Modify balance amount
|
||||
4. Save changes
|
||||
|
||||
### Scenario 3: View User Subscriptions
|
||||
|
||||
1. Click "Subscription" button
|
||||
2. View all user subscriptions
|
||||
3. Can operate subscriptions (renew, reset traffic, etc)
|
||||
|
||||
### Scenario 4: Track User Behavior
|
||||
|
||||
1. Click "More" button
|
||||
2. Select corresponding log:
|
||||
- Login logs: View login records
|
||||
- Balance logs: View balance changes
|
||||
- Commission logs: View commission earnings
|
||||
- Gift logs: View system gifts
|
||||
|
||||
## Important Notes
|
||||
|
||||
1. **Enable Control**: Disabling user immediately kicks them out
|
||||
2. **Balance Modification**: Direct balance modification, watch amount units
|
||||
3. **Delete User**: Operation irreversible, confirm before deletion
|
||||
4. **Subscription Management**: Can operate directly in user subscription page
|
||||
5. **Log Tracking**: Quickly view various user logs through "More" menu
|
||||
6. **Referral Relationship**: Can specify referrer when creating user
|
||||
7. **Batch Operations**: Currently not supported
|
||||
8. **Invite Code**: Each user has unique invite code
|
||||
|
||||
</div>
|
||||
Reference in New Issue
Block a user