diff --git a/apps/bichon/2.4.1/.env.sample b/apps/bichon/2.4.1/.env.sample new file mode 100644 index 000000000..eb3caad35 --- /dev/null +++ b/apps/bichon/2.4.1/.env.sample @@ -0,0 +1,6 @@ +CONTAINER_NAME=bichon-compose-check +PANEL_APP_PORT_HTTP=15630 +APP_DATA_DIR=./data +BICHON_ENCRYPT_PASSWORD=replace-with-a-long-random-encryption-password +BICHON_PUBLIC_URL= +BICHON_LOG_LEVEL=info diff --git a/apps/bichon/2.4.1/data.yml b/apps/bichon/2.4.1/data.yml new file mode 100644 index 000000000..bc72c36f8 --- /dev/null +++ b/apps/bichon/2.4.1/data.yml @@ -0,0 +1,95 @@ +additionalProperties: + formFields: + - default: 15630 + edit: true + envKey: PANEL_APP_PORT_HTTP + labelEn: HTTP Port + labelZh: HTTP 端口 + label: + en: HTTP Port + zh: HTTP 端口 + zh-Hant: HTTP 埠 + ja: HTTP ポート + ko: HTTP 포트 + ru: HTTP-порт + ms: Port HTTP + pt-br: Porta HTTP + required: true + rule: paramPort + type: number + - default: ./data + edit: true + envKey: APP_DATA_DIR + labelEn: Data Directory + labelZh: 数据目录 + label: + en: Data Directory + zh: 数据目录 + zh-Hant: 資料目錄 + ja: データディレクトリ + ko: 데이터 디렉터리 + ru: Каталог данных + ms: Direktori data + pt-br: Diretorio de dados + required: true + type: text + - edit: true + envKey: BICHON_ENCRYPT_PASSWORD + labelEn: Encryption Password + labelZh: 加密密码 + label: + en: Encryption Password + zh: 加密密码 + zh-Hant: 加密密碼 + ja: 暗号化パスワード + ko: 암호화 비밀번호 + ru: Пароль шифрования + ms: Kata laluan penyulitan + pt-br: Senha de criptografia + random: true + required: true + rule: paramComplexity + type: password + - default: "" + edit: true + envKey: BICHON_PUBLIC_URL + labelEn: Public URL + labelZh: 公开访问地址 + label: + en: Public URL + zh: 公开访问地址 + zh-Hant: 公開存取位址 + ja: 公開 URL + ko: 공개 URL + ru: Публичный URL + ms: URL awam + pt-br: URL publico + required: false + type: text + - default: info + edit: true + envKey: BICHON_LOG_LEVEL + labelEn: Log Level + labelZh: 日志级别 + label: + en: Log Level + zh: 日志级别 + zh-Hant: 日誌層級 + ja: ログレベル + ko: 로그 수준 + ru: Уровень журнала + ms: Tahap log + pt-br: Nivel de log + required: true + type: select + values: + - label: trace + value: trace + - label: debug + value: debug + - label: info + value: info + - label: warn + value: warn + - label: error + value: error diff --git a/apps/bichon/2.4.1/data/.gitkeep b/apps/bichon/2.4.1/data/.gitkeep new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/apps/bichon/2.4.1/data/.gitkeep @@ -0,0 +1 @@ + diff --git a/apps/bichon/2.4.1/docker-compose.yml b/apps/bichon/2.4.1/docker-compose.yml new file mode 100644 index 000000000..bec6a6442 --- /dev/null +++ b/apps/bichon/2.4.1/docker-compose.yml @@ -0,0 +1,24 @@ +services: + bichon: + image: "rustmailer/bichon:2.4.1" + container_name: ${CONTAINER_NAME} + restart: always + user: "1000:1000" + networks: + - 1panel-network + ports: + - "${PANEL_APP_PORT_HTTP}:15630" + environment: + - BICHON_ROOT_DIR=/data + - BICHON_ENCRYPT_PASSWORD=${BICHON_ENCRYPT_PASSWORD} + - BICHON_PUBLIC_URL=${BICHON_PUBLIC_URL} + - BICHON_LOG_LEVEL=${BICHON_LOG_LEVEL} + - BICHON_ANSI_LOGS=false + volumes: + - "${APP_DATA_DIR}:/data" + labels: + createdBy: "Apps" + +networks: + 1panel-network: + external: true diff --git a/apps/bichon/2.4.1/scripts/init.sh b/apps/bichon/2.4.1/scripts/init.sh new file mode 100755 index 000000000..7437617b3 --- /dev/null +++ b/apps/bichon/2.4.1/scripts/init.sh @@ -0,0 +1,60 @@ +#!/usr/bin/env bash +set -euo pipefail + +ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)" +ENV_FILE="${ENV_FILE:-$ROOT_DIR/.env}" + +read_env_value() { + local key="$1" + local value + [[ -f "$ENV_FILE" ]] || return 0 + value="$(sed -n "s/^${key}=//p" "$ENV_FILE" | tail -n 1)" + value="${value%$'\r'}" + case "$value" in + \"*\") value="${value#\"}"; value="${value%\"}" ;; + \'*\') value="${value#\'}"; value="${value%\'}" ;; + esac + printf '%s\n' "$value" +} + +DATA_DIR="${APP_DATA_DIR:-}" +if [[ -z "$DATA_DIR" ]]; then + DATA_DIR="$(read_env_value APP_DATA_DIR)" +fi +DATA_DIR="${DATA_DIR:-./data}" + +if [[ "$DATA_DIR" = /* ]]; then + RESOLVED_DATA_DIR="$(realpath -m -- "$DATA_DIR")" + if [[ -L "$DATA_DIR" ]]; then + printf 'APP_DATA_DIR must not be a symbolic link\n' >&2 + exit 1 + fi + if [[ -e "$RESOLVED_DATA_DIR" ]]; then + [[ -d "$RESOLVED_DATA_DIR" ]] || { + printf 'APP_DATA_DIR must refer to a directory\n' >&2 + exit 1 + } + [[ "$(stat -c '%u:%g' "$RESOLVED_DATA_DIR")" == '1000:1000' ]] || { + printf 'Existing absolute APP_DATA_DIR must be owned by UID/GID 1000:1000\n' >&2 + exit 1 + } + else + install -d -m 0750 -- "$RESOLVED_DATA_DIR" + if [[ "$(id -u)" -eq 0 ]]; then + chown 1000:1000 -- "$RESOLVED_DATA_DIR" + fi + fi +else + RESOLVED_DATA_DIR="$(realpath -m -- "$ROOT_DIR/${DATA_DIR#./}")" + case "$RESOLVED_DATA_DIR" in + "$ROOT_DIR"/*) ;; + *) + printf 'Relative APP_DATA_DIR must remain inside the application version directory\n' >&2 + exit 1 + ;; + esac + install -d -m 0750 -- "$RESOLVED_DATA_DIR" + if [[ "$(id -u)" -eq 0 ]]; then + chown 1000:1000 -- "$RESOLVED_DATA_DIR" + fi +fi diff --git a/apps/bichon/2.4.1/scripts/uninstall.sh b/apps/bichon/2.4.1/scripts/uninstall.sh new file mode 100755 index 000000000..c6af20129 --- /dev/null +++ b/apps/bichon/2.4.1/scripts/uninstall.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env bash +set -euo pipefail + +docker-compose down --volumes --remove-orphans diff --git a/apps/bichon/2.4.1/scripts/upgrade.sh b/apps/bichon/2.4.1/scripts/upgrade.sh new file mode 100755 index 000000000..4e732f57a --- /dev/null +++ b/apps/bichon/2.4.1/scripts/upgrade.sh @@ -0,0 +1,106 @@ +#!/usr/bin/env bash +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)" +APP_DIR="$(cd "$SCRIPT_DIR/.." && pwd -P)" +ENV_FILE="${ENV_FILE:-$APP_DIR/.env}" +ADMIN_IMAGE="rustmailer/bichon:2.3.0" + +read_env_value() { + local key="$1" + local value + [[ -f "$ENV_FILE" ]] || return 0 + value="$(sed -n "s/^${key}=//p" "$ENV_FILE" | tail -n 1)" + value="${value%$'\r'}" + case "$value" in + \"*\") value="${value#\"}"; value="${value%\"}" ;; + \'*\') value="${value#\'}"; value="${value%\'}" ;; + esac + printf '%s\n' "$value" +} + +"$SCRIPT_DIR/init.sh" + +APP_DATA_DIR="${APP_DATA_DIR:-$(read_env_value APP_DATA_DIR)}" +APP_DATA_DIR="${APP_DATA_DIR:-./data}" +if [[ "$APP_DATA_DIR" = /* ]]; then + RESOLVED_DATA_DIR="$(realpath -m -- "$APP_DATA_DIR")" +else + RESOLVED_DATA_DIR="$(realpath -m -- "$APP_DIR/${APP_DATA_DIR#./}")" + case "$RESOLVED_DATA_DIR" in + "$APP_DIR"/*) ;; + *) + printf 'Relative APP_DATA_DIR must remain inside the application directory\n' >&2 + exit 1 + ;; + esac +fi +[[ -d "$RESOLVED_DATA_DIR" ]] || { + printf 'APP_DATA_DIR does not exist: %s\n' "$RESOLVED_DATA_DIR" >&2 + exit 1 +} + +docker_args=(docker run --rm --network none --user 1000:1000 --mount "type=bind,source=$RESOLVED_DATA_DIR,target=/data" --env BICHON_ROOT_DIR=/data) +if [[ -n "${BICHON_INDEX_DIR:-$(read_env_value BICHON_INDEX_DIR)}" ]]; then + docker_args+=(--env "BICHON_INDEX_DIR=${BICHON_INDEX_DIR:-$(read_env_value BICHON_INDEX_DIR)}") +fi + +storage_state() { + "${docker_args[@]}" --entrypoint sh "$ADMIN_IMAGE" -c ' + set -eu + root=/data + storage="$root/bichon-storage" + version=0 + if [ -f "$root/STORAGE_VERSION" ]; then + version="$(cat "$root/STORAGE_VERSION")" + fi + case "$version" in + ""|*[!0-9]*) echo INVALID; exit 0 ;; + esac + if [ -d "$storage/blobs" ]; then + if [ "$version" -ge 2 ]; then echo CURRENT; else echo PARTIAL; fi + elif [ -d "$storage" ]; then + if [ "$version" -lt 2 ]; then echo LEGACY; else echo INVALID; fi + elif [ "$version" -eq 0 ]; then + echo CLEAN + else + echo INVALID + fi + ' +} + +state="$(storage_state)" +case "$state" in + CLEAN|CURRENT) + ;; + LEGACY) + if ! command -v script >/dev/null 2>&1; then + printf 'The util-linux script command is required for the Bichon v1 storage migration\n' >&2 + exit 1 + fi + + printf -v admin_command '%q ' "${docker_args[@]}" --interactive --tty --entrypoint bichon-admin "$ADMIN_IMAGE" + { + sleep 0.2 + printf '\033[B\033[B\r' + sleep 0.2 + printf '/data\r' + sleep 0.2 + printf '\r' + sleep 0.2 + printf '\r' + sleep 0.2 + printf '\r' + } | script -qefc "$admin_command" /dev/null + + state="$(storage_state)" + if [[ "$state" != CURRENT ]]; then + printf 'Bichon v1 storage migration did not reach storage version 2 (state: %s)\n' "$state" >&2 + exit 1 + fi + ;; + *) + printf 'Unrecognized or incomplete Bichon storage layout (state: %s); refusing to start the upgraded app\n' "$state" >&2 + exit 1 + ;; +esac