By: Sam Patterson
Abstract: Installation, Registration, and Licensing Information for Embarcadero ® InterBase® XE
Published September, 2010
Installation and Registration
Downloading and Installing
Using the Installer
Using the Wise Installer to Embed InterBase
Installing on Unix or Japanese Versions
Command Line Installation
Licensing Users, Processors, and Strong Encryption
Linux and Solaris
For a list of recent bug fixes and updated contact information, please refer to the Readme.html.
For a list of add-ons and licenses you can obtain for InterBase products, see Chapter 2, Licensing, in the InterBase Operations Guide. You receive all six InterBase user guides in PDF format at the time of purchase.
Check http://edn.embarcadero.com/interbase for a variety of information and resources of interest to those who develop and maintain InterBase databases and applications.
Embarcadero maintains several active newsgroups for InterBase users. To access them, go to http://forums.embarcadero.com/.
Return to top of page
The following table lists the system requirements for installing and running InterBase XE.
Microsoft Windows 7 (32-bit and 64-bit)Microsoft Windows Vista (32-bit and 64-bit)Microsoft Windows XP SP3 (32-bit)Microsoft Windows Server 2008Microsoft Windows Server 2008 R2Sun Solaris 10Red Hat Enterprise Linux 5 (32-bit and 64-bit)SUSE Linux 10 and 11 Mac OS X 10.5 and 10.6
Microsoft Windows and Linux: Intel x86 or x86-64Sun Solaris: SPARCMac OS X: Intel x86
All platforms: JDK 1.6
Hard disk space
20 MB for compact installation35 MB for full installation
InterClient XE server is certified to work with a compatible InterBase XE client. Since there are no breaking API changes, earlier versions of InterBase clients may work with the current version of the server also.
IMPORTANT! Mixing InterBase client and server versions is not supported. It is strongly recommended that compatible client and server versions are used for local connections on Windows.
You can install InterBase after downloading it from the web, or by using the InterBase XE installer (installing from a CD or DVD).
The InterBase XE installer installs InterBase on Windows, Linux, Solaris, and Mac OSX. As part of this installation, you have the opportunity to register the product. InterBase XE must be registered before you can start the server; though there is a way to use it without registering during the grace period (read below). If the server is started without entering any licensing information an error message with the registration key is logged in interbase.log. This registration code along with your serial number may then be used to register your software on any computer by going to http://reg.embarcadero.com.
Installing and registering the product provides a base level of functionality; the exact level of functionality depends on whether you are installing the Desktop Edition, ToGo Edition, or the Server Edition. It is important to note that the Desktop and TOGo editions are only available for the Windows operating systems.
To add more users, more processors, or strong encryption, you need to purchase additional appropriate licenses from the Embarcadero shop site or from your sales representative. The license key and registration are explained in the "Licensing" chapter of the Operations Guide. You will find this and the other InterBase books in the <interbase_home>/doc directory. See Licensing users, processors, and strong encryption below for more details.
There is a registration limit imposed on every Serial Number. For any unforeseen circumstance, if you encounter this limit while registering your Serial Number, please visit http://reg.embarcadero.com/bump to get a temporary increment and register once again. It is not common for one to hit this limit.
Note: For older InterBase version users - InterBase XE licenses are not compatible with earlier InterBase version licenses. InterBase XE requires new license purchase.
The following instructions guide you through the process of downloading, installing, and registering InterBase XE.
Note about the InterBase ToGo Edition: The InterBase ToGo edition includes two (2) zip files: ibtogo.zip and ibtogo_min.zip. The ibtogo.zip file includes all the files you need for development using the InterBase ToGo edition. The ibtogo_min.zip file includes the minimal set of files required to deploy the InterBase ToGo edition. To install the InterBase ToGo edition, extract the appropriate zip file to a location as specified in the "Client/Server Concepts" chapter of the InterBase Developer's Guide.
The following instructions guide you through the process of installing and registering InterBase using the cross-platform installer. You are encouraged to use this installer when possible. A console (command-line) installer is available for Linux and Solaris users who have environments that are not compatible with a GUI installer. However, to use the command-line installer on a Solaris or Linux computer, you must also have a copy of X-Windows installed. See Command-line installation for instructions on how to run the installation from a console window.
What it does
Install Embarcadero InterBase XE
Installs the main InterBase XE product.
InterBase XE on the web
Connects you to http://www.embarcadero.com/interbase.
Displays this file. InterBase strongly recommends that you look this over before proceeding with the installation.
<interbase_home>/bin/LicenseManagerLauncher -i Console
Click here to view frequently asked questions about registering your InterBase XE product.
Return to the opening panel if it is still displayed and choose the connectivity drivers that you want to install. Otherwise, run the InterBase installer again and choose the "Install InterBase Connectivity Drivers" button. Choose a driver to install and follow the prompts. Note that the JDBC driver is automatically installed, so it is not displayed as a driver choice.
The InterBase installer provides the following drivers:
ADO.NET driver for InterBase
DataDirect ODBC Driver
InterBase XE includes a Windows/English-only installer to help make embedding InterBase easy. The installer is located in the: Disk1\InstData\Windows\VM directory of the CD and is named, "ib_install.exe".
Command line options for ib_install.exe:
/S (run installer in silent mode)
/M=<filename> (this file contains custom settings for your installation)
You can define custom parameter values (say values.txt) as follows. The default values are:
where the variables are defined as:MAINDIR - The location of the InterBase Root Directory TCP_PORT - default is 3050 INSTANCE - default is gds_db COMPONENTS - This is a comma separated list of the Components that will be installed.
The options for COMPONENTS are:
A = Server and Client
B = Client only
C = Documentation
D = Registration (will not work in silent install mode)
For example, if the following values are saved in a file named values.txt, and you execute the command: ib_install.exe /s /m=values.txt, you will launch the silent installer with the settings from this file. If the values file is not found, the Silent Install will assume the default values as detailed above.
You can also provide custom values via such files to the GUI installer by executing ib_install.exe without the /s flag.
Note: To include a license activation file (*.slip) with your installation, save the activation file into the directory where the ib_install.exe file is located.
Using the Java Installer for UNIX installations, as well as Japanese Windows installations.
The installer is named ib_install.exe on Windows platforms and ib_install.bin on UNIX Platforms. Using a property file that contains the variables for a specific install can customize the installer. Property files should be placed in the same directory as the installer. Sample property files are available under the extras directory of the InterBase CD.
Windows example (Japanese installation only):
ib_install.exe -f ib_install.properties
ib_install.bin -f ib_install.properties
The mode that InstallAnywhere-based installer should run in
Console (UNIX platforms only)
The Install set that wish to use:
Server (Server and Client)
Client (Client Only)
Register (can only used in GUI mode)
SLIP_FILENAME (Value Added resellers only)
The location of the slip file that you will be using for InterBase.
This is the install location for InterBase.
The default is C:\\Embarcadero\\InterBase
Set to No by Default. If you want to take advantage of the InterBase XE Multi-Instance feature, set MULTI_INSTANCE=Yes. It is important to set the LABEL and PORT variables to something other than the default to not interfere with other version of InterBase running on the system
Default is 3050. This only needs to be set if MULTI_INSTANCE is set to Yes. Please choose a Port number that will not interfere with other programs on the server machine
Default is gds_db. This only needs to be set if MULTI_INSTANCE is set to Yes.
All Features are installed as Default and can only be disabled by setting the Feature to False.
Server: This includes the server, the guardian, the license file, the message file, the configuration file, and database information tools
Client: This includes the client library, the license file, and the message file
Graphical tools: Graphical tools for InterBase and the associated help files. Short name is GT. To disable set GT=FALSE
Development support: Development tools for InterBase, including gpre. Short name is DS. To disable set DS=FALSE
Documentation: InterBase Documentation. Short name is DOCS. To disable set DOCS=FALSE
Command line tools: This includes database management tools, database query tools, and user management tools. Short name is CLT. To disable set CLT=FALSE
Examples: Example databases and example programs that use embedded SQL, dynamic SQL, and the InterBase API. Short name is EXAMPLES. To disable set EXAMPLES=FALSE
InterClient JDBC: The type 4 driver allows access to all features of InterBase through JDBC. Also includes samples and docs. Short name is JDBC. To disable set JDBC=FALSE
Register: Used to register InterBase (GUI only) short name is REG. To disable set REG=FALSE. You must set REG to FALSE even if you are doing a silent or console installation
Here is an example of a silent install without DOCS, JDBC, and Registration. You will notice that it specifies a slip file location, uses Label of gds_db1 and Port number of 3060
Client: This includes the client library, the license file, and the message file.
Graphical tools: Graphical tools for InterBase and their associated help files. Short name is GT. To disable set GT=FALSE
Silent Client install without JDBC to non-default location
This completes your InterBase installation and registration. You now need to install any licenses that you have purchased for users, processors, and Internet use. Please see Licensing Users and Processors for information on licensing.
If your Linux or Solaris environment does not support the GUI installer, you can use the following steps to perform a console installation.
Use the TAR package to install InterBase (see .tar install instructions for Linux and Solaris) or use the InstallAnywhere-based installer. The InstallAnywhere-based installer requires X Window System libraries to be available. If they are not available, you will get the error "Installer User Interface Mode not Supported".
In addition, InterBase XE has a 14-day grace period for registration, but this feature requires a GUI and is not available to Linux and Solaris installations that do not have a GUI.
ib_install.bin -i Console
Follow the prompts.
For some platform-specific issues related to installation, please see the sections below:
Linux and Solaris
For more information about InterBase options, please visit the Embarcadero InterBase Portal. The Licensing chapter in Operations Guide PDF manual covers this topic in more detail.
You will have the following basic functionality after you register:
Desktop and ToGo Edition(s): Permits local connections only (same machine), enables eight cores/processors and eight simultaneous connections.
Server Edition: Enables eight CPU cores/processors and one user (4 connections).
You can purchase licenses to enable additional simultaneous users and additional processors through the Embarcadero web site or through your sales representative.
Execute the setup script.
Choose to install Server and Client or Install Client only.
Follow the prompts to configure:
Instance name and port
Run InterBase as a service
The script installs InterBase to the chosen location, sets the correct variables to allow InterBase to run remotely, and links to InterBase libraries.
Note: The installer must be run with “root” privileges.
Note: Command line registration is not available.
In a Multi-Instance install the /usr/interbase symbolic link is not automatically created. Set the INTERBASE and LD_LIBRARY_PATH environment variables to use that particular instance of InterBase. This does not apply to "single" instance installations.
If you are planning to install the InterBase XE software over an older version installed on the server machine, and you want to preserve the customization files, copy them to a safe place, for example:
gbak -b /usr/interbase/admin.ib /tmp/admin.ibk
cp /usr/interbase/ib_license.dat /tmp
cp /usr/interbase/ibconfig /tmp
You can skip this step if you haven't customized these files in a previous installation.
If InterBase is running on your server, shut it down. To save the current version, rename the directory, for example:
mv /usr/interbase /usr/interbase.save
To run InterBase as a service, run:
When you choose to run InterBase as a service, the InterBase server starts automatically whenever the machine is running in a multi-user mode.
To remove InterBase as a service, run:
You must then start the InterBase server manually whenever you need it.
In a multi-instance install the /usr/interbase symbolic link is not automatically created to your install location. Set the INTERBASE and DYLD_LIBRARY_PATH environment variables to use that particular instance of InterBase. This does not apply to "single" instance installations.
When you install the product, InterBase is setup automatically to run as a service. You will notice that the /Library/StartupItems/ folder on your machine has an entry to run the InterBase server whenever the system boots up.
The following issues are still in the process of being resolved.
The 16-bit UNICODE character sets UNICODE_LE and UNICODE_BE only work for Server character sets. These character sets cannot be used as a client character set. If your client needs full UNICODE character support, please use UTF8 instead of UNICODE_LE and UNICODE_BE for the client character set (aka LC_CSET). A client can use the UTF8 (or other native) client character set to connect with a UNICODE database.
InterBase XE supports no defined UNICODE collations in this release. The default collation is binary sort order for UNICODE.
Copyright © 1986-2010 Embarcadero Technologies, Inc. All Embarcadero brand and product names are trademarks or registered trademarks of Embarcadero Technologies in the United States and other countries. All other marks are the property of their respective owners.
Free Developer Edition!
Click here to download a free non-expiring Developer Edition or 30-day trial >
More InterBase Info
InterBase XE3 Product Info
Free Developer Edition download
InterBase on Google+
Follow @InterBase on Twitter
Server Response from: ETNASC04