Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

January 21, 2026 Documentation update Action required

​
Affects

Teams deploying or upgrading Midaz with Helm, especially teams moving to Helm Chart v5.x. This update applies to the public documentation portal. It does not change the runtime API behavior unless the linked product documentation says otherwise.

​
What changed

We’ve completely revamped the Helm deployment documentation to reflect the latest changes in Midaz Helm Chart v5.x. This update introduces a new unified architecture, integrated services, and comprehensive migration guides.

​
Major Changes in Helm v5.x

​
New Ledger Service (Primary Change)

The most significant change in v5.x is the introduction of the unified Ledger service, which combines the functionality of the separate onboarding and transaction modules into a single deployment.
  • Single service: One deployment instead of two separate services
  • Simplified configuration: Unified environment variables with module-specific prefixes
  • Automatic ingress routing: Existing DNS configurations continue to work seamlessly
  • New Balance Sync Worker: Background processing for balance synchronization
The separate Onboarding and Transaction services are now legacy and will be deprecated in a future release. We strongly recommend planning your migration to the unified Ledger service.

​
CRM Integrated into Main Chart

The CRM plugin is now integrated directly into the main Midaz Helm chart:
  • Previously deployed as a separate chart (plugin-crm) in the midaz-plugins namespace
  • Now available as an optional component in the midaz namespace
  • Simplified deployment and configuration
  • Shared MongoDB connection with other Midaz services

​
Console Removed

The Console component has been removed from the Helm chart as part of the migration to Lerian Console. For web-based management, please refer to the Lerian Console documentation.

​
Dependency Changes

  • RabbitMQ: Migrated from Bitnami to Groundhog2k chart (since v4.x)
  • Erlang Cookie: Now requires explicit configuration for RabbitMQ
  • BitnamiSecure Images: PostgreSQL, MongoDB, and Valkey now use hardened images

​
New Environment Variables

The Ledger service introduces module-specific prefixes for database configuration:
Old Variable (Legacy)New Variable (Ledger)
DB_PASSWORDDB_ONBOARDING_PASSWORD, DB_TRANSACTION_PASSWORD
MONGO_PASSWORDMONGO_ONBOARDING_PASSWORD, MONGO_TRANSACTION_PASSWORD

​
Documentation Updates

— We’ve restructured and expanded the Helm documentation section:

​
New Pages

  • Helm Overview: Central hub for all Helm-related documentation
  • Upgrading Helm: Comprehensive migration guide covering v3.x → v4.x → v5.x transitions with breaking changes and rollback procedures

​
Updated Pages

  • Using Helm: Completely rewritten to include:
  • Ledger service configuration (recommended)
  • Legacy Onboarding/Transaction configuration
  • CRM integration setup
  • Bootstrap jobs for external PostgreSQL and RabbitMQ
  • Detailed parameter tables for all services
  • Upgrading Midaz and plugins via Helm: Updated with:
  • Support for Ledger architecture (v5.x)
  • Tabs for Ledger vs Legacy commands
  • Updated version numbers
  • Version Compatibility: Updated with:
  • New Ledger architecture compatibility table
  • CRM integration versions
  • Updated plugin versions
  • Deployment Strategies Overview: Updated to reflect new Helm structure

​
Version Compatibility

Helm Chart VersionLedgerCRMRecommended
5.3.03.5.13.5.0Yes
5.2.03.5.03.5.0Yes
5.0.03.5.03.5.0Yes

​
Migration Paths

We provide detailed migration guides for all upgrade scenarios:
  • v4.x → v5.x: Enable Ledger service, migrate secrets to module-specific prefixes
  • v3.x → v4.x: Configure Erlang cookie for RabbitMQ, backup PVC data
  • v3.x → v5.x: Combined migration addressing both sets of breaking changes

​
Impact

This documentation update includes information teams should review before changing the affected integration or deployment.

​
What you need to do

1
Review the Helm v5.x migration guidance before your next Midaz deployment or upgrade.
2
Plan the move to the unified Ledger service and updated CRM deployment model where applicable.

​
Deadline

Before your next related integration, deployment, or upgrade change.

​
Why

Helm v5.x changes the documented deployment architecture and migration path. Teams operating Midaz with Helm need the updated guidance before changing environments.