functions 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426
  1. #!/bin/bash
  2. #
  3. # packager.io postinstall script functions
  4. #
  5. function debug() {
  6. if [ "${DEBUG}" == "yes" ]; then
  7. echo "DEBUG MODE ON"
  8. set -ex
  9. fi
  10. }
  11. function detect_os () {
  12. . /etc/os-release
  13. if [ "${ID}" == "debian" ] || [ "${ID}" == "ubuntu" ]; then
  14. OS="DEBIAN"
  15. elif [ "${ID}" == "centos" ] || [ "${ID}" == "fedora" ] || [ "${ID}" == "rhel" ]; then
  16. OS="REDHAT"
  17. elif [[ "${ID}" =~ suse|sles ]]; then
  18. OS="SUSE"
  19. else
  20. OS="UNKNOWN"
  21. fi
  22. if [ "${DEBUG}" == "yes" ]; then
  23. echo "OS is ${OS} based"
  24. fi
  25. }
  26. function detect_docker() {
  27. if [ -n "$(grep docker < /proc/1/cgroup)" ]; then
  28. DOCKER="yes"
  29. else
  30. DOCKER="no"
  31. fi
  32. if [ "${DEBUG}" == "yes" ]; then
  33. echo "os runs in docker container = ${DOCKER}"
  34. fi
  35. }
  36. function detect_initcmd () {
  37. if [ -n "$(which systemctl 2> /dev/null)" ]; then
  38. INIT_CMD="systemctl"
  39. elif [ -n "$(which initctl 2> /dev/null)" ]; then
  40. INIT_CMD="initctl"
  41. else
  42. function sysvinit () {
  43. service $2 $1
  44. }
  45. INIT_CMD="sysvinit"
  46. fi
  47. if [ "${DOCKER}" == "yes" ]; then
  48. INIT_CMD="initctl"
  49. fi
  50. if [ "${DEBUG}" == "yes" ]; then
  51. echo "INIT CMD = ${INIT_CMD}"
  52. fi
  53. }
  54. function detect_database () {
  55. if [ -n "$(which psql 2> /dev/null)" ]; then
  56. ADAPTER="postgresql"
  57. elif [ -n "$(which mysql 2> /dev/null)" ]; then
  58. ADAPTER="mysql2"
  59. fi
  60. if [ "${DEBUG}" == "yes" ]; then
  61. echo "Use ${ADAPTER} adapter in database.yml"
  62. fi
  63. }
  64. function detect_webserver () {
  65. if [ -n "$(which nginx 2> /dev/null)" ] ; then
  66. WEBSERVER="nginx"
  67. WEBSERVER_CMD="nginx"
  68. if [ "${OS}" == "DEBIAN" ]; then
  69. WEBSERVER_CONF="/etc/nginx/sites-available/zammad.conf"
  70. elif [ "${OS}" == "REDHAT" ]; then
  71. WEBSERVER_CONF="/etc/nginx/conf.d/zammad.conf"
  72. elif [ "${OS}" == "SUSE" ]; then
  73. WEBSERVER_CONF="/etc/nginx/vhosts.d/zammad.conf"
  74. fi
  75. elif [ -n "$(which apache2 2> /dev/null)" ]; then
  76. WEBSERVER="apache2"
  77. WEBSERVER_CMD="apache2"
  78. if [ "${OS}" == "DEBIAN" ]; then
  79. WEBSERVER_CONF="/etc/apache2/sites-available/zammad.conf"
  80. fi
  81. elif [ -n "$(which httpd 2> /dev/null)" ]; then
  82. WEBSERVER="apache2"
  83. WEBSERVER_CMD="httpd"
  84. if [ "${OS}" == "REDHAT" ]; then
  85. WEBSERVER_CONF="/etc/httpd/conf.d/zammad.conf"
  86. elif [ "${OS}" == "SUSE" ]; then
  87. WEBSERVER_CONF="/etc/apache2/vhosts.d/zammad.conf"
  88. fi
  89. fi
  90. if [ "${DEBUG}" == "yes" ]; then
  91. echo "Webserver is ${WEBSERVER_CMD}"
  92. fi
  93. }
  94. function create_initscripts () {
  95. echo "# (Re)creating init scripts"
  96. zammad scale web="${ZAMMAD_WEBS}" websocket="${ZAMMAD_WEBSOCKETS}" worker="${ZAMMAD_WORKERS}"
  97. echo "# Enabling Zammad on boot"
  98. ${INIT_CMD} enable zammad
  99. }
  100. function start_zammad () {
  101. echo "# Starting Zammad"
  102. ${INIT_CMD} start zammad
  103. }
  104. function stop_zammad () {
  105. echo "# Stopping Zammad"
  106. ${INIT_CMD} stop zammad
  107. }
  108. function create_database_password () {
  109. DB_PASS="$(tr -dc A-Za-z0-9 < /dev/urandom | head -c10)"
  110. }
  111. function create_postgresql_db () {
  112. if [ -n "$(which postgresql-setup 2> /dev/null)" ]; then
  113. echo "# Preparing postgresql server"
  114. postgresql-setup initdb
  115. fi
  116. echo "# Creating postgresql bootstart"
  117. ${INIT_CMD} enable postgresql.service
  118. echo "# Restarting postgresql server"
  119. ${INIT_CMD} restart postgresql
  120. echo "# Creating zammad postgresql user"
  121. echo "CREATE USER \"${DB_USER}\" WITH PASSWORD '${DB_PASS}';" | su - postgres -c psql
  122. echo "# Creating zammad postgresql db"
  123. su - postgres -c "createdb -E UTF8 ${DB} -O ${DB_USER}"
  124. echo "# Grant privileges to new postgresql user"
  125. echo "GRANT ALL PRIVILEGES ON DATABASE \"${DB}\" TO \"${DB_USER}\";" | su - postgres -c psql
  126. }
  127. function create_mysql_db () {
  128. if [ -f "${MY_CNF}" ]; then
  129. MYSQL_CREDENTIALS="--defaults-file=${MY_CNF}"
  130. else
  131. echo -n "Please enter your MySQL root password:"
  132. read -p 'Password: ' MYSQL_ROOT_PASS
  133. MYSQL_CREDENTIALS="-u root -p${MYSQL_ROOT_PASS}"
  134. fi
  135. echo "# Creating zammad mysql db"
  136. mysql ${MYSQL_CREDENTIALS} -e "CREATE DATABASE ${DB} DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;"
  137. echo "# Creating zammad mysql user"
  138. mysql ${MYSQL_CREDENTIALS} -e "CREATE USER \"${DB_USER}\"@\"${DB_HOST}\" IDENTIFIED BY \"${DB_PASS}\";"
  139. echo "# Grant privileges to new mysql user"
  140. mysql ${MYSQL_CREDENTIALS} -e "GRANT ALL PRIVILEGES ON ${DB}.* TO \"${DB_USER}\"@\"${DB_HOST}\"; FLUSH PRIVILEGES;"
  141. }
  142. function update_database_yml () {
  143. if [ "${OS}" == "REDHAT" ] || [ "${OS}" == "SUSE" ]; then
  144. if [ "${ADAPTER}" == "postgresql" ]; then
  145. DB_PASS=""
  146. fi
  147. fi
  148. echo "# Updating database.yml"
  149. sed -e "s/.*adapter:.*/ adapter: ${ADAPTER}/" \
  150. -e "s/.*username:.*/ username: ${DB_USER}/" \
  151. -e "s/.*password:.*/ password: ${DB_PASS}/" \
  152. -e "s/.*database:.*/ database: ${DB}/" < ${ZAMMAD_DIR}/contrib/packager.io/database.yml.pkgr > ${ZAMMAD_DIR}/config/database.yml
  153. echo "# ... Fixing permission database.yml"
  154. chown zammad:zammad ${ZAMMAD_DIR}/config/database.yml
  155. }
  156. function initialise_database () {
  157. zammad run rake db:migrate
  158. zammad run rake db:seed
  159. }
  160. function update_database () {
  161. echo "# database.yml found. Updating db..."
  162. zammad run rake db:migrate
  163. }
  164. function update_translations () {
  165. echo "# Updating translations..."
  166. zammad run rails r 'Locale.sync'
  167. zammad run rails r 'Translation.sync'
  168. }
  169. function create_webserver_config () {
  170. if [ "${OS}" == "DEBIAN" ]; then
  171. if [ ! -f "${WEBSERVER_CONF}" ]; then
  172. if [ -f "/etc/${WEBSERVER}/sites-enabled/zammad.conf" ]; then
  173. mv /etc/${WEBSERVER}/sites-enabled/zammad.conf ${WEBSERVER_CONF}
  174. else
  175. cp ${ZAMMAD_DIR}/contrib/${WEBSERVER}/zammad.conf ${WEBSERVER_CONF}
  176. fi
  177. ln -s ${WEBSERVER_CONF} /etc/${WEBSERVER}/sites-enabled/zammad.conf
  178. fi
  179. if [ "${WEBSERVER}" == "apache2" ]; then
  180. a2enmod proxy
  181. a2enmod proxy_http
  182. a2enmod proxy_wstunnel
  183. fi
  184. else
  185. test -f ${WEBSERVER_CONF} || cp ${ZAMMAD_DIR}/contrib/${WEBSERVER}/zammad.conf ${WEBSERVER_CONF}
  186. fi
  187. echo "# Creating webserver bootstart"
  188. ${INIT_CMD} enable ${WEBSERVER_CMD}
  189. echo "# Restarting webserver ${WEBSERVER_CMD}"
  190. ${INIT_CMD} restart ${WEBSERVER_CMD}
  191. }
  192. function enforce_redis () {
  193. REDIS_URL=$(zammad config:get REDIS_URL)
  194. if [ -n "${REDIS_URL}" ]; then
  195. echo "# REDIS_URL variable set to ${REDIS_URL}."
  196. echo "# Performing connection check."
  197. if zammad run ruby -r redis -e 'Redis.new(driver: :hiredis, url: ENV["REDIS_URL"]).ping'; then
  198. echo "# Connection check successful."
  199. return 0
  200. else
  201. echo "# Connection check unsuccessful."
  202. echo "ERROR - No redis server found at ${REDIS_URL}."
  203. echo "Please install Redis following the instructions at https://redis.io/docs/getting-started/ or set the REDIS_URL environment variable with the following command."
  204. echo "zammad config:set REDIS_URL=redis://your.redis.server:6379\n"
  205. echo "Acceptable formats for REDIS_URL are:"
  206. echo "redis[s]://[[username]:password@]host[:port][/db-number]"
  207. echo "Please fix these issues, then run the package installation again."
  208. exit 1
  209. fi
  210. fi
  211. echo "# Enforcing Redis..."
  212. local REDIS_SERVICE_NAME=""
  213. if [ "${OS}" == "DEBIAN" ]; then
  214. REDIS_SERVICE_NAME="redis-server"
  215. elif [ "${OS}" == "SUSE" ]; then
  216. REDIS_PID=$(fuser 6379/tcp 2> /dev/null)
  217. if [ -z "${REDIS_PID}" ]; then
  218. echo -e "# No running instance of Redis detected.\n# Creating systemd-service: redis@zammad.service."
  219. [[ -f '/etc/redis/zammad.conf' ]] || cp /etc/redis/default.conf.example /etc/redis/zammad.conf
  220. echo "# Ensuring correct file permissions for /etc/redis/zammad.conf."
  221. [[ $(stat -c "%U %G" /etc/redis/zammad.conf) == "root redis" ]] || chown root:redis /etc/redis/zammad.conf
  222. REDIS_SERVICE_NAME=redis@zammad.service
  223. else
  224. REDIS_SERVICE_NAME=$(ps -p $REDIS_PID -o unit=)
  225. echo "# Redis service ${REDIS_SERVICE_NAME} detected."
  226. fi
  227. else
  228. REDIS_SERVICE_NAME="redis"
  229. fi
  230. if [ -n "$(which redis-server 2> /dev/null)" ]; then
  231. echo "# Creating Redis bootstart"
  232. ${INIT_CMD} enable ${REDIS_SERVICE_NAME}
  233. echo "# Starting Redis server"
  234. if ${INIT_CMD} restart ${REDIS_SERVICE_NAME}; then
  235. echo "# Redis server is running."
  236. return 0
  237. else
  238. echo -e "\nSomething went wrong. Please check any error output above and fix the issues."
  239. echo "Then run the package installation again."
  240. exit 1
  241. fi
  242. fi
  243. }
  244. function setup_elasticsearch () {
  245. echo "# Configuring Elasticsearch..."
  246. ES_CONNECTION="$(zammad run rails r "puts '',Setting.get('es_url')"| tail -n 1 2>> /dev/null)"
  247. if [ -z "${ES_CONNECTION}" ]; then
  248. echo "-- Nevermind, no es_url is set, leaving Elasticsearch untouched ...!"
  249. echo "-- The above is all right if you don't want to use Elasticsearch (locally) - if this is not intended, consult https://docs.zammad.org !"
  250. return 0
  251. fi
  252. if [[ "$(/usr/share/elasticsearch/bin/elasticsearch --version| cut -c 10)" -gt 7 ]]; then
  253. # We're skipping the plugin reinstallation process for ES 8+ as it's part of the ES core
  254. return 0
  255. fi
  256. if [ -n "$(/usr/share/elasticsearch/bin/elasticsearch-plugin list | grep mapper-attachments)" ]; then
  257. REBUILD_ES_SEARCHINDEX="yes"
  258. echo "# Deleting old elasticsearch index..."
  259. zammad run rake zammad:searchindex:drop
  260. yes | /usr/share/elasticsearch/bin/elasticsearch-plugin -s remove mapper-attachments
  261. elif [ -n "$(/usr/share/elasticsearch/bin/elasticsearch-plugin list | grep ingest-attachment)" ]; then
  262. yes | /usr/share/elasticsearch/bin/elasticsearch-plugin -s remove ingest-attachment
  263. fi
  264. yes | /usr/share/elasticsearch/bin/elasticsearch-plugin -s install ingest-attachment
  265. if [ "${ES_CONNECTION}" == "http://127.0.0.1:9200" ] || [ "${ES_CONNECTION}" == "http://localhost:9200" ]; then
  266. ${INIT_CMD} restart elasticsearch
  267. else
  268. echo -e "\n It seems you're running an external Elasticsearch server on ${ES_CONNECTION}"
  269. echo -e "\n We'll not touch your Elasticsearch on the local and remote system."
  270. echo -e "\n Please get sure to install the 'ingest-attachment' plugin on your Elasticsearch server by:"
  271. echo -e "/usr/share/elasticsearch/bin/elasticsearch-plugin -s install ingest-attachment"
  272. echo -e "\nAfter this you might need to rebuild the searchindex by:"
  273. echo -e "zammad run rake zammad:searchindex:rebuild"
  274. fi
  275. }
  276. function elasticsearch_searchindex_rebuild () {
  277. zammad run rails r "Setting.set('es_url', \"${ES_CONNECTION}\")"
  278. if [ "${REBUILD_ES_SEARCHINDEX}" == "yes" ]; then
  279. echo "# (Re)building Elasticsearch searchindex..."
  280. nohup zammad run rake zammad:searchindex:rebuild &> ${ZAMMAD_DIR}/log/searchindex-rebuild.log &
  281. fi
  282. }
  283. function detect_zammad_packages () {
  284. if [ "$(zammad run rails r 'puts Package.count.positive?')" == "true" ] && [ -n "$(which pnpm 2> /dev/null)" ] ; then
  285. echo "# Detected custom packages..."
  286. ZAMMAD_PACKAGES="yes"
  287. else
  288. echo "# No custom packages detected..."
  289. ZAMMAD_PACKAGES="no"
  290. fi
  291. }
  292. function zammad_packages_reinstall_all () {
  293. detect_zammad_packages
  294. if [ "${ZAMMAD_PACKAGES}" == "yes" ]; then
  295. echo "# Setup custom packages files..."
  296. zammad run rake zammad:package:reinstall_all
  297. zammad run rake zammad:package:post_install
  298. fi
  299. }
  300. function update_or_install () {
  301. if [ -f ${ZAMMAD_DIR}/config/database.yml ]; then
  302. echo "# Clear cache..."
  303. zammad run rails r Rails.cache.clear
  304. update_database
  305. update_translations
  306. zammad_packages_reinstall_all
  307. else
  308. REBUILD_ES_SEARCHINDEX="yes"
  309. create_database_password
  310. if [ "${ADAPTER}" == "postgresql" ]; then
  311. echo "# Installing zammad on postgresql"
  312. create_postgresql_db
  313. elif [ "${ADAPTER}" == "mysql2" ]; then
  314. echo "# Installing zammad on mysql"
  315. create_mysql_db
  316. fi
  317. update_database_yml
  318. initialise_database
  319. fi
  320. setup_elasticsearch
  321. elasticsearch_searchindex_rebuild
  322. echo "# Enforcing 0600 on database.yml ..."
  323. chmod 600 ${ZAMMAD_DIR}/config/database.yml
  324. }
  325. function set_env_vars () {
  326. zammad config:set RUBY_MALLOC_ARENA_MAX=${ZAMMAD_RUBY_MALLOC_ARENA_MAX:=2}
  327. zammad config:set RUBY_GC_MALLOC_LIMIT=${ZAMMAD_RUBY_GC_MALLOC_LIMIT:=1077216}
  328. zammad config:set RUBY_GC_MALLOC_LIMIT_MAX=${ZAMMAD_RUBY_GC_MALLOC_LIMIT_MAX:=2177216}
  329. zammad config:set RUBY_GC_OLDMALLOC_LIMIT=${ZAMMAD_RUBY_GC_OLDMALLOC_LIMIT:=2177216}
  330. zammad config:set RUBY_GC_OLDMALLOC_LIMIT_MAX=${ZAMMAD_RUBY_GC_OLDMALLOC_LIMIT_MAX:=3000100}
  331. if [[ "$(zammad config:get RAILS_LOG_TO_STDOUT)" == "enabled" ]];then
  332. echo 'Setting default Logging to file, set via "zammad config:set RAILS_LOG_TO_STDOUT=true" if you want to log to STDOUT!'
  333. zammad config:set RAILS_LOG_TO_STDOUT=
  334. fi
  335. }
  336. function final_message () {
  337. echo -e "####################################################################################"
  338. echo -e "\nAdd your fully qualified domain name or public IP to servername directive of"
  339. echo -e "${WEBSERVER}, if this installation is done on a remote server. You have to change:"
  340. echo -e "${WEBSERVER_CONF} and restart ${WEBSERVER_CMD} process."
  341. echo -e "Otherwise just open http://localhost/ in your browser to start using Zammad.\n"
  342. if [ "${OS}" == "REDHAT" ]; then
  343. echo -e "\n Remember to enable selinux and firewall rules!\n"
  344. echo -e "Use the following commands:"
  345. echo -e " setsebool httpd_can_network_connect on -P"
  346. echo -e " firewall-cmd --zone=public --add-service=http --permanent"
  347. echo -e " firewall-cmd --zone=public --add-service=https --permanent"
  348. echo -e " firewall-cmd --reload\n"
  349. elif [ "${OS}" == "SUSE" ]; then
  350. echo -e "\n Make sure that the firewall is not blocking port 80 & 443!\n"
  351. echo -e "Use 'yast firewall' or 'SuSEfirewall2' commands to configure it"
  352. fi
  353. echo -e "####################################################################################"
  354. }