Skip to content

Commit a929fb5

Browse files
committed
chg: [doc] add tracker doc
1 parent 8312d0e commit a929fb5

File tree

2 files changed

+229
-159
lines changed

2 files changed

+229
-159
lines changed

README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,20 @@ Allow easy creation and customization by extending an abstract class.
8989
- Tor hidden services is part of the standard framework, all the AIL modules are available to the crawled hidden services
9090
- Crawler scheduler to trigger crawling on demand or at regular intervals for URLs or Tor hidden services
9191

92+
### Trackers:
93+
Trackers are user-defined rules or patterns that automatically detect, tag and notify about relevant information collected by AIL.
94+
95+
Trackers types: [Documentation](/doc/README.md#trackers-)
96+
- word or set of words
97+
- YARA rules
98+
- Regex
99+
- Typo Squatting
100+
101+
![tracker-create](./doc/screenshots/tracker_create.png "AIL framework create tracker")
102+
103+
![tracker-yara](./doc/screenshots/tracker_yara.png "AIL framework Yara tracker")
104+
105+
![retro-hunt](./doc/screenshots/retro_hunt.png "AIL framework Retro Hunt")
92106

93107
## Installation
94108

@@ -112,7 +126,7 @@ The default [installing_deps.sh](./installing_deps.sh) is for Debian and Ubuntu
112126
Requirement:
113127
- Python 3.8+
114128

115-
## Installation Notes
129+
### Installation Notes
116130

117131
For Lacus Crawler and LibreTranslate installation instructions (if you want to use those features), refer to the [HOWTO](https://github.com/ail-project/ail-framework/blob/master/HOWTO.md#crawler)
118132

@@ -136,6 +150,9 @@ The default credentials for the web interface are located in the ``DEFAULT_PASSW
136150

137151
CIRCL organises training on how to use or extend the AIL framework. AIL training materials are available at [https://github.com/ail-project/ail-training](https://github.com/ail-project/ail-training).
138152

153+
## Documentation
154+
155+
The documentation is available in [doc/README.md](doc/README.md)
139156

140157
## API
141158

@@ -207,12 +224,6 @@ If you use or reference AIL in an academic paper, you can cite it using the foll
207224

208225
### Trackers
209226

210-
![tracker-create](./doc/screenshots/tracker_create.png?raw=true "AIL framework create tracker")
211-
212-
![tracker-yara](./doc/screenshots/tracker_yara.png?raw=true "AIL framework Yara tracker")
213-
214-
![retro-hunt](./doc/screenshots/retro_hunt.png?raw=true "AIL framework Retro Hunt")
215-
216227
## License
217228

218229
```

0 commit comments

Comments
 (0)