Metadata-Version: 2.3
Name: armada-logs
Version: 0.1.0
Summary: Armada offers quick, detailed insights into network logs enriched with metadata information
Home-page: https://github.com/Viter-0/armada
License: MIT
Keywords: log-analysis,vmware,nsx,logging,network,flows,firewall
Author: Viter
Author-email: viterr@proton.me
Requires-Python: >=3.11
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: Log Analysis
Provides-Extra: all
Requires-Dist: aiosqlite (>=0.20.0)
Requires-Dist: alembic (>=1.14.0)
Requires-Dist: asyncpg (>=0.30.0)
Requires-Dist: bcrypt (>=4.2.1)
Requires-Dist: cryptography (>=44.0.0)
Requires-Dist: faker (>=33.3.0,<34.0.0) ; extra == "all"
Requires-Dist: fastapi-login (>=1.10.3)
Requires-Dist: fastapi[standard] (>=0.115.6)
Requires-Dist: httpx (>=0.28.1)
Requires-Dist: ldap3 (>=2.9.1)
Requires-Dist: pydantic (>=2.10.5)
Requires-Dist: pydantic-settings (>=2.7.1)
Requires-Dist: pyyaml (>=6.0.2)
Requires-Dist: sqlalchemy (>=2.0.36)
Requires-Dist: taskiq (>=0.11.10)
Requires-Dist: taskiq-redis (>=1.0.2)
Requires-Dist: truststore (>=0.10.0)
Requires-Dist: typer (>=0.15.1)
Requires-Dist: uvicorn (>=0.34.0)
Project-URL: Bug Tracker, https://github.com/Viter-0/armada/issues
Project-URL: Repository, https://github.com/Viter-0/armada
Description-Content-Type: text/markdown

# Armada

Armada is a lightweight tool designed for centralized network log viewing across multiple data sources. Armada offers quick, detailed insights into network flows enriched with metadata information.

Originally created to analyze VMware NSX logs, its broader goal is to become a versatile tool for general network log analysis.

## Features

- Simple setup process. There is no need for complex configurations or additional servers.;
- Search query suggestions and autocompletion;
- Log correlation with relevant asset data;
- Current Data Source Support:
  - VMware Aria Operations for Logs
  - VMware Aria Operations for Networks
  - Ivanti Neurons (HEAT) for ITSM
  - IBM QRadar

## Demo Access

You can explore Armada by accessing our demo environment

URL: <https://github.com/Viter-0/armada>

Login Credentials:

- Username: `demo@demo.lan`

- Password: `demo`

## Getting Started

Use pip to install Armada:

```console
pip install armada-logs
```

Run the application to launch the web server.

```console
armada run prod
```

Open the web interface in your browser. By default, it will start on <http://localhost:8000>

Create an initial user account.

Add at least one data source to start collecting logs and assets.

## Roadmap

Armada is continuously evolving with new features and integrations. Below are some of the planned enhancements. Have ideas or feature requests? Feel free to contribute or open an issue!

New Data Sources

- Palo Alto Firewall
- FortiGate Firewall
- Switches and Routers: Cisco, Fortinet, Aruba, Juniper
- Network Access Control (NAC): Cisco ISE, Aruba ClearPass

New Features

- Ability to view UTM logs such as Antivirus, Web-filter and IPS;
- Support for ARP and Security Groups as new asset types;
- Enhance asset data with user-defined attributes for more flexibility;
- Query data sources using user-defined attributes;

## Contributing

Armada thrives on community collaboration. If you want to suggest features, report bugs, or contribute code, don't hesitate to reach out or create an issue.

