Skip to content

Commit be10c1f

Browse files
authored
doc update
1 parent 3fa2b1c commit be10c1f

File tree

3 files changed

+1
-137
lines changed

3 files changed

+1
-137
lines changed

apps/docs/guide/modsecurity.md

Lines changed: 0 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -303,67 +303,7 @@ SecRule TX:ANOMALY_SCORE "@gt %{tx.anomaly_score_threshold}" \
303303
```
304304

305305

306-
## API Integration
307306

308-
For programmatic ModSecurity management, use the REST API:
309-
310-
### List CRS Rules
311-
```bash
312-
curl -X GET http://localhost:3001/api/modsec/crs-rules \
313-
-H "Authorization: Bearer YOUR_TOKEN"
314-
```
315-
316-
### Toggle CRS Rule
317-
```bash
318-
curl -X PATCH http://localhost:3001/api/modsec/crs/rules/RULE_FILE/toggle \
319-
-H "Authorization: Bearer YOUR_TOKEN" \
320-
-H "Content-Type: application/json" \
321-
-d '{
322-
"enabled": false
323-
}'
324-
```
325-
326-
### List Custom Rules
327-
```bash
328-
curl -X GET http://localhost:3001/api/modsec/rules \
329-
-H "Authorization: Bearer YOUR_TOKEN"
330-
```
331-
332-
### Create Custom Rule
333-
```bash
334-
curl -X POST http://localhost:3001/api/modsec/rules \
335-
-H "Authorization: Bearer YOUR_TOKEN" \
336-
-H "Content-Type: application/json" \
337-
-d '{
338-
"name": "Block SQL Injection",
339-
"category": "Security",
340-
"ruleContent": "SecRule ARGS \"@detectSQLi\" \"id:1001,phase:2,block,msg:\"SQL Injection Attack Detected\"\"",
341-
"description": "Blocks SQL injection attempts",
342-
"enabled": true
343-
}'
344-
```
345-
346-
### Update Custom Rule
347-
```bash
348-
curl -X PUT http://localhost:3001/api/modsec/rules/RULE_ID \
349-
-H "Authorization: Bearer YOUR_TOKEN" \
350-
-H "Content-Type: application/json" \
351-
-d '{
352-
"name": "Block SQL Injection",
353-
"category": "Security",
354-
"ruleContent": "SecRule ARGS \"@detectSQLi\" \"id:1001,phase:2,block,msg:\"SQL Injection Attack Detected\"\"",
355-
"description": "Blocks SQL injection attempts",
356-
"enabled": false
357-
}'
358-
```
359-
360-
### Delete Custom Rule
361-
```bash
362-
curl -X DELETE http://localhost:3001/api/modsec/rules/RULE_ID \
363-
-H "Authorization: Bearer YOUR_TOKEN"
364-
```
365-
366-
For complete API documentation, see the [API Reference](/api/modsecurity).
367307

368308

369309
For more information on related topics:

apps/docs/guide/performance.md

Lines changed: 1 addition & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -53,25 +53,7 @@ Configure alerts to notify you of performance issues:
5353
Condition: cpu > 80
5454
Threshold: 80%
5555
Severity: Warning
56-
Check Interval: 300 seconds (5 minutes)
57-
```
58-
59-
2. **Slow Response Time**:
60-
```
61-
Name: Slow Response Time
62-
Condition: response_time > 1000
63-
Threshold: 1000ms
64-
Severity: Warning
65-
Check Interval: 60 seconds (1 minute)
66-
```
67-
68-
3. **High Error Rate**:
69-
```
70-
Name: High Error Rate
71-
Condition: error_rate > 5
72-
Threshold: 5%
73-
Severity: Critical
74-
Check Interval: 60 seconds (1 minute)
56+
Check Interval: 10 seconds (5 minutes)
7557
```
7658

7759
### Notification Channels
@@ -101,63 +83,6 @@ Configure how alerts are delivered:
10183
- **Bot Token**: Telegram bot token
10284
- **Chat ID**: Telegram chat ID for notifications
10385

104-
### Alert Management
105-
106-
107-
## Performance Optimization
108-
109-
110-
#### CPU Bottlenecks
111-
112-
**Symptoms**:
113-
- High CPU utilization (>80%)
114-
- Slow response times
115-
- High load averages
116-
117-
**Solutions**:
118-
- Optimize application code
119-
- Enable caching
120-
- Scale horizontally (add more servers)
121-
- Upgrade CPU resources
122-
123-
#### Memory Bottlenecks
124-
125-
**Symptoms**:
126-
- High memory utilization (>80%)
127-
- Swap usage
128-
- Out-of-memory errors
129-
130-
**Solutions**:
131-
- Optimize memory usage
132-
- Increase memory allocation
133-
- Fix memory leaks
134-
- Implement memory caching
135-
136-
#### Network Bottlenecks
137-
138-
**Symptoms**:
139-
- High network latency
140-
- Packet loss
141-
- Low throughput
142-
143-
**Solutions**:
144-
- Optimize network configuration
145-
- Increase bandwidth
146-
- Implement CDN
147-
- Optimize application protocols
148-
149-
#### Disk Bottlenecks
150-
151-
**Symptoms**:
152-
- High disk I/O wait
153-
- Slow disk operations
154-
- Low disk space
155-
156-
**Solutions**:
157-
- Optimize disk usage
158-
- Implement disk caching
159-
- Upgrade to faster storage
160-
- Clean up unnecessary files
16186

16287

16388
For more information on related topics:

apps/docs/guide/ssl.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ Before requesting a Let's Encrypt certificate, ensure:
3737
1. **Domain DNS**: Your domain must point to this server's IP address
3838
2. **Port 80 Access**: Port 80 must be accessible for domain validation
3939
3. **Email Address**: Valid email for certificate notifications
40-
4. **Domain Ownership**: You must control the domain
4140

4241
### Requesting a Let's Encrypt Certificate
4342

0 commit comments

Comments
 (0)