---
title: "Installing a Plug-in Using Configuration"
url: https://docs.zeroc.com/ice/3.8/plugins/plug-in-facility/installing-a-plug-in-using-configuration
docs_index: https://docs.zeroc.com/llms.txt
---

> For an index of every page, see [llms.txt](https://docs.zeroc.com/llms.txt).

# Installing a Plug-in Using Configuration

Parts of this page are for some programming languages only, and name them. For one language's text alone, see [C++](https://docs.zeroc.com/ice/3.8/plugins/plug-in-facility/installing-a-plug-in-using-configuration/cpp.md), [C#](https://docs.zeroc.com/ice/3.8/plugins/plug-in-facility/installing-a-plug-in-using-configuration/csharp.md), [Java](https://docs.zeroc.com/ice/3.8/plugins/plug-in-facility/installing-a-plug-in-using-configuration/java.md), [JavaScript](https://docs.zeroc.com/ice/3.8/plugins/plug-in-facility/installing-a-plug-in-using-configuration/js.md), [MATLAB](https://docs.zeroc.com/ice/3.8/plugins/plug-in-facility/installing-a-plug-in-using-configuration/matlab.md), [PHP](https://docs.zeroc.com/ice/3.8/plugins/plug-in-facility/installing-a-plug-in-using-configuration/php.md), [Python](https://docs.zeroc.com/ice/3.8/plugins/plug-in-facility/installing-a-plug-in-using-configuration/python.md), [Ruby](https://docs.zeroc.com/ice/3.8/plugins/plug-in-facility/installing-a-plug-in-using-configuration/ruby.md), and [Swift](https://docs.zeroc.com/ice/3.8/plugins/plug-in-facility/installing-a-plug-in-using-configuration/swift.md).

A plug-in can be installed into a communicator using a [configuration property](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties.md) of the following form:

```config
Ice.Plugin.Name=entry_point [arg ...]
```

Most plug-ins accept only one specific name, so make sure to use the plug-in’s name for *Name*.

> **C++**
>
> In C++ and C++-based language mappings, `entry_point` consists of the path name of the shared library or DLL containing the factory function, along with the name of the factory function.
>
> For example:
>
> ```config
> Ice.Plugin.CustomLogger=customlogger,0:createCustomLoggerPlugin logLevel=Debug
> ```
>
> With `customlogger,0`, Ice loads `customlogger0.dll` on Windows, `libcustomlogger.so.0` on Linux, and `libcustomlogger.0.dylib` on macOS. See [Ice.Plugin.name](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties/cpp.md#ice.plugin.name) for the format of this entry point.

> **C#**
>
> In C#, `entry_point` names an assembly and a plug-in factory class, separated by a colon. The assembly can be an assembly name or a file path. The factory class must implement `Ice.PluginFactory` and provide a public parameterless constructor.
>
> For example:
>
> ```config
> Ice.Plugin.CustomLogger=CustomLogger.dll:ClearSky.CustomLoggerPluginFactory logLevel=Debug
> ```

> **Java**
>
> In Java, `entry_point` names a public plug-in factory class that implements `com.zeroc.Ice.PluginFactory` and has a public no-argument constructor. An optional JAR or class-directory path precedes the class name, separated by a colon. Without a path, Ice uses its configured class loaders to find the class.
>
> For example:
>
> ```config
> Ice.Plugin.CustomLogger=com.example.clearsky.CustomLoggerPluginFactory logLevel=Debug
> ```

> **JavaScript**
>
> > **Note**
> >
> > JavaScript does not provide a plug-in facility.

> **MATLAB**
>
> This mapping loads C++ plug-ins. The entry point names a shared library or DLL and its exported factory function:
>
> ```config
> Ice.Plugin.CustomLogger=customlogger,0:createCustomLoggerPlugin
> ```
>
> With `customlogger,0`, Ice loads `customlogger0.dll` on Windows and `libcustomlogger.so.0` on Linux. See [Ice.Plugin.name](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties/matlab.md#ice.plugin.name) for the format of this entry point.
>
> For the included discovery plug-ins, use `Ice.Plugin.IceDiscovery=1` or `Ice.Plugin.IceLocatorDiscovery=1` to enable the corresponding built-in factory.

> **PHP and Ruby**
>
> This mapping loads C++ plug-ins. The entry point names a shared library or DLL and its exported factory function:
>
> ```config
> Ice.Plugin.CustomLogger=customlogger,0:createCustomLoggerPlugin
> ```
>
> With `customlogger,0`, Ice loads `libcustomlogger.so.0` on Linux and `libcustomlogger.0.dylib` on macOS. See [Ice.Plugin.name](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties.md#ice.plugin.name) for the format of this entry point.
>
> For the included discovery plug-ins, use `Ice.Plugin.IceDiscovery=1` or `Ice.Plugin.IceLocatorDiscovery=1` to enable the corresponding built-in factory.

> **Python**
>
> This mapping loads C++ plug-ins. The entry point names a shared library or DLL and its exported factory function:
>
> ```config
> Ice.Plugin.CustomLogger=customlogger,0:createCustomLoggerPlugin
> ```
>
> With `customlogger,0`, Ice loads `customlogger0.dll` on Windows, `libcustomlogger.so.0` on Linux, and `libcustomlogger.0.dylib` on macOS. See [Ice.Plugin.name](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties/python.md#ice.plugin.name) for the format of this entry point.
>
> For the included discovery plug-ins, use `Ice.Plugin.IceDiscovery=1` or `Ice.Plugin.IceLocatorDiscovery=1` to enable the corresponding built-in factory.

> **Swift**
>
> This mapping loads C++ plug-ins. The entry point names a shared library or DLL and its exported factory function:
>
> ```config
> Ice.Plugin.CustomLogger=customlogger,0:createCustomLoggerPlugin
> ```
>
> With `customlogger,0`, Ice loads `libcustomlogger.0.dylib`. See [Ice.Plugin.name](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties/swift.md#ice.plugin.name) for the format of this entry point.
>
> For the included discovery plug-ins, use `Ice.Plugin.IceDiscovery=1` or `Ice.Plugin.IceLocatorDiscovery=1` to enable the corresponding built-in factory.

The [Ice.Plugin.\*](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties.md) property reference describes `entry_point` in greater detail.

After extracting the plug-in's entry point from the property value, any remaining text is parsed using semantics similar to that of command-line arguments. Whitespace separates the arguments, and any arguments that contain whitespace must be enclosed in quotes:

```config
Ice.Plugin.MyPlugin=entry_point --load "C:\Data Files\config.dat"
```

Ice converts arguments of the form `--Name.Property=value` into communicator properties and removes them from the argument list. It passes the remaining arguments to the plug-in factory during construction. For example:

```config
Ice.Plugin.MyPlugin=entry_point --MyPlugin.Mode=fast input.dat
```

The factory receives `input.dat` in its arguments and can read `MyPlugin.Mode` from the communicator's properties.

## See Also

- [Ice.Plugin.\*](https://docs.zeroc.com/ice/3.8/property-reference/ice-plugin-properties.md)
