ed: README

This commit is contained in:
jp.av.dev 2022-05-21 00:59:11 -04:00
parent 9901fc32f9
commit a373e66d29

View File

@ -1,3 +1,7 @@
+ POR HACER:
+ Reportes: pais - codigo - fecha
+ Generar Imagen: loc y codigo?
# iplocate
## Gestión de logs *nginx* archivados
@ -39,12 +43,15 @@ Crea base de datos ***SQLite3*** **`./ipinfo.db`** con tablas de **registro** y
ej. alias `alias iploc='~/ruta/script/iplocate.py'`
```bash
ipLocate
Consulta información sobre IP(s) disponibles en ipinfo.io con o sin token.
Carga logs de nginx en base de datos. Consulta con ipinfo.io y registra
en base de datos.
Consultas y reportes según información en la base de datos.
Uso:
iploc -h - Muestra esta ayuda.
Uso para consultas:
iploc <IP> - Consulta la información de <IP> disponible en ipinfo.io.
iploc -t <IP> - Consulta la info. de <IP> usando 'token' de ipinfo.io,
especificado en config.cfg.
@ -52,10 +59,11 @@ ej. alias `alias iploc='~/ruta/script/iplocate.py'`
iploc -f <archivo> - Consulta info. de las IPs en <archivo> (ipinfo.io).
iploc -F <archivo> - Consulta info. de las IPs en <archivo> (token, ipinfo.io).
iploc -D <archivo> - Consulta info. de las IPs en <archivo> (base de datos).
Operaciones base de datos:
iploc --sync - Sincroniza logs del servidor (bash script).
iploc -c - Carga logs en base de datos.
iploc -g - Guarda ipinfo de IPs sin registro en la BD.
iploc -h - Muestra esta ayuda.
iploc --sync - Sincroniza logs del servidor (bash script).
```
**`iploc --sync`**
@ -63,7 +71,7 @@ Realiza el proceso de copia de archivos del servidor, extracción y concatenado.
Explicado con detalle mas arriba.
**`iploc -c`**
Poblar la tabla **visita** de la BD. Carga los registros en archivos de log en la tabla.
Poblar tabla **visita** de la base de datos. Carga los registros en archivos de log en la tabla.
**`iploc -g`**
Consulta a `ipinfo.io` por cada ip registrada en **visita** (una vez por ip).
@ -71,25 +79,25 @@ Guarda los datos en tabla **registro**.
### Otras opciones
`iploc <IP>`:
**`iploc <IP>`**
- Muestra la información sobre \<IP\> disponible en ipinfo.io.
`iploc -t <IP>`: **PENDIENTE**
**`iploc -t <IP>`**
- Muestra la información sobre \<IP\> disponible en ipinfo.io
usando el **token** especificado en `./config.cfg`.
`iploc -d <IP>`: **PENDIENTE**
**`iploc -d <IP>`**
- Muestra toda la información disponible en BD acerca de \<IP\>
`iploc -f <archivo_IPs>`:
**`iploc -f <archivo_IPs>`**
- Muestra la información disponible en ipinfo.io para cada \<IP\>
en archivo pasado como argumento.
`iploc -D <archivo_IPs>`: **PENDIENTE**
**`iploc -D <archivo_IPs>`**
- Muestra toda la información disponible en BD para cada \<IP\>
en archivo pasado como argumento.
ej. formato \<archivo_IPs\>.
ej. formato `./archivo_IPs`.
```
1.1.1.1
8.8.8.8
@ -154,21 +162,26 @@ Correr `iploc -h` para crear base de datos.
Seguir los pasos explicados en **Uso**.
### Requerimientos, dependencias
### Dependencias
<br>
Servidor:
- Bash >= 5.0
- rsync
- Servidor:
- Bash >= 5.0
- rsync
Local:
- Bash local >= 5.1.16
- SQLite3 3.38.5
- sqlitebrowser 3.35.5 (opc.)
- Python >= 3.10
<br>
- Local:
- Bash >= 5.1.16
- SQLite3 3.38.5
- Python >= 3.10
- requests
- SQLAlchemy 1.4.32
- colorama
- rich
- sqlitebrowser 3.35.5 (opc.)
Token API [ipinfo.io](https://ipinfo.io/)
<br>
- *[Token](https://ipinfo.io/)*