mirror of
https://github.com/foxcpp/maddy.git
synced 2025-04-05 05:57:39 +03:00
f931cbfe45
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.
492 lines
15 KiB
Bash
Executable file
492 lines
15 KiB
Bash
Executable file
#!/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 <<EOF
|
|
Usage:
|
|
./build.sh [options] [subroutines]
|
|
|
|
Script to compile and install maddy mail server.
|
|
|
|
Options:
|
|
-h, --help guess!
|
|
-p, --prefix <path> installation prefix (default: /usr/local, \$PREFIX)
|
|
-d, --destdir <path> prefix all paths with this directory during installation
|
|
(default: empty string, \$DESTDIR)
|
|
-b, --builddir <path> directory to use to store build files
|
|
(default: \$PWD/build, \$BUILDDIR)
|
|
--systemddir <path> directory to install systemd units to
|
|
(default: \$PREFIX/lib/systemd, \$SYSTEMDUNITS)
|
|
--configdir <path> directory to install configuration files to
|
|
(default: /etc/maddy/, \$CONFDIR)
|
|
--fail2bandir <path> directory to install fail2ban configuration to
|
|
(default: /etc/fail2ban, \$FAIL2BANDIR)
|
|
--gitversion <revision> git commit or tag to checkout if not building inside
|
|
existing tree (default: master, \$GITVERSION)
|
|
--version <revision> bypass Git tag version detection and use specified string
|
|
(default: unknown, \$MADDY_VER)
|
|
--source <path> 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 <<EOF
|
|
_| _|
|
|
_|_|_| _|_| _|_|_| _|_|_| _|_|_| _| _|
|
|
_| _| _| _| _| _| _| _| _| _| _|
|
|
_| _| _| _| _| _| _| _| _| _| _|
|
|
_| _| _| _|_|_| _|_|_| _|_|_| _|_|_|
|
|
_|
|
|
All-in-one composable mail server. _|_|
|
|
|
|
EOF
|
|
}
|
|
|
|
finish_banner() {
|
|
cat >&2 <<EOF
|
|
--- Successfully installed maddy v$MADDY_VER.
|
|
|
|
Next steps:
|
|
|
|
0. Set host name and domain in $CONFDIR/maddy.conf.
|
|
|
|
1. Configure TLS certificates.
|
|
See https://foxcpp.dev/maddy/tutorials/setting-up/#tls-certificates
|
|
TL;DR Put correspoding paths in 'tls' directive in $CONFDIR/maddy.conf.
|
|
|
|
2. Start server once to generate DKIM keys.
|
|
# systemctl daemon-reload
|
|
# systemctl start maddy
|
|
|
|
3. Configure DNS records for your domain.
|
|
See https://foxcpp.dev/maddy/tutorials/setting-up/#dns-records
|
|
|
|
4. Enjoy!
|
|
EOF
|
|
|
|
}
|
|
|
|
run() {
|
|
IFS=$'\n'
|
|
read_config "$@"
|
|
export PKGDIR="$BUILDDIR/pkg"
|
|
set -euo pipefail
|
|
|
|
# Avoid leaving stale artifacts around so the following command, for
|
|
# example, will install only executables for sure.
|
|
# ./build.sh compile_binaries install_pkg
|
|
if [ -e "$PKGDIR" ]; then
|
|
echo '--- Clearing package directory...' >&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 "$@"
|