Redis authentication

To set up Redis Server and Redis Sentinel with authentication for when users of the database and messaging service are required to identify themselves, use the following procedure.

Redis Server setup

After installing the mdx-backend-redis package, edit /etc/mdx/mdx-backend-redis.conf (for more information, see Configuration for IPLM Core before 2025.3):

  • Set the bind directive to the interfaces Redis Server is to bind to

  • Keep the protected-mode directive commented or uncomment it and set it to yes

  • If using Redis in a High Availability (multi-node) deployment, uncomment the masterauth directive and set it to the desired Redis Server password

  • Uncomment the requirepass directive and set it to the desired Redis Server password

If mdx-backend-redis.conf must be modified after the mdx-backend-redis service is running, first stop the service, then edit mdx-backend-redis.conf, then restart the service.

Redis Sentinel setup

If using Redis in a High Availability (multi-node) deployment, after installing the mdx-backend-sentinel package, edit /etc/mdx/mdx-backend-sentinel.conf (for more information, see Configuration for IPLM Core before 2025.3):

  • Set the bind directive to the interfaces Redis Sentinel is to bind to

  • Set the protected-mode directive to yes

  • Uncomment the requirepass directive and set it to the desired Redis Sentinel password

  • Uncomment the sentinel auth-pass mymaster directive and set it to the Redis Server password set in mdx-backend-redis.conf

If mdx-backend-sentinel.conf must be modified after the mdx-backend-sentinel service is running, first stop the service, then edit mdx-backend-sentnel.conf, then restart the service.

PiServer setup

To setup PiServer to publish events to Redis (for more information, see IPLM Server configuration), edit /etc/mdx/piserver.yml by uncommenting the redis:redisPassword setting and setting it to the Redis Server password set in mdx-backend-redis.conf. If Redis Sentinel is used and is set with a password, also uncomment the redis: sentinelPassword setting and set it to the Redis Sentinel password set in mdx-backend-sentinel.conf.

At this point, the piserver service can be started or restarted if it is already running.

PiCache setup

Create a file containing the Redis Server and Redis Sentinel (if used) passwords. For example, /etc/mdx/redis-credentials-file.txt. In this file, put the Redis Server password on the first line and the Redis Sentinel password (if used) on the second line.

Edit the IPLM Cache configuration file, /etc/mdx/picache.conf, uncommenting the redis-credentials-file setting and setting it to the path of the above file. For example:

redis-credentials-file = /etc/mdx/redis-credentials-file.txt

At this point, the picache service can be started or restarted if it is already running.