Для быстрой и простой установки см. также: Краткое руководство по установке.
Информация и процедуры, описанные в данном руководстве по установке, относятся к версии 2.x программы Benno MailArchiv.
Данное руководство по установке решения для архивирования электронной почты Benno MailArchiv описывает все необходимые шаги, которые следует выполнить последовательно для правильной установки приложения Benno MailArchiv на серверную систему. Это руководство по установке действительно исключительно для версии программного обеспечения Benno MailArchiv 2.x.
Строгое соблюдение этих подробных инструкций по установке имеет важное значение, особенно для настройки решения, обеспечивающего архивирование всех коммерческих и налоговых электронных писем в соответствии с немецким законодательством и требованиями GoBD. Эти инструкции по установке являются частью процессуальной документации для архивирования электронной почты в соответствии с законодательством, если такое архивирование осуществляется.
ВАЖНОЕ ЗАМЕЧАНИЕ:
Настоящим мы особо подчеркиваем, что архивирование всех коммерчески и налогово значимых электронных писем в соответствии с требованиями GoBD и с соблюдением всех технических норм невозможно осуществить исключительно путем выполнения описанных здесь шагов установки! Согласно GoBD, все программные продукты для архивирования электронной почты (такие как Benno MailArchiv и другие) представляют собой лишь часть решения для архивирования электронной почты в соответствии с законодательством и не являются самостоятельным решением!
Для настройки архивирования электронной почты, соответствующего требованиям немецких общепринятых принципов бухгалтерского учета (GoBD), абсолютно необходимы дополнительные нетехнические и организационные меры, выходящие за рамки самого программного обеспечения. В частности, необходимо создать соответствующую процедурную документацию, отвечающую требованиям GoBD. Эта процедурная документация не будет далее обсуждаться в данном руководстве по установке или в этой вики.
Соответствующая технологическая документация может быть создана только после консультации с квалифицированным специалистом и разрабатывается индивидуально для каждого клиента. Если у вас возникнут вопросы, пожалуйста, свяжитесь с нашим сертифицированным партнером Benno MailArchiv напрямую с нами .
Как наши сертифицированные партнеры, так и мы сами оказываем квалифицированную поддержку в создании процессной документации с учетом всех других соответствующих аспектов GoBD.
Более подробную информацию можно найти в наших двух аналитических отчетах:
Белая книга: Что означает соответствие требованиям GoBD?
Белая книга: Правовые аспекты архивирования электронной почты в соответствии с законодательством
По всем дополнительным вопросам обращайтесь по электронной почте: support@benno-mailarchiv.de
В этом руководстве по установке описывается, как настроить Benno MailArchiv 2.x в типичной однопользовательской конфигурации. Настройка и управление многопользовательской конфигурацией описаны здесь . При необходимости наша команда профессиональных услуг с удовольствием предоставит вам более подробную информацию.
Для работы Benno MailArchiv требуется операционная система Linux. Кроме того, Benno MailArchiv требует Java в качестве среды выполнения. Веб-приложение Benno MailArchiv требует PHP в качестве среды выполнения. Perl необходим для управления пользователями из командной строки. Все подробности описаны ниже.
Benno MailArchiv работает на удивление быстро даже на относительно небольшом оборудовании. Для определения подходящей мощности оборудования необходимо изучить индивидуальные требования и обстоятельства. Эта статья в блоге дать представление о производительности. Здесь случайно выбранные электронные письма были заархивированы и проиндексированы в полном тексте на старом ноутбуке, достигнув средней пропускной способности 13,5 писем в секунду. Требования к оборудованию для Benno MailArchiv зависят в первую очередь от следующих параметров: количество писем для архивирования за единицу времени (например, объем электронной почты или желаемая пропускная способность в минуту), среднее количество и размер писем, сжимаемость вложений (изображения JPEG, ZIP-файлы и т. д. уже являются сжатыми файлами данных; документы Office и текстовые файлы, как правило, сжимаются гораздо эффективнее), количество и интенсивность одновременных обращений к веб-приложению и т. д. Как правило, применяются следующие минимальные требования: процессор: двухъядерный или четырехъядерный, оперативная память: 4 ГБ , место на жестком диске: по мере необходимости (любая технология (локальные жесткие диски, NAS, SAN и т. д.)).
Список операционных систем, разрешенных для установки Benno MailArchiv, можно найти здесь.
Для работы бэкэнда Benno MailArchiv и REST-интерфейса требуется среда Java. Для этого на сервере должна быть установлена актуальная версия OpenJDK.
Среда выполнения веб-приложения Benno MailArchiv: Фронтенд Benno MailArchiv реализован с использованием PHP и HTML- шаблонов с каскадными таблицами стилей ( CSS ). Для работы требуется актуальная версия PHP и веб-сервер.
Benno MailArchiv 2.x состоит из компонентов, указанных на приведенном выше рисунке. Эти компоненты разделены на следующие установочные пакеты:
Пакет benno-lib содержит библиотеки для базовой установки Benno MailArchiv.
Пакет benno-core предоставляет основные функции для Benno MailArchiv. Пакет benno-core необходим как для архивирования, так и для запросов к архиву через REST-интерфейс.
Пакет benno-archive включает функции импорта электронных писем в архив. benno-archive управляет каталогом очереди писем (по умолчанию: /srv/benno/inbox). Все найденные там файлы *.eml автоматически импортируются, архивируются, а затем (после успешного завершения операции архивирования) удаляются из каталога очереди писем.
Пакет benno-rest-lib предоставляет библиотеки для REST-интерфейса Benno MailArchiv.
Пакет benno-rest включает в себя REST-интерфейс Benno MailArchiv.
Пакеты Benno MailArchiv доступны в разделе загрузок на сайте Benno MailArchiv.
Раздел для загрузки находится в свободном доступе. Программное обеспечение можно загрузить в любое время. Использование Benno MailArchiv регулируется нашими действующими лицензионными условиями. Без действительного лицензионного ключа функциональность Benno MailArchiv ограничена.
Во время установки необходимо запросить у LWsystems действительный лицензионный ключ (подробности см. ниже). Лицензионный ключ дает пользователю право использовать программное обеспечение постоянно и без ограничений по времени. В течение (обычно одного года) периода технического обслуживания программного обеспечения можно в любое время установить последние версии пакета Benno MailArchiv 2.x. Если на существующий сервер установлены более новые версии программного обеспечения без действующего периода технического обслуживания, система переходит в демонстрационный режим (с ограниченной функциональностью) до тех пор, пока не будет установлен новый действительный лицензионный ключ для данной версии или не будет установлена более старая версия, совместимая с периодом технического обслуживания лицензионного ключа.
Для установки Benno MailArchiv на Debian, Ubuntu или UCS можно использовать систему управления пакетами соответствующего дистрибутива.
Benno MailArchiv доступно в центре приложений Univention Appcenter
В системах на основе Debian используется GNU Privacy Guard (GPG) для проверки подлинности исходных кодов пакетов. Следующие команды добавляют ключ исходного кода пакета Benno MailArchiv в вашу систему:
wget -O /etc/apt/trusted.gpg.d/benno-mailarchiv-archive-key-40.asc \ https://www.benno-mailarchiv.de/download/benno-mailarchiv-archive-key-40.asc
Для установки Benno MailArchiv достаточно добавить в вашу систему Linux еще один источник пакетов. Системы под управлением Debian 13 (Trixie) или более поздних версий должны быть настроены с использованием текущего формата deb822
cat - >> /etc/apt/sources.list.d/benno-mailarchiv.sources <
cat - >> /etc/apt/sources.list.d/benno-mailarchiv.list <
После добавления источника пакета Benno MailArchiv в систему и ключа подписи в менеджер пакетов, необходимо обновить списки пакетов с помощью следующей команды: `apt-get update`. После этого Benno MailArchiv можно установить через менеджер пакетов Debian/Ubuntu/UCS
apt-get установить benno-archive benno-rest benno-web
В процессе установки автоматически создаются два пользователя: benno и bennorest . Бэкенд Benno MailArchiv (архивирование) запускается от имени пользователя benno, а демон Benno Rest — от имени пользователя bennorest.
Описание установки для любого дистрибутива Linux можно найти в разделе « Установка из TGZ-пакетов» .
Для запуска Benno MailArchiv в типичной однопользовательской среде необходимо выполнить следующие настройки конфигурации. Базовая настройка Benno MailArchiv выполняется с помощью следующих конфигурационных файлов: /etc/benno/benno.xml и /etc/benno-web/benno.conf
Benno MailArchiv устанавливается и настраивается по умолчанию в процессе установки, что обеспечивает немедленную готовность к использованию. Для запуска Benno MailArchiv требуется всего одна настройка: создайте файл /etc/benno-web/rest.conf и добавьте строку вида SHARED_SECRET = YourPassword . Введите общий секретный ключ длиной не менее 20 символов , состоящий из случайных чисел и букв по вашему выбору. Общий секретный ключ не содержать немецких умлаутов (ä, ö, ü, Ä, Ö, Ü, ß) или специальных символов!
Создать файл можно, введя в консоли следующие команды:
echo 'verySecretAndSecurePassword' > /etc/benno/rest.secret history -c chown benno.benno /etc/benno/rest.secret chmod 0440 /etc/benno/rest.secret
Введите точно такой же общий секрет с префиксом SHARED_SECRET = в файл /etc/benno-web/rest.conf .
echo 'SHARED_SECRET = wholeSecretAndSecurePassword' > /etc/benno-web/rest.conf history -c chgrp www-data /etc/benno-web/rest.conf chmod 0440 /etc/benno-web/rest.conf
После установки общего секрета необходимо запустить демон Benno REST, чтобы обеспечить доступ через веб-приложение: systemctl start benno-rest
Запуск REST-демона записывается в файл /var/log/benno/rest.log :
2012-03-21 13:42:19,848 INFO Запуск сервера Jetty из файла /etc/benno/jetty.xml
Если общий секретный ключ не установлен, в журнал будет записано следующее сообщение об ошибке:
2012-03-21 13:42:19,952 FATAL Общий секрет в /etc/benno/benno.xml не установлен.
Важное замечание: если общие секреты в двух файлах различаются, REST-демон запустится без сообщения об ошибке, но веб-приложение не сможет получить доступ к серверу! В этом случае веб-приложение отобразит сообщение об ошибке «Ошибка при запросе к серверу Benno MailArchiv».
После импорта первого электронного письма полная функциональность системы доступна в течение 60 дней даже без файла лицензии (демонстрационный режим) . После истечения демо-периода или если не установлен действительный файл лицензии, архивирование писем продолжится. Если демо-режим истек и действительная лицензия не установлена, доступ к архивированным письмам (поиск и отображение) через веб-приложение возможен только при отключении прав доступа пользователей /etc/benno-web/benno.conf режим Community Edition Внимание! Отключение этих прав доступа в файле конфигурации позволит ВСЕМ пользователям читать ВСЕ письма в архиве!
Обратите внимание, что коммерческое использование веб-приложения в версии Community Edition запрещено и является нарушением условий лицензии! Подробная информация о лицензировании приведена в разделе «Лицензии в Benno MailArchive» здесь .
Для перевода Benno MailArchiv в обычный режим работы требуется действующая лицензия. Файл лицензии содержит различную информацию, включая сам лицензионный ключ.
Дополнительная информация о лицензировании:
Действующий лицензионный файл можно получить в любое время через веб-форму (см. ниже). Для заказа лицензионного файла выполните следующие действия:
Для этого выполните следующую команду:
benno-client --instance-id
Эта команда выводит идентификатор экземпляра системы, который вы указываете при запросе лицензии.
Для получения действующего лицензионного файла для вашей установки Benno MailArchiv воспользуйтесь следующей веб-формой: https://www.benno-mailarchiv.de/lizenz . Лицензионный файл будет отправлен вам по электронной почте.
Если электронное письмо, содержащее файл лицензии, было заархивировано системой Benno MailArchiv, лицензия будет автоматически распознана при следующем перезапуске Benno REST Demon.
В качестве альтернативы, прикрепленный файл лицензии benno.lic также можно сохранить в системе Benno MailArchiv.
Скопируйте файл лицензии в /etc/benno/benno.lic и, при необходимости, убедитесь, что права доступа к файлу установлены следующим образом:
-rw-r--r-- 1 root root 145 Jun 27 2:24 pm /etc/benno/benno.lic
Лицензию можно установить на компьютере с Windows, используя PuTTY .
После настройки файла лицензии необходимо перезапустить демон Benno REST для активации лицензии: /etc/init.d/benno-rest restart. Проверьте файл /var/log/benno/rest.log, чтобы убедиться, что лицензия распознана правильно. В файле журнала должна содержаться следующая запись:
2012-03-21 13:44:25,183 INFO Лицензия в /etc/benno/benno.lic действительна
Если файл лицензии отсутствует или недоступен для чтения, в журнал будет записано следующее сообщение об ошибке:
2012-03-21 13:44:25,183 INFO Не удалось проверить файл лицензии: /etc/benno/benno.lic (Нет такого файла или каталога)
Если проверка лицензии не пройдёт по другим причинам, в журнал будет записано следующее сообщение об ошибке:
2012-03-21 13:44:25,183 ПРЕДУПРЕЖДЕНИЕ Ошибка лицензии ПРОВЕРКА ЛИЦЕНЗИИ НЕ ПРОЙДЕНА
Программа Benno MailArchiv установлена и готова к использованию.
Какие следующие шаги?
Лицензионный файл создается на основе идентификатора экземпляра. Вы можете просмотреть его в веб-интерфейсе как администратор на странице информации или в консоли с помощью команды
benno-client --instance-id
тратить.
Для запуска Benno MailArchiv после установки не требуется никаких изменений в настройках! Benno MailArchiv готов к использованию сразу после установки. Электронные письма для архивирования необходимо скопировать в каталог /srv/benno/inbox. Они должны быть доступны для чтения пользователю "benno". Для начала работы Benno MailArchiv требуется действительный файл лицензии и настройка общего секрета для обеспечения безопасной связи между ядром и REST-сервером (см. предыдущие разделы).
При импорте очень больших объемов электронной почты (например, примерно 20 000 писем в день или больше) виртуальная машина Java может потреблять почти 100% ресурсов процессора после длительной работы. Через некоторое время импорт писем прекращается. В файл журнала будут поступать сообщения, связанные с ошибкой "OutOfMemoryError", например: "2012-07-19 08:58:34,419 ERROR de.lwsystems.mailarchive.mailservice.DirectoryWatchService: java.lang.OutOfMemoryError: Java heap space." В случае возникновения такой ситуации ее можно легко решить, выделив больше памяти для службы benno-archive. Максимальный размер памяти, выделяемый виртуальной машиной Java, устанавливается с помощью параметра "-Xmx". Например, параметр "-Xmx2500m" устанавливает это значение равным 2500 МБ . Значение можно задать в файле «/etc/default/benno-archive» в переменной JAVA_OPTIONS:
START_ARCHIVE = yes JAVA_OPTIONS = '-server -Xmx2500m' DAEMON_ADDRESS = '127.0.0.1' DAEMON_PORT = '2555' DAEMON_ARGS = '-c /etc/benno/benno.xml' USER = benno
Пробел после значения также необходимо указать.
клиенты настраиваются в конфигурационном файле /etc/benno/benno.xml. Для каждого клиента необходимо создать отдельную XML-структуру containerarchive … /containerarchive в структуре configuredarchives, содержащую параметры и данные соответствующего клиента.
В Benno MailArchiv 2.0 для управления пользователями в однопользовательских установках доступен инструмент командной строки benno-useradmin. Эта программа позволяет управлять пользователями в локальной базе данных пользователей. Для использования benno-useradmin требуются пакеты perl, libdbi-perl и libdbd-sqlite2-perl. Команда является частью пакета benno-web. При установке в Debian, Ubuntu или UCS указанные зависимые пакеты устанавливаются автоматически.
Вместо использования внутренней базы данных пользователей Benno MailArchiv, управление пользователями также может осуществляться через существующий каталог LDAP. Для интеграции с LDAP доступен отдельный программный модуль, который будет включен в стандартную комплектацию Benno MailArchiv 2.0.1. Соответствующие инструкции по установке и настройке можно найти здесь . Также возможно подключение к базам данных ODBC вместо LDAP. При необходимости свяжитесь с нами.
Инструмент командной строки benno-useradmin в настоящее время предназначен для однопользовательских установок Benno MailArchiv. Многопользовательские установки в основном связаны с использованием и функционированием Benno MailArchiv Hosting Edition. Опыт показывает, что в таких случаях часто требуется индивидуальное подключение к соответствующей среде предоставления услуг или управления хостинг-провайдера/интернет-провайдера, которое мы внедряем индивидуально и в рамках конкретного проекта.
Команду benno-useradmin можно вызвать со следующими параметрами:
benno-useradmin [ -h ] [ -l ] [ -u < username > ] [ -d | -E ] [ -D ] [ -p < password > ] [ -n < name > ] [ -e < email1,email2, ... > > ] -C [ < container > ] -c < file > файл конфигурации ( default / etc / benno-web / benno.conf ) -l список всех пользователей -u < username > имя пользователя ( отображает данные пользователя если не указаны другие параметры ) Добавить или изменить данные пользователя -p < password > пароль пользователя -n < name > отображаемое имя пользователя -e < email,email > список адресов электронной почты, разделенных запятыми ( '' удаляет все ) -C < container > имя контейнера ( по умолчанию BennoContainer ) -d отключить пользователя -E включить пользователя -D удалить пользователя -h эта справка -v вывести номер версии
benno-useradmin -u k.klaasen -p совершенно секретно -n «Клаас Клаасен» -e «k.klaasen@firma.com, klaas.klaasen@firma.com»
benno-useradmin -u k.klaasen -p newpw
benno-useradmin -u k.klaasen -e 'k.klaasen@firma.com, k.klaasen@firma2.com
Внимание! Адреса электронной почты всегда будут полностью заменены.
benno-useradmin -u k.klaasen
benno-useradmin -u k.klaasen -D
Доступ к веб-приложению можно получить по следующему URI :
http://benno-server/benno
По умолчанию используется пользователь "admin". Перед первым доступом к системе установите пароль для этого пользователя и создайте соответствующие учетные записи с необходимыми правами.
benno-useradmin -u admin -p ЗАЩИТНЫЙ ПАРОЛЬ -e "адрес электронной почты@company.de"
Стандартный путь доступа к данным и сервисам Benno MailArchiv.
Это так называемый «каталог очереди» Benno MailArchiv. В этот каталог необходимо помещать отдельные письма для архивирования (одно письмо на файл). Benno MailArchiv обрабатывает файлы по отдельности. После успешной обработки (архивирования и индексирования) файлы писем удаляются из каталога. Файлы писем для архивирования должны иметь расширение .eml. Здесь можно хранить письма от всех клиентов. Benno MailArchiv автоматически распределяет письма по архивам различных клиентов на основе настроек конфигурации в файле /etc/benno/benno.xml.
Это стандартный каталог для хранения различных архивов и соответствующих им поисковых индексов.
Это каталог установки веб-приложения Benno MailArchiv.
Это каталог установки компонентов программы Benno MailArchiv (за исключением веб-приложения Benno MailArchiv).
Настройки конфигурации для бэкэнда Benno MailArchiv находятся в каталоге /etc/benno. Список конфигурационных файлов приведен ниже.
Содержит параметры конфигурации для пакетов benno-archive и benno-rest. В частности, здесь управляются различные клиенты и их соответствующие настройки, такие как пути к файлам и т. д.
Содержит параметры конфигурации для ведения журналов и различных уровней детализации benno-archive. Здесь вы можете настроить уровень детализации, с которым регистрируются различные операции архивирования. Ведение журналов может быть настроено на следующих уровнях: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Содержит параметры конфигурации для логирования и различных уровней детализации benno-rest. Здесь можно настроить уровень детализации логирования различных операций запроса к архиву. Логирование может быть настроено на следующих уровнях: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
Это лицензионный файл для установки Benno MailArchiv. Он содержит тип лицензионного ключа (Standard Edition, Hosting Edition, Evaluation и т. д.), полное доменное имя хоста (FQDN), IP-адрес сервера и дату окончания текущего периода технического обслуживания. И, наконец, сам лицензионный ключ прилагается.
Содержит параметры конфигурации для встроенного HTTP-сервера benno-rest. В этом файле не требуется вносить никаких изменений в конфигурацию.
Содержит информацию о конфигурации запуска benno-archive, например, следует ли запускать службу автоматически при запуске сервера.
Содержит информацию о конфигурации запуска benno-rest, например, следует ли запускать службу автоматически при запуске сервера.
Конфигурационные файлы для веб-приложения Benno MailArchiv находятся в каталоге /etc/benno-web/benno.conf. Описание конфигурационных файлов приведено ниже.
Включает PHP-файлы веб-приложения Bennno MailArchiv.
Включает шаблоны HTML- интерфейса веб-приложения Bennno MailArchiv.
Включает в себя конфигурационные файлы для веб-интерфейса (см. ниже).
Содержит настройки разрешений для компонентов веб-приложения Benno MailArchiv. Не вносите никаких изменений в этот файл!
Файл benno.conf содержит параметры конфигурации веб-приложения Benno MailArchiv, а также общий секретный ключ для безопасной связи с бэкэндом.
В веб-приложении электронные письма можно пересылать на любой адрес электронной почты в любое время. Нажав кнопку «Переслать письмо», можно переслать письмо на любой свободно определяемый адрес электронной почты. По умолчанию письмо отправляется с заголовком отправителя benno@localhost . Многие почтовые серверы или MTA не доставляют письма от отправителей, чей домен не является полным доменным именем (FQDN), поэтому письма с таким заголовком часто не доходят до внешних получателей (т.е. получателей за пределами вашего собственного почтового домена). Для надежной пересылки писем на внешние адреса следует изменить значение параметра MAIL_FROM:
По умолчанию: MAIL_FROM = benno@localhost
Адаптировано (например): MAIL_FROM = benno@musterfirma.de
Электронное письмо отправляется через MTA, установленный в системе архивирования. В Debian/Ubuntu хорошим выбором будет Postfix. В диалоговом окне конфигурации выберите опцию « Спутниковая система ». Следующий шаг включает указание smarthost, который будет выступать в качестве ретранслятора для пересылаемой электронной почты.