Mailu/core/admin/run_dev.sh

#!/usr/bin/env bash

set -euo pipefail

### CONFIG

DEV_NAME="${DEV_NAME:-mailu-dev}"
DEV_DB="${DEV_DB:-}"
DEV_PROFILER="${DEV_PROFILER:-false}"
DEV_LISTEN="${DEV_LISTEN:-127.0.0.1:8080}"
[[ "${DEV_LISTEN}" == *:* ]] || DEV_LISTEN="127.0.0.1:${DEV_LISTEN}"
DEV_ADMIN="${DEV_ADMIN:-admin@example.com}"
DEV_PASSWORD="${DEV_PASSWORD:-letmein}"
DEV_ARGS=( "$@" )

### MAIN

[[ -n "${DEV_DB}" ]] && {
    [[ -f "${DEV_DB}" ]] || {
        echo "Sorry, can't find DEV_DB: '${DEV_DB}'"
        exit 1
    }
    DEV_DB="$(realpath "${DEV_DB}")"
}

docker="$(command -v podman || command -v docker || echo false)"
[[ "${docker}" == "false" ]] && {
    echo "Sorry, you'll need podman or docker to run this."
    exit 1
}

tmp="$(mktemp -d)"
[[ -n "${tmp}" && -d "${tmp}" ]] || {
    echo "Sorry, can't create temporary folder."
    exit 1
}
trap "rm -rf '${tmp}'" INT TERM EXIT

admin="$(realpath "$(pwd)/${0%/*}")"
base="${admin}/../base"
assets="${admin}/assets"

cd "${tmp}"

# base
cp "${base}"/requirements-* .
cp -r "${base}"/libs .
sed -E '/^#/d;s:^FROM system$:FROM system AS base:' "${base}/Dockerfile" >Dockerfile

# assets
cp "${assets}/package.json" .
cp -r "${assets}/assets" ./assets
awk '/new compress/{f=1}!f{print}/}),/{f=0}' <"${assets}/webpack.config.js" >webpack.config.js
sed -E '/^#/d;s:^(FROM [^ ]+$):\1 AS assets:' "${assets}/Dockerfile" >>Dockerfile

# admin
sed -E '/^#/d;/^(COPY|EXPOSE|HEALTHCHECK|VOLUME|CMD) /d; s:^(.* )[^ ]*pybabel[^\\]*(.*):\1true \2:' "${admin}/Dockerfile" >>Dockerfile

# development
cat >>Dockerfile <<EOF
COPY --from=assets /work/static/ ./static/

RUN set -euxo pipefail \
  ; mkdir /data \
  ; ln -s /app/audit.py / \
  ; ln -s /app/start.py /

ENV \
    FLASK_DEBUG="true" \
    MEMORY_SESSIONS="true" \
    RATELIMIT_STORAGE_URL="memory://" \
    SESSION_COOKIE_SECURE="false" \
    \
    DEBUG="true" \
    DEBUG_PROFILER="${DEV_PROFILER}" \
    DEBUG_ASSETS="/app/static" \
    DEBUG_TB_INTERCEPT_REDIRECTS=False \
    \
    ADMIN_ADDRESS="127.0.0.1" \
    FRONT_ADDRESS="127.0.0.1" \
    SMTP_ADDRESS="127.0.0.1" \
    IMAP_ADDRESS="127.0.0.1" \
    REDIS_ADDRESS="127.0.0.1" \
    ANTIVIRUS_ADDRESS="127.0.0.1" \
    ANTISPAM_ADDRESS="127.0.0.1" \
    WEBMAIL_ADDRESS="127.0.0.1" \
    WEBDAV_ADDRESS="127.0.0.1"

CMD ["/bin/bash", "-c", "flask db upgrade &>/dev/null && flask mailu admin '${DEV_ADMIN/@*}' '${DEV_ADMIN#*@}' '${DEV_PASSWORD}' --mode ifmissing >/dev/null; flask --debug run --host=0.0.0.0 --port=8080"]
EOF

# build
chmod -R u+rwX,go+rX .
echo Running: "${docker/*\/}" build --tag "${DEV_NAME}:latest" "${DEV_ARGS[@]}" .
"${docker}" build --tag "${DEV_NAME}:latest" "${DEV_ARGS[@]}" .

# gather volumes to map into container
volumes=()

[[ -n "${DEV_DB}" ]] && volumes+=( --volume "${DEV_DB}:/data/main.db" )

for vol in audit.py start.py mailu/ migrations/; do
    volumes+=( --volume "${admin}/${vol}:/app/${vol}" )
done

for file in "${assets}/assets"/*; do
    [[ ! -f "${file}" || "${file}" == */vendor.js ]] && continue
    volumes+=( --volume "${file}:/app/static/${file/*\//}" )
done

# show configuration
cat <<EOF

=============================================================================

The "${DEV_NAME}" container was built using this configuration:

DEV_NAME="${DEV_NAME}"
DEV_DB="${DEV_DB}"
DEV_PROFILER="${DEV_PROFILER}"
DEV_LISTEN="${DEV_LISTEN}"
DEV_ADMIN="${DEV_ADMIN}"
DEV_PASSWORD="${DEV_PASSWORD}"
DEV_ARGS=( ${DEV_ARGS[*]} )

=============================================================================

You can start the container later using this command:

${docker/*\/} run --rm -it --name "${DEV_NAME}" --publish ${DEV_LISTEN}:8080$(printf " %q" "${volumes[@]}") "${DEV_NAME}"

=============================================================================

Enter the running container using this command:
${docker/*\/} exec -it "${DEV_NAME}" /bin/bash

=============================================================================

To update requirements-prod.txt you can build (and test) using:
${docker/*\/} build --tag "${DEV_NAME}:latest" --build-arg MAILU_DEPS=dev .

And then fetch the new dependencies with:
${docker/*\/} exec "${DEV_NAME}" pip freeze >$(realpath "${base}")/requirements-new.txt

=============================================================================

The Mailu UI can be found here: http://${DEV_LISTEN}/sso/login
EOF
[[ -z "${DEV_DB}" ]] && echo "You can log in with user ${DEV_ADMIN} and password ${DEV_PASSWORD}"
cat <<EOF

=============================================================================

Starting mailu dev environment...
EOF

# run
"${docker}" run --rm -it --name "${DEV_NAME}" --publish "${DEV_LISTEN}:8080" "${volumes[@]}" "${DEV_NAME}"