Configuring Z ChatOps server

You can configure Z ChatOps server by editing the bnz-server.yaml file.

Before you begin

Make sure that you have configured your certificate. For details, see Configuring the certificate.

Procedure

Go to the Z ChatOps configuration directory.
- For container users:
  1. Go to the directory where you extract the IBM Z ChatOps container archive.
  2. Run the following command to open an interactive bash shell on the IBM Z ChatOps container that is running.
```
./bnzContainer.sh shell
```
  3. Go to the configuration directory.
```
cd config
```
    Tip: If you are familiar with docker/podman commands, you can use commands to open the interactive bash shell. You can also edit the configuration files directly in the mounted path of the zchatops-configuration-1144, zchatops-configuration-1143, zchatops-configuration-1142, zchatops-configuration-1141, or zchatops-configuration-114 volume.
- For native installation users:
```
cd $ZCHATOPS_HOME/config
```

Edit the bnz-server.yaml file. Replace the default values according to your needs, for example, your chat tool. You can also enable the web chat feature or AI-based incident explanations.

# ********************************************************************************
# Licensed Materials - Property of IBM
# IBM Z ChatOps Copyright IBM Corp. 2020, 2025
#
# All Rights Reserved
# US Government Users Restricted Rights - Use, duplication or
# disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
# ********************************************************************************

# This file controls all configurations of the chatbot server for IBM Z ChatOps

# Configure microservice
microservice:
  # Specify the port number of your microservice server.
  # The default value is 4001.
  port: 4001

# Configure logging
log:
  # Specify the level of logs, the value can be error, warn, info, verbose, debug or silly.
  # The default value is info.
  level: info

  # Specify the maximum size of the file after which it will rotate. The value can be a number of bytes without any unit
  # or a number suffixed with 'k', 'm', or 'g' as units of kb, mb, or gb separately.
  # The default value is null, which means the file size is unlimited except operating system limit.
  maximumSize: null

  # Specify the maximum file number of logs to keep.
  # The default value is null, which means only one log file and no logs will be removed.
  maximumFiles: null

  # Specify whether the console output is suppressed or not. The value can be true or false.
  # The default value is true, which means the console output is suppressed.
  consoleSilent: true

chatBot:
  # Specify the chat tool, the value can be mattermost, slack or msteams.
  # The default value is mattermost.
  chatTool: mattermost
  # Enable web chat
  # The default value is false
  webChat: false
  # Enable watsonx Assistant for Z RAG API
  # The default value is false
  enableIncidentExplanation: false
# Specify the maximum number of resources that chatbot can retrieve for you
limit: 10

What to do next

For Microsoft Teams users only: you need to complete the messaging endpoint configuration before you can use Z ChatOps. For details, see Configuring messaging endpoint for Microsoft Teams.