From 05ff43849ba9c1cd65bb8cd33b906553758e2a8d Mon Sep 17 00:00:00 2001 From: "push-app-to-main[bot]" <203845782+push-app-to-main[bot]@users.noreply.github.com> Date: Sat, 7 Feb 2026 22:24:55 +0100 Subject: [PATCH] Bichon (#11671) * Add bichon (ct) * Update date_created for bichon.json * Update bichon.sh * Update bichon.json --------- Co-authored-by: push-app-to-main[bot] <203845782+push-app-to-main[bot]@users.noreply.github.com> Co-authored-by: CanbiZ (MickLesk) <47820557+MickLesk@users.noreply.github.com> Co-authored-by: Tobias <96661824+CrazyWolf13@users.noreply.github.com> --- ct/bichon.sh | 55 +++++++++++++++++++++++++++ frontend/public/json/bichon.json | 40 ++++++++++++++++++++ install/bichon-install.sh | 65 ++++++++++++++++++++++++++++++++ 3 files changed, 160 insertions(+) create mode 100644 ct/bichon.sh create mode 100644 frontend/public/json/bichon.json create mode 100644 install/bichon-install.sh diff --git a/ct/bichon.sh b/ct/bichon.sh new file mode 100644 index 000000000..796f8c647 --- /dev/null +++ b/ct/bichon.sh @@ -0,0 +1,55 @@ +#!/usr/bin/env bash +source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func) +# Copyright (c) 2021-2026 community-scripts ORG +# Author: Slaviša Arežina (tremor021) +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://github.com/rustmailer/bichon + +APP="Bichon" +var_tags="${var_tags:-email;archive}" +var_cpu="${var_cpu:-1}" +var_ram="${var_ram:-1024}" +var_disk="${var_disk:-4}" +var_os="${var_os:-debian}" +var_version="${var_version:-13}" +var_unprivileged="${var_unprivileged:-1}" + +header_info "$APP" +variables +color +catch_errors + +function update_script() { + header_info + check_container_storage + check_container_resources + if [[ ! -d /opt/bichon ]]; then + msg_error "No ${APP} Installation Found!" + exit + fi + + if check_for_gh_release "bichon" "rustmailer/bichon"; then + msg_info "Stopping service" + systemctl stop bichon + msg_ok "Stopped service" + + cp /opt/bichon/bichon.env /tmp/bichon.env.backup + CLEAN_INSTALL=1 fetch_and_deploy_gh_release "bichon" "rustmailer/bichon" "prebuild" "latest" "/opt/bichon" "bichon-*-x86_64-unknown-linux-gnu.tar.gz" + cp /tmp/bichon.env.backup /opt/bichon/bichon.env + + msg_info "Starting service" + systemctl start bichon + msg_ok "Service started" + msg_ok "Updated successfully!" + fi + exit +} + +start +build_container +description + +msg_ok "Completed successfully!\n" +echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}" +echo -e "${INFO}${YW} Access it using the following URL:${CL}" +echo -e "${TAB}${GATEWAY}${BGN}http://${IP}:15630${CL}" diff --git a/frontend/public/json/bichon.json b/frontend/public/json/bichon.json new file mode 100644 index 000000000..a9c3ddf6c --- /dev/null +++ b/frontend/public/json/bichon.json @@ -0,0 +1,40 @@ +{ + "name": "Bichon", + "slug": "bichon", + "categories": [ + 7 + ], + "date_created": "2026-02-07", + "type": "ct", + "updateable": true, + "privileged": false, + "interface_port": 15630, + "documentation": "https://github.com/rustmailer/bichon/wiki", + "config_path": "/opt/bichon/bichon.env", + "website": "https://github.com/rustmailer/bichon", + "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/bichon.webp", + "description": "Bichon is an open-source email archiving system that synchronizes emails from IMAP servers, indexes them for full-text search, and provides a REST API for programmatic access. Unlike email clients, Bichon is designed for archiving and searching rather than sending/receiving emails. It runs as a standalone server application that continuously synchronizes configured email accounts and maintains a searchable local archive.", + "install_methods": [ + { + "type": "default", + "script": "ct/bichon.sh", + "resources": { + "cpu": 1, + "ram": 1024, + "hdd": 4, + "os": "Debian", + "version": "13" + } + } + ], + "default_credentials": { + "username": "admin", + "password": "admin@bichon" + }, + "notes": [ + { + "text": "The Disk space initially allocated by the script is only a placeholder, as we can't know how much space you will ever need. You should increase it to match your workload.", + "type": "info" + } + ] +} diff --git a/install/bichon-install.sh b/install/bichon-install.sh new file mode 100644 index 000000000..f92454923 --- /dev/null +++ b/install/bichon-install.sh @@ -0,0 +1,65 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2026 community-scripts ORG +# Author: Slaviša Arežina (tremor021) +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://github.com/rustmailer/bichon + +source /dev/stdin <<<"$FUNCTIONS_FILE_PATH" +color +verb_ip6 +catch_errors +setting_up_container +network_check +update_os + +fetch_and_deploy_gh_release "bichon" "rustmailer/bichon" "prebuild" "latest" "/opt/bichon" "bichon-*-x86_64-unknown-linux-gnu.tar.gz" + +read -r -p "${TAB3}Enter the public URL for Bichon (e.g., https://bichon.yourdomain.com) or leave empty to use container IP: " bichon_url +if [[ -z "$bichon_url" ]]; then + msg_info "No URL provided" + BICHON_PUBLIC_URL="http://$LOCAL_IP:15630" + msg_ok "Using local IP: http://$LOCAL_IP:15630\n" +else + msg_info "URL provided" + BICHON_PUBLIC_URL="$bichon_url" + msg_ok "Using provided URL: $BICHON_PUBLIC_URL\n" +fi + +msg_info "Setting up Bichon" +mkdir -p /opt/bichon-data +BICHON_ENC_PASSWORD=$(openssl rand -base64 32 | tr -d "=+/" | cut -c1-32) + +cat </opt/bichon/bichon.env +BICHON_ROOT_DIR=/opt/bichon-data +BICHON_LOG_LEVEL=info +BICHON_ENCRYPT_PASSWORD=$BICHON_ENC_PASSWORD +BICHON_PUBLIC_URL=$BICHON_PUBLIC_URL +BICHON_CORS_ORIGINS=$BICHON_PUBLIC_URL +EOF +msg_ok "Setup Bichon" + +msg_info "Creating Service" +cat </etc/systemd/system/bichon.service +[Unit] +Description=Bichon service +After=network.target + +[Service] +Type=simple +User=root +EnvironmentFile=/opt/bichon/bichon.env +WorkingDirectory=/opt/bichon +ExecStart=/opt/bichon/bichon +Restart=on-failure +RestartSec=5 + +[Install] +WantedBy=multi-user.target +EOF +systemctl enable -q --now bichon +msg_info "Created Service" + +motd_ssh +customize +cleanup_lxc