HELIOS Base UB User manual |
In the following descriptions, instructions, and examples, the expression "HELIOSDIR" is used for the path of the directory where the HELIOS software is installed. For example, this could be "/usr/local/helios".
For those who have already installed previous versions of EtherShare or PCShare:
The former default installation paths "/usr/local/es" and
"/usr/local/pcshare" respectively, can easily be migrated to the new default path "/usr/local/helios" by means of the HELIOS Installer (see 4.3.1 "Migrate Settings").
The following list gives details about the hard- and software you need for making the HELIOS Base software successfully work:
- One of the following systems:
- Sun SPARC Solaris 8 or newer
- IBM RS/6000 AIX 4.3.3 or newer
- HP PA-RISC HP-UX 11i v1
- HP Itanium with HP-UX 11i v2 or newer
- Silicon Graphics IRIX 6.5 or newer
- Compaq ALPHA UNIX Tru64 5.1 or newer
- Linux (Linux 2.4 Kernel for Pentium II or newer)
- Linux x86_64 (Kernel 2.6.10) or newer
- Mac OS X/Mac OS X Server 10.3 or newer
- Windows 2000/2003
- CD-ROM drive
- 200 MB in the "/usr" file system, in addition to the individual disk storage requirements of each of the users
- At least 128 MB RAM on the server
- At least one supported network adapter installed and activated
- RPC (UNIX) and TCP/IP must be installed and running, e.g. the rpcinfo -p command must work
This chapter describes the steps that are indispensable for a standard installation and gives short explanations, where necessary. Please remember that all activities you have to do are marked by an "instruction" arrow in the left margin. For a quick installation, you may proceed directly from one instruction to the other, and skip the explanations in between.
References to "CD017 or earlier" mean EtherShare 2.6, PCShare 3.0, EtherShare OPI 2.1, PDF HandShake 2.0, and PrintPreview 1.1, or earlier.
References to "4th generation" mean EtherShare 3.1, PCShare 3.1 WebShare 1.0, ImageServer 2.5, PDF HandShake 2.1 and PrintPreview 2.0. These versions were available on HELIOS CD018, CD019, and CD020.
For Mac OS X, Linux and Windows machines, the machine ID is provided by a USB-dongle, which you receive from your HELIOS dealer, and which you have to plug in first (see the note on page 0-16 in "Welcome to HELIOS Base").
The installation is carried out by two separated programs. The first program ("installer") must be started from the CD-ROM. It lets you select the product(s) you wish to install and copies all related files and the installation program to the local disk of your host. The "backend" installer then automatically completes the installation.
HELIOS issues software updates every now and then to enhance the product. These updates are distributed via the HELIOS web server and they are included on every HELIOS CD-ROM. The installation procedure for software updates is described in 17 "The HELIOS Update Installer".
Note: For installing the HELIOS software, you must be able to log in as "root" on your host.
Note: If you do not enter any activation key, the HELIOS product you have installed will run in a 3-hour demo mode only.
In case you have no activation key at hand, please follow the instructions given in the paragraphs License information and What you have to do in "Welcome to HELIOS Base" at the beginning of this manual.
Under certain conditions, HELIOS issues so-called demo licenses. If you are entitled to get a demo license, you will receive an activation key for demonstration purposes that expires after a given period of time.
The host must be provided with a fully installed and configured operating system. You must be able to log in as superuser ("root") to allow the installation program to create subdirectories and make the required system changes.
Important: Before starting the installation, you should create a backup copy of the system disk of your host computer.
Those who upgrade from an earlier product version, e.g. CD016, install as described in 4.1.5 "Software installation" and 4.3 "Migrating from earlier versions (CD017 or earlier) to UB".
The "HELIOS Installer" is a server program and does not support mouse operation. It is designed to be fully operable with the keys available on a standard "vt100"-keyboard.
- Positioning the cursor with the cursor keys
- Typing the first letter of the menu item
- Positioning the cursor with the TAB key
In lists, the BACKSPACE key deletes the selected entry. In text fields, it deletes the character to the left of the cursor and moves all other text one position to the left in order to fill the gap.
Note: If BACKSPACE (on some special terminals/keyboards) does not work, try DEL instead.
The DEL key deletes the character under the cursor and moves all other text one position to the left to fill the gap. The DEL key is not always available on a UNIX terminal keyboard.
The currently selected function is aborted and the program goes back to the previous prompt or action.
In lists, the Insert key inserts an entry. In text fields, the Insert key inserts a space character at the cursor position.
Note: If you plan to install the HELIOS Software on a Mac OS X platform, skip ahead to 4.1.6 "Software installation (Mac OS X)".
If you are not upgrading to the new software products move to First time installation on the next page.Before installing and migrating the new product versions, all previous HELIOS products must be stopped and deactivated in order to prevent the old product versions from being loaded instead of the new ones (Note that running the "uninstall" script is only required for versions before 4th generation, i.e. up to CD 017):
The installation and migration can be done by installing the new versions without removing the previous versions. If you are upgrading from versions prior to EtherShare 3.1, PCShare 3.1, etc., please install the new versions in a different directory, e.g. "/usr/local/helios".
You are guided through the installation by a menu-driven program, the HELIOS Installer. While older HELIOS installation processes required a lot of confirmations by the user/system administrator, e.g. accepting various default settings, this HELIOS Installer does nearly everything on its own. You merely have to start the installation.
Note: The following installation example describes the steps that must be taken on an IBM RS/6000 computer under AIX. Slight deviations may occur - depending on your system type and configuration.
Then place the CD-ROM in the CD drive of your host computer and enter the mount and install commands which may be different for different host systems.
The appropriate commands for your specific computer are stated in the booklet we have enclosed with our CD-ROM.
As soon as you have entered the last command, the Introduction, Welcome, and License windows of the "HELIOS Installer" window appear.
If you agree to the terms and conditions select Agree. If you do not agree select Disagree; then the installation of the HELIOS software will be cancelled.
Note: The bottom of the HELIOS Installer window provides helpful details and instructions.
The default installation path of the HELIOS software is
"/usr/local/helios". However, if you want to use - for whatever reason - a different path you must first specify it in the HELIOS Installer.
In the HELIOS Installer select Setup from the main menu and specify the desired path. Then confirm your changes with Ok, else select Cancel.
Note: The HELIOS Installer creates an installation log file in the "/tmp" directory ("helios.installer.log") which records all actions and steps that have been taken during the installation or migration process.
To start the installation of the HELIOS software select Install HELIOS Products from the main menu and press RETURN.
The Installable Products section shows all available HELIOS software products. HELIOS software products already installed on the server are listed in the Already Installed section. Otherwise this section is missing (Fig. 2 and 3).
Note: The HELIOS products Base and Base Data are always required for the installation of any other HELIOS product, e.g. EtherShare, PCShare, etc.
In the Installable Products section highlight the product you wish to install and press the space bar, so it becomes marked. To deselect one (or more) item(s) in the list, press the space bar again.
The example in Fig. 2 shows that Base (with Base Data) and EtherShare are already installed, and PCShare is about to be installed. Fig. 3 shows a "fresh" installation of Base (with Base Data), EtherShare and PCShare, where no HELIOS product software was installed before.
Important: Starting the installation will stop all HELIOS services running on the server. Therefore, please make sure all HELIOS users are logged-out before you install new products. To verify the HELIOS user status you can use the "swho" command described in 7.7 "swho", or use HELIOS Admin (Lists > Active Users).
Leave the installation menu with Esc or Ctrl-X (see also 4.1.4 "Navigating within the HELIOS Installer") to get back to the main menu. You can now quit the HELIOS Installer.
The HELIOS Installer has now installed all of the specified applications and related updates from the HELIOS CD. You may wish to know if there are subsequent updates available for download and installation. See 17 "The HELIOS Update Installer" for complete details.
See 15 "Uninstalling the HELIOS software" for instructions on how to remove the HELIOS software from the server.
If this is an upgrade installation, you can now migrate your settings from the previous versions. To do so, skip ahead to 4.3 "Migrating from earlier versions (CD017 or earlier) to UB"
Otherwise, your next step is to enter the HELIOS software license(s) for the installed product(s). Find instructions on how to do that by skipping ahead to 4.4 "Licenses".
Insert the HELIOS CD-ROM in the Mac OS X computer and double-click the "HELIOS Network Installer" CD icon, which appears on the desktop.
If you have administrative rights on the machine you can use your name and password in the authentication dialog.
The Introduction dialog (Fig. 7) gives an overview of the installable HELIOS products and their main features.
Make sure that the Please select pull-down menu shows the entry Installation, and click Continue to proceed.
If you agree to the terms and conditions click Agree. If you do not agree click Disagree; then the installation of the HELIOS software will be cancelled.
In the Destination for HELIOS Products menu (Fig. 9) enter the path to the location where you want to install the HELIOS products, or click Choose, which brings up the Macintosh File Selector (Fig. 10). Then click Continue.
The Installable Products section shows all available HELIOS software products. If there are already HELIOS software products installed on the server they are listed in the Already Installed section. Otherwise this section is empty (Fig. 11 and 12).
Note: The HELIOS products Base and Base Data are always required for the installation of any other HELIOS product, e.g. EtherShare, PCShare, etc.
In the Installable Products section click the checkbox of the product you wish to install (see Fig. 12).
The example shows that Base (with Base Data) and EtherShare are already installed, and PCShare is about to be installed. Fig. 11 shows a "fresh" installation of Base (with Base Data), EtherShare and PCShare, where no HELIOS product software was installed before.
Important: Starting the installation will stop all HELIOS services running on the server. Therefore, please make sure all HELIOS users are logged-out before you install new products. To verify the HELIOS user status you can use the "swho" command described in 7.7 "swho", or use HELIOS Admin (Lists > Active Users).
The Status window (Fig. 13) informs you about the progress of the HELIOS software installation. As soon as the installation has finished, the software is started so the services are available immediately.
When upgrading from HELIOS 4th generation products to the UB products, all settings are preserved. See the migration documentation for details:
This section is applicable to sites upgrading from these versions or earlier: EtherShare 2.6, PCShare 3.0, EtherShare OPI 2.1, PDF HandShake 2.0, and PrintPreview 1.1 (see References to HELIOS CDs in 4.1.2 "General remarks").
The format to store server settings was changed beginning with the 4th generation version. There is only one preferences file for all HELIOS products. You can convert your configuration files (e.g. "atalk.conf") from a previous version.
Note: Keep in mind that you must have installed the new product before you can migrate. You might also need to adjust the migrated settings manually.
Verify that the paths are correct and select the settings to migrate, select Ok and quit the HELIOS Installer (Fig. 14).
Important: If you are migrating settings from just one product, EtherShare or PCShare, you must erase the other path entry in the respective field (Fig. 14)! Otherwise, you will receive an error message.
The Migrate Settings feature calls the HELIOS utility "migrate", which is described in 7.4 "migrate".
The following comparison shows where the various software settings used to be set in previous versions, and where they are set in the new version (see References to HELIOS CDs in 4.1.2 "General remarks").
/etc/printcap -/var/conf/printcap
-/PPD & font list -/var/spool/qmeta/
-/lpr Interface files -/var/spool/qmeta/
-/conf/atalk.conf -/var/conf/Preferences
All AppleTalk network interfaces are migrated into the preferences file. The interfaces are stored with the same syntax (e.g.: if=-, nif=-), but in the form of a string list in the preferences file. The settings can be verified by issuing the "prefdump" command. The interface settings are stored in:
To configure the network interfaces use the "netconf" program, which is described in the EtherShare manual (Note that Mac OS X uses its own network interface configuration program instead of "netconf").
As all new printer queues can be administered via HELIOS Admin and new output options are available, we have decided not to migrate PCShare printers to the new preferences storage. Shared printers can be published for PCShare with a single click in HELIOS Admin. Other printer queues must be created using HELIOS Admin.
Only old DOS printer queues using the HELIOS PCShare DOS "printsrv" must be configured using PCShare Admin.
Please note that home directories are turned on by default. Home volume settings can be configured by use of HELIOS Admin. For a conversion between different character sets on home volumes refer to the utility script "converthome" in the EtherShare manual.
OPI & PDF HandShake server settings are not migrated, please set them manually in HELIOS Admin (Settings > PDF HandShake Settings and ImageServer Settings).
As all old configuration files will stay unchanged in the system it is possible to switch back to the previous versions anytime (see References to HELIOS CDs in 4.1.2 "General remarks").
In the "EtherShare Installation Menu" take the steps
1) Install programs and configuration files and
2) Install and configure AppleTalk kernel modules. Then quit the "EtherShare Installation Menu".
In the "PCShare Installation Menu" take only step
1) Install programs and configuration files.
Then quit the "PCShare Installation Menu".
Note: All changes and modifications applied to the new versions are not migrated back into the previous product versions.
After the new version is installed and running, the old version can remain on the server for the purpose of switching back to the previous versions.
To prevent the old versions from loading during a system boot, deactivate the old product versions as start scripts, and start the HELIOS services again:
If you have used the previous version or the migration failed it is possible to start the migration again. Every time you do a migration the old version settings will override the new version settings.
The font lists and PPD of all spool files can be removed because the new one is in "HELIOSDIR/var/spool/qmeta".
The new versions provide an ICC-Profiles volume.
After all existing ICC-Profiles have been copied into the "HELIOSDIR/var/ICC-Profiles" volume, the old
ICC-Profiles volume can be removed.
For instructions on how to enter HELIOS software licenses on a Mac OS X platform read 4.4.3 "Entering a new license (Mac OS X)".
After you have installed a HELIOS software product on the server you must license the program in order to make it work.
In our example, we license the PCShare software which was installed in HELIOS installation above in this chapter.
In the PCShare Base License dialog window (Fig.17) enter the serial number of the product, the number of users (i.e. the type of license you purchased with the software product) and the checksum which you get from the "Activation Key Reply" form. Then confirm with Ok.
Note: What you have to do in "Welcome to HELIOS Base" shows you step-by-step how to receive the "Activation Key Reply" form with the required keys.
To leave the License a HELIOS Product menu go to Ok and press RETURN. Otherwise the changes you have applied to the server will not take effect.
The corresponding HELIOS application must be stopped and restarted for the new license to take effect. See 4.5 "Starting/Stopping HELIOS Services manually".
An already existing HELIOS license cannot be edited. In such cases it must be removed and then replaced by another. To remove a HELIOS software license do the following:
In the License a HELIOS Product menu highlight the software license you want to remove and press BACKSPACE or Ctrl-H (see also 4.1.4 "Navigating within the HELIOS Installer").
To leave the License a HELIOS Product menu go to Ok and press RETURN. Otherwise the changes you have applied to the server will not take effect.
"HELIOS Services" is a GUI application designed for entering HELIOS software licenses, and for easily starting and stopping HELIOS processes.
Double-click the "HELIOS Services" icon in the "Applications" folder and select the Licenses tab within the "HELIOS Services" window (Fig. 18).
The field Machine ID shows the machine ID of your Apple computer. In the other field all HELIOS product licenses are displayed, with Product name, Serial Number, and Expiration Date (Note that the entry in the Expiration Date column remains empty if you are running the software with a full license.).
An extra dialog window opens (Fig. 20) which lets you choose the desired product from the pull-down menu Product, and lets you enter the serial number (Serial), the number of Units, and the Checksum. As mentioned before, if you are running a full license of the HELIOS products, leave the Expires field empty. Otherwise, the expiration date of the demo or subscription license must be entered in the Expires field as well.
Note: All HELIOS products are licensed for use on a single computer system ("server"). The server has a unique machine identification ("HELIOS MachID") which is provided by a HELIOS USB dongle. The software can only once be licensed for a given USB dongle (MachID). Compare Fig. 18 and 19.
HELIOS services must be stopped and restarted for the new license to take effect. See 4.5 "Starting/Stopping HELIOS Services manually".
For instructions on how to start and stop HELIOS Services under Mac OS X skip to Start/Stop (Mac OS X) below.
Sometimes it might become necessary to start or stop HELIOS services on the server manually, e.g. after installing updates via the HELIOS Update Installer (see also 17 "The HELIOS Update Installer").
Important: Before issuing the "stop-helios" command make sure that all clients are logged-off (e.g. with the "swho" command, see 7.7 "swho").
"HELIOS Services" is a Mac OS X GUI application designed for entering HELIOS software licenses, and for easily starting and stopping HELIOS processes.
The HELIOS Services window appears providing information on the HELIOS products status when you click Status.
Click the lock icon (Fig. 21) to authenticate. After the authentication, the Start button will become available.
The Messages box shows the information that the HELIOS services are being started. When all available services are running, the display shows Done..
A click on the Status button then reveals a listing of all HELIOS processes (Fig. 22) and gives information about their name (Service), their Status, their process ID number (PID), date and time of starting (When), and - if a process has been started more than once - the number of Restarts.
"HELIOS Services" has a feature that lets you specify a shutdown message and the time span to shutdown (Fig. 23).
Specify the shutdown message in the Shutdown message text box. In the Time to shutdown (minutes) field enter the time after which the services should be stopped (if you specify "0" for the time to shutdown the services will be stopped immediately).
Important: Shutting down a Mac OS X machine does not stop the HELIOS software. At the next login, all volumes which were open at shutdown are rebuilt.
The Messages box then displays the information that the HELIOS services are being stopped (Fig. 24).
HELIOS server applications allow very precise, and easy to administer, control of access to their services. For example, access to volumes can be limited to members of specific groups (if you are not a member of an authorized group, the volume will not even be listed to login), and ca password can be required to mount the volume. Printers can also be password protected. HELIOS Admin recognizes four levels of authorization, to allow appropriate delegation of administrative capabilities.
During the installation of the HELIOS software the users "root" and "demouser" are created. Both of them come without any password, i.e. their password field is empty. This means a significant lack of security (anybody can log on to the server as user "root" without needing to know the password), and so you should specify a password for "root".
Important: For your own security, provide your user accounts with passwords to prevent them from unauthorized access and abuse!
Note: If this is an upgrade from an installation that utilized HELIOS encrypted passwords, and those settings were migrated to the new version, then normally no further action is needed.
HELIOS Admin is automatically installed in the "HELIOS Applications" volume of the HELIOS server. See 6.2 "Starting HELIOS Admin" for instructions on how to run HELIOS Admin from any network client, or on the host server itself.
From the HELIOS Admin File menu, select Login. Use User Name "root" and leave the Password field empty.
On specifying the password, HELIOS Admin prompts for the new password to be entered once again. This ensures that no typing mistakes have been made. After clicking OK the password will be allocated to user "root".
Note: The password field is always shown empty, even if the user has already allocated a password.
Note: On a Mac OS X machine, the "root" login is disabled by default. Once a "root" password is specified with HELIOS Admin, the "root" login is enabled automatically.
Also note that if a password is modified via host system tools, our additional password file is not changed. Therefore it makes more sense to administer users with HELIOS Admin.Then set passwords for all other existing users, or add new users (passwords defined in HELIOS Admin also update the user's system password).
Alternatively, passwords can be set by using the HELIOS utility program "authutil". See 7.15 "authutil".
HELIOS offers additional access control by means of IP access lists, based upon the user's IP address. The default installation creates a single IP access list, that specifies which IP addresses are allowed access to HELIOS resources (volumes, home directories, printers) and services (HELIOS Admin).
All of the above settings are easily configured by means of HELIOS Admin, which allows easy GUI-based server administration from any client on the network. Once the HELIOS software is installed, HELIOS Admin should be used to configure these security options.
Finer IP-based access control can be specified for individual HELIOS resources. For example, each volume can have its own IP access list. This allows certain volumes to be accessible only from within the local network, while others can be made available to remote offices or customers. Or the System Administrator can be authorized to access HELIOS Admin from home. The default IP access list is called ipaccess, and is described in 5.8 "HELIOSDIR/var/conf". To create a resource-specific IP access list, create an "ipaccess" file (see 6.8.5 "IP Access") with the desired access settings for that resource, and use either HELIOS Admin or the "prefvalue" command to associate it with the appropriate volume, etc. For reference, upon installation, a second access list is created, ipaccess.local, which contains the settings that will allow access only to users on the local network.
If your server is protected by a firewall, then access from network clients to HELIOS server services (volumes, printers, Admin, etc.) will be blocked by the firewall, until ports for the respective services are opened in the firewall.
You will not need any other ports open, unless you enable other HELIOS services (e.g. DHCP server, Remote LPR, etc.).
A complete overview about TCP server and client ports used by the HELIOS software is given in A 3.5 "TCP ports used by HELIOS".
Check the product specific README files which contain the latest information and updates that did not make it into the manuals. They are available in:
To configure the network interfaces use - if necessary - the "netconf" program, which is described in the EtherShare manual (except for Mac OS X which uses its own network interface configuration program).
Note: If EtherShare is installed, and the server has more than one network interface, then AppleTalk routing is automatically configured. If you need to change the configuration, refer to the EtherShare manual for instructions on the "netconf" utility (recommended). Alternatively, the prefvalue command can be used to set the "atalkd" preferences (see "AppleTalk preference keys" in the HELIOS EtherShare manual).
Note: HELIOS LanTest can be used to test network server volume and local hard disk performance. LanTest can be found in the "HELIOS Applications" volume, in the "MacOS" > "EtherShare Tools" > "HELIOS LanTest" folder.
Set up users, groups, volumes, printers, ipaccess, etc. We recommend to do this with HELIOS Admin (see 6 "HELIOS Admin").
Note: This chapter only refers to migrating software as of HELIOS CD018 or newer (i.e. EtherShare 3.1, PCShare 3.1, WebShare 1.0, ImageServer 2.5, PDF HandShake 2.1 and PrintPreview 2.0, or newer).
All installed HELIOS products and settings can be transferred to a new platform by installing the HELIOS products from CD and moving the HELIOS "var" folder to the new platform. All server settings including volumes and printers are transferred to the new platform and are automatically used on the new system. All volumes and printer spool directories will then be re-created on the new platform when start-helios -i is executed.
Enter the command "stop-helios" on the old (here Sun Solaris) platform. Copy the complete "HELIOSDIR/var" directory, which contains all volumes and printer settings, from the old platform to the new platform (Linux).
In doing so the "HELIOSDIR/var" directory on the Linux platform will be replaced with the "HELIOSDIR/var" directory of the Sun Solaris platform.
Note: Users, groups and volume content are NOT migrated. Please set users and groups manually in HELIOS Admin (Lists > Users and Lists > Groups), and copy the volume content from the old to the new platform.
It is prudent to save to CD, the "HELIOSDIR/var" directory at regular intervals, so that if a prior setting needs to be recovered, or if the server goes down and you want to quickly migrate settings to a different server, it will be easy to do so. Tape backups are often not readily accessible for such purposes.
The configuration in "var/conf" and "var/spool/qmeta" is automatically saved daily in a "tar" file. This allows restoring old settings, e.g. if the preferences file has accidentally been deleted.
If there is the need to restore the system to a previous configuration, go to "HELIOSDIR/var/adm" and open the desired "tar" archive "configuration.tgz" (today) to "configuration.tgz.6" (seven days ago).
As with all computer systems, it is highly advisable to make regular backups of network volumes to tape or disk. Although modern servers provide comprehensive safety mechanisms in case of system faults, it is never possible to fully exclude loss of data. For this reason, the administrator should regularly archive all volumes of the file server to mass storage. For data backup solutions see the HELIOS web site:
© 2005 HELIOS Software GmbH |