Skip to content

Commit 19bab74

Browse files
authored
doc update
1 parent bda9a58 commit 19bab74

File tree

6 files changed

+5
-1203
lines changed

6 files changed

+5
-1203
lines changed

apps/docs/guide/domains.md

Lines changed: 3 additions & 147 deletions
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,12 @@ When entering a domain name, follow these guidelines:
4949
- **Valid Characters**: Letters (a-z), numbers (0-9), hyphens (-)
5050
- **Cannot Start/End**: Cannot start or end with a hyphen
5151
- **Subdomains**: Use dot notation for subdomains (e.g., `api.example.com`)
52-
- **Wildcards**: Wildcard domains are supported (*.example.com)
5352

5453
**Examples of Valid Domain Names:**
5554
```
5655
example.com
5756
api.example.com
5857
www.example.com
59-
*.example.com
6058
my-app.example.org
6159
```
6260

@@ -91,7 +89,7 @@ Protocol: HTTP
9189
Weight: 1
9290
Max Fails: 3
9391
Fail Timeout: 10
94-
SSL Verify: Yes
92+
SSL Verify: OFF
9593
```
9694

9795
#### Multiple Backend Servers (Load Balancing)
@@ -106,11 +104,10 @@ Server 2:
106104
Port: 8080
107105
Weight: 2
108106
109-
Server 3 (Backup):
107+
Server 3:
110108
Host: 192.168.1.102
111109
Port: 8080
112110
Weight: 1
113-
Backup: Yes
114111
```
115112

116113
#### HTTPS Backend with SSL Verification
@@ -119,7 +116,7 @@ Host: api.backend.com
119116
Port: 443
120117
Protocol: HTTPS
121118
Weight: 1
122-
SSL Verify: Yes
119+
SSL Verify: OFF
123120
```
124121

125122
## Load Balancing Configuration
@@ -187,90 +184,6 @@ Path: /health
187184
Success Criteria: 200, 204
188185
```
189186

190-
## Advanced Domain Configuration
191-
192-
### Custom Nginx Configuration
193-
194-
For advanced use cases, you can add custom Nginx configuration directives:
195-
196-
1. Select your domain from the list
197-
2. Click the **Advanced** tab
198-
3. Add custom configuration in the text area
199-
200-
#### Example Custom Configuration
201-
```nginx
202-
# Custom headers
203-
add_header X-Frame-Options "SAMEORIGIN" always;
204-
add_header X-Content-Type-Options "nosniff" always;
205-
add_header X-XSS-Protection "1; mode=block" always;
206-
207-
# CORS configuration
208-
if ($request_method = 'OPTIONS') {
209-
add_header 'Access-Control-Allow-Origin' '*';
210-
add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
211-
add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range';
212-
add_header 'Access-Control-Max-Age' 1728000;
213-
add_header 'Content-Type' 'text/plain; charset=utf-8';
214-
add_header 'Content-Length' 0;
215-
return 204;
216-
}
217-
218-
# Rate limiting
219-
limit_req_zone $binary_remote_addr zone=api:10m rate=10r/s;
220-
limit_req zone=api burst=20 nodelay;
221-
```
222-
223-
### URL Rewriting and Redirects
224-
225-
Configure URL rewriting and redirects for your domain:
226-
227-
#### Permanent Redirect (301)
228-
```nginx
229-
# Redirect old domain to new domain
230-
server_name old-domain.com;
231-
return 301 $scheme://new-domain.com$request_uri;
232-
```
233-
234-
#### Temporary Redirect (302)
235-
```nginx
236-
# Temporary maintenance redirect
237-
return 302 /maintenance.html;
238-
```
239-
240-
#### URL Rewriting
241-
```nginx
242-
# Rewrite rules
243-
location /old-path/ {
244-
rewrite ^/old-path/(.*)$ /new-path/$1 permanent;
245-
}
246-
```
247-
248-
## Domain Status and Monitoring
249-
250-
### Domain Status Indicators
251-
252-
Each domain displays status indicators:
253-
254-
- **Active**: Domain is online and accepting traffic
255-
- **Inactive**: Domain is disabled and not accepting traffic
256-
- **Error**: Domain has configuration errors or all upstreams are down
257-
258-
### Upstream Server Status
259-
260-
Upstream servers show individual health status:
261-
262-
- **Up**: Server is healthy and accepting traffic
263-
- **Down**: Server is not responding or has failed health checks
264-
- **Checking**: Health check is in progress
265-
266-
### Domain Performance Metrics
267-
268-
Monitor domain performance through the **Performance** tab:
269-
270-
- **Request Rate**: Requests per second
271-
- **Response Time**: Average response time
272-
- **Error Rate**: Percentage of failed requests
273-
- **Bandwidth**: Data transfer statistics
274187

275188
## Domain Operations
276189

@@ -304,63 +217,6 @@ After making changes to domain configuration, you may need to reload Nginx:
304217
1. Click the **Reload Nginx** button in the domain list
305218
2. Or use the system-wide reload in **System** settings
306219

307-
## Troubleshooting Domain Issues
308-
309-
### Common Issues and Solutions
310-
311-
#### Domain Not Accessible
312-
313-
**Symptoms**: 502 Bad Gateway, connection refused
314-
315-
**Possible Causes**:
316-
- All upstream servers are down
317-
- Incorrect upstream configuration
318-
- Network connectivity issues
319-
320-
**Solutions**:
321-
1. Check upstream server status
322-
2. Verify host and port configuration
323-
3. Test connectivity to upstream servers
324-
4. Check firewall rules
325-
326-
#### SSL Certificate Issues
327-
328-
**Symptoms**: SSL warnings, certificate errors
329-
330-
**Possible Causes**:
331-
- Expired SSL certificate
332-
- Incorrect certificate configuration
333-
- Domain mismatch
334-
335-
**Solutions**:
336-
1. Check SSL certificate validity
337-
2. Verify certificate matches domain
338-
3. Renew or reissue certificate
339-
4. Check certificate chain
340-
341-
#### Load Balancing Not Working
342-
343-
**Symptoms**: All traffic going to one server
344-
345-
**Possible Causes**:
346-
- Incorrect load balancing algorithm
347-
- Server weights not configured
348-
- Health checks failing
349-
350-
**Solutions**:
351-
1. Verify load balancing algorithm
352-
2. Check server weights
353-
3. Review health check configuration
354-
4. Monitor server health status
355-
356-
### Debug Mode
357-
358-
Enable debug mode for detailed logging:
359-
360-
1. Go to **System** settings
361-
2. Enable **Debug Mode**
362-
3. Check logs in **Logs** section
363-
4. Disable debug mode when finished
364220

365221
## Best Practices
366222

0 commit comments

Comments
 (0)