diff --git a/README.md b/README.md index 3e952a1..f99aa52 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ ++ POR HACER: + + Reportes: pais - codigo - fecha + + Generar Imagen: loc y codigo? + # iplocate ## Gestión de logs *nginx* archivados @@ -38,24 +42,28 @@ Crea base de datos ***SQLite3*** **`./ipinfo.db`** con tablas de **registro** y `./iplocate.py -h` 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. + ipLocate - Uso: - iploc - Consulta la información de disponible en ipinfo.io. - iploc -t - Consulta la info. de usando 'token' de ipinfo.io, - especificado en config.cfg. - iploc -d - Consulta la información de disponible en base de datos. - iploc -f - Consulta info. de las IPs en (ipinfo.io). - iploc -F - Consulta info. de las IPs en (token, ipinfo.io). - iploc -D - Consulta info. de las IPs en (base de datos). - 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). + 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. + + iploc -h - Muestra esta ayuda. + + Uso para consultas: + iploc - Consulta la información de disponible en ipinfo.io. + iploc -t - Consulta la info. de usando 'token' de ipinfo.io, + especificado en config.cfg. + iploc -d - Consulta la información de disponible en base de datos. + iploc -f - Consulta info. de las IPs en (ipinfo.io). + iploc -F - Consulta info. de las IPs en (token, ipinfo.io). + iploc -D - Consulta info. de las IPs en (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 --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 `: +**`iploc `** - Muestra la información sobre \ disponible en ipinfo.io. -`iploc -t `: **PENDIENTE** +**`iploc -t `** - Muestra la información sobre \ disponible en ipinfo.io usando el **token** especificado en `./config.cfg`. -`iploc -d `: **PENDIENTE** +**`iploc -d `** - Muestra toda la información disponible en BD acerca de \ -`iploc -f `: +**`iploc -f `** - Muestra la información disponible en ipinfo.io para cada \ en archivo pasado como argumento. -`iploc -D `: **PENDIENTE** +**`iploc -D `** - Muestra toda la información disponible en BD para cada \ en archivo pasado como argumento. -ej. formato \. +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 +
-Servidor: -- Bash >= 5.0 -- rsync - -Local: -- Bash local >= 5.1.16 -- SQLite3 3.38.5 -- sqlitebrowser 3.35.5 (opc.) -- Python >= 3.10 - - requests - - SQLAlchemy 1.4.32 - - colorama - -Token API [ipinfo.io](https://ipinfo.io/) +- Servidor: + - Bash >= 5.0 + - rsync + +
+ +- Local: + - Bash >= 5.1.16 + - SQLite3 3.38.5 + - Python >= 3.10 + - requests + - SQLAlchemy 1.4.32 + - rich + - sqlitebrowser 3.35.5 (opc.) + +
+ +- *[Token](https://ipinfo.io/)*