Tips on REBOL/Link Installation and Operation

Document Version 1.0
IOS Version 1.0

Contents:

1. Overview
2. Installing and Distributing
3. Reinstalling
4. Uninstalling
5. Moving the Installation Directory
6. Starting an Alternate Executable
7. Updating All Clients
8. Wiping and Restarting
9. Registry Resynchronization
10. Multiuser Caveat
11. Other Client Files
      11.1 Servers.r File
      11.2 Accounts.r File
      11.3 Prefs.r File

1. Overview

This document describes a number of useful operational features of the REBOL/Link IOS client.

2. Installing and Distributing

To install REBOL/Link all you need is the executable file. No other files or DLLs are required. Just copy it to the target system and run it to install. It's that easy.

For example, you can copy the executable file to a floppy or CDROM. To install it, simply run it from the floppy or CDROM.

To distribute REBOL/Link to other members of your company or organization, you can post the executable file to a web site. Your users can download the file to disk and run it, or they can run it directly off the web site (in browsers like IE).

3. Reinstalling

To install a newer version, just run it. It will detect that it is newer than the installed version and will prompt to install the newer version.

To install the same version (which can be the case if you buy keys for additional servers), remove or rename the existing rebol-link executable file from the installation directory, and run the new file. The new file will automatically copy itself back to the installation directory.

4. Uninstalling

Uninstalling REBOL/Link is "harmless" and has minimal side effects. No files are deleted, just in case you need any of the data files that were synchronized.

To install again, just run the executable file again.

5. Moving the Installation Directory

REBOL/Link can be easily relocated on the client disk. Here's how to move the installation directory:

1. Uninstall REBOL/Link. No files are deleted.
2. Move all the files to the new target location.
3. Run REBOL/Link and enter the target location in the installer menus.

6. Starting an Alternate Executable

You many have noticed that if you start REBOL/Link from a directory other than its installed location, it will prompt you with an option to change to the installed version. This is necessary to force users who put the executable file on their desktop to use the latest version. They may be running an older version from their desktop, which would not be desirable.

Administrators should discourage users from putting the executable file on their desktop. Have them install by running the file directory from a web page or from an installation CDROM or floppy.

7. Updating All Clients

The system administrator can distributed an updated copy of the REBOL/Link client. A separate document covers this topic: Updating IOS Clients.

8. Wiping and Restarting

If you need to, you can delete all files in the installation directory and perform a clean resynchronization. To do so, just copy the rebol-link executable to a safe location and delete the installation directory and all subdirectories. But, be sure that any local file changes have been published before doing the deletion.

Run the saved rebol-link file to resynchronize all files. You will need to reenter your username and password.

9. Registry Resynchronization

A less intensive way to resynchronize the client is to delete the registry.r file found in the link root location in the installation directory. (The link root is the directory that holds all the files for a particular IOS instance and is usually given the same name as the server.)

Shutdown the client, delete registry.r, and restart the client. The client will resync, but all local files that match those on the server will not be downloaded again.

10. Multiuser Caveat

If you logon to the same server under multiple file names, you will need to perform an extra step to properly synchronize under version 1.0. If you do not, you may not see the correct sets of files, folders, and applications.

To cause the necessary resynchronization, send a conference message or publish a file. This will force the proper resync. This problem will be fixed in future versions.

11. Other Client Files

The client automatically creates and updates three additional files when it starts. They are discussed below.

Note that you can delete one or more of these files, and they will be restored to their defaults the next time the REBOL/Link client starts.

11.1 Servers.r File

The servers.r file contains the list of servers to which REBOL/Link can connect. The format of the file is a set of one or more blocks that contain the specifics of each server. The format is:

[ Name: "Server" Host: "server.host.address" Path: "cgi-bin/proxyname" Root: %server/ ]

The name field is that which appears in the preferences configuration menu. The host field is the address of the server. The path field is the web-site relative cgi-path to the IOS cgi proxy server. The root field is the local hard disk location of the synchronized files, relative to the installation directory.

The servers.r file can contain one or more such entries. However, in order to access other servers, the REBOL/Link executable must contain the correct authentication keys for that server. For strict security reasons, you cannot use any arbitrary REBOL/Link client with any server. You must use the client that contains the correct authentication key to the server.

As an example, to add the developer server to your link client, add this entry to your servers.r file:

[ Name: "Developer" Host: "developer.express.rebol.net" Path: "cgi-bin/publicproxy" Root: %developer/ ]

If you delete the servers.r file, it will be restored to its default settings the next time you start REBOL/Link.

11.2 Accounts.r File

The accounts.r file contains your user account information for different servers. This is where username and password information is stored. Note that once you have logged on, the password stored in a hash encoded format, not as plain text.

11.3 Prefs.r File

The prefs.r file contains multiple fields that hold configuration information for a users REBOL/Link client. This file is modified by the client whenever settings are changed. However, it can also be edited by the user or administrator if necessary.

The prefs.r file will be discussed in a separate document.