Manage Configuration Directory

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

Tip: The configuration directory is only intended for storing your customizations. Do not copy original files to this location.

The Configuration Directory Location on Windows

By default, the Acrolinx configuration directory is created in the directory: C:\ProgramData\Acrolinx\ServerConfiguration\.

The ProgramData directory is the Windows standard for storing application settings independently from the installation directory. This directory ensures that settings and customizations are retained when the software is updated. By default, this folder is hidden. To display it, you can follow the Microsoft procedure to display hidden files and folders (Windows 7 example).

In Windows, you can also preview the contents the configuration directory in the Dashboard, by navigating to Maintenance View Configuration.

The Configuration Directory Location on Unix-Based Operating Systems

By default, the server installer creates the configuration directory at the following location:

<USER_HOME>/.config/Acrolinx/ServerConfiguration<VERSION_NUMBER>/

The installer always creates a configuration directory that's specific to your server version. The placeholder <VERSION_NUMBER>indicates the version of the server that you're installing. For example, if you're installing version 4.5 of the Core Platform, a configuration directory would be created at the following location:

<USER_HOME>/.config/Acrolinx/ServerConfiguration4.5.0/

If you upgrade from an older version, the installer copies the configuration directory from the previous version. That way, you can continue using your previous configurations in the new location. Additionally, you'll have an archive of your configurations from previous server versions.

The Configuration Directory Environment Variable

The location of the configuration directory is stored in the environment variable: ACROLINX_CONFIGURATION_ROOT.

  • To confirm the location of your configuration directory in Windows, paste the environment variable %ACROLINX_CONFIGURATION_ROOT% into the address bar of Windows explorer and press Enter.
  • To confirm the location of your configuration directory on a Unix-based operating system, open the core server wrapper configuration file <INSTALL_DIR>/server/bin/coreserver.wrapper.conf and check the value of the parameterwrapper.app.parameter.3= .

Our instructions use the name of the environment variable to refer to the configuration directory in all file paths like this:

%ACROLINX_CONFIGURATION_ROOT%\data\en\configuration.properties

Files That You Can Save to the Configuration Directory

You can save most types of files to the configuration directory with a few exceptions. As general guideline, you can use the following types of files with the configuration directory:

  • Files anywhere in the server directory that have the extension *.properties, *.conf, *.xml, *.xsl, or *.css.
  • Files anywhere in the data directory that have the extension *.properties.
  • Files anywhere in the server\www\gwt directory that have the extension *.ico, *.png, *.gif, *.html, *.js, or *.css.

For a detailed list of files that you can save in the configuration directory, look for file names that have the prefix "(Overlay)" in the installation update checklist.

Files That You Can't Save to the Configuration Directory

However, there are some files that you can’t save in the configuration directory because they don’t work with the configuration overlay mechanism. Edit the following files in their original locations in the installation directory:

  • Transformation files for term imports and exports: data\transformation\*.xsl
  • Term sets that are based on an XML filter: <LANG_ID>\terms\*.xml
  • All custom report files: data\jasper-reports\*.*
  • Reuse repository assignments configured in the Dashboard: data\reuse\reuse.config

Default Overlay Copies

When you start the core server, the server copies the most commonly edited files in your installation to the configuration directory. These "overlay copies" are empty or contain help information only. The server creates these files and related subdirectories so that it’s easier for you to update your installation. The following overlay copies are created by default in the configuration directory:

server\bin\coreserver.properties
server\bin\ls-<NUMBER>.properties
server\bin\persistence.properties
data\configurations.properties

The server creates as many overlay copies of the ls-<NUMBER>.properties files as there are language server properties files present in the installation directory. However, if you delete one of these files and interrupt the continuous numbering, the server only creates overlay copies of the files counting up until this interruption. For example, if you have five language servers and delete the file ls-04.properties, the server only creates overlay copies for the first three properties files ls-01, ls-02, and ls-03.

Configuration Directory Updates

Once you’ve determined the location of the configuration directory, you can create new subdirectories and configuration files.

For example, suppose that you want to configure an alternative name for the "sentence too long" guideline in German. To perform this task, you would do the following:

  • Create the location data\de\ in your configuration directory.
  • Create the file configuration.properties in the de directory.
  • Add the property <RULE_SET>.lengthChecker.sentenceTooLongRuleName=<NEW_NAME> to the file you just created and reload the language configuration load your changes.

Changing the Location of the Configuration Directory

By default, the server installer creates the configuration directory in the "All Users" account. You can define an alternative location for the configuration directory by updating the relevant environment variable. You might define an alternative location so that your configuration files are on a drive or share that is accessible from other computers.

To change the location of the configuration directory in Windows, follow these steps:

  1. Update the environment variable ACROLINX_CONFIGURATION_ROOT with the path to the new location.

    You can edit environment variables in the Windows Environment Variables dialog box by navigating to Start Menu Control Panel System and Security System > Advanced System Settings Environment Variables.

    You can also update the environment variable with following command in a command-line shell:

    SET ACROLINX_CONFIGURATION_ROOT=<PATH>

    For example, to change the custom directory to a location outside of the "All users" directory, you could enter the following command:

    SET ACROLINX_CONFIGURATION_ROOT=D:\AcrolinxConfig
  2. Stop all servers in the Servers section of the Dashboard.
  3. Start all servers.

To change the location of the configuration directory on a Unix-based OS, follow these steps:

  1. In your installation directory, open the wrapper configuration files for the core server and language servers.

    <INSTALL_DIR>/server/bin/ coreserver.wrapper.conf
    
    <INSTALL_DIR>/server/bin/ ls-<NUMBER>.wrapper.conf
    
    <INSTALL_DIR>/seo/conf/seo.wrapper.conf
  2. In each file, locate the wrapper.app parameters and locate a parameter that has %ACROLINX_CONFIGURATION_ROOT% at the beginning of the value.

    For example, in the wrapper configuration file for the core server, the relevant parameter should resemble the following example:

    wrapper.app.parameter.3="%ACROLINX_CONFIGURATION_ROOT%"
  3. In each file, update the parameter with the location of your new configuration directory. For example, to change the location to a directory outside of the home directory, you could update the parameter in each file as follows:

    Server Wrapper ConfigurationParameter
    Core serverwrapper.app.parameter.3=/mnt/AcrolinxConfig/
    Language serverwrapper.app.parameter.4=/mnt/AcrolinxConfig/
  4. Save your changes.

  5. Stop all servers in the Servers section of the Dashboard.

  6. Manually start all servers from the command shell.

    <INSTALL_DIR>/server/bin/run-all.sh start

Disabling the Configuration Directory

By default, all changes that you make to your installation are stored in a configuration directory that is independent from the main server installation directory. However, you can also disable this feature and update the original files in your installation directory instead of creating overlay copies. You’re strongly advised to use the configuration directory for all changes to your installation, but you might be required to disable this feature if restrictions on your server computer prevent you from editing files outside of your server installation directory.

To disable the configuration directory in Windows, follow these steps:

  1. Add the environment variable ACROLINX_CONFIGURATION_ENABLE and set the value to FALSE.

    You can edit environment variables in the Windows Environment Variables dialog box by navigating to Start Menu Control Panel System and Security > System > Advanced System Settings Environment Variables.

    You can also update the environment variable with following command in a command-line shell:

    SET ACROLINX_CONFIGURATION_ENABLE=FALSE
  2. Restart your computer.

    Important: The Acrolinx documentation refers to the configuration directory in most standard instructions and file paths. If you disable the configuration directory, ignore all references to the configuration directory in the documentation. Instead, use the corresponding locations in the installation directory.

To disable the configuration directory in a Unix-based OS, follow these steps:

  1. In your installation directory, open the wrapper configuration files for the core server, and language servers:

    <INSTALL_DIR>/server/bin/ coreserver.wrapper.conf
    
    <INSTALL_DIR>/components/seo/conf/ seo.wrapper.conf
    
    <INSTALL_DIR>/server/bin/ ls-<NUMBER>.wrapper.conf
  2. In each file, update the relevant wrapper parameter wrapper.app.parameter.<NUMBER> with the value false.
    1. In the core server wrapper configuration file, update the parameter wrapper.app.parameter.2 with the value false.

      The updated parameter to should resemble the following example: wrapper.app.parameter.2=false

    2. In the language server wrapper configuration files, update the parameter wrapper.app.parameter.3 with the value false.

      The updated parameter to should resemble the following example: wrapper.app.parameter.3=false

  3. Save your changes and restart all servers.