Checkpoint

This commit is contained in:
2026-07-26 02:20:45 -03:00
parent f04cbb7e02
commit 0f506ec19e
38 changed files with 1757 additions and 154 deletions
+19
View File
@@ -0,0 +1,19 @@
---
title: Introduction
description: Welcome to Duckity's documentation site!
icon: Fish
---
Welcome to Duckity's documentation site. Here you'll find everything you need to know about
Duckity, plus some extras to help you use Duckity more efficiently and effectively.
Duckity is an API-protection software. Unlike CAPTCHAs, which are black boxes and depend on AI
(known to make mistakes), Duckity relies on well-studied algorithms and even some things commonly
used to give you full control over access to your API.
Duckity is NOT a replacement for basic security practices like rate limiting, and neither it is a
DDoS protection service. Use Cloudflare, Bunny.net, or similar for protection of that kind.
If you're new to Duckity, head over to the [Quick Start](/quick-start). It'll guide you on how to get started and
give you some templates to reduce the boilerplate configuration tasks.
+63
View File
@@ -0,0 +1,63 @@
---
title: Quick Start
description: Learn how to use Duckity in some minutes.
icon: Zap
---
Getting started with Duckity is quite simple. Head over to
[Duckity's Dashboard](https://app.duckity.com/) and log in using your favorite method. If it's your
first time logging in, your account will be automatically created.
If it's your first time logging into Duckity, your dashboard will be empty.
![Screenshot](/images/screenshot-dashboard-empty.png)
## Applications
Duckity is divided into one or more applications within your account. You create one application
per project in which you want to integrate Duckity. To create a new application, press on the
yellow **+ New Application** button at the top right corner of the screen.
![Screenshot](/images/screenshot-dashboard-create-application.png)
Once you've set the name of it, press on the **✓ Create Application** button. Congratulations! You
now have your first application created.
![Screenshot](/images/screenshot-dashboard-application.png)
Each application has a credentials pair consisting of:
- **Application ID**: The unique identifier of your app.
- **Application Secret**: Your app's "password". As the name implies, keep it secret.
Additionally, in case your application is a web app, you can set up the CORS origins to fit your
application's origins. For example, if you'll be protecting the login form of your app hosted at
`https://example.com/login`, add `https://example.com` (scheme and host, no path) to your app's
origins. If your application is not a web app, you can leave the CORS origins empty.
## Protection Profiles
Applications commonly have multiple features that need to be protected. For example, you may have a
signup form and a login form with different protection needs. For each, you'll create one
**protection profile** with settings tuned to each feature's specific needs.
Each application needs at least one protection profile to work. To create your first one, press the
**+ Create Protection Profile** button.
![Screenshot](/images/screenshot-dashboard-create-protection-profile.png)
Set the name to the name of the feature you'll be protecting, like "Sign-up Form" or "Add Friend".
This is for you to recognize it later, it won't be displayed to your users. Once you're done
filling it, press on **✓ Create Protection Profile**.
Congrats! Your first protection profile is now created. You'll see a lot of configuration options,
but don't worry; We'll go one by one explaining them below.
![Screenshot](/images/screenshot-dashboard-protection-profile.png)
### Throttling Windows
The first of all settings a protection profile has are the throttling windows. Throttling windows
rate-limit challenge issuance.
![Screenshot](/images/screenshot-dashboard-throttling-windows.png)