blitzwing/cobalt-7
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs/run-an-instance: mention unlimited api keys

Browse source
This commit is contained in:
dumbmoron 2024-10-04 17:43:35 +00:00
parent cfd54e91d5
commit 3691e2e4f1
No known key found for this signature in database
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/run-an-instance.md
View file

@ -103,6 +103,7 @@ where *`UUIDv4String`* is a stringified version of a UUIDv4 identifier.
- **`limit`** specifies how many requests the API key can make during the window specified in the `RATELIMIT_WINDOW` env. - **`limit`** specifies how many requests the API key can make during the window specified in the `RATELIMIT_WINDOW` env.
- when omitted, the limit specified in `RATELIMIT_MAX` will be used. - when omitted, the limit specified in `RATELIMIT_MAX` will be used.
- it can be also set to `"unlimited"`, in which case the API key bypasses all rate limits.
- **`ips`** contains an array of allowlisted IP ranges, which can be specified both as individual ips or CIDR ranges (e.g. *`["192.168.42.69", "2001:db8::48", "10.0.0.0/8", "fe80::/10"]`*). - **`ips`** contains an array of allowlisted IP ranges, which can be specified both as individual ips or CIDR ranges (e.g. *`["192.168.42.69", "2001:db8::48", "10.0.0.0/8", "fe80::/10"]`*).
- when specified, only requests from these ip ranges can use the specified api key. - when specified, only requests from these ip ranges can use the specified api key.
@ -122,6 +123,11 @@ an example key file could look like this:
"limit": 10, "limit": 10,
"ips": ["10.0.0.0/8", "192.168.42.42"], "ips": ["10.0.0.0/8", "192.168.42.42"],
"userAgents": ["*Chrome*"] "userAgents": ["*Chrome*"]
},
"b00b1234-a3e5-99b1-c6d1-dba4512ae190": {
"limit": "unlimited",
"ips": ["192.168.1.2"],
"userAgents": ["cobaltbot/1.0"]
} }
} }
``` ```