Skip to content

Latest commit

 

History

History
103 lines (71 loc) · 5.45 KB

README.md

File metadata and controls

103 lines (71 loc) · 5.45 KB
Raw

Mercator

Latest Release License Contributors Stars Artifact Hub

Mercator is a powerful and versatile open-source web application designed to facilitate the mapping of information systems, as outlined in the Mapping The Information System Guide by ANSSI. Whether you're an operator of vital importance or part of a broader IT governance framework, Mercator is an essential tool for gaining visibility, control, and ensuring the resilience of your information systems.

📚 Explore the Documentation | 🔍 View the Application Sources

📖 Read this in other languages: French

🌟 Key Features

  • 🖥️ Comprehensive Visualizations: Generate graphical representations of your ecosystem, including logical, administrative, and physical infrastructure views.
  • 📝 Architecture Reports: Automatically create detailed architecture reports of your information system.
  • 🗺️ Mapping Diagrams: Draw and export mapping diagrams to visually communicate system architecture.
  • ✅ Compliance Monitoring: Assess and compute compliance levels across your systems.
  • 🔒 Security Integrations: Search for vulnerabilities using CVE-Search integration.
  • 📊 Data Export: Export data in various formats, including Excel, CSV, and PDF.
  • 🌐 REST API: Seamlessly integrate with other systems using the REST API with JSON support.
  • 👥 Multi-User Management: Role-based access control for collaborative environments.
  • 🌍 Multilingual Support: Available in multiple languages for global teams.
  • 🔗 LDAP/Active Directory Integration: Connect with existing user directories for streamlined authentication.
  • 🛠️ CPE Support: Leverage Common Platform Enumeration (CPE) for enhanced system identification.

🖼️ Screenshots

🏠 Main Dashboard

📊 Compliance Levels

🔧 Input Screens

🗺️ Cartography Drawing

🔍 Data Exploration

🗂️ Data Model

🛠️ Technologies Used

  • Backend: PHP, Laravel
  • Frontend: JavaScript
  • Databases: MariaDB, MySQL, PostgreSQL, and SQLite (See Laravel Database Documentation)
  • Additional Libraries: WebAssembly, Graphviz, ChartJS

📦 Installation

🔧 Manual Installation

For detailed instructions, please refer to the installation guides:

🐳 Docker Installation

Get up and running quickly using Docker. Run a local instance in development mode:

docker run -it --rm -e USE_DEMO_DATA=1 -p 8000:8080 ghcr.io/dbarzin/mercator:latest

To persist your data using SQLite:

touch ./db.sqlite && chmod a+w ./db.sqlite
docker run -it --rm -e APP_ENV=development -p 8000:8080 -v $PWD/db.sqlite:/var/www/mercator/sql/db.sqlite ghcr.io/dbarzin/mercator:latest

Populate the database with demo data:

docker run -it --rm \
           -e APP_ENV=development \
           -p 8000:8080 \
           -v $PWD/db.sqlite:/var/www/mercator/sql/db.sqlite \
           -e USE_DEMO_DATA=1 \
           ghcr.io/dbarzin/mercator:latest

Access your instance at http://127.0.0.1:8000.

user : admin@admin.com
password : password

For a production-ready environment with HTTPS and automated setup, check out the docker-compose folder.

📜 Changelog

Stay up to date with the latest improvements and updates in the Changelog.

📄 License

Mercator is open-source software distributed under the GPL License.