OSGi Configurations Manager

osgi configuration

Download (1.0.0)

OSGi Configurations Manager Overview

The OSGi Configurations Manager is a Jahia module that allows administrators to manage OSGi configuration files (.cfg, .yml) directly from the Jahia Administration interface.

Key Features

File Management: List, create, delete, and enable/disable (.disabled) configurations.
Advanced Search: Filter by name or perform a Deep Search within file content.
Visual Editor: Structured editing for .cfg files with drag-and-drop reordering.
Raw Editor: Integrated Monaco Editor with syntax highlighting for YAML and Properties.

Security & Traceability

Encryption: Built-in CryptoEngine supports ENC(...) values. Encryption can be toggled per property.
Audit Logging: All sensitive actions (Save, Delete, Toggle) are logged with the acting username.
File Filtering: Sensitive files can be hidden via org.jahia.modules.osgiconfigmanager.cfg using the filteredFiles property.

Developer Guide: Decrypting Properties

To use encrypted properties in your Java services, use the CryptoEngine:

import org.jahia.modules.osgiconfigmanager.admin.CryptoEngine;

public void update(Map<String, Object> properties) {
    String value = (String) properties.get("mySecret");
    if (value != null && value.startsWith("ENC(") && value.endsWith(")")) {
        String cipherText = value.substring(4, value.length() - 1);
        this.secret = CryptoEngine.decryptString(cipherText);
    }
}

Dependencies & Dependants

Dependencies

jContent

Dependants

NONE

How To Install

Installation & Configuration Guide

⚠️ Prerequisite: This module requires JContent version 3.5.0 or higher.

1. Module Deployment

Deploy the module to your Jahia instance:

Navigate to Administration > Modules > Modules management.
Click Upload a module and select the osgi-configurations-manager-1.0.0.jar.
Verify that the module status is Started.

2. Configuring Permissions

To grant access to non-root users:

Go to Administration > Users and Roles > Roles.
Select a role (e.g., server-admin).
In the Permissions tab, locate and check: canManageOsgiConfigurations.
Click Save.

3. Root User Access

The system root user bypasses all permission checks and has full access to the module immediately after installation.

Images

Image description — Screenshot 2026_03_17 at 15.53.54.png

License

MIT License

Copyright (c) 2026 Dominique Gigon

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

OSGi Configurations Manager group_work