From f931cbfe452bf474abd66c7de1d75392b0292722 Mon Sep 17 00:00:00 2001 From: "fox.cpp" Date: Fri, 7 Feb 2020 01:11:57 +0300 Subject: [PATCH] Rewrite build scripts New script build.sh is much more suitable for downstream packaging (e.g. ./build.sh package) than hacked together package.sh wrapper for get.sh while still being usable for "effort-less" installation. Additionally, hostname setting in get.sh is flawed in many ways and is not reimplemented in build.sh. build.sh has proper command line options that allow to customize build configuration and installation prefixes. Documentation page get.sh is removed since all applicable environment variables and flags are documented in ./build.sh --help. build.sh can be called from the source directory to build maddy from *this* source instead of forced 'go get' that was used in get.sh. However, if build.sh is called not from the source directory, it clones the repo and (optionally) uses the specified commit. This keeps build.sh usable in curl|bash commands. Due to the way source code is fetched, build.sh uses Git tags instead of Go module versions as get.sh did. --- .gitignore | 2 +- build.sh | 492 +++++++++++++++++++++++++++++++++++ docs/get.sh-script.md | 31 --- docs/man/README.md | 2 +- docs/tutorials/setting-up.md | 22 +- get.sh | 202 -------------- package.sh | 44 ---- 7 files changed, 509 insertions(+), 286 deletions(-) create mode 100755 build.sh delete mode 100644 docs/get.sh-script.md delete mode 100755 get.sh delete mode 100755 package.sh diff --git a/.gitignore b/.gitignore index 73cd48d..8bdb740 100644 --- a/.gitignore +++ b/.gitignore @@ -35,4 +35,4 @@ cmd/maddy-*-helper/maddy-*-helper cmd/maddy/*mtasts-cache cmd/maddy/*queue -maddy-setup/ +build/ diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..366a10c --- /dev/null +++ b/build.sh @@ -0,0 +1,492 @@ +#!/usr/bin/env bash + +options=$(getopt -o hb:p:d: --longoptions help,builddir:,prefix:,destdir:,systemddir:,configdir:,fail2bandir:,prefix:,gitversion:,version:,source:,sudo -- "$@") +eval set -- "$options" +print_help() { + cat >&2 < installation prefix (default: /usr/local, \$PREFIX) + -d, --destdir prefix all paths with this directory during installation + (default: empty string, \$DESTDIR) + -b, --builddir directory to use to store build files + (default: \$PWD/build, \$BUILDDIR) + --systemddir directory to install systemd units to + (default: \$PREFIX/lib/systemd, \$SYSTEMDUNITS) + --configdir directory to install configuration files to + (default: /etc/maddy/, \$CONFDIR) + --fail2bandir directory to install fail2ban configuration to + (default: /etc/fail2ban, \$FAIL2BANDIR) + --gitversion git commit or tag to checkout if not building inside + existing tree (default: master, \$GITVERSION) + --version bypass Git tag version detection and use specified string + (default: unknown, \$MADDY_VER) + --source path to the maddy source tree to use + (default: look for go.mod or download, \$MADDY_SRC) + --sudo run install_pkg and create_user with sudo + +If no [subroutines] are specified, package, create_user, install_pkg are used with +latter two being executed using sudo. + +Otherwise specified subroutines are executed in the specified order. + +Available subroutines: +- package + Download sources, compile binaries and install everything under correspoding + directories in \$BUILDDIR/pkg. +- create_user + Create user and group named 'maddy'. +- install_pkg + Copy contents of \$BUILDDIR/pkg to \$DESTDIR. Special case is maddy.conf + file, if it exists in \$DESTDIR, it is copied to maddy.conf.new instead of + overwritting. package subroutine should executed before for this to work + properly. +- ensure_go + Check system Go toolchain for compatibility and download a newer version from + golang.org if necessary. +- ensure_source_tree + Download source code if necessary or use current directory if it is a Go + module tree already. +- compile_binaries + Build executable files and copy them to \$BUILDDIR/pkg/\$PREFIX/bin. +- build_man_pages + Build manual pages and copy them to \$BUILDDIR/pkg/\$PREFIX/man. +- prepare_cfg + Copy default config to \$BUILDDIR/pkg. +- prepare_misc + Copy contents of dist/ to \$BUILDDIR/pkg, patching paths to match \$PREFIX if + necessary. + +Examples: + ./build.sh + Compile maddy and install it along with all necessary stuff (e.g. + systemd units). + ./build.sh --gitversion=47777793ed0 + Same as above but build specific Git commit. + ./build.sh package + Compile maddy, but do not install anything. + ./build.sh compile_binaries install_pkg + Compile and install only executables without any extra stuff like + fail2ban configs. +EOF +} + +read_config() { + # This will make sure the variable safe to use after 'set -u' + # if it is not defined, the empty value is fine. + export DESTDIR=$DESTDIR + + # Most variables are exported so they are accessible when we cann "$0" with + # sudo. + + if [ -z "$GITVERSION" ]; then + export GITVERSION=master + fi + if [ -z "$PREFIX" ]; then + export PREFIX=/usr/local + fi + if [ -z "$CONFDIR" ]; then + export CONFDIR=/etc/maddy + fi + if [ -z "$FAIL2BANDIR" ]; then + export FAIL2BANDIR=/etc/fail2ban + fi + if [ -z "$BUILDDIR" ]; then + export BUILDDIR="$PWD/build" + fi + if [ -z "$MADDY_VER" ]; then + export MADDY_VER=unknown + fi + if [ -z "$MADDY_SRC" ]; then + export MADDY_SRC= + fi + + export CGO_CFLAGS="-g -O2 -D_FORTIFY_SOURCE=2 $CFLAGS" + export CGO_CXXFLAGS="-g -O2 -D_FORTIFY_SOURCE=2 $CXXFLAGS" + export LDFLAGS="-Wl,-z,relro,-z,now $LDFLAGS" + export CGO_LDFLAGS=$LDFLAGS + + while true; do + case "$1" in + -h|--help) + print_help + exit + ;; + -b|--builddir) + shift + export BUILDDIR="$1" + ;; + -p|--prefix) + shift + export PREFIX="$1" + ;; + -d|--destdir) + shift + export DESTDIR="$1" + ;; + --systemddir) + shift + export SYSTEMDUNITS="$1" + ;; + --configdir) + shift + export CONFDIR="$1" + ;; + --fail2bandir) + shift + export FAIL2BANDIR="$1" + ;; + --gitversion) + shift + export GITVERSION="$1" + ;; + --buildversion) + shift + export MADDY_VER="$1" + ;; + --source) + shift + export MADDY_SRC="$1" + ;; + --sudo) + export elevate=1 + ;; + --) + break + shift + ;; + *) + echo "Unknown option: ${arg}. See --help." >&2 + exit 2 + esac + shift + done + + # Since this variable depends on $PREFIX, read it after processing command + # line arguments. + if [ -z "$SYSTEMDUNITS" ]; then + export SYSTEMDUNITS=$PREFIX/lib/systemd + fi + + shift + positional=( "${@}" ) +} + + +# Test whether the Go toolchain is available on the system and matches required +# version. If it is not present or incompatible - download Go $GOVERSION and unpack. +ensure_go() { + REQUIRED_GOVERSION=1.13.0 + GOVERSION=1.13.4 + + pushd "$BUILDDIR" >/dev/null + + if ! command -v go >/dev/null; then + downloadgo=1 + else + SYSGOVERSION=$(go version | cut -f3 -d ' ' | grep -Po "([0-9]+\.){2}[0-9]+") + SYSGOMAJOR=$(cut -f1 -d. <<<"$SYSGOVERSION") + SYSGOMINOR=$(cut -f2 -d. <<<"$SYSGOVERSION") + SYSGOPATCH=$(cut -f3 -d. <<<"$SYSGOVERSION") + WANTEDGOMAJOR=$(cut -f1 -d. <<<$REQUIRED_GOVERSION) + WANTEDGOMINOR=$(cut -f2 -d. <<<$REQUIRED_GOVERSION) + WANTEDGOPATCH=$(cut -f3 -d. <<<$REQUIRED_GOVERSION) + + downloadgo=0 + if [ "$SYSGOMAJOR" -ne "$WANTEDGOMAJOR" ]; then + downloadgo=1 + fi + if [ "$SYSGOMINOR" -lt "$WANTEDGOMINOR" ]; then + downloadgo=1 + fi + if [ "$SYSGOPATCH" -lt "$WANTEDGOPATCH" ]; then + downloadgo=1 + fi + + if [ $downloadgo -eq 0 ]; then + echo "--- Using system Go toolchain ($SYSGOVERSION, $(command -v go))." >&2 + fi + fi + + if [ $downloadgo -eq 1 ]; then + echo "--- Downloading Go $GOVERSION toolchain..." >&2 + if ! [ -e go$GOVERSION ]; then + if ! [ -e go$GOVERSION.linux-amd64.tar.gz ]; then + wget -q "https://dl.google.com/go/go$GOVERSION.linux-amd64.tar.gz" + fi + tar xf go$GOVERSION.linux-amd64.tar.gz + mv go go$GOVERSION + fi + export GOROOT="$PWD/go$GOVERSION" + export PATH=go$GOVERSION/bin:$PATH + + echo "--- Using downloaded Go toolchain ($GOVERSION, $(command -v go))." >&2 + fi + + popd >/dev/null +} + +# If the script is executed independently (e.g. via curl|bash) - download the +# maddy source code. +ensure_source_tree() { + # Use specified source tree instead of auto-detection. + if [ -n "$MADDY_SRC" ]; then + echo '--- Using existing source tree...' >&2 + return + fi + + gomod="$(go env GOMOD)" + if [ "$gomod" = "/dev/null" ]; then + echo '--- Downloading source tree...' >&2 + if [ ! -e "$BUILDDIR/maddy" ]; then + git clone https://github.com/foxcpp/maddy.git "$BUILDDIR/maddy" + fi + export MADDY_SRC="$BUILDDIR/maddy" + pushd "$MADDY_SRC" >/dev/null + git stash push --quiet --all + git fetch origin master + else + MADDY_SRC="$(dirname "$gomod")" + export MADDY_SRC + pushd "$MADDY_SRC" >/dev/null + fi + + if [ ! -e "$MADDY_SRC/.git" ]; then + if [ "$MADDY_VER" != "unknown" ]; then + echo '--- WARNING: Source tree is not a Git repository and no version specified.' >&2 + fi + return + fi + + if [ "$GITVERSION" != "" ]; then + git checkout --quiet "$GITVERSION" + fi + + MADDY_VER=$(git describe --long 2>/dev/null | sed 's/\([^-]*-g\)/r\1/;s/-/./g' || + printf "r%s.%s" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)") + export MADDY_VER + + popd >/dev/null +} + +compile_binaries() { + mkdir -p "$PKGDIR/$PREFIX/bin/" + pushd "$MADDY_SRC" >/dev/null + + echo '--- Downloading dependencies...' >&2 + go get -d ./... + + echo '--- Building main executable...' >&2 + go build -trimpath -buildmode=pie \ + -ldflags "-extldflags $LDFLAGS \ + -X \"github.com/foxcpp/maddy.DefaultLibexecDirectory=$PREFIX/lib/maddy\" \ + -X \"github.com/foxcpp/maddy.ConfigDirectory=$CONFDIR\" \ + -X \"github.com/foxcpp/maddy.Version=$MADDY_VER\"" \ + -o "$PKGDIR/$PREFIX/bin/maddy" ./cmd/maddy + + echo '--- Building management utility executable...' >&2 + go build -trimpath -buildmode=pie \ + -ldflags "-extldflags $LDFLAGS \ + -X \"github.com/foxcpp/maddy.DefaultLibexecDirectory=$PREFIX/lib/maddy\" \ + -X \"github.com/foxcpp/maddy.ConfigDirectory=$CONFDIR\" \ + -X \"github.com/foxcpp/maddy.Version=$MADDY_VER\"" \ + -o "$PKGDIR/$PREFIX/bin/maddyctl" ./cmd/maddyctl + + popd >/dev/null +} + +build_man_pages() { + set +e + if ! command -v scdoc &>/dev/null; then + echo '--- No scdoc utility found. Skipping man pages installation.' >&2 + set -e + return + fi + if ! command -v gzip &>/dev/null; then + echo '--- No gzip utility found. Skipping man pages installation.' >&2 + set -e + return + fi + set -e + + echo '--- Building man pages...' >&2 + + for f in "$MADDY_SRC"/docs/man/*.1.scd; do + scdoc < "$f" | gzip > /tmp/maddy-tmp.gz + install -Dm 0644 /tmp/maddy-tmp.gz "$PKGDIR/$PREFIX/share/man/man1/$(basename -s .scd "$f").gz" + done + for f in "$MADDY_SRC"/docs/man/*.5.scd; do + scdoc < "$f" | gzip > /tmp/maddy-tmp.gz + install -Dm 0644 /tmp/maddy-tmp.gz "$PKGDIR/$PREFIX/share/man/man5/$(basename -s .scd "$f").gz" + done +} + +prepare_misc() { + echo '--- Preparing integration files...' >&2 + + pushd "$MADDY_SRC/dist" >/dev/null + + install -Dm 0644 -t "$PKGDIR/$PREFIX/share/vim/vimfiles/ftdetect/" vim/ftdetect/maddy-conf.vim + install -Dm 0644 -t "$PKGDIR/$PREFIX/share/vim/vimfiles/ftplugin/" vim/ftplugin/maddy-conf.vim + install -Dm 0644 -t "$PKGDIR/$PREFIX/share/vim/vimfiles/syntax/" vim/syntax/maddy-conf.vim + + install -Dm 0644 -t "$PKGDIR/$FAIL2BANDIR/jail.d/" fail2ban/jail.d/* + install -Dm 0644 -t "$PKGDIR/$FAIL2BANDIR/filter.d/" fail2ban/filter.d/* + + install -Dm 0644 -t "$PKGDIR/$PREFIX/lib/systemd/system/" systemd/maddy.service systemd/maddy@.service + + install -Dm 0644 -t "$PKGDIR/$CONFDIR/integration/" integration/rspamd.conf + install -Dm 0755 -t "$PKGDIR/$PREFIX/lib/maddy/" scripts/rspamd-hook + + sed -Ei "s!/usr/bin!$PREFIX/bin!g;\ + s!/usr/lib/maddy!$PREFIX/lib/maddy!g;\ + s!/etc/maddy!$CONFDIR!g" "$PKGDIR/$SYSTEMDUNITS/system/maddy.service" "$PKGDIR/$SYSTEMDUNITS/system/maddy@.service" + + popd >/dev/null +} + +prepare_cfg() { + install -Dm 0644 "$MADDY_SRC/maddy.conf" "$PKGDIR/$CONFDIR/maddy.conf" +} + +check_system_deps() { + if [ "$(go env CC)" = "" ]; then + echo 'WARNING: No C compiler available. maddy will be built without SQLite3 support and default configuration will be unusable.' >&2 + fi +} + +package() { + ensure_go + ensure_source_tree + + check_system_deps + + compile_binaries + build_man_pages + prepare_misc + prepare_cfg +} + +# Prevent 'unbound variable' in install_pkg and create_user if they are called +# directly via './build.sh ...'. +elevate=0 + +install_pkg() { + echo '--- Installing built tree...' >&2 + if [ -e "$DESTDIR/$CONFDIR/maddy.conf" ]; then + echo '--- maddy.conf exists, installing default configuration as maddy.conf.new...' >&2 + # Can be false for repeately executed install_pkg. + if [ -e "$PKGDIR/$CONFDIR/maddy.conf" ]; then + mv "$PKGDIR/$CONFDIR/maddy.conf"{,.new} + fi + fi + + pushd "$PKGDIR" >/dev/null + while IFS= read -r -d '' f + do + # This loop runs in a subshell and does not inherit shell options. + # -e is useful here to abort early if user presses Ctrl-C on sudo + # password prompt. + set -e + + if [ "$elevate" -eq 1 ]; then + sudo install -Dm "$(stat -c '%a' "$f")" "$f" "$DESTDIR/$f" + else + install -Dm "$(stat -c '%a' "$f")" "$f" "$DESTDIR/$f" + fi + done < <(find . -mindepth 1 -type f -print0) + popd >/dev/null +} + +create_user() { + set +e + if ! grep -q "maddy:x" /etc/passwd; then + echo '--- Creating maddy user...' >&2 + if [ "$elevate" -eq 1 ]; then + sudo useradd -M -U -s /usr/bin/nologin -d /var/lib/maddy/ maddy + else + useradd -M -U -s /usr/bin/nologin -d /var/lib/maddy/ maddy + fi + fi +} + +start_banner() { + cat >&2 <&2 <&2 + rm -rf "$PKGDIR" + fi + mkdir -p "$BUILDDIR" "$PKGDIR" + + if [ ${#positional[@]} -ne 0 ]; then + for arg in "${positional[@]}"; do + eval "$arg" + done + exit + fi + + # Do not print fancy banners if the script is likely running from an + # automated package build environment. + if [ "$DESTDIR" = "" ]; then + start_banner + fi + + package + export elevate=1 + create_user + install_pkg + + if [ "$DESTDIR" = "" ]; then + finish_banner + fi +} +run "$@" diff --git a/docs/get.sh-script.md b/docs/get.sh-script.md deleted file mode 100644 index 4bb5705..0000000 --- a/docs/get.sh-script.md +++ /dev/null @@ -1,31 +0,0 @@ -# get.sh script - -get.sh script does the following: - -- Makes sure you have a supported version of Go toolchain, if this is not the - case - it downloads one. -- Downloads and compiles maddy executables. -- Installs maddy executables to /usr/local/bin. -- Installs the dist/ directory contents -- Installs the man/ directory contents -- Install the default configuration. -- Creates maddy user and group. - -It is Linux-specific, users of other systems will have to use Manual -installation. - -## Environmental variables - -Users can be set following environmental variables to control the exact -behavior of the get.sh script. - -| Variable | Default value | Description | -| --------------- | --------------------- | --- | -| GOVERSION | 1.13.4 | Go toolchain version to download if the system toolchain is not compatible. | -| MADDYVERSION | master | maddy version to download & install. | -| DESTDIR | | Interpret all paths as relative to this directory during installation. | -| PREFIX | /usr/local | Installation prefix. | -| SYSTEMDUNITS | $PREFIX/lib/systemd | Directory to install systemd units to. | -| CONFDIR | /etc/maddy | Path to write configuration files to. | -| FAIL2BANDIR | /etc/fail2ban | Path to install fail2ban configs to. | -| SUDO | sudo | Executable to call to elevate privileges during installation. | diff --git a/docs/man/README.md b/docs/man/README.md index ff04003..2363c6e 100644 --- a/docs/man/README.md +++ b/docs/man/README.md @@ -12,5 +12,5 @@ scdoc < maddy-filters.5.scd > maddy-filters.5 man ./maddy-filters.5 ``` -get.sh script in the repo root compiles and installs man pages if the scdoc +build.sh script in the repo root compiles and installs man pages if the scdoc utility is installed in the system. diff --git a/docs/tutorials/setting-up.md b/docs/tutorials/setting-up.md index 86dcd5d..5975a25 100644 --- a/docs/tutorials/setting-up.md +++ b/docs/tutorials/setting-up.md @@ -9,7 +9,7 @@ For purposes of clarity, these values are used in this tutorial as examples, wherever you see them, you need to replace them with your actual values: - Domain: example.org -- MX domain (hostname): example.org +- MX domain (hostname): mx.example.org - IPv4 address: 10.2.3.4 - IPv6 address: 2001:beef::1 @@ -36,19 +36,27 @@ distributions, this should be enough: # apt-get install build-essential ``` -get.sh script will do the rest for you: +build.sh script will do the rest for you: ``` -$ curl 'https://foxcpp.dev/maddy/get.sh' | bash +$ curl 'https://foxcpp.dev/maddy/build.sh' | bash ``` -It will leave `maddy-setup` directory lying around, you might want to keep it -so you don't have to redownload and recompile everything on update. - *Note:* If you can't / don't use this script for some reason, instructions for manual installation can be found [here](../manual-installation) +## Host name + domain + +Open /etc/maddy/maddy.conf with ~~vim~~your favorite editor and change +the following lines to match your server name and domain you want to handle +mail for. + +``` +$(hostname) = mx.example.org +$(primary_domain) = example.org +``` + ## TLS certificates One thing that can't be automagically configured is TLS certs. If you already @@ -168,7 +176,7 @@ For Debian-based distributions: apt-get install fail2ban ``` -2. get.sh already installed necessary jail configuration files, but you have to +2. build.sh already installed necessary jail configuration files, but you have to enable them. Open /etc/fail2ban/jail.d/common.local (create one if needed) and add the following lines: ``` diff --git a/get.sh b/get.sh deleted file mode 100755 index eaec03a..0000000 --- a/get.sh +++ /dev/null @@ -1,202 +0,0 @@ -#!/bin/bash - -REQUIRED_GOVERSION=1.13.0 - -# This will make sure the variable safe to use after 'set -u' -# if it is not defined, the empty value is fine. -DESTDIR=$DESTDIR - -if [ "$GOVERSION" == "" ]; then - GOVERSION=1.13.4 -fi -if [ "$MADDYVERSION" == "" ]; then - MADDYVERSION=master -fi -if [ "$PREFIX" == "" ]; then - PREFIX=/usr/local -fi -if [ "$SYSTEMDUNITS" == "" ]; then - SYSTEMDUNITS=$PREFIX/lib/systemd -fi -if [ "$CONFDIR" == "" ]; then - CONFDIR=/etc/maddy -fi -if [ "$SUDO" == "" ]; then - SUDO=sudo -fi -if [ "$NO_RUN" == "" ]; then - NO_RUN=0 -fi -if [ "$HOSTNAME" == "" ]; then - HOSTNAME=$(uname -n) -fi - -export CGO_CFLAGS="-g -O2 -D_FORTIFY_SOURCE=2 $CFLAGS" -export CGO_CXXFLAGS="-g -O2 -D_FORTIFY_SOURCE=2 $CXXFLAGS" -export LDFLAGS="-Wl,-z,relro,-z,now $LDFLAGS" -export CGO_LDFLAGS=$LDFLAGS - -set -euo pipefail -IFS=$'\n' - -ensure_go_toolchain() { - if ! command -v go >/dev/null; then - downloadgo=1 - else - SYSGOVERSION=$(go version | cut -f3 -d ' ' | grep -Po "([0-9]+\.){2}[0-9]+") - SYSGOMAJOR=$(cut -f1 -d. <<<"$SYSGOVERSION") - SYSGOMINOR=$(cut -f2 -d. <<<"$SYSGOVERSION") - SYSGOPATCH=$(cut -f3 -d. <<<"$SYSGOVERSION") - WANTEDGOMAJOR=$(cut -f1 -d. <<<$REQUIRED_GOVERSION) - WANTEDGOMINOR=$(cut -f2 -d. <<<$REQUIRED_GOVERSION) - WANTEDGOPATCH=$(cut -f3 -d. <<<$REQUIRED_GOVERSION) - - downloadgo=0 - if [ "$SYSGOMAJOR" -ne "$WANTEDGOMAJOR" ]; then - downloadgo=1 - fi - if [ "$SYSGOMINOR" -lt "$WANTEDGOMINOR" ]; then - downloadgo=1 - fi - if [ "$SYSGOPATCH" -lt "$WANTEDGOPATCH" ]; then - downloadgo=1 - fi - - if [ $downloadgo -eq 0 ]; then - echo "Using system Go toolchain ($SYSGOVERSION, $(command -v go))." >&2 - fi - fi - - if [ $downloadgo -eq 1 ]; then - echo "Downloading Go $GOVERSION toolchain..." >&2 - if ! [ -e go$GOVERSION ]; then - if ! [ -e go$GOVERSION.linux-amd64.tar.gz ]; then - wget -q "https://dl.google.com/go/go$GOVERSION.linux-amd64.tar.gz" - fi - tar xf go$GOVERSION.linux-amd64.tar.gz - mv go go$GOVERSION - fi - export GOROOT=$PWD/go$GOVERSION - export PATH=go$GOVERSION/bin:$PATH - fi -} - -download_and_compile() { - export GOPATH="$PWD/gopath:$(go env GOPATH)" - export GOBIN="$PWD/gopath/bin" - - echo 'Downloading and compiling maddy...' >&2 - - export GO111MODULE=on - - go get -trimpath -buildmode=pie \ - -ldflags "-extldflags $LDFLAGS \ - -X \"github.com/foxcpp/maddy.DefaultLibexecDirectory=$PREFIX/lib/maddy\" \ - -X \"github.com/foxcpp/maddy.ConfigDirectory=$CONFDIR\"" \ - github.com/foxcpp/maddy/cmd/{maddy,maddyctl}@$MADDYVERSION -} - -source_dir() { - maddy_version_tag=$("$PWD/gopath/bin/maddy" -v | cut -f2 -d ' ') - echo "$PWD/gopath/pkg/mod/github.com/foxcpp/maddy@$maddy_version_tag" -} - -install_executables() { - echo 'Installing maddy...' >&2 - - $SUDO mkdir -p "$DESTDIR/$PREFIX/bin" - $SUDO cp --remove-destination "$PWD/gopath/bin/maddy" "$PWD/gopath/bin/maddyctl" "$DESTDIR/$PREFIX/bin/" -} - -install_dist() { - echo 'Installing dist files...' >&2 - - $SUDO bash "$(source_dir)/dist/install.sh" - - $SUDO sed -Ei "s!/usr/bin!$PREFIX/bin!g;\ - s!/usr/lib/maddy!$PREFIX/lib/maddy!g;\ - s!/etc/maddy!$CONFDIR!g" "$DESTDIR/$SYSTEMDUNITS/system/maddy.service" "$DESTDIR/$SYSTEMDUNITS/system/maddy@.service" -} - -install_man() { - set +e - if ! command -v scdoc &>/dev/null; then - echo 'No scdoc utility found. Skipping man pages installation.' >&2 - set -e - return - fi - if ! command -v gzip &>/dev/null; then - echo 'No gzip utility found. Skipping man pages installation.' >&2 - set -e - return - fi - set -e - - echo 'Installing man pages...' >&2 - for f in "$(source_dir)"/docs/man/*.1.scd; do - scdoc < "$f" | gzip > /tmp/maddy-tmp.gz - $SUDO install -Dm 0644 /tmp/maddy-tmp.gz "$DESTDIR/$PREFIX/share/man/man1/$(basename -s .scd "$f").gz" - done - for f in "$(source_dir)"/docs/man/*.5.scd; do - scdoc < "$f" | gzip > /tmp/maddy-tmp.gz - $SUDO install -Dm 0644 /tmp/maddy-tmp.gz "$DESTDIR/$PREFIX/share/man/man5/$(basename -s .scd "$f").gz" - done - rm /tmp/maddy-tmp.gz - -} - -create_user() { - echo 'Creating maddy user and group...' >&2 - - $SUDO useradd -UMr -s /sbin/nologin maddy || true -} - -install_config() { - echo 'Using configuration path:' $CONFDIR/maddy.conf - if ! [ -e "$DESTDIR/$CONFDIR/maddy.conf" ]; then - echo 'Installing default configuration...' >&2 - - install "$(source_dir)/maddy.conf" /tmp/maddy.conf - - host=$HOSTNAME - set +e # premit to fail if stdin is /dev/null (in package.sh) - read -rp "What's your domain, btw? [$host] > " DOMAIN - set -e - if [ "$DOMAIN" = "" ]; then - DOMAIN=$host - fi - echo 'Good, I will put that into configuration for you.' >&2 - - sed -Ei "s/^\\$\\(primary_domain\) = .+$/$\(primary_domain\) = $DOMAIN/" /tmp/maddy.conf - sed -Ei "s/^\\$\\(hostname\) = .+$/$\(hostname\) = $DOMAIN/" /tmp/maddy.conf - sed -Ei "s!/etc/maddy!$CONFDIR!g" /tmp/maddy.conf - - $SUDO install -Dm 0644 /tmp/maddy.conf "$DESTDIR/$CONFDIR/maddy.conf" - rm /tmp/maddy.conf - else - echo "Configuration already exists in /etc/maddy/maddy.conf, skipping defaults installation." >&2 - fi -} - -run() { - mkdir -p maddy-setup/ - cd maddy-setup/ - - ensure_go_toolchain - download_and_compile - install_executables - install_dist - install_man - install_config - create_user - $SUDO systemctl daemon-reload - - echo "Okay, almost ready." >&2 - echo "It's up to you to figure out TLS certificates and DNS stuff, though." >&2 - echo "Here is the tutorial to help you:" >&2 - echo "https://github.com/foxcpp/maddy/wiki/Tutorial:-Setting-up-a-mail-server-with-maddy" >&2 -} - -if [ "$NO_RUN" != "1" ]; then - run -fi diff --git a/package.sh b/package.sh deleted file mode 100755 index 8ed978a..0000000 --- a/package.sh +++ /dev/null @@ -1,44 +0,0 @@ -#!/bin/bash - -# Build maddy using get.sh and copy all installation files into maddy-pkgdir-XXXXXXXXX directory. -# DO NOT RUN FROM THE SOURCE DIRECTORY. IT WILL BREAK. - -script_dir="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )" - -if [ "$script_dir" = "$PWD" ]; then - echo 'Do not run package.sh from the source directory.' >&2 - exit 1 -fi - -if [ "$pkgdir" = "" ]; then - pkgdir="$PWD"/maddy-pkgdir-$(date +%s) - rm -rf "$pkgdir" - mkdir "$pkgdir" -fi - -if [ "$PREFIX" = "" ]; then - export PREFIX="/usr" -fi -if [ "$HOSTNAME" = "" ]; then - export HOSTNAME=example.org -fi - -export DESTDIR="$pkgdir" NO_RUN=1 SUDO=fakeroot -# shellcheck source=get.sh -. "$script_dir"/get.sh - -set -euo pipefail - -mkdir -p maddy-setup -cd maddy-setup/ - -run() { - ensure_go_toolchain - download_and_compile - install_executables - install_dist - install_man - install_config