|Acrolinx Server||5.2, 5.3, 5.4, 5.5, 5.6, 2018.10|
|If you have an earlier server version, you can download an archived version of this article.|
When you install Acrolinx, you unpack separate software packages for the server components and the guidance settings.
To install Acrolinx for the first time, follow these steps:
- Install the Acrolinx Server .
- Install the guidance package files for the Acrolinx server .
- (Optional) Configure the connection to external databases .
Start the servers for the first time
This step enables you to access the dashboard, which is required for subsequent steps. If you install the server on a new computer, the server also creates the configuration directory .
Check the log files for errors or warnings
You can diagnose issues that occur during installation by reviewing the core server and language server log files.
Sign in to the dashboard and check the installation .
On the Servers page in the dashboard you can check that all servers have started correctly.
Request and Install the license
Once the server is started, a hardware ID is generated and displayed in the dashboard. You can then use the hardware ID to request a license.
Check the log files for further errors or warnings
The license installation procedure requires you to restart the core server. You can check the core server log files to ensure that the licensing information has been correctly read.
Connect to external databases
You need to connect to external database servers for terminology, analytics, and reporting data. That means you’ll need to set up three databases, one for terminology, which stores your terms, one for analytics, which runs your Analytics Dashboards and one for reporting, which stores your checking data.
Installing the Acrolinx Server
The Acrolinx Server software package contains one top-level directory that corresponds to the server version and build number. This top-level directory contains the server files and the installer script.
This guide refers to the installation directory as <INSTALL_DIR> .
In addition to the Acrolinx Server software package, you also need an Acrolinx guidance package to complete the installation. You need GNU tar to unbundle the server package and an unzip utility to unzip the guidance package. When executing the Acrolinx installer scripts, you should also use a POSIX-compliant shell such as Bash.
To install the Acrolinx Server, follow these steps:
Verify that Java Development Kit (JDK) is installed and that your shell environment finds the correct Java installation. You can either use Oracle Java SE 8 JDK x64 or IBM Java 8 SDK 64-bit.
Example: $ which javaFor more information on the Java requirements for Acrolinx, see the topic Software Requirements .
Ensure that the maximum number of open files for the user account where the server will run is at least 4096.
Different components of the Acrolinx Server each require separate processes that contribute to the open file limit. The server also starts more processes when a user connects to the server. If you have a user base of more than 100 users and the ulimit is less that 4096, the server might exceed the maximum number of open files, which can cause users to lose access to the server.
You can get the current limit by entering the following bash command: $ ulimit -n
To set a new limit you enter the previous bash command followed by a value for the new limit.
Example: $ ulimit -n 4096
You must have super user privileges to run this command.
ulimitcommand isn't persistent. You'll either need to re-enter it each time your server reboots, or add it to a script that runs at startup.
Use GNU tar to unbundle the software package.
$ cd <INSTALL_ROOT> $ <GNU_TAR_COMMAND> -xvzf <FILE_NAME>.tgz
If you’re upgrading an existing installation of Acrolinx, don’t untar the server archive into the existing installation directory.
Run the Acrolinx Server installation script.
$ cd <INSTALL_DIR> $ bash ./installer.sh
You can also use one of the following options to change how the script runs:
Option Description -lscount
This option specifies the total number of language servers to install. It persistently overrides the LSCOUNT parameter in the installation parameters file.Example:
$ cd /home/acrolinx/acrolinx/ $ bash ./installer.sh -lscount 4Note:
-lscountcan't be used together with the
-d Create a parameters file without going through the full installation process . You can use this option to create a parameters file that a non-interactive installation process can use. This is the equivalent of an "answer file" in a non-interactive Windows installation. -batch
Start the server installation in non-interactive mode . When the installation runs in non-interactive mode, you won't be prompted to confirm any installation actions. The installer script uses the default installation parameters instead. -i Install init scripts that ensure that the server automatically starts when you reboot your system.
This option only works on Red Hat Enterprise Linux.
-u Remove init scripts that were installed with the -i option.
When prompted, review and confirm the installation parameters.
Important: The installation script automatically determines the IP address of the computer. If your computer has more than one network interface, the installer picks the address of the first network interface. It is strongly recommended that you replace the IP address with a symbolic name .
If you need to change the installation parameters, follow these steps:
Exit the installation script and open the installer parameters file.
- Update the relevant installation parameters.
Run the installation script again.
You can rerun the installer script any time if you need to change the installation parameters again. The installer script overwrites all configuration files in the server/bin directory. Before you run the installer script on an existing installation, back up any files in the server/bin directory that you have changed.
- Exit the installation script and open the installer parameters file.
After you have installed the server, install the guidance package files .
Installing Guidance Package Files
The guidance package files typically contain settings that are customized according to the style guide for your organization. If you’re upgrading your guidance package, you must back up any settings that you have changed .
- Modules for certain checking functionalities
- Configurations for the spelling checker
- Grammar and style guidelines
- A terminology database
- Help files for some error types.
To install the Acrolinx guidance package files, follow these steps:
Unzip the guidance package into the Acrolinx server directory that was created during the server installation.
Your guidance package has the following naming convention:
$ cd <INSTALL_DIR> $ <UNZIP_COMMAND> <FILE_NAME>.zip
Some guidance package files might already exist in the installation directory because they were created during the server installation procedure. If you’re prompted to overwrite existing files, enter "A" for all .
Run the installer script with the
option to prepare the guidance package for use on a Unix-based operating system.
You use this option to correct any paths that might only work on Windows installations.
$ cd <INSTALL_DIR> $ bash ./installer.sh -prepling
After you have installed the guidance package, start the servers .
Starting the Servers for the First Time
The core server, the language servers, the analytics server, and the SEO server each come with a shell script that you can use to start or stop the servers.
To start or stop a server, follow these steps:
Open a shell and navigate to the directory:
Enter one of the following the commands:
Task Command Start the core server. ./coreserver.sh start Stop the core server. ./coreserver.sh stop Restart the core server. ./coreserver.sh restart Start a language server. ./ls-<NUMBER>.sh start
Stop a language server. ./ls-<NUMBER>.sh stop
Restart a language server. ./ls-<NUMBER>.sh restart
Start the analytics server. ./analyticsserver.sh start Stop the analytics server. ./analyticsserver.sh stop Restart the analytics server. ./analyticsserver.sh restart Start the SEO server. ./seo-server.sh start Stop the SEO server. ./seo-server.sh stop Restart the SEO server. ./seo-server.sh restart Start all installed servers ./run-all.sh startRestriction:This script doesn't resolve symlinks in the path to the server/bin directory. The script might not run correctly if you open the script from a symlink. If you run into any problems, try specifying the path to the bin directory as the second parameter like this:
Create a startup script that starts the core server and language servers once the computer is restarted. On Red Hat Enterprise Linux, you can run the installer script with the option
create these startup scripts
If you’re unsure how to create a startup script, contact your operating system administrator.
If you start the Acrolinx Server without a license installed, you can use it for one hour to perform testing. During this time the Acrolinx Server runs under a trial license.
The trial license comes with the checking module enabled, including the ability to check with all plug-ins and languages. Use the admin account, you can only work with one Access Point .
After 1 hour, you need to do one of the following:
- Restart the server.
- Wait for the final license.
Requesting and Installing the License
To request and install a license, follow these steps:
Access the dashboard from a web browser at the following address:
Sign in to the dashboard and click the
The overview page in the License Section displays the license information.
If no license is installed, request a license.
- Navigate to License > Request .
Type your Acrolinx
address, select the appropriate
for the request
and click the
Request License By E-mail
An e-mail message containing the essential ordering information is automatically created as a draft in your default e-mail program.
Current Hardware ID
in an e-mail.
Note: Your Order Number is a three or four-digit number, which you get you from your Acrolinx project consultant. If you already have a license installed, the license request page displays the order number, which is defined in your current license. If your order number hasn’t changed, re-enter the currently licensed order number into the Order number field.
The Order Number is necessary for the Acrolinx licensing team to generate a license. If you don’t have an order number, please request one from your Acrolinx project consultant.
- Type your Acrolinx Order Number and Your E-mail address, select the appropriate Purpose for the request , and click the Request License By E-mail button.
When you receive the
file from Acrolinx by e-mail, navigate to
License > Install
, and click
Important: Save a copy of the acrolinx.license where you can access it for future installations or reinstallations.
Restart the core server to load the license.
The license is installed to the directory $ACROLINX_CONFIGURATION_ROOT/server/bin/ in the configuration directory .
Checking the Installation with the Dashboard
To check that all servers have loaded correctly:
Sign in to the dashboard.
Note: The Username of the default administrator account is admin . The default administrator Password is also admin . We recommend you change this default password as soon as possible.
- Open the Servers page and verify that there’s a row for the core server, the Analytics server, and each of your installed language servers.
- Select a Language Server to open the corresponding page.
For each language server, verify the following:
- The Guidance Package section displays the correct version information of the installed guidance package.
- The Writing Guides section lists all of the configured writing guides.
- The Term Sets section lists all of the configured term sets.
Checking the Log Files for Errors or Warnings
You can diagnose issues that occur during installation by reviewing the core server and language server log files.
To check the log files for errors or warnings, follow these steps:
Open the core server and language server log files.
- Navigate to the directory where the log files are stored and open the files in an editor. <INSTALL_DIR>/server/logs/coreserver.log for the core server log file and <INSTALL_DIR>/server/logs/ls-<LS_NUMBER>.log for the language server log files.
- In the dashboard, navigate to , and select the desired log file to display.
The log file entries have the following syntax:
[TIMESTAMP] | [SEVERITY] [PROCESS] [DESCRIPTION]
2010/08/18 12:41:25.805 | [INFO ][init] Term database initialized
Pay special attention to entries that have the severity
. When displaying the log files in the dashboard, you can select to display only warnings and errors.
The server can successfully start despite critical issues or errors, but these entries can indicate that a vital component of the Acrolinx Server isn’t functioning correctly.
For more information about log files, see the log files description .