fix(docs, tests, acme): fix: update changelog, documentation, examples and tests for v19.4.0 release. Adjust global ACME configuration to use ssl@bleu.de and add non-privileged port examples.
This commit is contained in:
@ -208,11 +208,18 @@ const smartproxy = new SmartProxy({
|
||||
// Certificate provisioning was automatic or via certProvisionFunction
|
||||
```
|
||||
|
||||
### After (v18+)
|
||||
### After (v19+)
|
||||
|
||||
```typescript
|
||||
// New approach with route-based configuration
|
||||
// New approach with global ACME configuration
|
||||
const smartproxy = new SmartProxy({
|
||||
// Global ACME defaults (v19+)
|
||||
acme: {
|
||||
email: 'ssl@bleu.de',
|
||||
useProduction: true,
|
||||
port: 80 // Or 8080 for non-privileged
|
||||
},
|
||||
|
||||
routes: [{
|
||||
match: { ports: 443, domains: 'example.com' },
|
||||
action: {
|
||||
@ -220,11 +227,7 @@ const smartproxy = new SmartProxy({
|
||||
target: { host: 'localhost', port: 8080 },
|
||||
tls: {
|
||||
mode: 'terminate',
|
||||
certificate: 'auto',
|
||||
acme: {
|
||||
email: 'admin@example.com',
|
||||
useProduction: true
|
||||
}
|
||||
certificate: 'auto' // Uses global ACME settings
|
||||
}
|
||||
}
|
||||
}]
|
||||
@ -235,9 +238,38 @@ const smartproxy = new SmartProxy({
|
||||
|
||||
### Common Issues
|
||||
|
||||
1. **Certificate not provisioning**: Ensure port 80 is accessible for ACME challenges
|
||||
2. **ACME rate limits**: Use staging environment for testing
|
||||
1. **Certificate not provisioning**: Ensure the ACME challenge port (80 or configured port) is accessible
|
||||
2. **ACME rate limits**: Use staging environment for testing (`useProduction: false`)
|
||||
3. **Permission errors**: Ensure the certificate directory is writable
|
||||
4. **Invalid email domain**: ACME servers may reject certain email domains (e.g., example.com). Use a real email domain
|
||||
5. **Port binding errors**: Use higher ports (e.g., 8080) if running without root privileges
|
||||
|
||||
### Using Non-Privileged Ports
|
||||
|
||||
For development or non-root environments:
|
||||
|
||||
```typescript
|
||||
const proxy = new SmartProxy({
|
||||
acme: {
|
||||
email: 'ssl@bleu.de',
|
||||
port: 8080, // Use 8080 instead of 80
|
||||
useProduction: false
|
||||
},
|
||||
routes: [
|
||||
{
|
||||
match: { ports: 8443, domains: 'example.com' },
|
||||
action: {
|
||||
type: 'forward',
|
||||
target: { host: 'localhost', port: 3000 },
|
||||
tls: {
|
||||
mode: 'terminate',
|
||||
certificate: 'auto'
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
});
|
||||
```
|
||||
|
||||
### Debug Mode
|
||||
|
||||
|
Reference in New Issue
Block a user