#
-# Cookbook Name:: otrs
+# Cookbook:: otrs
# Recipe:: default
#
-# Copyright 2012, OpenStreetMap Foundation
+# Copyright:: 2024, OpenStreetMap Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
-# http://www.apache.org/licenses/LICENSE-2.0
+# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# limitations under the License.
#
-include_recipe "tools"
+include_recipe "accounts"
+include_recipe "apache"
+include_recipe "exim"
include_recipe "postgresql"
-include_recipe "apache::ssl"
+include_recipe "tools"
passwords = data_bag_item("otrs", "passwords")
-package "libapache2-mod-perl2"
-package "libapache2-reload-perl"
-
-package "libgd-gd2-perl"
-package "libgd-graph-perl"
-package "libgd-text-perl"
-package "libjson-xs-perl"
-package "libmail-imapclient-perl"
-package "libnet-ldap-perl"
-package "libpdf-api2-perl"
-package "libsoap-lite-perl"
-package "libyaml-libyaml-perl"
-package "libcrypt-eksblowfish-perl"
+apache_module "perl" do
+ package "libapache2-mod-perl2"
+end
+apache_module "deflate"
apache_module "headers"
+apache_module "rewrite"
-version = node[:otrs][:version]
-user = node[:otrs][:user]
database_cluster = node[:otrs][:database_cluster]
database_name = node[:otrs][:database_name]
database_user = node[:otrs][:database_user]
database_password = passwords[node[:otrs][:database_password]]
site = node[:otrs][:site]
+site_aliases = node[:otrs][:site_aliases] || []
-remote_file "#{Chef::Config[:file_cache_path]}/otrs-#{version}.tar.bz2" do
- source "http://ftp.otrs.org/pub/otrs/otrs-#{version}.tar.bz2"
- not_if { File.exist?("/opt/otrs-#{version}") }
+postgresql_user database_user do
+ cluster database_cluster
+ password database_password
end
-execute "untar-otrs-#{version}" do
- command "tar jxf #{Chef::Config[:file_cache_path]}/otrs-#{version}.tar.bz2"
- cwd "/opt"
- user "root"
- group "root"
- not_if { File.exist?("/opt/otrs-#{version}") }
+postgresql_database database_name do
+ cluster database_cluster
+ owner database_user
end
-config = edit_file "/opt/otrs-#{version}/Kernel/Config.pm.dist" do |line|
- line.gsub!(/^( *)\$Self->{Database} = 'otrs'/, "\\1$Self->{Database} = '#{database_name}'")
- line.gsub!(/^( *)\$Self->{DatabaseUser} = 'otrs'/, "\\1$Self->{DatabaseUser} = '#{database_user}'")
- line.gsub!(/^( *)\$Self->{DatabasePw} = 'some-pass'/, "\\1$Self->{DatabasePw} = '#{database_password}'")
- line.gsub!(/^( *)\$Self->{Database} = 'otrs'/, "\\1$Self->{Database} = '#{database_name}'")
- line.gsub!(/^( *\$Self->{DatabaseDSN} = "DBI:mysql:)/, "#\\1")
- line.gsub!(/^#( *\$Self->{DatabaseDSN} = "DBI:Pg:.*;host=)/, "\\1")
- line.gsub!(/^( *)# (\$Self->{CheckMXRecord} = 0)/, "\\1\\2")
-
- line
-end
+package "dbconfig-common"
-file "/opt/otrs-#{version}/Kernel/Config.pm" do
- owner user
- group "www-data"
- mode 0664
- content config
+template "/etc/dbconfig-common/otrs2.conf" do
+ source "dbconfig.config.erb"
+ owner "root"
+ group "root"
+ mode "600"
+ variables :database_name => database_name,
+ :database_user => database_user,
+ :database_password => database_password,
+ :database_cluster => database_cluster
end
-generic_agent = edit_file "/opt/otrs-#{version}/Kernel/Config/GenericAgent.pm.dist" do |line|
- line
+# Ensure the OTRS package in backports has a priority preference.
+apt_preference "otrs2" do
+ pin "release o=Debian Backports"
+ pin_priority "600"
end
-file "/opt/otrs-#{version}/Kernel/Config/GenericAgent.pm" do
- owner user
- group "www-data"
- mode 0664
- content generic_agent
-end
+apt_package "otrs2"
-link "/opt/otrs" do
- to "/opt/otrs-#{version}"
-end
-
-execute "/opt/otrs/bin/otrs.SetPermissions.pl" do
- action :run
- command "/opt/otrs/bin/otrs.SetPermissions.pl --otrs-user=#{user} --web-user=www-data --otrs-group=www-data --web-group=www-data /opt/otrs-#{version}"
- user "root"
- group "root"
- only_if { File.stat("/opt/otrs/README.md").uid != Etc.getpwnam("otrs").uid }
+# Ensure debconf is repopulated on a dbconfig change
+execute "dpkg-reconfigure-otrs2" do
+ action :nothing
+ command "dpkg-reconfigure -fnoninteractive otrs2"
+ subscribes :run, "template[/etc/dbconfig-common/otrs2.conf]"
end
-execute "/opt/otrs/bin/otrs.RebuildConfig.pl" do
- action :run
- command "/opt/otrs/bin/otrs.RebuildConfig.pl"
- user "root"
- group "root"
- not_if { File.exist?("/opt/otrs/Kernel/Config/Files/ZZZAAuto.pm") }
+# Disable deb otrs2 apache config
+apache_conf "otrs2" do
+ action :disable
end
-if node[:postgresql][:clusters][database_cluster]
- postgresql_user database_user do
- cluster database_cluster
- password database_password
- end
-
- postgresql_database database_name do
- cluster database_cluster
- owner database_user
- end
+# Disable deb otrs2 cron job
+file "/etc/cron.d/otrs2" do
+ action :delete
+ manage_symlink_source true
end
-execute "/opt/otrs/bin/Cron.sh" do
- action :nothing
- command "/opt/otrs/bin/Cron.sh restart"
+systemd_service "otrs" do
+ description "OTRS Daemon"
+ type "forking"
user "otrs"
- group "otrs"
+ group "www-data"
+ exec_start_pre "-/usr/share/otrs/bin/otrs.Daemon.pl stop" # Stop if race with deb cron
+ exec_start "/usr/share/otrs/bin/otrs.Daemon.pl start"
+ private_tmp true
+ protect_system "strict"
+ protect_home false
+ runtime_directory "otrs"
+ runtime_directory_mode 0o770
+ runtime_directory_preserve true
+ read_write_paths ["/var/lib/otrs", "/run/otrs", "/var/log/exim4", "/var/spool/exim4"]
end
-Dir.glob("/opt/otrs/var/cron/*.dist") do |distname|
- name = distname.sub(".dist", "")
+service "otrs" do
+ action [:enable, :start]
+ subscribes :restart, "apt_package[otrs2]"
+ subscribes :restart, "systemd_service[otrs]"
+end
- file name do
- owner "otrs"
- group "www-data"
- mode 0664
- content IO.read(distname)
- notifies :run, "execute[/opt/otrs/bin/Cron.sh]"
- end
+ssl_certificate site do
+ domains [site] + site_aliases
+ notifies :reload, "service[apache2]"
end
apache_site site do
template "apache.erb"
-end
-
-template "/etc/sudoers.d/otrs" do
- source "sudoers.erb"
- owner "root"
- group "root"
- mode 0440
+ variables :aliases => site_aliases
end
template "/etc/cron.daily/otrs-backup" do
source "backup.cron.erb"
owner "root"
group "root"
- mode 0755
+ mode "755"
end