Zammad

https://github.com/zammad/zammad-documentation
Admin
Zammad is an open-source, web-based help desk and customer support system that consolidates...
Tokens:302,720
Snippets:1,464
Trust Score:7
License:AGPL-3.0
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Example output: Freshly started Zendesk import

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/migration/zendesk.rst

Example output from the status check command when the import has just started. The `finished_at` field is `nil`, indicating the process is still running.

```text
#<ImportJob:0x0000000008274310
   id: 1,
   name: "Import::Zendesk",
   dry_run: false,
   payload: {},
   result:
   {"Organizations"=>
      {"skipped"=>0,
      "created"=>0,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>0,
      "total"=>100}},
   started_at: Mon, 03 Jan 2022 18:41:51 UTC +00:00,
   finished_at: nil,
   created_at: Mon, 03 Jan 2022 18:41:16 UTC +00:00,
   updated_at: Mon, 03 Jan 2022 18:43:32 UTC +00:00>
```

--------------------------------

### Start Rails console shell (Package)

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/admin/console.rst

Starts an interactive Rails console for a Package installation, allowing multiple commands.

```console
$ zammad run rails c

```

--------------------------------

### Freshly Started Import Output

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/migration/freshdesk.rst

Example output of the import job status when the import has just started. The `finished_at` field is `nil`, indicating the process is still running.

```text
#<ImportJob:0x0000000008274310
   id: 1,
   name: "Import::Freshdesk",
   dry_run: false,
   payload: {},
   result:
   {"Organizations"=>
      {"skipped"=>0,
      "created"=>0,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>0,
      "total"=>100}},
   started_at: Mon, 03 Jan 2022 18:41:51 UTC +00:00,
   finished_at: nil,
   created_at: Mon, 03 Jan 2022 18:41:16 UTC +00:00,
   updated_at: Mon, 03 Jan 2022 18:43:32 UTC +00:00>
```

--------------------------------

### Kayako migration status output: freshly started

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/migration/kayako.rst

Example output of the migration status command when the import has just started. The 'finished_at' field is nil, indicating the process is still running.

```text
#<ImportJob:0x0000000008274310
   id: 1,
   name: "Import::Kayako",
   dry_run: false,
   payload: {},
   result:
   {"Organizations"=>
      {"skipped"=>0,
      "created"=>0,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>0,
      "total"=>100}},
   started_at: Mon, 03 Jan 2022 18:41:51 UTC +00:00,
   finished_at: nil,
   created_at: Mon, 03 Jan 2022 18:41:16 UTC +00:00,
   updated_at: Mon, 03 Jan 2022 18:43:32 UTC +00:00>
```

--------------------------------

### Start and enable Elasticsearch service

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/install/elasticsearch/install-elasticsearch-9.rst

Starts Elasticsearch and enables it to start on boot with systemd.

```console
$ sudo systemctl enable elasticsearch.service --now
```

--------------------------------

### Open Zammad console

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/migration/zendesk.rst

Open the Zammad console. Use the package installation command for package installations and the source installation command for source installations.

```console
$ zammad run rails c
```

```console
$ rails c
```

--------------------------------

### Install Zammad on OpenSUSE/SLES

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/install/package.rst

Refreshes repositories and installs Zammad on OpenSUSE/SLES.

```console
$ sudo zypper refresh
```

```console
$ sudo zypper install zammad
```

--------------------------------

### Install pgloader on OpenSUSE/SLES

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/appendix/migrate-to-postgresql.rst

Refreshes repositories and installs pgloader on OpenSUSE/SLES.

```console
$ sudo zypper refresh
```

```console
$ sudo zypper install pgloader
```

--------------------------------

### Install pgloader on CentOS

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/appendix/migrate-to-postgresql.rst

Installs pgloader on CentOS using dnf.

```console
$ sudo dnf install -y pgloader
```

--------------------------------

### Start Rails console shell (Source/Development)

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/admin/console.rst

Starts an interactive Rails console for a Source/Development installation, allowing multiple commands.

```console
$ rails c

```

--------------------------------

### Run pgloader migration

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/appendix/migrate-to-postgresql.rst

Starts the actual migration with verbose output.

```console
$ pgloader --verbose /tmp/pgloader-command
```

--------------------------------

### Build HTML documentation

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/README.md

Compile the documentation into HTML format. Run this command in the project root after installing dependencies.

```makefile
make html
```

--------------------------------

### Start Rails console shell (Docker)

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/admin/console.rst

Starts an interactive Rails console for a Docker installation, allowing multiple commands.

```console
$ docker compose run --rm zammad-railsserver bundle exec rails c

```

--------------------------------

### Debian nftables: Example ruleset with open ports

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/install/package.rst

An example /etc/nftables.conf file that defines a table with a filter hook for input, forward, and output chains. Includes rules to accept established connections, SSH, and HTTP/HTTPS (TCP & UDP). The policy for input is drop, so only matched traffic is allowed. Modify to match your environment.

```text
#!/usr/local/sbin/nft -f
flush ruleset

table inet filter {
   chain input {
      type filter hook input priority 0; policy drop;
      ct state established,related accept
      tcp dport ssh log accept
      tcp dport { http, https } accept
      udp dport { http, https } accept
   }

   chain forward {
      type filter hook forward priority 0; policy accept;
   }

   chain output {
      type filter hook output priority 0; policy accept;
   }
}

```

--------------------------------

### Install required tools on Ubuntu

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/install/package.rst

Install curl, apt-transport-https, and gnupg on Ubuntu using apt.

```console
$ sudo apt install curl apt-transport-https gnupg
```

--------------------------------

### Start Rails console in safe mode (Source)

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/admin/console.rst

Starts Rails console in safe mode for a Source installation by setting ZAMMAD_SAFE_MODE=1, ignoring third-party service availability.

```console
$ ZAMMAD_SAFE_MODE=1 rails c

```

--------------------------------

### Example output: Zendesk import half way

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/migration/zendesk.rst

Example output from the status check command when the import is halfway through. The `finished_at` field is still `nil`, indicating the process is still running.

```text
#<ImportJob:0x000055ba3d9dbbb8
   id: 1,
   name: "Import::Zendesk",
   dry_run: false,
   payload: {},
   result:
   {"Groups"=>
      {"skipped"=>0,
      "created"=>3,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>3,
      "total"=>3},
   "Organizations"=>
      {"skipped"=>0,
      "created"=>193,
      "updated"=>1,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>194,
      "total"=>194},
   "Users"=>
      {"skipped"=>0,
      "created"=>3352,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>3352,
      "total"=>3352},
   "Tickets"=>
      {"skipped"=>0,
      "created"=>987,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>987,
      "total"=>1000}},
   started_at: Tue, 04 Jan 2022 11:37:38 UTC +00:00,
   finished_at: nil,
   created_at: Tue, 04 Jan 2022 11:37:36 UTC +00:00,
   updated_at: Tue, 04 Jan 2022 12:12:52 UTC +00:00>
```

--------------------------------

### Start Rails console in safe mode (Package)

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/admin/console.rst

Starts Rails console in safe mode for a Package installation by setting ZAMMAD_SAFE_MODE=1, ignoring third-party service availability.

```console
$ ZAMMAD_SAFE_MODE=1 zammad run rails c

```

--------------------------------

### Install PostgreSQL on CentOS

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/appendix/migrate-to-postgresql.rst

Installs PostgreSQL server and contrib packages on CentOS, initializes the database, and enables the service.

```console
$ sudo dnf install postgresql-server postgresql-contrib
```

```console
$ sudo postgresql-setup initdb
```

```console
$ sudo systemctl start postgresql
```

```console
$ sudo systemctl enable postgresql
```

--------------------------------

### Install Sphinx dependencies

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/README.md

Install the required Python packages for building the documentation. Run this command in the project root after cloning the repository.

```bash
$ pip install -r requirements.txt
```

--------------------------------

### Set, get, and unset environment variables with zammad config

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/appendix/environment-variables.rst

Commands for setting, getting, and unsetting environment variables in package installations, followed by restarting Zammad to apply changes.

```console
$ zammad config:set OPTION=value
```

```console
$ zammad config:get OPTION
```

```console
$ zammad config:unset OPTION
```

```console
$ sudo systemctl restart zammad
```

--------------------------------

### Restore output example

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/appendix/backup-and-restore/restore.rst

Example output of a successful restore operation, showing the steps and confirmation messages.

```text
# Zammad restore started - Fri Jan 21 17:54:13 CET 2022!

The restore will delete your current database!
Be sure to have a backup available!

Please ensure to have twice the storage of the uncompressed backup size!

Note that the restoration USUALLY requires root permissions as services are stopped!

Enter 'yes' if you want to proceed!
Restore?: yes
Enter file date to restore:
20220120124714
20220121175344
File date: 20220121175344
Enter db date to restore:
20220120124714
20220121175344
DB date: 20220121175344
# Stopping Zammad
# Checking requirements
# ... Dropping current database zammad
Dropped database 'zammad'
# ... Creating database zammad for owner zammad
CREATE DATABASE
# Restoring PostgreSQL DB
# Restoring Files
# Ensuring correct file permissions ...
# Clearing Cache ...
# Starting Zammad

# Zammad restored successfully - Fri Jan 21 17:54:34 CET 2022!
```

--------------------------------

### Start Zendesk migration

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/migration/zendesk.rst

Start the actual migration by creating an ImportJob and performing it asynchronously.

```irb
>> job = ImportJob.create(name: 'Import::Zendesk')
```

```irb
>> AsyncImportJob.perform_later(job)
```

--------------------------------

### Show Calendar API - Response Example

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/api/calendar.rst

A GET request to /api/v1/calendars/{id} returns the calendar details. The example response includes business hours, public holidays, and metadata. Requires the admin.calendar permission.

```json
Status: 200 Ok

{
   "id":2,
   "name":"Test calendar",
   "timezone":"Europe/Berlin",
   "business_hours":{
      "mon":{
         "active":true,
         "timeframes":[
            [
               "09:00",
               "17:00"
            ]
         ]
      },
      "tue":{
         "active":true,
         "timeframes":[
            [
               "09:00",
               "17:00"
            ]
         ]
      },
      "wed":{
         "active":true,
         "timeframes":[
            [
               "09:00",
               "17:00"
            ]
         ]
      },
      "thu":{
         "active":true,
         "timeframes":[
            [
               "09:00",
               "17:00"
            ]
         ]
      },
      "fri":{
         "active":true,
         "timeframes":[
            [
               "09:00",
               "17:00"
            ]
         ]
      },
      "sat":{
         "active":false,
         "timeframes":[
            [
               "10:00",
               "14:00"
            ]
         ]
      },
      "sun":{
         "active":false,
         "timeframes":[
            [
               "10:00",
               "14:00"
            ]
         ]
      }
   },
   "default":false,
   "ical_url":"",
   "public_holidays":{
      "2021-11-10":{
         "active":true,
         "summary":"Feast day 1"
      },
      "2021-11-11":{
         "active":true,
         "summary":"Feast day 2"
      }
   },
   "last_log":null,
   "last_sync":"2021-11-10T13:14:20.835Z",
   "updated_by_id":3,
   "created_by_id":3,
   "created_at":"2021-11-10T13:14:20.835Z",
   "updated_at":"2021-11-10T13:14:20.835Z"
}
```

--------------------------------

### Show Object Manager Attribute - Response Example

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/api/object.rst

Example response from the GET /api/v1/object_manager_attributes/{id} endpoint. Shows the structure of an object attribute object, including metadata like id, name, display, data_type, and screens.

```json
{
   "id": 18,
   "object_lookup_id": 1,
   "name": "email",
   "display": "Email",
   "data_type": "input",
   "data_option": {
      "type": "email",
      "maxlength": 150,
      "null": true,
      "item_class": "formGroup--halfSize"
   },
   "data_option_new": {},
   "editable": false,
   "active": true,
   "screens": {
      "signup": {
         "-all-": {
            "null": false
         }
      },
      "invite_agent": {
         "-all-": {
            "null": false
         }
      },
      "invite_customer": {
         "-all-": {
            "null": false
         }
      },
      "edit": {
         "-all-": {
            "null": true
         }
      },
      "create": {
         "-all-": {
            "null": true
         }
      },
      "view": {
         "-all-": {
            "shown": true
         }
      }
   },
   "to_create": false,
   "to_migrate": false,
   "to_delete": false,
   "to_config": false,
   "position": 400,
   "created_by_id": 1,
   "updated_by_id": 1,
   "created_at": "2021-11-09T13:12:32.784Z",
   "updated_at": "2021-11-09T13:12:32.784Z"
}
```

--------------------------------

### Install Apache dependencies (OpenSUSE)

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/appendix/single-sign-on.rst

Installs krb5-client and apache2-mod_auth_kerb for Kerberos support on OpenSUSE.

```console
$ sudo zypper install krb5-client apache2-mod_auth_kerb
```

--------------------------------

### Restore NGINX after aborting tutorial

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/appendix/single-sign-on.rst

Commands to stop and disable Apache and re-enable NGINX if the tutorial cannot be completed. Run as root or with sudo.

```console
$ sudo systemctl stop apache2
```

```console
$ sudo systemctl disable apache2
```

```console
$ sudo systemctl enable nginx
```

```console
$ sudo systemctl start nginx
```

--------------------------------

### GET /api/v1/audit_logs response example

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/api/audit_log.rst

Example JSON response from the audit log endpoint. Shows entries with fields like id, user_id, action_type, auditable_type, value_from, value_to, source_ip, and timestamps. The response is an array of audit log entries.

```json
# HTTP-Code 200 Ok

[
  {
    "id": 1,
    "user_id": 3,
    "user_fullname": "Christopher Miller",
    "action_type": "create",
    "auditable_type": "ChecklistTemplate",
    "auditable_id": 1,
    "auditable_name": "Onboarding",
    "value_from": {},
    "value_to": {
      "name": "Onboarding",
      "active": true,
      "sorted_item_names": [
        "Buy chair",
        "Coffee briefing",
        "Create accounts"
      ]
    },
    "source_ip": "172.19.0.1",
    "preferences": {},
    "created_at": "2026-07-23T09:14:51.650Z",
    "updated_at": "2026-07-23T09:14:51.650Z"
  },
  {
    "id": 2,
    "user_id": 3,
    "user_fullname": "Christopher Miller",
    "action_type": "update",
    "auditable_type": "Setting",
    "auditable_id": 280,
    "auditable_name": "ai_provider",
    "value_from": {
      "area": "AI::Provider",
      "name": "ai_provider",
      "title": "AI provider",
      "options": {},
      "frontend": true,
      "description": "Defines if the AI provider is configured.",
      "state_current": {
        "value": true
      },
      "state_initial": {
        "value": false
      }
    },
    "value_to": {
      "area": "AI::Provider",
      "name": "ai_provider",
      "title": "AI provider",
      "options": {},
      "frontend": true,
      "description": "Defines if the AI provider is configured.",
      "state_current": {
        "value": false
      },
      "state_initial": {
        "value": false
      }
    },
    "source_ip": "172.19.0.1",
    "preferences": {
      "changed_attributes": [
        "state_current"
      ]
    },
    "created_at": "2026-07-23T09:14:59.501Z",
    "updated_at": "2026-07-23T09:14:59.501Z"
  },
  {
    "id": 3,
    "user_id": 3,
    "user_fullname": "Christopher Miller",
    "action_type": "update",
    "auditable_type": "Role",
    "auditable_id": 2,
    "auditable_name": "Agent",
    "value_from": {},
    "value_to": {
      "permissions": [
        "admin.text_module"
      ],
      "group_permissions": {
        "2nd Level": [
          "full"
        ],
        "Service Desk": [
          "full"
        ]
      }
    },
    "source_ip": "172.19.0.1",
    "preferences": {},
    "created_at": "2026-07-23T09:16:30.188Z",
    "updated_at": "2026-07-23T09:16:30.188Z"
  },
  {
    "id": 4,
    "user_id": 3,
    "user_fullname": "Christopher Miller",
    "action_type": "update",
    "auditable_type": "Setting",
    "auditable_id": 265,
    "auditable_name": "pgp_integration",
    "value_from": {
      "area": "Integration::Switch",
      "name": "pgp_integration",
      "title": "PGP integration",
      "options": {
        "form": [
          {
            "tag": "boolean",
            "name": "pgp_integration",
            "null": true,
            "display": "",
            "options": {
              "true": "yes",
              "false": "no"
            }
          }
        ]
      },
      "frontend": true,
      "description": "Defines if PGP encryption is enabled or not.",
      "state_current": {
        "value": false
      },
      "state_initial": {
        "value": false
      }
    },
    "value_to": {
      "area": "Integration::Switch",
      "name": "pgp_integration",
      "title": "PGP integration",
      "options": {
        "form": [
          {
            "tag": "boolean",
            "name": "pgp_integration",
            "null": true,
            "display": "",
            "options": {
              "true": "yes",
              "false": "no"
            }
          }
        ]
      },
      "frontend": true,
      "description": "Defines if PGP encryption is enabled or not.",
      "state_current": {
        "value": true
      },
      "state_initial": {
        "value": false
      }
    },
    "source_ip": "172.19.0.1",
    "preferences": {
      "changed_attributes": [
        "state_current"
      ]
    },
    "created_at": "2026-07-23T09:17:20.469Z",
    "updated_at": "2026-07-23T09:17:20.469Z"
  }
]
```

--------------------------------

### Update Docker Compose Installation

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/install/update.rst

Run these commands in sequence to update a Zammad Docker Compose installation. First, navigate to the zammad-docker-compose directory, then pull the latest Git changes, pull the Docker images, and finally start the containers with the updated images.

```console
$ cd zammad-docker-compose
```

```console
$ git pull
```

```console
$ docker compose pull
```

```console
$ docker compose up -d
```

--------------------------------

### Example output: Finished Zendesk import

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/migration/zendesk.rst

Example output from the status check command when the import has finished. The `finished_at` field is set, indicating the process is complete.

```text
#<ImportJob:0x0000561da0def350
   id: 1,
   name: "Import::Zendesk",
   dry_run: false,
   payload: {},
   result:
   {"Groups"=>
      {"skipped"=>0,
      "created"=>3,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>3,
      "total"=>3},
   "Organizations"=>
      {"skipped"=>0,
      "created"=>193,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>194,
      "total"=>194},
   "Users"=>
      {"skipped"=>0,
      "created"=>3352,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>0,
      "deactivated"=>0,
      "sum"=>3352,
      "total"=>3352},
   "Tickets"=>
      {"skipped"=>0,
      "created"=>4714,
      "updated"=>0,
      "unchanged"=>0,
      "failed"=>1,
      "deactivated"=>0,
      "sum"=>4715,
      "total"=>4715}},
   started_at: Tue, 04 Jan 2022 11:37:38 UTC +00:00,
   finished_at: Tue, 04 Jan 2022 14:30:57 UTC +00:00,
   created_at: Tue, 04 Jan 2022 11:37:36 UTC +00:00,
   updated_at: Tue, 04 Jan 2022 14:30:57 UTC +00:00>
```

--------------------------------

### Global Search Request

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/api/intro.rst

Example GET request to the global search endpoint, which searches across all object types without specifying an object.

```http
GET /api/v1/search?query=welcome
```

--------------------------------

### GET /api/v1/tickets/{ticket id}/shared_draft - Sample Response

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/api/ticket/shared_drafts.rst

Sample response for the GET request to /api/v1/tickets/{ticket id}/shared_draft. The response includes the shared draft ID, ticket attributes, and user assets. The base64 coded inline image is cut off in the example.

```json
# HTTP-Code 200 OK

{
   "shared_draft_id": 2,
   "assets": {
      "TicketSharedDraftZoom": {
         "2": {
            "id": 2,
            "ticket_id": 58,
            "new_article": {
               "body": "<div>Some text for a shared draft. <br></div><div><br></div><div>Some inline image:<img tabindex=\"0\" style=\"width: 1000px; max-width: 100%;\" src=\"data:image/jpeg;base64,/9j/4AAQSkZJRg[...]",
               "type": "email",
               "internal": false,
               "subtype": "",
               "in_reply_to": "",
               "to": "jane@doe.com",
               "cc": "",
               "subject": "",
               "from": "Christopher Miller",
               "ticket_id": 58,
               "content_type": "text/html",
               "sender_id": 1,
               "type_id": 1,
               "preferences": {
                  "security": {
                     "encryption": {},
                     "sign": {
                        "success": true
                     },
                     "type": "S/MIME"
                  }
               }
            },
            "ticket_attributes": {
               "group_id": "2",
               "owner_id": "4",
               "state_id": "2",
               "priority_id": "2"
            },
            "created_by_id": 3,
            "updated_by_id": 3,
            "created_at": "2023-08-18T13:28:13.279Z",
            "updated_at": "2023-08-18T13:28:13.279Z"
         }
      },
      "User": {
         "3": {
            "login_failed": 0,
            "last_login": "2023-08-18T12:31:24.645Z",
            "updated_by_id": 1,
            "id": 3,
            "organization_id": 2,
            "login": "chris@chrispresso.com",
            "firstname": "Christopher",
            "lastname": "Miller",
            "email": "chris@chrispresso.com",
            "image": "7a6a0d1d94ad2037153cf3a6c1b49a53",
            "image_source": null,
            "web": "",
            "phone": "",
            "fax": "",
            "mobile": "",
            "department": "",
            "street": "",
            "zip": "",
            "city": "",
            "country": "",
            "address": "",
            "vip": false,
            "verified": false,
            "active": true,
            "note": "",
            "source": null,
            "out_of_office": false,
            "out_of_office_start_at": null,
            "out_of_office_end_at": null,
            "out_of_office_replacement_id": null,
            "preferences": {
               "locale": "en-us",
               "notification_config": {
                  "matrix": {
                     "create": {
                        "criteria": {
                           "owned_by_me": true,
                           "owned_by_nobody": true,
                           "subscribed": true,
                           "no": false
                        },
                        "channel": {
                           "email": true,
                           "online": true
                        }
                     },
                     "update": {
                        "criteria": {
                           "owned_by_me": true,
                           "owned_by_nobody": true,
                           "subscribed": true,
                           "no": false
                        },
                        "channel": {
                           "email": true,
                           "online": true
                        }
                     },
                     "reminder_reached": {
                        "criteria": {
                           "owned_by_me": true,
                           "owned_by_nobody": false,
                           "subscribed": false,
                           "no": false
                        },
                        "channel": {
                           "email": true,
                           "online": true
                        }
                     },
                     "escalation": {
                        "criteria": {
                           "owned_by_me": true,
                           "owned_by_nobody": false,
                           "subscribed": false,
                           "no": false
                        },
                        "channel": {
                           "email": true,
                           "online": true
                        }
                     }
                  }
               },
               "intro": true,
               "theme": "light",
               "two_factor_authentication": {}
            },
            "created_by_id": 1,
            "created_at": "2023-07-26T08:44:48.807Z",
            "updated_at": "2023-08-18T12:31:24.670Z",
            "role_ids": [
            ]
         }
      }
   }
}
```

--------------------------------

### Install PostgreSQL on OpenSUSE/SLES

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/appendix/migrate-to-postgresql.rst

Refreshes repositories, installs PostgreSQL packages, and enables the service on OpenSUSE/SLES.

```console
$ sudo zypper refresh
```

```console
$ sudo zypper install postgresql postgresql-server postgresql-contrib
```

```console
$ sudo systemctl start postgresql
```

```console
$ sudo systemctl enable postgresql
```

--------------------------------

### Safe mode console response

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/admin/console.rst

Example output when starting Rails console in safe mode, showing a warning about ignored services and a Redis connection error.

```text
Zammad is running in safe mode. Any third party services like Redis are ignored.

There was an error trying to connect to Redis via redis://localhost:6379.
Please provide a Redis instance at localhost:6379 or set REDIS_URL to point to a different location.
＃<Redis::CannotConnectError: Error connecting to Redis on localhost:6379 (Errno::ECONNREFUSED)>
Loading production environment (Rails 6.1.7.3)
3.1.3 :001 >

```

--------------------------------

### Install Zammad (OpenSUSE)

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/appendix/backup-and-restore/migrate-hosts.rst

Installs the Zammad package on OpenSUSE after forced removal, completing the reinstall process.

```console
$ sudo zypper install zammad
```

--------------------------------

### Enable Apache site with a2ensite

Source: https://github.com/zammad/zammad-documentation/blob/pre-release/getting-started/configure-webserver.rst

Enables the Zammad site on Ubuntu, Debian, and openSUSE. Run after copying the sample config and adjusting server name and certificate paths.

```console
$ sudo a2ensite zammad
```
Tokens:
Raw