@riavzon/bot-detector 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -19,17 +19,42 @@ Each checker contributes a penalty score toward a configurable ban threshold. Re
|
|
|
19
19
|
- Supports cjs and fully typed
|
|
20
20
|
|
|
21
21
|
## Requirements
|
|
22
|
+
|
|
22
23
|
- Node.js 18 or later
|
|
23
24
|
- Express 5
|
|
24
25
|
- A supported database for visitor persistence
|
|
25
26
|
|
|
26
|
-
##
|
|
27
|
+
## Quick setup
|
|
28
|
+
|
|
29
|
+
The fastest way to get started is with the create package. Run this in the root
|
|
30
|
+
of your Express project:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npx @riavzon/bot-detector-create
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
This single command installs all dependencies, downloads and compiles every
|
|
37
|
+
threat intelligence feed, writes a fully annotated `botDetectorConfig.ts` at
|
|
38
|
+
your project root, and creates the database tables, all without any manual
|
|
39
|
+
steps. See the
|
|
40
|
+
[@riavzon/bot-detector-create](https://www.npmjs.com/package/@riavzon/bot-detector-create)
|
|
41
|
+
package for details.
|
|
42
|
+
|
|
43
|
+
## Manual installation
|
|
44
|
+
|
|
45
|
+
If you prefer to wire things up yourself:
|
|
27
46
|
|
|
28
47
|
```bash
|
|
29
48
|
npm install @riavzon/bot-detector
|
|
30
49
|
```
|
|
31
50
|
|
|
32
|
-
After installation, the package runs `bot-detector init` automatically to
|
|
51
|
+
After installation, the package runs `bot-detector init` automatically to
|
|
52
|
+
download its data sources and validate that
|
|
53
|
+
[mmdbctl](https://github.com/ipinfo/mmdbctl) is installed. If it's not, the
|
|
54
|
+
installer prompts you and installs it automatically. It also asks for a contact
|
|
55
|
+
string used to fetch [BGP](https://en.wikipedia.org/wiki/Border_Gateway_Protocol)
|
|
56
|
+
data from bgp.tools, which requires it before granting API access. See
|
|
57
|
+
[BGP.tools](https://bgp.tools/kb/api) for details.
|
|
33
58
|
|
|
34
59
|
The compiled databases are written to `_data-sources/` inside the package directory, which include the following files:
|
|
35
60
|
|