Handle System Banner
Previous: Handle System Overview       Next: Using the Handle Administration Tool           Table of Contents

2. Installation

Installing JavaTM

The Handle System Server requires JavaTM to run. If you already have JavaTM installed, confirm that has a version number greater than 1.2. You can check this by running the command java -version.

If you need to install JavaTM, you can obtain a version for several popular platforms at http://java.sun.com/j2se/. For other platforms, contact your vendor or see if there is an appropriate version of JavaTM on the list at http://hdl.handle.net/4263537/4066.

Unpacking the Distribution

Download the Handle System Server distribution from http://www.handle.net. To decompress the distribution package on Unix-like platforms use the gunzip and tar programs. The distribution package can be decompress on Win32 based systems using the program WinZip.

Once decompressed, copy all of the jar files (`handle.jar', `sunjce-1.2.1.jar', `sunjce_provider.jar', `local_policy.jar', and `US_export_policy.jar') into a directory on your computer. For the rest of these instructions, we will assume this directory is `/hs/bin/'.

Choosing an Installation Directory

Choose a directory that will hold the configuration and data for this server. For the rest of these instructions we will use the `/hs/svr_1' directory. Be sure to create a new directory for each server on the same machine. To create this directory on Unix, run this command: mkdir -p /hs/svr_1.

Running the Setup Program

The Handle System Server provides two different installation programs. Since both require JavaTM, make sure you have the java binary directory in your system path.

The first uses a textual interface, and is recommended for remote installation and advanced users. On Unix-like systems it can be invoked by running the command:
 
java -cp /hs/bin/handle.jar net.handle.server.SimpleSetup /hs/svr_1
On Windows, DOS, or OS/2-like systems:
 
java -cp \hs\bin\handle.jar net.handle.server.SimpleSetup \hs\svr_1

An alternative is to use the GUI based setup program. This is the best choice if you are installing on a local machine and have not set up a Handle server before.

On Unix-like systems the GUI setup can be invoked by running the command:
 
java -cp /hs/bin/handle.jar net.handle.apps.gui.hsetup.Setup
On Windows, DOS, or OS/2-like systems:
 
java -cp \hs\bin\handle.jar net.handle.apps.gui.hsetup.Setup

Both installation programs will guide you through a series of configuration options. Once complete, there should be a file called `sitebndl.zip' in your handle server directory. You will need to email this file to hdladmin@cnri.reston.va.us. If you are ran the graphical setup program you may have chosen to mail it already. Soon after the `sitebndl.zip' file is received an administrator will create the naming authority on the root service (known as the Global Handle Registry), and notify you when this has been completed. You will not be able to continue the install until you receive further information concerning your naming authority.

ONCE YOU RECEIVE THE NAMING AUTHORITY INFORMATION FROM HDLADMIN THEN PROCEED WITH THE FOLLOWING STEPS TO 'HOME' YOUR NAMING AUTHORITY TO YOUR NEW LOCAL SERVER.

Running the Server For the First Time

Go to your `svr_1' directory(where you installed your server) and edit the `config.dct' file. Replace the words YOUR_NAMING_AUTHORITY under server_admins and replication_admins with your naming authority (as indicated in your email message). This allows anyone with the private key that matches your public key to be an administrator for your server.

Start the server using the configuration generated in step 4. This can be done with the following command:

On Unix-like systems:
 
java -cp /hs/bin/handle.jar net.handle.server.Main /hs/svr_1

On Windows, DOS, or OS/2-like systems:
 
java -cp \hs\bin\handle.jar net.handle.server.Main \hs\svr_1


Note: If you chose to encrypt your private key(s), you will be prompted for your passphrase here. Also note that JavaTM does not have the ability to disconnect from a terminal so you will have to put the process in the background. On Unix systems press Ctrl-Z then bg then press ENTER.

Next, start the Handle Administration Tool using the following command. This assumes your `handle.jar' file is in the `/hs/bin' directory.
 
java -cp /hs/bin/handle.jar net.handle.apps.gui.hadmin.HandleTool

Click on the Server Admin button and choose Home Naming Authority from the menu that pops up. You will be prompted for your authentication information.

Browse to find your private key file. It will be in the `svr_1' directory(where you installed your server) and is named `admpriv.bin'. You will be prompted for your secret passphrase. This is the password you entered for Administration when you ran the setup program. It may take a minute to authenticate.

After you are successfully authenticated, a window should appear. Type in your server address (IP address or domain name) Type in your naming authority handle by replacing YOUR_NAMING_AUTHORITY. If you used the default port then you should not have to change the port number. Your interface will most likely be TCP. Then press OK.

You should receive a successful message, and now you are ready to create handles on your local server.

How Your Naming Authority is Set Up

This section describes how your naming authority handle was set up and how authentication and permissions can be configured.

The naming authority 1100 would have the following properties:

When authenticating you will need to identify yourself using the NA Admin Public Key (see above) and the associated private key which is in your admpriv.bin file on your computer. The instructions for this are in the `INSTALL.txt' file and in Running the Server For the First Time. This is what you will need to do to "home" your naming authority.

When creating new handles, you will need to specify an administrator who will have permission to modify or delete each new handle. This is done by adding an Admin value that references a public key, secret key or admin group to each new handle. We recommend that you specify your NA Admin Group (see above) value as the administrator for each new handle.

Every value in a handle has a different index. The following pattern works well. Start with 100 for all admin values. The admin group starts at 200 and the public key index is 300.

So the values of a handle (1100/test1), might look like this:

 
100 HS_ADMIN 0.NA/1100 index 200
1 URL http:www.someorg.com/blahblah
2 email mailto:someone@org


Previous: Installation       Next: Using the Handle Administration Tool           Table of Contents