Difference between revisions of "Ice"

From Mumble Wiki
Jump to: navigation, search
(Configuring Glacier2)
Line 41: Line 41:
Then, create a password hash using the openssl utility.
Then, create a password hash using the openssl utility.
   openssl password pink
   openssl passwd pink
this will spit out a hash, which looks something like CTThafhdv9Lz2
this will spit out a hash, which looks something like CTThafhdv9Lz2

Revision as of 19:26, 13 September 2008

Murmur supports remote scripting using ZeroC ICE, a RPC mechanism. There are bindings for C++, Java, .NET, Python, PHP and Ruby, and this is supported on all our platforms (Win32, Linux and OSX). ICE also works over a network, meaning you can create a web application that interfaces with a murmur process running on another machine.

Getting ready to use ICE

You can download ICE directly from ZeroC. If you installed a binary version of Murmur, it already includes the necesarry components for running ICE, but you might need additional tools to develop with it.

Apache and PHP

If you want to use ICE from PHP, you'll need to tell the PHP parser where to find the slice (Specification Language for ICE) file for Murmur, which is called simply Murmur.ice. If you're running from the command line, you'll need to create a file called php.ini in the directory you are running from. Insert the following:

ice.slice = /path/to/Murmur.ice

When you get far enough that it's time to run the script from Apache, you'll need to tell Apache's PHP parser where to find the slice file. If you have a /etc/php.d file, you can simply create a new murmur.ini file in that directory with the same contents as the php.ini above. If not, you'll have to append it at the end of /etc/php.ini

Using ICE

How to use ICE differs from language to language. The parameters and method names will remain the same, but the syntax will naturally be different. Murmur will, by default, open up an adapter on port 6502 (or 10000 for homedir installs), which has a single accessible object named "Meta". This is the Meta server, and from it you can retrieve adapters for any configured server.

There's an example included in the source; have a look at icedemo.php.

Guide on how to set up a Windows web server in order to use the ICE php scripts

These are example scripts. Use at your own risk. These scripts are not intended for production machines. These are examples of what ICE can do.

Install Apache, PHP, and ICE. First install Apache, and install it to C:\apache then install PHP. Tell PHP to install to C:\PHP5. In the installer on the "Web Server Setup" window select Apache 2.2.x Module. When you get to "Select Apache Configuration Directory put C:\apache\conf\. Proceed through the installer. Install the defaults, you do not need to install the extensions for PHP. Now install ICE. Go to C:\Ice-3.3.0-VC60\bin and copy bzip2.dll, ice33.dll, iceutil33.dll, msvcp60.dll, msvcrt.dll, php_ice.dll, slice33.dll, and stlport_vc646.dll to C:\apache\bin . Now open C:\PHP5\php.ini and add the following two lines to the bottom of the file:


Save the file and then download Murmur.ice, icedemo.php, and weblist.php (right click on "(download)" and select "Save Link As..." Put Murmur.ice in C:\PHP5. Put icedemo.php and weblist.php in C:\apache\htdocs. Double click the Apache icon in the system tray and select "Restart." You should now be able to go to http://<your IP or Domain>/icedemo.php (or weblist.php).

Using Glacier2

Glacier2 is a ICE routing and firewall utility, and allows you to securely run the server on one machine and murmur on another. Note that if both server and client are on a secure LAN, you can just use iptables to protect the ICE port, which is a lot easier than setting up Glacier2.

The examples here assume that is the public IP address of the server running Murmur. We're going to use the username "magic" with the password "pink".

Configuring Glacier2

Create a config file called config.glacier2 and put the following in it:

 Glacier2.Client.Endpoints=tcp -h -p 4063

Then, create a password hash using the openssl utility.

 openssl passwd pink

this will spit out a hash, which looks something like CTThafhdv9Lz2

Create a file called password.txt containing:

 magic CTThafhdv9Lz2

Start glacier2 as this:

 glacier2router --Ice.Config=config.glacier2

Configuring Murmur

There's nothing to do in murmur. Seriously. Leave the default setting of binding to alone.

Configuring Client (PHP)

This is where it starts getting slightly ugly. Note that this requires ICE >= 3.3.1, as Ice 3.3.0 has a bug in it which prevents this from working. The following is the adaptation necesarry to weblist.php to get it to work:

try {
  $router = $ICE->stringToProxy("Glacier2/router:tcp -p 4063 -h");
  $router = $router->ice_uncheckedCast("::Glacier2::Router")->ice_router(null);
  $session = $router->createSession("magic", "pink");
  $base = $ICE->stringToProxy("Meta:tcp -h -p 6502")->ice_router($router);
  $meta = $base->ice_checkedCast("::Murmur::Meta")->ice_router($router);


For each object you get a proxy to (including the return from $meta->getServer), you need to add ->ice_router($router)