Skip to content

Commit 896d5f3

Browse files
committed
Added ddos doc
1 parent a07eb90 commit 896d5f3

File tree

6 files changed

+170
-47
lines changed

6 files changed

+170
-47
lines changed

docs/articles/cloudflare-settings.mdx

Lines changed: 0 additions & 45 deletions
This file was deleted.

docs/articles/ddos-protection.mdx

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
---
2+
title: Managed DDoS Protection
3+
sidebar_label: DDoS Protection
4+
---
5+
6+
Zuplo provides automatic DDoS (Distributed Denial of Service) protection for all
7+
APIs deployed on the platform. This service detects and mitigates attacks in
8+
real-time, ensuring your APIs remain available even under attack.
9+
10+
:::note
11+
12+
Zuplo Managed DDoS is only available for customers using Zuplo's managed edge
13+
deployment model. Customers using managed dedicated deployments should refer to
14+
the
15+
[Managed Dedicated WAF Options](./zuplo-waf.mdx#managed-dedicated-waf-options)
16+
document.
17+
18+
:::
19+
20+
## What is DDoS?
21+
22+
DDoS attacks attempt to overwhelm your API by flooding it with malicious traffic
23+
from multiple sources. Zuplo's protection covers both:
24+
25+
- **Network Layer Attacks (Layer 3/4)**: UDP floods, SYN floods, and other
26+
network-level attacks
27+
- **Application Layer Attacks (Layer 7)**: HTTP floods, slowloris, and other
28+
application-level attacks
29+
30+
## Key Benefits
31+
32+
- **Always-On**: Protection is automatic from deployment—no configuration needed
33+
- **Multi-Layer Defense**: Covers both network and application layer attacks
34+
- **Unmetered Protection**: No bandwidth limits during attacks
35+
- **Adaptive**: Continuously updated to handle new attack patterns
36+
- **Minimal False Positives**: Smart detection reduces blocking of legitimate
37+
traffic
38+
- **Avoid Unexpected Costs**: Zuplo never charges for requests that are blocked
39+
by DDoS protection protecting you from unexpected overage fees.
40+
41+
## Protection Levels
42+
43+
Zuplo offers different sensitivity levels for DDoS protection, allowing you to
44+
balance security with accessibility based on your specific needs.
45+
46+
### Working Copy Environments
47+
48+
All Working Copy environments (`.zuplo.dev` domains) are automatically protected
49+
with **Medium** sensitivity. This provides robust protection while minimizing
50+
the risk of blocking legitimate traffic during development and testing.
51+
52+
### Preview and Production Environments
53+
54+
Preview and production deployments benefit from advanced DDoS protection
55+
capabilities:
56+
57+
- **Default Setting**: Medium sensitivity (balanced protection)
58+
- **Enterprise Customization**: Optional enterprise add-on allowing
59+
configuration of protection levels
60+
61+
### Sensitivity Levels Explained
62+
63+
Enterprise customers with the DDoS customization add-on can choose from four
64+
sensitivity levels:
65+
66+
#### High Sensitivity
67+
68+
- Most aggressive protection with the lowest threshold for triggering mitigation
69+
- Ideal for APIs that face frequent attacks or handle highly sensitive data
70+
- May occasionally block legitimate traffic during unusual usage patterns
71+
72+
#### Medium Sensitivity (Default)
73+
74+
- Balanced approach providing strong protection with moderate thresholds
75+
- Recommended for most production APIs
76+
- Optimizes for both security and accessibility
77+
78+
#### Low Sensitivity
79+
80+
- Higher threshold for triggering mitigation
81+
- Suitable for APIs with highly variable traffic patterns
82+
- Reduces false positives for legitimate traffic spikes
83+
84+
#### Essentially Off
85+
86+
- Minimal protection with the highest threshold
87+
- Protection still activates for extremely large attacks to maintain network
88+
stability
89+
- Recommended only when you have alternative DDoS protection mechanisms.
90+
91+
## How Protection Works
92+
93+
### Detection
94+
95+
Zuplo's DDoS protection uses sophisticated algorithms to analyze traffic
96+
patterns in real-time. The system examines multiple factors including:
97+
98+
- Request rates and patterns
99+
- Source IP reputation
100+
- Geographic distribution
101+
- Protocol compliance
102+
- Behavioral anomalies
103+
104+
### Mitigation
105+
106+
When an attack is detected, the system automatically applies appropriate
107+
mitigation techniques:
108+
109+
1. **Traffic Filtering**: Malicious traffic is filtered at the edge before
110+
reaching your API
111+
2. **Rate Limiting**: Excessive requests from suspicious sources are throttled
112+
3. **Connection Management**: Advanced TCP protection handles sophisticated
113+
connection-based attacks
114+
115+
### Continuous Improvement
116+
117+
The protection system continuously evolves:
118+
119+
- Managed rulesets are regularly updated
120+
- New attack patterns are incorporated into detection algorithms
121+
- Protection mechanisms adapt based on the global threat landscape
122+
123+
## Enterprise Customization
124+
125+
Enterprise customers can enhance their DDoS protection with:
126+
127+
- **Custom Sensitivity Levels**: Adjust protection thresholds per environment
128+
- **Advanced Analytics**: Detailed attack reports and traffic analysis
129+
- **Custom Rule Configuration**: Tailor protection to specific traffic patterns
130+
131+
:::tip
132+
133+
Contact your Zuplo account team to learn more about Enterprise DDoS
134+
customization options.
135+
136+
:::

docs/articles/local-development-troubleshooting.mdx

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,37 @@ port 9100. To change the port number, you can call
1111
npx zuplo dev --port <port number> --editor-port <editor port number>
1212
```
1313

14+
## Certificates Errors
15+
16+
When running Zuplo locally you may want to call a service with a self-signed
17+
certificate. By default this is not supported - we recommend using
18+
signed/trusted certicates in deployed environments. However, for local
19+
development you can ignore certificate errors by adding the
20+
`--unsafely-ignore-certificate-errors` flag on the `zuplo dev` command.
21+
22+
Run your development server with the following command:
23+
24+
```bash
25+
npx zuplo dev --unsafely-ignore-certificate-errors
26+
```
27+
28+
If you want to update your `package.json` to always allow self-signed
29+
certificates, you can add the following script:
30+
31+
```json
32+
{
33+
"scripts": {
34+
"dev": "zuplo dev --unsafely-ignore-certificate-errors"
35+
}
36+
}
37+
```
38+
1439
## Updating the Zuplo CLI
1540

1641
To update the CLI, run the following command in your project directory.
1742

1843
```bash
19-
npm install zuplo@latest
44+
npm install zuplo@latest
2045
```
2146

2247
You must include the @latest to ensure you are getting the latest. Otherwise,

docs/articles/zuplo-waf.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Gateways. This service offers multiple layers of protection against common
88
threats, attacks, and malicious traffic without requiring you to manage complex
99
security configurations.
1010

11+
<EnterpriseFeature name="Zuplo Managed WAF" />
12+
1113
:::note
1214

1315
Zuplo Managed WAF is only available for customers using Zuplo's managed edge

sidebar.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ export const docs: Navigation = [
172172
"articles/waf-ddos-aws-waf-shield",
173173
],
174174
},
175-
"articles/cloudflare-settings",
175+
"articles/ddos-protection",
176176
],
177177
},
178178
{

vercel.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1197,6 +1197,11 @@
11971197
"source": "/docs/legacy/dev-portal/overview{/}?",
11981198
"destination": "/docs/dev-portal/introduction",
11991199
"permanent": true
1200+
},
1201+
{
1202+
"source": "/docs/articles/cloudflare-settings{/}?",
1203+
"destination": "/docs/articles/zuplo-ddos",
1204+
"permanent": true
12001205
}
12011206
],
12021207
"rewrites": [

0 commit comments

Comments
 (0)