Skip to content

Commit 8fa4e75

Browse files
authored
doc update
1 parent 19bab74 commit 8fa4e75

File tree

5 files changed

+0
-76
lines changed

5 files changed

+0
-76
lines changed

apps/docs/guide/domains.md

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -217,37 +217,6 @@ After making changes to domain configuration, you may need to reload Nginx:
217217
1. Click the **Reload Nginx** button in the domain list
218218
2. Or use the system-wide reload in **System** settings
219219

220-
221-
## Best Practices
222-
223-
### Domain Configuration
224-
225-
1. **Use Descriptive Names**: Make domain names clear and descriptive
226-
2. **Organize by Environment**: Separate production, staging, and development domains
227-
3. **Document Configuration**: Keep records of special configurations
228-
4. **Regular Backups**: Backup domain configurations regularly
229-
230-
### Upstream Server Management
231-
232-
1. **Multiple Servers**: Always configure at least two upstream servers for redundancy
233-
2. **Health Checks**: Enable health checks for all production domains
234-
3. **Weight Distribution**: Use appropriate weights based on server capacity
235-
4. **Backup Servers**: Configure backup servers for high availability
236-
237-
### Security
238-
239-
1. **SSL Everywhere**: Enable SSL for all production domains
240-
2. **ModSecurity**: Enable WAF protection for all public-facing domains
241-
3. **Access Control**: Use ACLs to restrict access as needed
242-
4. **Regular Updates**: Keep SSL certificates and security rules updated
243-
244-
### Performance
245-
246-
1. **Monitor Metrics**: Regularly check performance metrics
247-
2. **Optimize Configuration**: Tune settings based on traffic patterns
248-
3. **Load Testing**: Test configuration under load
249-
4. **Capacity Planning**: Plan for growth and scale accordingly
250-
251220
## API Integration
252221

253222
For programmatic domain management, use the REST API:
@@ -301,15 +270,7 @@ curl -X DELETE http://localhost:3001/api/domains/DOMAIN_ID \
301270

302271
For complete API documentation, see the [API Reference](/api/domains).
303272

304-
## Conclusion
305-
306-
Domain management is a core feature of the Nginx WAF Management Platform. By following this guide, you should be able to:
307273

308-
- Add and configure domains effectively
309-
- Set up reliable load balancing
310-
- Monitor domain performance
311-
- Troubleshoot common issues
312-
- Implement best practices for production use
313274

314275
For more information on related topics:
315276
- [SSL Certificate Management](/guide/ssl)

apps/docs/guide/logs.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -189,15 +189,6 @@ curl -X GET "http://localhost:3001/api/logs/download?type=error&format=json" \
189189
3. **Capacity Planning**: Use logs for capacity planning
190190
4. **Optimization**: Optimize based on log analysis
191191

192-
## Conclusion
193-
194-
Log analysis is essential for maintaining system security, performance, and reliability. By following this guide, you should be able to:
195-
196-
- View and filter different types of logs
197-
- Search for specific log entries
198-
- Analyze access patterns and security events
199-
- Troubleshoot issues using log data
200-
- Export logs for external analysis
201192

202193
For more information on related topics:
203194
- [Domain Management](/guide/domains)

apps/docs/guide/modsecurity.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -365,15 +365,6 @@ curl -X DELETE http://localhost:3001/api/modsec/rules/RULE_ID \
365365

366366
For complete API documentation, see the [API Reference](/api/modsecurity).
367367

368-
## Conclusion
369-
370-
ModSecurity WAF is a powerful tool for protecting your web applications. By following this guide, you should be able to:
371-
372-
- Configure ModSecurity for optimal protection
373-
- Manage OWASP CRS rules effectively
374-
- Create custom security rules
375-
- Monitor and analyze security events
376-
- Troubleshoot common WAF issues
377368

378369
For more information on related topics:
379370
- [Domain Management](/guide/domains)

apps/docs/guide/performance.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -327,15 +327,7 @@ curl -X DELETE http://localhost:3001/api/performance/cleanup \
327327
3. **Scale Proactively**: Scale resources before issues occur
328328
4. **Document Decisions**: Document scaling decisions and rationale
329329

330-
## Conclusion
331330

332-
Performance monitoring is essential for maintaining system health and optimizing user experience. By following this guide, you should be able to:
333-
334-
- Monitor system and domain performance effectively
335-
- Configure alerts for performance issues
336-
- Analyze performance trends and identify bottlenecks
337-
- Optimize system performance based on data
338-
- Plan for future capacity needs
339331

340332
For more information on related topics:
341333
- [Domain Management](/guide/domains)

apps/docs/guide/ssl.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -150,14 +150,11 @@ The automatic renewal process:
150150
3. **Certificate Request**: New certificate is requested from Let's Encrypt
151151
4. **Validation**: Domain ownership is validated
152152
5. **Installation**: New certificate is installed
153-
6. **Notification**: Success/failure notification is sent
154153

155154
### Renewal Notifications
156155

157156
Configure notifications for renewal events:
158157

159-
- **Success Notifications**: Certificate renewed successfully
160-
- **Failure Notifications**: Renewal failed, manual intervention required
161158
- **Expiry Warnings**: Certificate expiring soon (if auto-renewal fails)
162159

163160
## API Integration
@@ -210,15 +207,7 @@ curl -X DELETE http://localhost:3001/api/ssl/CERTIFICATE_ID \
210207

211208
For complete API documentation, see the [API Reference](/api/ssl).
212209

213-
## Conclusion
214210

215-
SSL certificate management is crucial for securing your web applications. By following this guide, you should be able to:
216-
217-
- Configure Let's Encrypt certificates automatically
218-
- Upload and manage custom certificates
219-
- Set up automatic renewal with monitoring
220-
- Troubleshoot common SSL issues
221-
- Implement SSL best practices
222211

223212
For more information on related topics:
224213
- [Domain Management](/guide/domains)

0 commit comments

Comments
 (0)