Safing/mmdbmeld
1
0
Fork 0
mirror of https://github.com/safing/mmdbmeld.git synced 2026-05-20 20:40:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs

Browse Source
This commit is contained in:
Daniel
2024-02-01 15:22:59 +01:00
parent f16ba11df6
commit dc5c21bf2b
1 changed files with 22 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+22 -12
View File
@@ -167,38 +167,48 @@ These are used to derive the IP ranges the data (row, entry) is applicable for.
##### CSV
File suffix `.csv`.
Define columns with `fields`, which must match a field defined in the `types`:
```yaml
databases:
...
fields: ["from", "to", "autonomous_system_number", "autonomous_system_organization"]
- name: "Example DB"
inputs:
- file: "example.csv"
fields: ["from", "to", "autonomous_system_number", "autonomous_system_organization"]
```
All rows must have exactly the specified amount of columns. Use `-` to define a column you are not using, eg.:
```yaml
databases:
...
fields: ["from", "to", "country.iso_code", "-", "-", "-", "-", "location.latitude", "location.longitude", "-"]
- name: "Example DB"
inputs:
- file: "example.csv"
fields: ["from", "to", "country.iso_code", "-", "-", "-", "-", "location.latitude", "location.longitude", "-"]
```
##### IPFire
File suffix `.ipfire.txt`.
The [IPFire Firewall](https://www.ipfire.org/) maintains a [geoip database in a custom format](https://git.ipfire.org/?p=location/location-database.git;a=summary), which notably includes IP categorization, such as `is-anycast`.
Define fields with `fieldMap`, mapping IPFire database keys to `types`:
```yaml
databases:
...
fieldMap:
"aut-num": "autonomous_system_number"
"name": "autonomous_system_organization"
"country": "country.iso_code"
"is-anycast": "is_anycast"
"is-satellite-provider": "is_satellite_provider"
"is-anonymous-proxy": "is_anonymous_proxy"
- name: "Example DB"
inputs:
- file: "example.ipfire.txt"
fieldMap:
"aut-num": "autonomous_system_number"
"name": "autonomous_system_organization"
"country": "country.iso_code"
"is-anycast": "is_anycast"
"is-satellite-provider": "is_satellite_provider"
"is-anonymous-proxy": "is_anonymous_proxy"
```
### Defaults