@mashroom/mashroom

Mashroom Server

Mashroom Server is a Node.js based Microfrontend Integration Platform.

This package contains the core of Mashroom Server. It contains core services for managing plugins and default plugin loaders for Express middleware, Express webapps and shared code as services. It also provides a common logging infrastructure.

From a technical point of view this is s a plugin loader that scans npm packages (package.json) for plugin definitions and loads them at runtime. Such a plugin could be an Express webapp or a SPA or more generally all kind of code it knows how to load, which is determined by the available plugin loaders. Plugin loaders itself are also just plugins, so it is possible to extend the list of known plugin types.

Usage

The easiest way to start is to clone one of the quickstart repositories:

• mashroom-quickstart
• mashroom-portal-quickstart

You can find a full documentation with a setup and configuration guide here: https://www.mashroom-server.com/documentation

Changelog

2.7.0 (July 8, 2024)

• VHost Path Mapper: Replace the location header URL with the relative path if the host matches the frontend host. This saves an unnecessary round trip if the protocol does not match the frontend protocol (see #121)
• VHost Path Mapper: Fixed reverse mapping of the location header if the URL is absolute
• HTTP Proxy: Adds now a proper x-forwarded-host header (if createForwardedForHeaders is set)
• HTTP Proxy: Added missing createForwardedForHeaders config prop to the JSON schema
• Portal: It is now possible to configure what should happen if the authentication expires. Until now the strategy was to just reload the current page, now you can choose between multiple strategies:
  • stayOnPage
  • reload (Default, same behaviour as before)
  • redirect (redirect to another page)
  • displayDomElement (set display: block on the DOM element with given ID)
  BREAKING CHANGE: Mashroom Portal WebApp plugin properties warnBeforeAuthenticationExpiresSec and autoExtendAuthentication have been removed, instead it expects a configuration like this:

    "authenticationExpiration": {
      "warnBeforeExpirationSec": 60,
      "autoExtend": false,
      "onExpiration": {
        "strategy": "reload"
      }
    },
  

• LDAP Security Provider: Replaced decommissioned ldapjs client
• Session Plugin: Uses now a session cookie (without a maxAge) by default, so, the session can only expire on the server side and not because the cookie expires