Deployment

Required configurations

Not all features are active by default, and therefore don't necessarily need to be configured.

Others, on the other hand, do require configuration during deployment.

These features are as follows:

• Database configuration

Example

The most basic deployment should include an image and the environment variables for the database connection.

If necessary, add configuration elements such as port forwarding, container name, hostname, etc.

---
version: "3"

services:
  app:
    image: ghcr.io/fr-bez-aosc/znuny:beta-6.5.8
    container_name: znuny
    ports:
      - 8080:80
    environment:
      ZNUNY_DATABASE_HOST: db
      ZNUNY_DATABASE_PORT: 5432
      ZNUNY_DATABASE_NAME: znuny
      ZNUNY_DATABASE_USER: znuny
      ZNUNY_DATABASE_PASSWORD: password

Optional configurations

Deployment of the containerized application is fully configurable via environment variables.

Each feature therefore has a variable capable of enabling or disabling it, and customizing its configuration.

Mails

Example

---
version: "3"

services:
  app:
    image: ghcr.io/fr-bez-aosc/znuny:beta-6.5.8
    container_name: znuny
    ports:
    - 8080:80
    environment:
      ZNUNY_DATABASE_HOST: db
      ZNUNY_DATABASE_PORT: 5432
      ZNUNY_DATABASE_NAME: znuny
      ZNUNY_DATABASE_USER: znuny
      ZNUNY_DATABASE_PASSWORD: password
      ZNUNY_MAILING_TYPE: external
      ZNUNY_MAILING_HOST: smpt.domain.tld
      ZNUNY_MAILING_PORT: 25
      ZNUNY_MAILING_USER: znuny
      ZNUNY_MAILING_PASSWORD: password

Info

To enable mail sending via an external server, the ZNUNY_MAILING_TYPE variable must be set to external.
Otherwise, this variable will be set to internal and all other mail configuration variables will be ignored when the application will be configured.

Logs

Example

---
version: "3"

services:
  app:
    image: ghcr.io/fr-bez-aosc/znuny:beta-6.5.8
    container_name: znuny
    ports:
    - 8080:80
    environment:
      ZNUNY_DATABASE_HOST: db
      ZNUNY_DATABASE_PORT: 5432
      ZNUNY_DATABASE_NAME: znuny
      ZNUNY_DATABASE_USER: znuny
      ZNUNY_DATABASE_PASSWORD: password
      ZNUNY_LOG_PATH: /var/log/znuny

Info

By default, the application Znuny uses Rsyslog to manage its logging.
However, with this method, the amount of logging is often low or non-existent.
The variable ZNUNY_LOG_PATH allows you to dispense with Rsyslog for log management. The application will simply write to a single log file, whose path can be customized.

The Znuny application does not write all its activity in its log files.
Only actions performed via the application's command line are logged.
Daemon and cron logs are output directly in the standard json container output.

Apache

Example

---
version: "3"

services:
  app:
    image: ghcr.io/fr-bez-aosc/znuny:beta-6.5.8
    container_name: znuny
    ports:
    - 8080:80
    environment:
      ZNUNY_DATABASE_HOST: db
      ZNUNY_DATABASE_PORT: 5432
      ZNUNY_DATABASE_NAME: znuny
      ZNUNY_DATABASE_USER: znuny
      ZNUNY_DATABASE_PASSWORD: password
      ZNUNY_APACHE_DOMAIN: znuny.domain.tld
      ZNUNY_APACHE_REWRITE_RULES: |-
        RewriteRule ^/$ http://%{HTTP_HOST}/otrs/customer.pl
        RewriteRule ^/otrs/$ http://%{HTTP_HOST}/otrs/customer.pl
        RewriteRule ^/otrs$ http://%{HTTP_HOST}/otrs/customer.pl

Info

If required, you can set up a web domain for the virtualhost of the Apache2 server.
This can be especially useful if you want to have a record of it in the server logs.
If no domain is specified, then the Apache2 server will be configured with a "default" value for the virtualhost's ServerNmae option.

If required, you can also configure request rewriting rules directly in the virtualhost configuration.

Local user

Example

---
version: "3"

services:
  app:
    image: ghcr.io/fr-bez-aosc/znuny:beta-6.5.8
    container_name: znuny
    ports:
    - 8080:80
    environment:
      ZNUNY_DATABASE_HOST: db
      ZNUNY_DATABASE_PORT: 5432
      ZNUNY_DATABASE_NAME: znuny
      ZNUNY_DATABASE_USER: znuny
      ZNUNY_DATABASE_PASSWORD: password
      ZNUNY_USER_ADMIN_NAME: root@localhost
      ZNUNY_USER_ADMIN_PASSWORD: password

Info

Local administrator user configuration only works if LDAP agent configurations are not specified.
If agent LDAP configurations are defined, those of the local administrator user become obsolete.

Addons

Example

---
version: "3"

services:
  app:
    image: ghcr.io/fr-bez-aosc/znuny:beta-6.5.8
    container_name: znuny
    ports:
    - 8080:80
    environment:
      ZNUNY_DATABASE_HOST: db
      ZNUNY_DATABASE_PORT: 5432
      ZNUNY_DATABASE_NAME: znuny
      ZNUNY_DATABASE_USER: znuny
      ZNUNY_DATABASE_PASSWORD: password
      ZNUNY_ADDONS: https://download.znuny.org/releases/packages:Survey,https://addons.znuny.com/public:Znuny-HealthStatus

Info

Extensions must be formatted with the repository as well as their name. The ZNUNY_ADDONS variable supports a comma-separated list.

The example above supports the following extensions :

• https://download.znuny.org/releases/packages:Survey
• https://addons.znuny.com/public:Znuny-HealthStatus

Authentications

Example

---
version: "3"

services:
  app:
    image: ghcr.io/fr-bez-aosc/znuny:beta-6.5.8
    container_name: znuny
    ports:
    - 8080:80
    environment:
      ZNUNY_DATABASE_HOST: db
      ZNUNY_DATABASE_PORT: 5432
      ZNUNY_DATABASE_NAME: znuny
      ZNUNY_DATABASE_USER: znuny
      ZNUNY_DATABASE_PASSWORD: password
      ZNUNY_AUTHENTICATIONS_BACKENDS: |-
        $Self->{CustomerUser1} = {
          Name => 'LDAP Data Source',
          Module => 'Kernel::System::CustomerUser::LDAP',
          Params => {
            Host => 'ldaps://openldap.default.svc.cluster.local',
            BaseDN => 'o=client,ou=People,dc=domain,dc=tld',
            SSCOPE => 'sub',
            UserDN => 'cn=znuny,ou=applications,dc=domain,dc=tld',
              UserPw => 'password',
              DestCharset => 'utf-8',
              SourceCharset => 'utf-8',
              AlwaysFilter => '',
              Params => {
                  port => 686,
                  timeout => 120,
                  async => 0,
                  version => 3,
              },
        },
        (...)