[en] Each Acrolinx version comes with its own Helm chart version. It looks something like this: 1.0.3+2021.05. The version string is based on the version number of the operator and includes the platform version <operator version>+<platform version>. This will change with every release. You can keep track of this in our Standard Stack Compatibility Guide.

[en] To change the Helm chart version, do the following:

[en] It might look like this:

spec:
  repo: https://acrolinx.github.io/helm/
  chart: acrolinx-platform
  version: "x.x.x+xxxx.xx"

[en] When you first start working with Acrolinx, you'll receive a guidance package from us. It comes with customized writing guidance based on the requirements of your organization. This includes your company-specific style guidelines and terminology. You’ll find all available guidance package image builds in your Acrolinx download area.

[en] Your guidance package container image starts with the prefix acrolinx/guidance. A container image is a copy of a container — the files and components within it that make up an application. Once a container image is created, it forms a kind of template. This is used to create new apps or expand on and scale an existing app.

[en] After you identify your guidance package version, specify the name of your guidance package. The name appears after acrolinx/guidance/. For example, acrolinx in acrolinx/guidance/acrolinx.

[en] To specify the name of your guidance package, do the following:

[en] It might look like this:

spec:
  set:
    ### [...]
    platform.spec.guidance: "acrolinx:xxxx.xx-45078"

[en] Platform Image Pull Credentials

[en] Acrolinx distributes your Acrolinx Platform images via a private container registry. The credentials for that registry are temporary. You can get them and refresh them through the Acrolinx download area. The Helm installation does this automatically.

[en] Enter your credentials for your Acrolinx download area as follows:

[en] For example:

spec:
  set:
    ### [...]
    images.downloadAreaUser: "<user>"
    images.downloadAreaPwd: "<password>"

[en] It’s best if you run Acrolinx as a particular user, for example acrolinx, instead of with root privileges.

[en] Not sure what your user and group IDs are? Find them out as follows:

[en] To set the user ID and group ID, do the following:

[en] This might look something like this:

spec:
  set:
    ### [...]
    platform.spec.securityContext.runAsUser: uid
    platform.spec.securityContext.runAsGroup: gid

[en] Acrolinx comes with files that you can update and customize based on your needs. You can edit overlay copies of these files in your configuration directory to configure your Acrolinx installation. To store your platform configuration permanently, a configuration directory needs to exist on the machine that’s running the cluster. You'll need to mount that directory into the Acrolinx Platform.

[en] To mount that directory into the Acrolinx Platform, do the following:

[en] For example:

spec:
  set:
    ### [...]
    platform.spec.coreServer.overlayDirectory.volumeSource.hostPath.path: /home/acrolinx/config

[en] As part of the Acrolinx Platform definition, you can set the number of language servers and the language configurations they load. You’ll configure the language servers topology in the platform.spec.languageServers list.

[en] Each item in the list has the following subsettings:

[en] To configure your language servers, do the following:

 spec:
  ### [...]
  valuesContent: |-
    platform:
      spec:
        languageServers:
          - name: default
            languages: [ en, de, sv ]
            replicas: 1

[en] Acrolinx stores terminology, analytics, and reporting data in databases. When you install the Acrolinx Platform, the following come with a default database:

[en] Acrolinx freely distributes the default databases, but you should only use them for test purposes. Connect Acrolinx to a database other than the freely distributed database formats that come with the Acrolinx Platform.

[en] Disable the Test Database

[en] The containerized Acrolinx Platform comes with a built-in test database. This lets you start the platform immediately without any further configuration. You can use this database while you configure and test your installation.

[en] To disable the test database, do the following:

[en] For example:

spec:
  ### [...]
  valuesContent: |-
    platform:
      spec:
      ### [...]
        persistence:
        ### Set to `true` to install Postgres test databases into the cluster.
       ### Don't do that on a production system!!
          installTestDB: false

[en] Configure Production Database Connections

[en] To connect the server to external terminology and reporting databases, configure the connection settings in the persistence.properties. You can learn more in the following articles: