How meeds-io/meeds works
Project type and purpose
• This is a Maven-driven, multi-module Java distribution of the “Meeds” (eXo Platform) community portal.
• Goal: compile service-layer modules, assemble web applications, package everything into a standalone Tomcat distribution (and Docker images).
High-level anatomy from the file tree
• Top-level pom.xml: orchestrates modules.
• packaging/… : Maven modules that build assemblies (PLF-assemblies), collect community sources, prepare a standalone Tomcat distribution, manage dependencies, resources, Tomcat config, start/stop scripts.
• services/… : Java service modules (JARs) that plug into the Exo container (CommunityEdition, Configuration, Tomcat listener for injecting DataSources).
• webapps/… : WAR modules providing portal extensions (Meeds UI, root portal, Sites extension, Tomcat integration webapp).
• .github/workflows & crowdin.yml: CI/CD pipeline and translation sync.
• README: describes Maven build/install, output directory, how to launch the bundled server, and Docker image signing.
Components
a. Build & Delivery
– Developer workstation & GitHub repo
– Maven (multi-module build)
– External Maven repo (repository.exoplatform.org)
– Crowdin translation service
– GitHub Actions workflows → build, test, package, publish archives & Docker images
– Cosign for Docker image signing
b. Packaging modules
– plf-assemblies: assembly descriptors → assemble JARs, WARs, resources, Tomcat config
– plf-community-tomcat-standalone: produces meeds-community-<version> folder → bundled Tomcat + apps
– plf-dependencies / resources / tomcat-resources: supplies libs, configuration XMLs, filters for HSQLDB/MySQL/Postgres
c. Service modules (JARs) loaded by the Exo container
– plf-community-edition-service
– plf-configuration
– plf-tomcat-pc-creator-listener
d. Web application modules (WARs) deployed on Tomcat
– plf-meeds-extension (portal UI, i18n resources, groovy templates)
– plf-root-webapp (root landing pages)
– plf-sites-extension (sites management, templates, JSPs, groovy, images)
– plf-tomcat-integration-webapp (Tomcat context integration)
e. Runtime distribution
– Tomcat server (container)
– Exo container inside Tomcat
– Loaded service JARs (as Exo plugins)
– Deployed WARs
– Configuration files (WEB-INF/conf, META-INF/exo-conf, platform.properties)
– Embedded DB (HSQLDB by default) or external DB (MySQL/PostgreSQL) via DataSourceInjector
Relationships & interactions
• Maven compiles service and webapp modules → artifacts (JAR/WAR)
• Packaging modules reference those artifacts + resource files + Tomcat base → produce standalone distribution
• CI/CD workflows orchestrate the Maven build, run tests, assemble Docker images, sign them via cosign, push to GHCR/DockerHub
• At runtime, user HTTP requests → Tomcat → Exo container loads service modules → WARs handle portal UI → services provide business logic → database via JDBC
Architectural patterns & design principles
• Modular monolith: separate modules for services vs. UI extensions, all assembled into one deployable unit
• Plugin architecture: services register via META-INF/services/org.exoplatform.container.ExoProfileExtension
• Assembly pattern: use Maven Assembly Plugin descriptors (packaging/plf-assemblies/src/main/resources/assemblies/*.xml)
• CI/CD as code: GitHub Actions YAMLs define build/test/publish pipelines
• Internationalization via Crowdin + properties files under webapps/*/locale