Znuny

https://github.com/znuny/manual
Admin
Znuny is an open-source, web-based service management and ticketing system used for customer...
Tokens:214,474
Snippets:1,974
Trust Score:8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example output of Admin::Package::RepositoryList

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/admin/packagemanagement/index.rst

Example output from the Admin::Package::RepositoryList command, showing available repositories and their packages. Use the 'Install' column to identify the exact package identifier for installation.

```default
Listing package repositories...
+----------------------------------------------------------------------------+
| 1) Name: Freebie Features
|    URL:  https://download.znuny.org/releases/packages
+----------------------------------------------------------------------------+
| 2) Name: Znuny Open Source Add-ons
|    URL:  https://addons.znuny.com/public
+----------------------------------------------------------------------------+

Listing package repository content...
+----------------------------------------------------------------------------+
| Package overview for repository Freebie Features:
+----------------------------------------------------------------------------+
| 1) Name:        CloneDB
|    Version:     7.2.1
|    Vendor:      Znuny GmbH
|    URL:         https://www.znuny.org/
|    License:     GNU AFFERO GENERAL PUBLIC LICENSE Version 3, November 2007
|    Description: Clones a Znuny database into an empty target database.
|    Install:     Freebie Features:CloneDB-7.2.1.opm
+----------------------------------------------------------------------------+
| 2) Name:        FAQ
|    Version:     7.2.1
|    Vendor:      Znuny GmbH
|    URL:         https://www.znuny.org/
|    License:     GNU AFFERO GENERAL PUBLIC LICENSE Version 3, November 2007
|    Description: FAQ/knowledge base.
|    Install:     Freebie Features:FAQ-7.2.1.opm
+----------------------------------------------------------------------------+
| 3) Name:        SystemMonitoring
|    Version:     7.2.1
|    Vendor:      Znuny
|    URL:         https://www.znuny.org/
|    License:     GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007
|    Description: Basic mail interface to System Monitoring Suites. Also provides deeper integration to Nagios and Icinga2 (acknowledge on lock and check script).
|    Install:     Freebie Features:SystemMonitoring-7.2.1.opm
+----------------------------------------------------------------------------+
| 4) Name:        Znuny-PrimarySecondary
|    Version:     7.2.3
|    Vendor:      Znuny GmbH
|    URL:         https://www.znuny.org/
|    License:     GNU AFFERO GENERAL PUBLIC LICENSE Version 3, November 2007
|    Description: Includes "Ticket Primary/Secondary" feature.
|    Install:     Freebie Features:Znuny-PrimarySecondary-7.2.3.opm
+----------------------------------------------------------------------------+

+----------------------------------------------------------------------------+
| Package overview for repository Znuny Open Source Add-ons:
+----------------------------------------------------------------------------+
| 1) Name:        GeneralCatalog
|    Version:     7.2.1
|    Vendor:      Znuny
|    URL:         https://www.znuny.org/
|    License:     GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007
|    Description: The General Catalog package.
|    Install:     Znuny Open Source Add-ons:GeneralCatalog-7.2.1.opm
+----------------------------------------------------------------------------+
| 2) Name:        ITSMConfigurationManagement
|    Version:     7.2.1
|    Vendor:      Znuny
|    URL:         https://www.znuny.org/
|    License:     GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007
```

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

### Access web installer

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/installation/index.rst

Start the web based installer by visiting this URL in a browser. Replace HOSTNAME with your server's hostname.

```text
http://HOSTNAME/znuny/installer.pl
```

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

### LDAP Authentication Backend Configuration Example

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/admin/usermanagement/user_backends/index.rst

Example configuration for an LDAP authentication backend. Ensure the Net::LDAP module is installed before use.

```perl
 # This is an example configuration for an LDAP auth. backend.
 # (take care that Net::LDAP is installed!)
 $Self->{'Customer::AuthModule1'} = 'Kernel::System::CustomerAuth::LDAP';
 $Self->{'Customer::AuthModule::LDAP::Host1'} = 'ldap.example.com';
 $Self->{'Customer::AuthModule::LDAP::BaseDN1'} = 'dc=example,dc=com';
 $Self->{'Customer::AuthModule::LDAP::UID1'} = 'uid';

# Check if the user is allowed to auth in a posixGroup
# (e. g. user needs to be in a group xyz to use Znuny)
 $Self->{'Customer::AuthModule::LDAP::GroupDN1'} = 'cn=znuny-allow,ou=posixGroups,dc=example,dc=com';
 $Self->{'Customer::AuthModule::LDAP::AccessAttr1'} = 'memberUid';

# for ldap posixGroups objectclass (just uid)
 $Self->{'Customer::AuthModule::LDAP::UserAttr1'} = 'UID';

# for non ldap posixGroups objectclass (full user dn)
 $Self->{'Customer::AuthModule::LDAP::UserAttr1'} = 'DN';

# The following is valid but would only be necessary if the
# anonymous user do NOT have permission to read from the LDAP tree
 $Self->{'Customer::AuthModule::LDAP::SearchUserDN1'} = '';
 $Self->{'Customer::AuthModule::LDAP::SearchUserPw1'} = '';

# in case you want to add always one filter to each ldap query, use
# this option. e. g. AlwaysFilter => '(mail=*)' or AlwaysFilter => '(objectclass=user)'
$Self->{'Customer::AuthModule::LDAP::AlwaysFilter1'} = '';

# in case you want to add a suffix to each customer login name, then
# you can use this option. e. g. user just want to use user but
# in your ldap directory exists user@domain.
 $Self->{'Customer::AuthModule::LDAP::UserSuffix1'} = '@domain.com';

# Net::LDAP new params (if needed - for more info see perldoc Net::LDAP)
 $Self->{'Customer::AuthModule::LDAP::Params1'} = {
     port    => 389,
     timeout => 120,
     async   => 0,
     version => 3,
 };
```

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

### Create Apache configuration symlink (RHEL based, source install)

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/installation/index.rst

For source installs, create a symbolic link to enable the Apache configuration. The RPM install already has this in place.

```bash
ln -s /opt/znuny/scripts/apache2-httpd.include.conf /etc/httpd/conf.d/znuny.conf
```

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

### Start services on Debian-based systems

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/updating/patchlevel.rst

Starts the web server, MTA, and creates Znuny's crontab to start the daemon. The daemon is not started manually; cron handles it.

```default
systemctl start apache2
# Start your local MTA, mostly Postfix, sometimes Exim or Sendmail
systemctl start postfix
# Create Znuny's crontab to start the daemon
su -c 'bin/Cron.sh start' - znuny
```

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

### Start services on RHEL-based systems

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/updating/patchlevel.rst

Starts the web server, MTA, and creates Znuny's crontab to start the daemon. The daemon is not started manually; cron handles it.

```default
systemctl start httpd
# Start your local MTA, mostly Postfix, sometimes Exim or Sendmail
systemctl start postfix
# Create Znuny's crontab to start the daemon
su -c 'bin/Cron.sh start' - znuny
```

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

### Shell commands to activate stat 10001 example

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/console/advanced_stats.rst

Commands to rename the distribution example file so that the example statistic 10001 is available. Run the commands as the application user, then run the stat 10001 (default on a new system).

```shell
su - <APP_USER>
cd var/stats/formatdefinition/excel
cp 10001.example.yml.dist 10001.yml
```

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

### Import Znuny GPG key for RPM installation

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/installation/index.rst

Imports the Znuny GPG key required for RPM installation on RHEL-based systems. Starting with version 7.3.2, RPMs are signed.

```bash
curl -LO https://download.znuny.org/znuny-release-key.asc
rpm --import znuny-release-key.asc
```

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

### TicketGet Operation Request

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/admin/webservices/examples/GenericTicketConnectorREST/index.rst

Example HTTP GET request to retrieve ticket data using a ticket ID and session ID.

```http
GET /znuny/nph-genericinterface.pl/Webservice/GenericTicketConnectorREST/Ticket/<ticket_id>?SessionID=<your_session_id> HTTP/1.1
Host: localhost
Accept: application/json
```

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

### Install a package with bin/znuny.Console.pl Admin::Package::Install

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/admin/packagemanagement/index.rst

Use this command to install a desired package from the repository. Replace the package identifier with the one from the list, e.g., 'Freebie Features:SystemMonitoring-7.2.1.opm'.

```bash
bin/znuny.Console.pl Admin::Package::Install "Freebie Features:SystemMonitoring-7.2.1.opm"
```

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

### Install a package locally with Admin::Package::Install

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/admin/packagemanagement/index.rst

Installs a package from a local OPM file. Replace the path with the actual location of your package file.

```bash
bin/znuny.Console.pl Admin::Package::Install /path/to/packages/SystemMonitoring-7.1.2.opm
```

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

### LDAP Authentication Backend Configuration Example

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/admin/usermanagement/user_backends/index.rst

Example configuration for an LDAP authentication backend in Znuny. Requires Net::LDAP to be installed. Sets the AuthModule to Kernel::System::Auth::LDAP and specifies LDAP host, BaseDN, UID, and optional group-based access control using GroupDN and AccessAttr. The UserAttr can be set to 'UID' for posixGroups objectclass or 'DN' for non-posixGroups.

```perl
# This is an example configuration for an LDAP auth. backend.
# (take care that Net::LDAP is installed!)
$Self->{AuthModule} = 'Kernel::System::Auth::LDAP';
$Self->{'AuthModule::LDAP::Host'} = 'ldap.example.com';
$Self->{'AuthModule::LDAP::BaseDN'} = 'dc=example,dc=com';
$Self->{'AuthModule::LDAP::UID'} = 'uid';

# Check if the user is allowed to auth in a posixGroup
# (e. g. user needs to be in a group xyz to use )
$Self->{'AuthModule::LDAP::GroupDN'} = 'cn=znuny-allow,ou=posixGroups,dc=example,dc=com';
$Self->{'AuthModule::LDAP::AccessAttr'} = 'memberUid';
# for ldap posixGroups objectclass (just uid)
$Self->{'AuthModule::LDAP::UserAttr'} = 'UID';
# for non ldap posixGroups objectclass (with full user dn)
$Self->{'AuthModule::LDAP::UserAttr'} = 'DN';
```

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

### Example file path for page navigation

Source: https://github.com/znuny/manual/blob/znuny-7_3/README.md

Example of a file path used to construct a page navigation link. The path is shown as a directory tree.

```screen
source\
  admin\
    email\
      postmaster_mail_account.rst
```

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

### Repository Upgrade via Console

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/admin/packagemanagement/index.rst

First update the repository to get the latest package list, then upgrade the desired package. The repository list command fetches available packages, and the upgrade command installs the specified version.

```bash
bin/znuny.Console.pl Admin::Package::RepositoryList
```

```bash
bin/znuny.Console.pl Admin::Package::Upgrade "Freebie Features:SystemMonitoring-7.2.1.opm"
```

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

### Example parameters available for use (VAR1 dump)

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/admin/automation/generic_agent/index.rst

Example dump of the parameters passed to the Run method, showing the structure of the %Param hash. Includes ticket search parameters, ticket data, and the 'New' hash containing changes made to the ticket.

```perl
VAR1 = {
         'EscalationTimeSearchType' => '',
         'ChangeTimeSearchType' => '',
         'MIMEBase_To' => '',
         'LastCloseTimeSearchType' => '',
         'TimePendingSearchType' => '',
         'EscalationResponseTimeSearchType' => '',
         'MIMEBase_From' => '',
         'ScheduleLastRun' => '2022-04-08 12:59:25',
         'LastChangeTimeSearchType' => '',
         'MIMEBase_Subject' => '',
         'TimeSearchType' => '',
         'MIMEBase_Body' => '',
         'TicketNumber' => '*',
         'EscalationUpdateTimeSearchType' => '',
         'New' => {                                ##### All the changes made to the ticket.
                    'SendNoNotification' => '0',
                    'ParamValue5' => '',
                    'ParamValue1' => 'A',
                    'Delete' => '0',
                    'ParamKey3' => 'Test3',
                    'PendingTimeType' => '60',
                    'ParamKey6' => '',
                    'Test' => 'A',
                    'PendingTime' => '',
                    'ParamValue3' => 'C',
                    'ParamValue2' => 'B',
                    'NoteTimeUnits' => '',
                    'ParamKey2' => 'Test2',
                    'ParamKey1' => 'Test',
                    'CustomerID' => '',
                    'Test3' => 'C',
                    'ParamKey5' => '',
                    'Note' => {
                                'Subject' => '[Ticket#2021012710123456] ',
                                'Body' => 'Test Note'
                              },
                    'Title' => '',
                    'NoteSubject' => '',
                    'Test2' => 'B',
                    'CustomerUserLogin' => '',
                    'ParamValue6' => '',
                    'NoteFrom' => '',
                    'Module' => 'Kernel::System::GenericAgent::SystemCommandExecution',
                    'ParamKey4' => '',
                    'ParamValue4' => '',
                    'NoteBody' => 'Test Body'
                  },
         'CustomerID' => '',
         'Valid' => '1',
         'CloseTimeSearchType' => '',
         'MIMEBase_Cc' => '',
         'EscalationSolutionTimeSearchType' => '',
         'Name' => 'Test',
         'CustomerUserLogin' => '',
         'Title' => '',
         'TicketID' => '1'
       };
```

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

### Enable services on RHEL based systems

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/installation/index.rst

Use systemctl to enable the MariaDB database and Apache HTTP server on boot for RHEL-based distributions.

```bash
systemctl enable mariadb httpd
```

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

### LDAP AuthSyncModule configuration example

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/admin/usermanagement/user_backends/index.rst

Example configuration for enabling LDAP user synchronization after successful authentication. Requires Net::LDAP to be installed. Sets the AuthSyncModule to 'Kernel::System::Auth::Sync::LDAP' and defines host, BaseDN, UID, optional search user credentials, an optional AlwaysFilter, and a UserSyncMap mapping LDAP fields to database fields. The SearchUserDN and SearchUserPw are only needed if the anonymous user lacks read permission. The AlwaysFilter can be a simple filter or a logical OR expression. The UserSyncMap values can be a list of LDAP fields, a single field name, or fixed strings prefixed with underscore.

```default
# --------------------------------------------------- #
# authentication sync settings                        #
# (enable agent data sync. after succsessful          #
# authentication)                                     #
# --------------------------------------------------- #
# This is an example configuration for an LDAP auth sync. backend.
# (take care that Net::LDAP is installed!)
$Self->{'AuthSyncModule'} = 'Kernel::System::Auth::Sync::LDAP';
$Self->{'AuthSyncModule::LDAP::Host'} = 'ldap.example.com';
$Self->{'AuthSyncModule::LDAP::BaseDN'} = 'dc=example,dc=com';
$Self->{'AuthSyncModule::LDAP::UID'} = 'uid';

# The following is valid but would only be necessary if the
# anonymous user do NOT have permission to read from the LDAP tree
$Self->{'AuthSyncModule::LDAP::SearchUserDN'} = '';
$Self->{'AuthSyncModule::LDAP::SearchUserPw'} = '';

# in case you want to add always one filter to each ldap query, use
# this option. e. g. AlwaysFilter => '(mail=*)' or AlwaysFilter => '(objectclass=user)'
# or if you want to filter with a logical OR-Expression, like AlwaysFilter => '(|(mail=*abc.com)(mail=*xyz.com))'
$Self->{'AuthSyncModule::LDAP::AlwaysFilter'} = '';

# AuthSyncModule::LDAP::UserSyncMap
# (map if agent should create/synced from LDAP to DB after successful login)
# you may specify LDAP-Fields as either
#  * list, which will check each field. first existing will be picked ( ["givenName","cn","_empty"] )
#  * name of an LDAP-Field (may return empty strings) ("givenName")
#  * fixed strings, prefixed with an underscore: "_test", which will always return this fixed string
$Self->{'AuthSyncModule::LDAP::UserSyncMap'} = {
    # DB -> LDAP
    UserFirstname => 'givenName',
    UserLastname  => 'sn',
    UserEmail     => 'mail',
};
```

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

### Start daemon

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/standardoperations/systemcloning/index.rst

Command to start the Znuny daemon.

```bash
bin/znuny.Console.pl Maint::Daemon::Start
```

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

### Install Perl modules on RHEL with yum

Source: https://github.com/znuny/manual/blob/znuny-7_3/source/installation/index.rst

Use this command on RHEL-based systems to install the missing Perl modules. Some modules are already installed with the RPM, so this completes the set. The command installs modules like Moo, Text::CSV_XS, YAML::XS, and others.

```default
yum install -y "perl(Moo)"  "perl(Text::CSV_XS)" "perl(YAML::XS)" "perl(ModPerl::Util)" "perl(Mail::IMAPClient)" "perl(JSON::XS)" "perl(Encode::HanExtra)" "perl(Crypt::Eksblowfish::Bcrypt)" "perl(Data::UUID)" "perl(Date::Format)" "perl(DateTime::TimeZone)" "perl(DateTime)" "perl(DBD::mysql)" "perl(DBI)" "perl(Hash::Merge)" "perl(Net::LDAP)" "perl(Net::DNS)" "perl(Template)" "perl(Template::Stash::XS)" "perl(XML::LibXML)" "perl(XML::LibXSLT)" "perl(XML::Parser)" "perl(Spreadsheet::XLSX)" "perl(Package::Stash)"
```

```default
cpanm JavaScript::Minifier::XS CSS::Minifier::XS iCal::Parser
```
Tokens:
Raw