How limanmys/core works
Based on your analysis of the Liman project’s file tree and README, you’re dealing with a full-stack web application built in PHP (using a framework similar to Laravel) that functions as a central server, client, and network device management system. This system is designed to support both core server management and an extensible architecture where additional modules or “extensions” can be added to enhance functionality.
Project Type & Core Purpose
• That Liman is a backend-driven web application with a strong API layer. It uses the Model-View-Controller pattern to serve a web interface for server management and user/role administration.
• That it supports extension modules, third-party authentication (via Keycloak, LDAP, etc.), and containerized deployment (Docker, Kubernetes, Helm charts).
Break Down the Main Components
a. Client/Frontend Layer:
– Represented by the “public” directory (static assets, JS, CSS, and the index.php file) alongside the “resources/views” and “resources/assets”.
– This layer interfaces with users (administrators, operators) through a web-based interface.
b. API/Controller Layer:
– Highlight API endpoints found in directories such as “app/Http/Controllers/API” and additional controllers (e.g., Extension, HASync).
– Note RESTful endpoints handling authentication, server management, notifications, settings, and more.
c. Business Logic & Service Layer:
– Identify core logic in “app/Models”, “app/Classes”, “app/Jobs”, and service providers (“app/Providers”).
– This layer handles authentication with various strategies (LDAP, Keycloak, LimanAuthenticator), data processing, notifications, and extension management.
d. Database/Persistence Layer:
– Include the “database” folder that contains migrations, seeds, and schema definitions.
– This layer maps to your relational database supporting user settings, server configurations, logs, etc.
e. Infrastructure & External Integration:
– Note connectors (“app/Connectors”) which abstract communication with external systems.
– Include the integration of external services and modules manifested in the extension features and OAuth2, notifications, etc.
f. Containerization and Deployment:
– Represent Docker (via Dockerfile and docker-compose.yml) and Kubernetes deployment resources (k8s/helm) that define how the application is containerized, orchestrated, and deployed.
Relationships and Interactions
• How the Controller layer interacts with the Business Logic layer (services, jobs, middleware) which in turn communicates with the Database side via Eloquent models and migrations.
• External integrations (authentication systems, external notifications, extensions) as additional nodes or connectors that interface with the Business Logic layer.
Architectural Patterns and Design Principles
• That the application follows the MVC pattern and leverages dependency injection (as seen in dedicated service providers).
• Modularity (via extension directories and clear separation for authentication modules).
• Middleware layers for additional security, localization, and filtering (as found in “app/Http/Middleware”).
• Asynchronous processing using Jobs (for high availability sync, notifications, etc.) that decouple long-running tasks.
Specific Items
• To annotate middleware interactions and asynchronous job handling (with Job queues) since they play a critical role in processing.