What You Should Know Before Installing

Guidance Package Compatibility

Make sure that the version of the Acrolinx Core Platform and the version of the guidance package files that you intend to install are compatible.

Core Platform files and guidance package files with the same major and minor version numbers are compatible.

Administrator Rights

Make sure that you have administrator rights on the host computer before starting an installation. Especially on Windows, if you’re installing to a location other than your C: drive, ensure that you have full administrative permissions on the installation directory.

To ensure that you have administrative permissions on Windows, right-click the directory, select Properties > Security, and edit the permissions for your user account so that you have full control over the directory. If there are other users that require the ability to change installation and configuration files, ensure that those user accounts have full control as well.

Dedicated Acrolinx User and Reverse Proxy

If you're installing Acrolinx on Linux, we recommend creating a dedicated non-privileged user account to install and run the Core Platform. For security reasons it's best practice to always run Acrolinx as a non-privileged user without superuser permissions, so it helps to create a dedicated user for this purpose.

During installation, some steps might require superuser permissions. In these cases, switch to a different account to perform the step, and then switch back to the dedicated Acrolinx user.

If you create a dedicated user to run the Core Platform, you'll probably want to set up a reverse proxy on the same computer. The Core Platform uses the default ports 80 and 443, which require superuser permissions. The reverse proxy can listen on ports that require superuser permissions. By running the Core Platform behind the reverse proxy, your writers won't have to worry about which ports they're connecting to.

Additionally, if the computer is only used for Acrolinx, you can also terminate the HTTPS connection in the reverse proxy. This gives you a secure connection without having to follow the HTTPS setup described in secure Acrolinx with HTTPS.

For more details, check out our article on how to run Acrolinx behind a reverse proxy.

Configuration

The configuration directory stores all overlays of all files that you use to configure the Core Platform. When you install the Core Platform, an empty configuration directory is created at a default location that is separate from the Core Platform installation directory. You create files in the configuration directory and restart the relevant server. When the server restarts, it loads updated settings from files that it detects in the configuration directory. All remaining standard settings are loaded from the installation directory as usual.

You configure the Acrolinx Core Platform by adding overlays of the relevant files to the configuration directory. The configuration directory is a location outside of the Core Platform installation directory. An overlay is a copy of the standard software file that is stored in the configuration directory with the same subdirectory structure as the installation directory. You can use overlays to keep your configurations separate from the configuration updates that are delivered as part of each new release.

You can find detailed information in our article on The Configuration Directory.

The Acrolinx URL

When you install the Core Platform, the installer uses the computer name as the Acrolinx URL. However, Acrolinx recommends that you use a symbolic name instead of a computer-specific address. A symbolic name eliminates the need to update properties files or saved integration settings if you migrate Acrolinx to another computer.

Symbolic names are configured by your system administrator.
For example, suppose that your computer has the IP address 10.10.10.45 and the computer name dev-pubs-23458b.

  • You could use either the IP address or the computer name as your Acrolinx URL, but both types of address are difficult to remember and are computer-specific.
  • If you configure a symbolic name such as acrolinxserver.company.local, you can easily reroute incoming connections if you migrate the Acrolinx Core Platform to another computer.

Language Server Allocation

During installation, the installer prompts you to enter the number of language servers. In a typical scenario, the number of language servers matches the number of languages configured in your guidance package. Every time the core server starts, it allocates a language configuration to each language server according to a sequence defined in the guidance package. It’s also possible to configure more language servers than languages. You can use this configuration to balance the processing workload for one language across multiple language servers.

To learn more about configuring language server allocation, refer to the following topics:

Time Zone

For consistency on dates and times throughout Acrolinx, we recommend that you set your operating system to UTC.


This product includes software developed by the Indiana University Extreme! Lab.