An easy-to-use desktop application to manage OSGi frameworks remotely
❓ Why OSGi.fx?
OSGi.fx is the ultimate remote management tool for your OSGi frameworks. Unlike legacy consoles, it offers a modern, responsive JavaFX interface and AI-driven capabilities that give you:
- 🚀 Deep Insights: Visualize bundles, services, users, and components instantly.
- ⚡ Real-time Monitoring: Track threads, heap usage, and logs live.
- 🕸️ Visual Dependencies: Explore complex relationships with interactive graphs.
- ✨ Ease of Use: Drag-and-drop installs, smart auto-complete, and valid configuration editing.
- 🤖 AI Ready: Built-in Model Context Protocol (MCP) server for seamless AI agent integration.
📸 Gallery
🛠️ Tech Stack
| Component | Technology |
|---|---|
| ☕ Java (Application) | 25 |
| ☕ Java (Agent) | 1.8 |
| 🖥️ Rich Client Platform | JavaFX 25 |
| ⚙️ Runtime (Application) | OSGi R8 (Equinox), Eclipse 4 (e4), e(fx)clipse |
| ⚙️ Runtime (Agent) | OSGi R6 |
| 🎨 UI Libraries | ControlsFX, TilesFX, FormsFX |
| 🛠️ Software Tools | Bndtools 7.2.1 |
🚀 Getting Started
The latest released version is 2.4.5.
📥 Download & Install
Visit the Project Website to download and install the latest version for your platform.
[!IMPORTANT] Important Notes for Download and Update:
- The required VM will directly be downloaded while installing the application using
jdeploy.- If the auto-update feature is enabled, every new version will be automatically downloaded while starting the application.
- Upgrade Note: Due to the update, the application might not work as expected as the old bundle cache (OSGi storage) still exists. Ensure you delete the existing OSGi storage area located in
~/.osgifx-ws.
Remote Agent Setup
[!NOTE] Minimum Requirements: Java 1.8 & OSGi R6.
To manage an OSGi framework, install the com.osgifx.console.agent bundle.
1. Socket Connection
Set osgi.fx.agent.socket.port system property in the runtime (e.g., 2000 or 0.0.0.0:2000).
Secure Sockets (SSL): To secure sockets, set:
osgi.fx.agent.socket.secure=trueosgi.fx.agent.socket.secure.sslcontext.filter=my_sslcontext(filter for SSLContext service)
2. MQTT Connection
Install in.bytehue.messaging.mqtt5.provider.jar.
- Configure
in.bytehue.messaging.clientPID. - Set Agent Properties:
osgi.fx.agent.mqtt.pubtopic: Topic for agent responses.osgi.fx.agent.mqtt.subtopic: Topic for agent requests.
OAuth Support: You can use OAuth tokens instead of passwords. Configure the token in OSGi.fx application settings.
✨ Features
| Feature | Version | Implemented | Released |
|---|---|---|---|
| 📦 Bundle Inventory View all installed bundles and fragments |
2.4.4 | ✅ | 🚀 |
| 📦 Package Insights Explore exported and imported packages |
2.4.4 | ✅ | 🚀 |
| 🛠️ Service Registry Inspect all registered OSGi services |
2.4.4 | ✅ | 🚀 |
| 🧩 Component Viewer Visualize declarative services (DS) components |
2.4.4 | ✅ | 🚀 |
| ⚙️ System Properties Access robust system and framework properties |
2.4.4 | ✅ | 🚀 |
| 🧵 Thread Monitor Track daemon and non-daemon threads |
2.4.4 | ✅ | 🚀 |
| 📢 Event Emitter Dispatch synchronous or asynchronous events |
2.4.4 | ✅ | 🚀 |
| 👂 Event Listener Subscribe to OSGi events in real-time |
2.4.4 | ✅ | 🚀 |
| 📝 Log Stream Live streaming of OSGi logs |
2.4.4 | ✅ | 🚀 |
| logger R7 Logger Config Manage OSGi R7 logger levels and configurations |
2.4.4 | ✅ | 🚀 |
| 🐚 Gogo Shell Execute Gogo commands remotely |
2.4.4 | ✅ | 🚀 |
| 💻 CLI Executor Run system CLI commands directly |
2.4.4 | ✅ | 🚀 |
| ✨ Smart Auto-Complete Intelligent suggestion for remote Gogo commands |
2.4.4 | ✅ | 🚀 |
| 📥 Bundle Manager Install, update, starting and stopping bundles |
2.4.4 | ✅ | 🚀 |
| 🖱️ Drag & Drop Install Effortless bundle installation via drag-and-drop |
2.4.4 | ✅ | 🚀 |
| 🔧 Config Admin Manage configurations via ConfigurationAdmin |
2.4.4 | ✅ | 🚀 |
| 📋 Metatype Inspector Browse OCDs and property descriptors |
2.4.4 | ✅ | 🚀 |
| ⏯️ Bundle Lifecycle Start, stop, and uninstall bundles/fragments |
2.4.4 | ✅ | 🚀 |
| ⚡ Component Control Enable or disable DS components on the fly |
2.4.4 | ✅ | 🚀 |
| ✏️ Config Editor Create, update, and delete configurations |
2.4.4 | ✅ | 🚀 |
| 🏗️ Config Factory Instantiate new configurations from factory PIDs |
2.4.4 | ✅ | 🚀 |
| 📊 Runtime Dashboard Overview of memory, uptime, bundles, threads, and services |
2.4.4 | ✅ | 🚀 |
| 🕸️ Bundle Graph Visualize bundle dependencies interactively |
2.4.4 | ✅ | 🚀 |
| 🔗 Component Graph Visualize DS component references and dependencies |
2.4.4 | ✅ | 🚀 |
| 🔄 Cycle Detector Identify circular dependencies in DS components |
2.4.4 | ✅ | 🚀 |
| 📤 Graph Export Export dependency graphs to DOT (GraphViz) format |
2.4.4 | ✅ | 🚀 |
| 📂 Log Viewer Access and analyze application log files |
2.4.4 | ✅ | 🚀 |
| 🕵️ Leak Detector Identify suspicious classloader leaks |
2.4.4 | ✅ | 🚀 |
| 🌐 HTTP Runtime Inspect Servlets, Filters, and Resources |
2.4.4 | ✅ | 🚀 |
| 📈 Heap Monitor Real-time heap usage and GC tracking |
2.4.4 | ✅ | 🚀 |
| 🔌 Extension Manager Install and manage external plugins |
2.4.4 | ✅ | 🚀 |
| 🗑️ Extension Uninstaller Remove installed extensions easily |
2.4.4 | ✅ | 🚀 |
| 📜 OBR Generator Generate OBR XML repositories |
2.4.4 | ✅ | 🚀 |
| 🌲 DMT Explorer Traverse and update the Device Management Tree |
2.4.4 | ✅ | 🚀 |
| 👥 User Admin Manage roles, users, and groups |
2.4.4 | ✅ | 🚀 |
| ❤️ Health Checks Execute and monitor Felix Health Checks |
2.4.4 | ✅ | 🚀 |
| 📸 Snapshot Capture and analyze runtime state snapshots |
2.4.4 | ✅ | 🚀 |
| ℹ️ DTO Inspector Explore standard OSGi Runtime DTOs |
2.4.4 | ✅ | 🚀 |
| 🔍 Advanced Search Powerful search across the OSGi framework |
2.4.4 | ✅ | 🚀 |
| 🤖 MCP Support Model Context Protocol integration for AI agents. Read More |
2.4.5 | ✅ | 🚀 |
| 👻 Headless Launch Start application with pre-configured connection |
2.4.5 | ✅ | 🚀 |
Advanced Capabilities
Batch Operations
You can install multiple bundles and create multiple configurations in one go.
- Select
Actions -> Batch Install. - Choose a directory containing your JARs and JSON configuration files.
- Note: JSON files must comply with the OSGi Configurator Specification.
- Select which resources to process from the list.
Extension System
OSGi.fx is extensible. You can build your own plugins using OSGi and JavaFX.
- Read the Extension Development Guide
- See the Tic-Tac-Toe Extension for a complete sample.
💡 Troubleshooting & Tips
- 👻 Headless Mode: Starting from 2.4.5, need to connect without the connection wizard? Use the
-Dosgifx.config=/path/to/config.jsonsystem property to launch OSGi.fx with a pre-defined connection. See the Headless Launch Documentation. - 🤖 AI Assistance: OSGi.fx 2.4.5 supports the Model Context Protocol (MCP), allowing AI agents to connect to and debug your OSGi runtime directly! See the MCP Server Documentation.
👨💻 Maintainer
Amit Kumar Mondal (admin@amitinside.com)
🤝 Contributing
Want to contribute? Great! Check out our Development Guide for instructions on building from source and setting up your IDE.
📄 License
This project is licensed under Apache License Version 2.0 