setup_functions.sh 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388
  1. # All functions used during setup of a service
  2. docker_pull() {
  3. for image in ${IMAGES[@]};do
  4. [[ "$image" != "dockerbunker/${SERVICE_NAME}" ]] \
  5. && echo -e "\n\e[1mPulling $image\e[0m" \
  6. && docker pull $image
  7. done
  8. }
  9. docker_run() {
  10. $1
  11. }
  12. docker_run_all() {
  13. echo -e "\n\e[1mStarting up containers\e[0m"
  14. for container in "${containers[@]}";do
  15. ! [[ $(docker ps -q --filter name="^/${container}$") ]] \
  16. && echo -en "- $container" \
  17. && ${container//-/_} \
  18. && exit_response \
  19. || echo "- $container (already running)"
  20. done
  21. connect_containers_to_network
  22. }
  23. get_current_images_sha256() {
  24. # get current images' sha256
  25. if [[ -z ${CURRENT_IMAGES_SHA256[@]} ]];then
  26. collectImageNamesAndCorrespondingSha256
  27. declare -A CURRENT_IMAGES_SHA256
  28. for key in "${!IMAGES_AND_SHA256[@]}";do
  29. CURRENT_IMAGES_SHA256[$key]+=${IMAGES_AND_SHA256[$key]}
  30. done
  31. fi
  32. declare -p CURRENT_IMAGES_SHA256 >> "${BASE_DIR}"/.image_shas.tmp
  33. unset IMAGES_AND_SHA256
  34. }
  35. pull_and_compare() {
  36. [[ -f "${BASE_DIR}"/.image_shas.tmp ]] \
  37. && rm "${BASE_DIR}"/.image_shas.tmp
  38. get_current_images_sha256
  39. if [[ ${DOCKER_COMPOSE} ]];then
  40. pushd "${SERVICE_HOME}" >/dev/null
  41. echo ""
  42. echo -e "\e[1mPulling new images\e[0m"
  43. echo ""
  44. docker-compose pull
  45. else
  46. docker_pull
  47. fi
  48. if [[ -f "${BASE_DIR}"/.image_shas.tmp ]];then
  49. source "${BASE_DIR}"/.image_shas.tmp
  50. else
  51. echo -e "\n\e[31mCould not find digests of current images.\nExiting.\e[0m"
  52. exit 1
  53. fi
  54. # compare sha256 and delete old unused images
  55. collectImageNamesAndCorrespondingSha256
  56. declare -A NEW_IMAGES_SHA256
  57. for key in "${!IMAGES_AND_SHA256[@]}";do
  58. NEW_IMAGES_SHA256[$key]+=${IMAGES_AND_SHA256[$key]}
  59. done
  60. for key in "${!CURRENT_IMAGES_SHA256[@]}";do
  61. if [[ ${CURRENT_IMAGES_SHA256[$key]} != ${NEW_IMAGES_SHA256[$key]} ]];then
  62. old_images_to_delete+=( ${CURRENT_IMAGES_SHA256[$key]} )
  63. else
  64. unchanged_images_to_keep+=( ${CURRENT_IMAGES_SHA256[$key]} )
  65. fi
  66. done
  67. if [[ ${DOCKER_COMPOSE} ]] \
  68. && [[ ${old_images_to_delete[0]} ]];then
  69. pushd "${SERVICE_HOME}" >/dev/null
  70. echo -e "\n\e[1mTaking down ${PROPER_NAME}\e[0m"
  71. docker-compose down
  72. echo -e "\n\e[1mBringing ${PROPER_NAME} back up\e[0m"
  73. docker-compose up -d
  74. popd >/dev/null
  75. fi
  76. [[ ${old_images_to_delete[0]} ]] \
  77. && declare -p old_images_to_delete >> "${BASE_DIR}"/.image_shas.tmp
  78. [[ ${unchanged_images_to_keep[0]} ]] \
  79. && declare -p unchanged_images_to_keep >> "${BASE_DIR}"/.image_shas.tmp
  80. for container in "${containers[@]}";do
  81. ! [[ $(docker ps -q --filter name="^/${container}$") ]] \
  82. && missing_containers+=( $container )
  83. done
  84. [[ -z ${old_images_to_delete[0]} ]] && [[ -z ${missing_containers[0]} ]] \
  85. && echo -e "\n\e[1mImage(s) did not change.\e[0m" \
  86. && rm "${BASE_DIR}"/.image_shas.tmp \
  87. && exit 0
  88. }
  89. delete_old_images() {
  90. if [[ -f "${BASE_DIR}"/.image_shas.tmp ]];then
  91. source "${BASE_DIR}"/.image_shas.tmp
  92. else
  93. echo -en "\n\e[31mCould not find digests of current images.\nExiting.\e[0m"
  94. return
  95. fi
  96. [[ -z ${old_images_to_delete[0]} ]] \
  97. && return
  98. prompt_confirm "Delete all old images?"
  99. if [[ $? == 0 ]];then
  100. echo ""
  101. for image in "${old_images_to_delete[@]}";do
  102. echo -en "\e[1m[DELETING]\e[0m $image"
  103. docker rmi $image >/dev/null
  104. exit_response
  105. done
  106. for image in ${unchanged_images_to_keep[@]};do
  107. echo -en "\e[1m[KEEPING]\e[0m $image (did not change)"
  108. done
  109. echo ""
  110. fi
  111. rm "${BASE_DIR}"/.image_shas.tmp
  112. }
  113. setup_nginx() {
  114. [[ ! $(docker ps -q --filter name=^/${NGINX_CONTAINER}$) ]] && bash "${SERVICES_DIR}"/nginx/nginx.sh setup
  115. }
  116. # Build image if necessary, set up nginx container if necessary, create or use existing volumes, create networks if necessary, pull images if necessary
  117. initial_setup_routine() {
  118. [[ ${STATIC} ]] && return
  119. setup_nginx
  120. for container in "${containers[@]}";do
  121. [[ ( $(docker inspect $container 2> /dev/null) && $? == 0 ) ]] && docker rm $container
  122. done
  123. docker_pull
  124. create_volumes
  125. create_networks
  126. }
  127. create_volumes() {
  128. if [[ ${volumes[@]} && ! ${DOCKER_COMPOSE} ]];then
  129. echo -e "\n\e[1mCreating volumes\e[0m"
  130. for volume in "${!volumes[@]}";do
  131. [[ ! $(docker volume ls -q --filter name=^${volume}$) ]] \
  132. && echo -en "- $volume" \
  133. && docker volume create $volume >/dev/null \
  134. && exit_response \
  135. || echo "- $volume (already exists)"
  136. done
  137. fi
  138. }
  139. create_networks() {
  140. for network in "${networks[@]}";do
  141. [[ $(docker network ls -q --filter name=^${network}$) ]] \
  142. && docker network rm $network >/dev/null
  143. [[ ! $(docker network ls -q --filter name=^${network}$) ]] \
  144. && docker network create $network >/dev/null
  145. done
  146. }
  147. generate_certificate() {
  148. [[ -L "${CONF_DIR}"/nginx/ssl/${SERVICE_DOMAIN[0]}/cert.pem ]] && rm "${CONF_DIR}"/nginx/ssl/${SERVICE_DOMAIN[0]}/cert.pem
  149. [[ -L "${CONF_DIR}"/nginx/ssl/${SERVICE_DOMAIN[0]}/key.pem ]] && rm "${CONF_DIR}"/nginx/ssl/${SERVICE_DOMAIN[0]}/key.pem
  150. echo -en "\n\e[1mGenerating self-signed certificate for ${SERVICE_DOMAIN[0]}\e[0m"
  151. openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout "${CONF_DIR}"/nginx/ssl/${SERVICE_DOMAIN[0]}/key.pem -out "${CONF_DIR}"/nginx/ssl/${SERVICE_DOMAIN[0]}/cert.pem -subj "/C=XY/ST=hidden/L=nowhere/O=${PROPER_NAME}/OU=IT Department/CN=${SERVICE_DOMAIN[0]}" >/dev/null 2>&1
  152. exit_response
  153. }
  154. # this generates the nginx configuration for the service that is being set up and puts it into data/services/ngix/conf.d
  155. basic_nginx() {
  156. if [[ -z $reinstall ]];then
  157. [[ ! -d "${CONF_DIR}"/nginx/ssl ]] \
  158. && mkdir -p "${CONF_DIR}"/nginx/ssl
  159. [[ ! -f "${CONF_DIR}"/nginx/ssl/dhparam.pem ]] \
  160. && cp "${SERVICES_DIR}/nginx/ssl/dhparam.pem" "${CONF_DIR}"/nginx/ssl
  161. [[ ! -d "${CONF_DIR}"/nginx/ssl/${SERVICE_DOMAIN[0]} ]] && \
  162. mkdir -p "${CONF_DIR}"/nginx/ssl/${SERVICE_DOMAIN[0]}
  163. if [[ ! -f "${CONF_DIR}"/nginx/ssl/${SERVICE_DOMAIN[0]}/cert.pem ]];then
  164. generate_certificate
  165. fi
  166. [[ ! -d "${CONF_DIR}"/nginx/conf.d ]] && \
  167. mkdir -p "${CONF_DIR}"/nginx/conf.d
  168. if [[ ! -f "${CONF_DIR}"/nginx/conf.d/${SERVICE_DOMAIN[0]}.conf ]];then
  169. cp "${SERVICES_DIR}"/${SERVICE_NAME}/nginx/${SERVICE_NAME}.conf "${SERVICES_DIR}"/${SERVICE_NAME}/nginx/${SERVICE_DOMAIN[0]}.conf
  170. for variable in "${SUBSTITUTE[@]}";do
  171. subst="\\${variable}"
  172. variable=`eval echo "$variable"`
  173. sed -i "s@${subst}@${variable}@g;" \
  174. "${SERVICES_DIR}"/${SERVICE_NAME}/nginx/${SERVICE_DOMAIN[0]}.conf
  175. done
  176. fi
  177. echo -en "\n\e[1mMoving nginx configuration in place\e[0m"
  178. if [[ -f "${SERVICES_DIR}"/${SERVICE_NAME}/nginx/${SERVICE_DOMAIN[0]}.conf ]];then
  179. mv "${SERVICES_DIR}"/${SERVICE_NAME}/nginx/${SERVICE_DOMAIN[0]}.conf "${CONF_DIR}"/nginx/conf.d
  180. # add basic_auth
  181. if [[ ${BASIC_AUTH} == "yes" ]];then
  182. [[ ! -d "${CONF_DIR}"/nginx/conf.d/${SERVICE_DOMAIN} ]] && \
  183. mkdir -p "${CONF_DIR}"/nginx/conf.d/${SERVICE_DOMAIN}
  184. SALT="$(openssl rand 3)"
  185. SHA1="$(printf "%s%s" "${HTPASSWD}" "$SALT" | openssl dgst -binary -sha1)"
  186. printf "${HTUSER}:{SSHA}%s\n" "$(printf "%s%s" "$SHA1" "$SALT" | base64)" > "${CONF_DIR}"/nginx/conf.d/${SERVICE_DOMAIN}/.htpasswd
  187. cp "${SERVICES_DIR}"/nginx/basic_auth.conf \
  188. "${CONF_DIR}"/nginx/conf.d/${SERVICE_DOMAIN}/basic_auth.conf
  189. for variable in "${SUBSTITUTE[@]}";do
  190. subst="\\${variable}"
  191. variable=`eval echo "$variable"`
  192. sed -i "s@${subst}@${variable}@g;" \
  193. "${CONF_DIR}"/nginx/conf.d/${SERVICE_DOMAIN}/basic_auth.conf
  194. done
  195. fi
  196. exit_response
  197. else
  198. ! [[ -f "${CONF_DIR}"/nginx/conf.d/${SERVICE_DOMAIN[0]}.conf ]] && echo "Nginx configuration file could not be found. Exiting." && exit 1
  199. fi
  200. fi
  201. }
  202. # called in docker_run_all if container is found in ${add_to_network}
  203. connect_containers_to_network() {
  204. [[ $1 ]] \
  205. && [[ $(docker ps -q --filter name=^/"${1}"$) ]] \
  206. && ! [[ $(docker network inspect dockerbunker-network | grep $1) ]] \
  207. && docker network connect ${NETWORK} ${1} >/dev/null \
  208. && return
  209. for container in ${add_to_network[@]};do
  210. [[ $(docker ps -q --filter name=^/"${container}"$) ]] \
  211. && ! [[ $(docker network inspect dockerbunker-network | grep ${container}) ]] \
  212. && docker network connect ${NETWORK} ${container} >/dev/null
  213. done
  214. }
  215. wait_for_db() {
  216. if ! docker exec ${FUNCNAME[1]//_/-} mysqladmin ping -h"127.0.0.1" --silent;then
  217. while ! docker exec ${FUNCNAME[1]//_/-} mysqladmin ping -h"127.0.0.1" --silent;do
  218. sleep 1
  219. done
  220. fi
  221. }
  222. post_setup_routine() {
  223. remove_from_CONFIGURED_SERVICES
  224. ! elementInArray "${PROPER_NAME}" "${INSTALLED_SERVICES[@]}" && INSTALLED_SERVICES+=( "${PROPER_NAME}" )
  225. for container in ${add_to_network[@]};do
  226. ! elementInArray "${container}" "${CONTAINERS_IN_DOCKERBUNKER_NETWORK[@]}" && CONTAINERS_IN_DOCKERBUNKER_NETWORK+=( "${container}" )
  227. done
  228. [[ -f "${ENV_DIR}/dockerbunker.env" ]] && ( sed -i '/CONFIGURED_SERVICES/d' "${ENV_DIR}/dockerbunker.env"; sed -i '/WEB_SERVICES/d' "${ENV_DIR}/dockerbunker.env"; sed -i '/CONTAINERS_IN_DOCKERBUNKER_NETWORK/d' "${ENV_DIR}/dockerbunker.env"; sed -i '/INSTALLED_SERVICES/d' "${ENV_DIR}/dockerbunker.env" )
  229. declare -p CONFIGURED_SERVICES >> "${ENV_DIR}/dockerbunker.env"
  230. declare -p INSTALLED_SERVICES >> "${ENV_DIR}/dockerbunker.env"
  231. declare -p WEB_SERVICES >> "${ENV_DIR}/dockerbunker.env"
  232. declare -p CONTAINERS_IN_DOCKERBUNKER_NETWORK >> "${ENV_DIR}/dockerbunker.env" 2>/dev/null
  233. if elementInArray "${PROPER_NAME}" "${STOPPED_SERVICES[@]}";then
  234. remove_from_STOPPED_SERVICES
  235. fi
  236. connect_containers_to_network
  237. activate_nginx_conf
  238. if [[ $SSL_CHOICE == "le" ]] && [[ ! -d "${CONF_DIR}"/nginx/ssl/letsencrypt/${SERVICE_DOMAIN[0]} ]];then
  239. letsencrypt issue
  240. fi
  241. }
  242. # This function issues a Let's Encrypt certificate if the choice has been made earlier and finally updates the arrays in dockerbunker.env so dockerbunker knows that the service now is installed
  243. letsencrypt() {
  244. echo ""
  245. add_domains() {
  246. prompt_confirm "Include other domains in certificate beside ${SERVICE_DOMAIN[*]}?"
  247. if [[ $? == 0 ]];then
  248. unset fqdn_is_valid
  249. unset domains
  250. while [[ -z $fqdn_is_valid ]];do
  251. if [[ $invalid ]];then
  252. echo -e "\nPlease enter a valid domain!\n"
  253. fi
  254. unset invalid
  255. read -p "Enter domains, separated by spaces: ${SERVICE_DOMAIN[*]} " -ei "" domains
  256. if [[ -z $domains ]];then
  257. domains=( ${SERVICE_DOMAIN[*]} )
  258. break
  259. else
  260. domains=( ${SERVICE_DOMAIN[*]} $domains )
  261. for i in "${domains[@]}";do
  262. # don't check if main domain is valid, otherwise it will complain that the domain already exists because an nginx configuration is already in place
  263. [[ $i != ${SERVICE_DOMAIN[0]} ]] && validate_fqdn $i
  264. done
  265. invalid=1
  266. fi
  267. invalid=1
  268. done
  269. if [[ ${STATIC} ]];then
  270. [[ ${domains[1]} ]] && sed -i "s/server_name.*/server_name ${domains[*]}\;/" "data/conf/nginx/conf.d/${SERVICE_DOMAIN[0]}.conf" && sed -i "s/^SERVICE\_DOMAIN.*/SERVICE\_DOMAIN\=\(\ ${domains[*]}\ \)/" "data/env/static/${SERVICE_DOMAIN[0]}.env"
  271. else
  272. [[ ${domains[1]} ]] && sed -i "s/server_name.*/server_name ${domains[*]}\;/" "data/conf/nginx/conf.d/${SERVICE_DOMAIN[0]}.conf" && sed -i "s/^SERVICE\_DOMAIN.*/SERVICE\_DOMAIN\=\(\ ${domains[*]}\ \)/" "data/env/${SERVICE_NAME}.env"
  273. fi
  274. expand="--expand "
  275. else
  276. domains=( ${SERVICE_DOMAIN[@]} )
  277. fi
  278. }
  279. issue() {
  280. [[ -z $1 ]] && ! [[ $(docker ps -q --filter name=^/${SERVICE_NAME}-service-dockerbunker$) ]] && echo "${PROPER_NAME} container not running. Exiting." && exit 1
  281. for value in $*;do
  282. [[ ( $value == "letsencrypt" || $value == "issue" || $value == "static" ) ]] || domains+=( "$value" )
  283. done
  284. for domain in ${domains[@]};do
  285. [[ ${domain} != ${SERVICE_DOMAIN[0]} ]] && validate_fqdn $domain || fqdn_is_valid=1
  286. if [[ $fqdn_is_valid ]];then
  287. [[ ! "${le_domains[@]}" =~ $domain ]] && le_domains+=( "-d $domain" )
  288. else
  289. exit
  290. fi
  291. done
  292. [[ ( "${domains[@]}" =~ ${SERVICE_DOMAIN[0]} && ! "${domains[0]}" =~ "${SERVICE_DOMAIN[0]}" ) ]] && ( echo "Please list ${SERVICE_DOMAIN[0]} first.";exit 1 )
  293. [[ "${domains[@]}" =~ ${SERVICE_DOMAIN[0]} ]] || ( echo -e "Please include your chosen ${PROPER_NAME} domain ${SERVICE_DOMAIN[0]}";exit 1 )
  294. [[ ! -d "${CONF_DIR}"/nginx/ssl/letsencrypt ]] && mkdir "${CONF_DIR}"/nginx/ssl/letsencrypt
  295. [[ ( "${domains[@]}" =~ "${SERVICE_DOMAIN[0]}" && "${domains[0]}" =~ "${SERVICE_DOMAIN[0]}" ) ]] \
  296. && echo "" \
  297. && docker run --rm -it --name=certbot \
  298. --network ${NETWORK} \
  299. -v "${CONF_DIR}"/nginx/ssl/letsencrypt:/etc/letsencrypt \
  300. -v "${BASE_DIR}"/data/web:/var/www/html:rw \
  301. certbot/certbot \
  302. certonly --noninteractive \
  303. --webroot -w /var/www/html \
  304. ${le_domains[@]} \
  305. --email ${LE_EMAIL} ${expand}\
  306. --agree-tos
  307. if [[ $? == 0 ]];then
  308. if ! [[ -L "data/conf/nginx/ssl/${SERVICE_DOMAIN[0]}/cert.pem" ]];then
  309. echo -en "\n\e[1mBacking up self-signed certificate\e[0m"
  310. mv "${CONF_DIR}"/nginx/ssl/${SERVICE_DOMAIN[0]}/cert.{pem,pem.backup} && \
  311. mv "${CONF_DIR}"/nginx/ssl/${SERVICE_DOMAIN[0]}/key.{pem,pem.backup} && exit_response || exit_response
  312. echo -en "\n\e[1mSymlinking letsencrypt certificate\e[0m"
  313. ln -sf "/etc/nginx/ssl/letsencrypt/live/${SERVICE_DOMAIN[0]}/fullchain.pem" "${CONF_DIR}"/nginx/ssl/${SERVICE_DOMAIN[0]}/cert.pem && \
  314. ln -sf "/etc/nginx/ssl/letsencrypt/live/${SERVICE_DOMAIN[0]}/privkey.pem" "${CONF_DIR}"/nginx/ssl/${SERVICE_DOMAIN[0]}/key.pem && exit_response || exit_response
  315. fi
  316. restart_nginx
  317. fi
  318. }
  319. renew() {
  320. docker run --rm -it --name=certbot \
  321. --network ${NETWORK} \
  322. -v "${CONF_DIR}"/nginx/ssl/letsencrypt:/etc/letsencrypt \
  323. -v "${BASE_DIR}"/data/web:/var/www/html:rw \
  324. certbot/certbot \
  325. renew
  326. restart_nginx
  327. }
  328. echo -e "\e[1mObtain certificate from Let's Encrypt\e[0m"
  329. if [[ ( "$1" == "issue" ) ]] || [[ ( "$1" == "letsencrypt" && "$2" == "issue" ) ]];then
  330. add_domains
  331. issue ${domains[@]}
  332. elif [[ ( "$1" == "letsencrypt" && "$2" == "renew" ) ]] || [[ "$1" == "renew" ]];then
  333. renew
  334. else
  335. echo "Usage: issue example.org www.example.org | renew"
  336. exit 0
  337. fi
  338. }