Overview of Configuration Properties

The following tables provide an overview of configuration properties broken down by server component. Most Acrolinx properties are configured in the core server properties file or the language configuration files, however there also properties that are configured in other types of configuration files.

For more information on how to configure each property, see the relevant topics.

TABLE 1. CORE SERVER PROPERTIES

You can use the properties in the following table to configure the behavior of the core server.

To edit coreserver.properties from the Dashboard, go to Maintenance > Configuration Properties, then follow the folder structure config > server > bin and click on the file coreserver.properties. You can then edit the properties directly from the Dashboard.

Alternatively, you can edit coreserver.properties from the configuration directory: %ACROLINX_CONFIGURATION_ROOT%\server\bin\coreserver.properties

PropertiesRelevant Topics

authentication.useExternal

authentication.external

authentication.external.ldap.localAuthenticationLifetimeMinutes

Use an External Directory Service to Authenticate Users

authentication.lockout.attemptsConfigure the number of times a user may enter an incorrect password before the account gets locked. You can set 0 to turn off the lockout feature. By default it's set to 5. Note that the last attempt will already trigger the "account locked" error message.
authentication.lockout.durationSecondsConfigure the duration of the lockout in seconds. Accounts that are locked because of incorrect passwords get unlocked after this time period or after the server is restarted. This value must be greater than 0 since we don’t support manual account unlocking. The default value is 30 seconds.
client.doNotStoreAccessToken

Set to false by default. Can be set to true to increase security. The Sidebar then won't store authentication information anymore, and will just keep this information in memory instead.

Any saved access tokens will be deleted after a user signs in. This means that when you enable doNotStoreAccessToken, a user will be able to sign in one last time with any locally stored token.

Enabling this feature will have the effect in most editors that users will have to sign in each time they check a new document.

client.userIdDefaultSetting the Suggested Acrolinx Username when Users Register
dictionary.editableScopes

Configure the spelling exception lists that a writer can submit entries to from the Sidebar. The options are document, guidanceProfile, and language. By default it's set to guidanceProfile,document.

Learn more in our article on how to restrict access to spelling exception lists.

endpointHostThe hostname of the core server.
endpointListenHostRestrict the address that the core server listens on.
endpointPortThe port that the core server listens on for external communication. It's set to 8031 by default.
endpointProtocolDefines whether http or https is used for communication between the core server and Integrations. It's set to http by default.
externalBaseUrl

Allow Acrolinx for GitHub to work with a Core Platform behind a Reverse Proxy

http.logging.filenameWeb request logging. See Managing the Server Logs for details.
internalEndpointHost

internalEndpointHost is similar to endpointHost, but for internal communication between your core server and all your other Acrolinx servers (Language servers and Analytics server). It's set to localhost by default.

internalEndpointListenHost

internalendpointListenHost is similar to endpointListenHost, but for internal communication. Your language servers and Analytics server need to use this host to reach the core server. It's set to localhost by default.

internalEndpointPort

internalEndpointPort is similar to endpointPort, but for internal communication between your core server and all your other Acrolinx servers (Language servers, and Analytics server). It's set to 8032 by default.

If you change this property, make sure that you also update the relevant properties in your language server and Analytics server properties files.

Specifically, you should update coreServerEndpointUrl in ls-<LS_NUMBER>.properties and com.acrolinx.jreport.coreserver.port in analyticsserver.properties to point to this port.

internalEndpointProtocol

internalEndpointProtocol is similar to endpointProtocol, but for internal communication between your core server and all your other Acrolinx servers (Language servers and Analytics server). It's set to http by default.

internalSslKeystore

internalSslKeystorePassword

internalSslKeystore and internalSslKeystorePassword are similar to sslKeystore and sslKeystorePassword respectively, but for internal communication between your core server and all your other Acrolinx servers (Language servers and Analytics server). They both need to be explicitly set.

languageServers.largeTaskWaitThreshold

languageServers.batchTaskWaitThreshold

languageServers.largeTaskSizeThreshold

Optimizing the check request queue.

maxParallelResourceLoadRequests

serializedResourceReloading

Configuring language configurations to reload simultaneously.
sanitization.sanitizers.terminology.idAlias

sanitization.sanitizers.terminology.replacedRanges

Prevent special characters from causing problems when entering terms.

schedulerQueueLimit

Define the maximum number of checks that the core server can hold in the check request queue. The limit is for the sum of all checks, regardless of language or other attributes.

Optimize the Check Request Queue

securityHeadersEnabledToggle security features like the SAMEORIGIN policy. You might need to set this to true if you're embedding the Acrolinx Term Browser in an iframe. It's set to false by default.

singleSignOn.method

singleSignOn.genericPassword

singleSignOn.usernameKey

singleSignOn.passwordKey

singleSignOn.allowedRemoteAddresses

Set Up Acrolinx for Single Sign-on

sslKeystore

sslKeystorePassword

sslTruststore

sslTruststorePassword

Securing Acrolinx with HTTPS
termBrowser.authRequiredSecure access to the Acrolinx Term Browser

termContributionUrl.isEnabled

termContributionUrl.contextFieldName

Configure Term Contribution from the Acrolinx Scorecard.


termContribution.disableInternalTermContribution
termContributionUrl.template

Integrate Acrolinx with a Third-Party Terminology Solution
termContribution.authRequired

Enabling Anonymous Term Contribution.

termSearchLog.enableLog

Enable the term search log.

termSearchLog.enableProposalSubmission

termSearchLog.statusName

termSearchLog.domainName

termSearchLog.languageName

Enable users to propose terms from the search field in the Acrolinx Term Browser and configure the default settings for proposed terms.


TABLE 2. LANGUAGE CONFIGURATION PROPERTIES

You can use the properties in the following table to configure the checking behavior for a particular language. You configure these properties in the language configuration files: %ACROLINX_CONFIGURATION_ROOT%\data\<LANG_ID>\configuration.properties

PropertiesRelevant Topics
harvestingRules

Configuring Term Discovery Behavior.


lengthChecker.sentenceLength

Configuring the Maximum Length for the 'Sentence Too Long' Guideline.


lengthChecker.sentenceTooLongRuleName

lengthChecker.sentenceTooLongPhrase

Configuring how the ''Sentence Too Long' Guideline appears for Integration users.


reuse.overrideOtherFlags

Preventing Reuse Issues from Overriding Other Issues.


reuseSentenceHelp

sentenceTooLongHelp

spellCheckerHelp

Customizing the Location of Help Files.


terminology.sources

Configure Term Sets in the Language Configuration File.

termharvesting.onlyServerSide

Configuring Term Discovery Behavior.

terminology.markAdmittedTerms

terminology.scoreAdmittedTerms

useCustomizableAdmittedTermFlag

suggestAdmittedTerms

Configure the Checking Behavior for Admitted Terms


TABLE 3. OTHER PROPERTIES

You can use the properties in the following table to configure the component that is included in parentheses after the property name.

PropertiesRelevant Topics
coreServerEndpointUrl

(language server properties)

%ACROLINX_CONFIGURATION_ROOT%\server\bin\ls-<ID>.properties

Changing the Core Server Address.

pool

(master language configuration file)

%ACROLINX_CONFIGURATION_ROOT%\data\configurations.properties

Adjusting the Allocation of Language Configurations, and Dedicating Language Configurations.

termhelp.template.root

(Term Browser properties)

%ACROLINX_CONFIGURATION_ROOT%\data\termbrowser.properties

Configuring the Location of the Term Help Templates.


wrapper.logfile.maxsize

(wrapper logging configuration file)

%ACROLINX_CONFIGURATION_ROOT%\server\bin\wrapper.logging.conf

Changing Range Logging History.

wrapper.logfile.maxfiles

(wrapper logging configuration file)

%ACROLINX_CONFIGURATION_ROOT%\server\bin\wrapper.logging.conf

Changing Range Logging History.