| Home Prev |  EasyAccess 4.3 Getting Started Guide
|
Next |
|---|
This section describes the installation of the EasyAccess server software on one of the supported computing platforms. The supported platforms and minimum resource requirements are described in Chapter 1, Overview.
The following steps are required to install the software:
Download the installation package from the MyClavister section of the Clavister website. This can be found under the Downloads section of MyClavister. A MyClavister user account will need to be created if one does not already exist.
Download a valid license file from the Licenses section of the relevant MyClavister account. The license file will be required during the installation procedure and the EasyAccess server will not start if it is not present. The server can start with an expired license file but connection attempts to it will fail.
Downloading a license is described further in Section 2.3, Licenses.
Next, use the installation instructions that follow in this section for the relevant computing platform.
![[Note]](images/note.png) |
Note: Upgrading from a Pre-4.0 version |
|---|---|
|
This section should not be used if upgrading from a version before 4.0. The Release Notes PDF for the 4.0.2 version contains a section which describes how to upgrade. Pre-4.0 versions use a different internal database so an export of old data followed by an import into the new version may be required. |
The EasyAccess Folder Structure
Installation on either a Windows or a Linux based computer will create a similar folder structure under the root file path specified during installation. Under Windows, for example, the default path will be the Windows Program Files folder. The top folder in the structure is called EasyAccess under which is a Server folder. Under the Server folder will be the following key folders:bin - Contains executable files, including files for starting the EasyAccess server.
config - Contains JSON files which define the configuration. The file phenix-store.json is the main configuration file.
license - Contains the current license file. The license file must be placed here if it was not specified during installation otherwise the EasyAccess server will not start.
logs - Contains the log files server.log and events.log for different event types. The server.log file is an important tool for troubleshooting.
An Internal or External Database Can Be Used
Note that the standard installation includes installation of the default EasyAccess internal HSQLDB database. However, from EasyAccess version 4.0 onwards, the possibility exists to use an external database server instead which can be either a MySQL or an MSSQL database. An external database can be running on a separate computer or the same computer as the associated EasyAccess installation. If the EasyAccess installation is to be part of a cluster then an external database server must be used instead of the internal database.The additional setup steps required for using an external database can be found in Section 2.5, External Database Setup.
This section describes the installation of the EasyAccess server software on a Windows based computer.
First, execute the Windows .exe installer file on the computer after downloading it from MyClavister (link: https://my.clavister.com). This will run an installation wizard which will go through the following steps:
A welcome message is presented in the first wizard step. Click Next to continue.
Accept the license agreement.
Select an installation location for the server file or accept the default. For example: C:\Program Files\EasyAccess\Server.
Locate and select a valid license file. Downloading a license is described in Section 2.3, Licenses.
Enter the default system administrator username and password. These credentials will be used to access the EasyAccess configuration manager WebUI. Note that only the characters A-Z, a-z and 0-9 should be used.
Set an encryption key which will be used as a seed for encrypting persistent data such as token keys. If this is a single standalone EasyAccess node or the first node in a cluster then the encryption key can be anything. If this node is to be joined into an already existing cluster the key given MUST be the same as the other nodes. Note that only the characters A-Z, a-z and 0-9 should be used.
Enter the HTTP port used for accessing the EasyAccess configuration manager WebUI. For example, 8443.
Select Finish to close the wizard.
Starting the EasyAccess Server on Windows
The server is started in one of the following two ways:If it is desirable to have a console window open to show server activity, open the EasyAccess/server/bin folder and then start the EasyAccess server executable file. This file will have a name of the form EasyAccess_<vernum>.exe.
If a console is not needed, the service called EasyAccess should be started. On Windows, this is done by opening the service list and then right clicking the EasyAccess service before selecting the Start option. This is shown below. The service will not need to be started again after a Windows restart as it will start automatically.
Note that the server will take a short amount of time to initialize and start up completely. The startup phase can be monitored by viewing the CPU load in the Windows task manager. Alternatively, use the following Windows console command:
C:\> netstat -aon | findstr :8443This will show the server is listening on the management port (in this case 8443) if the server has started. The server.log file should also contain a log that indicates successful startup.
