diff --git a/frontend/public/json/filebrowser-quantum.json b/frontend/public/json/filebrowser-quantum.json new file mode 100644 index 000000000..7f749a5f4 --- /dev/null +++ b/frontend/public/json/filebrowser-quantum.json @@ -0,0 +1,47 @@ +{ + "name": "FileBrowser Quantum", + "slug": "filebrowser-quantum", + "categories": [ + 1, + 11 + ], + "date_created": "2025-06-16", + "type": "addon", + "updateable": false, + "privileged": false, + "interface_port": 8080, + "documentation": "https://github.com/gtsteffaniak/filebrowser/wiki/Getting-Started", + "website": "https://github.com/gtsteffaniak/filebrowser", + "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons/webp/filebrowser-quantum.webp", + "config_path": "/usr/local/community-scripts/fq-config.yaml", + "description": "FileBrowser Quantum provides an easy way to access and manage your files from the web. It has has a web page interface that allows you to create secure shared links, users with their own specific permissions and settings, and offers a great viewing experience for many file types. This version is called Quantum because it packs tons of advanced features into a tiny easy to run file. Unlike the majority of alternative options, FileBrowser Quantum is simple to install and easy to configure.", + "install_methods": [ + { + "type": "default", + "script": "tools/addon/filebrowser-quantum.sh", + "resources": { + "cpu": null, + "ram": null, + "hdd": null, + "os": null, + "version": null + } + }, + { + "type": "alpine", + "script": "tools/addon/filebrowser-quantum.sh", + "resources": { + "cpu": null, + "ram": null, + "hdd": null, + "os": null, + "version": null + } + } + ], + "default_credentials": { + "username": "admin", + "password": "helper-scripts.com" + }, + "notes": [] +} diff --git a/tools/addon/filebrowser-quantum.sh b/tools/addon/filebrowser-quantum.sh new file mode 100644 index 000000000..74911a788 --- /dev/null +++ b/tools/addon/filebrowser-quantum.sh @@ -0,0 +1,244 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2025 community-scripts ORG +# Author: Author: MickLesk +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE + +function header_info() { + clear + cat <<"EOF" + _______ __ ____ ____ __ + / ____(_) /__ / __ )_________ _ __________ _____ / __ \__ ______ _____ / /___ ______ ___ + / /_ / / / _ \/ __ / ___/ __ \ | /| / / ___/ _ \/ ___/ / / / / / / / __ `/ __ \/ __/ / / / __ `__ \ + / __/ / / / __/ /_/ / / / /_/ / |/ |/ (__ ) __/ / / /_/ / /_/ / /_/ / / / / /_/ /_/ / / / / / / +/_/ /_/_/\___/_____/_/ \____/|__/|__/____/\___/_/ \___\_\__,_/\__,_/_/ /_/\__/\__,_/_/ /_/ /_/ + +EOF +} + +YW=$(echo "\033[33m") +GN=$(echo "\033[1;92m") +RD=$(echo "\033[01;31m") +BL=$(echo "\033[36m") +CL=$(echo "\033[m") +CM="${GN}✔️${CL}" +CROSS="${RD}✖️${CL}" +INFO="${BL}ℹ️${CL}" + +APP="FileBrowser Quantum" +INSTALL_PATH="/usr/local/bin/filebrowser" +CONFIG_PATH="/usr/local/community-scripts/fq-config.yaml" +DEFAULT_PORT=8080 +SRC_DIR="/" + +# Get primary IP +IFACE=$(ip -4 route | awk '/default/ {print $5; exit}') +IP=$(ip -4 addr show "$IFACE" | awk '/inet / {print $2}' | cut -d/ -f1 | head -n 1) +[[ -z "$IP" ]] && IP=$(hostname -I | awk '{print $1}') +[[ -z "$IP" ]] && IP="127.0.0.1" + +# OS Detection +if [[ -f "/etc/alpine-release" ]]; then + OS="Alpine" + SERVICE_PATH="/etc/init.d/filebrowser" + PKG_MANAGER="apk add --no-cache" +elif [[ -f "/etc/debian_version" ]]; then + OS="Debian" + SERVICE_PATH="/etc/systemd/system/filebrowser.service" + PKG_MANAGER="apt-get install -y" +else + echo -e "${CROSS} Unsupported OS detected. Exiting." + exit 1 +fi + +header_info + +function msg_info() { + local msg="$1" + echo -e "${INFO} ${YW}${msg}...${CL}" +} + +function msg_ok() { + local msg="$1" + echo -e "${CM} ${GN}${msg}${CL}" +} + +function msg_error() { + local msg="$1" + echo -e "${CROSS} ${RD}${msg}${CL}" +} + +# Detect legacy FileBrowser installation +LEGACY_DB="/usr/local/community-scripts/filebrowser.db" +LEGACY_BIN="/usr/local/bin/filebrowser" +LEGACY_SERVICE_DEB="/etc/systemd/system/filebrowser.service" +LEGACY_SERVICE_ALP="/etc/init.d/filebrowser" + +if [[ -f "$LEGACY_DB" || -f "$LEGACY_BIN" && ! -f "$CONFIG_PATH" ]]; then + echo -e "${YW}⚠️ Detected legacy FileBrowser installation.${CL}" + echo -n "Uninstall legacy FileBrowser and continue with Quantum install? (y/n): " + read -r remove_legacy + if [[ "${remove_legacy,,}" =~ ^(y|yes)$ ]]; then + msg_info "Uninstalling legacy FileBrowser" + if [[ -f "$LEGACY_SERVICE_DEB" ]]; then + systemctl disable --now filebrowser.service &>/dev/null + rm -f "$LEGACY_SERVICE_DEB" + elif [[ -f "$LEGACY_SERVICE_ALP" ]]; then + rc-service filebrowser stop &>/dev/null + rc-update del filebrowser &>/dev/null + rm -f "$LEGACY_SERVICE_ALP" + fi + rm -f "$LEGACY_BIN" "$LEGACY_DB" + msg_ok "Legacy FileBrowser removed" + else + echo -e "${YW}❌ Installation aborted by user.${CL}" + exit 0 + fi +fi + +# Check existing installation +if [[ -f "$INSTALL_PATH" ]]; then + echo -e "${YW}⚠️ ${APP} is already installed.${CL}" + echo -n "Uninstall ${APP}? (y/N): " + read -r uninstall_prompt + if [[ "${uninstall_prompt,,}" =~ ^(y|yes)$ ]]; then + msg_info "Uninstalling ${APP}" + if [[ "$OS" == "Debian" ]]; then + systemctl disable --now filebrowser.service &>/dev/null + rm -f "$SERVICE_PATH" + else + rc-service filebrowser stop &>/dev/null + rc-update del filebrowser &>/dev/null + rm -f "$SERVICE_PATH" + fi + rm -f "$INSTALL_PATH" "$CONFIG_PATH" + msg_ok "${APP} has been uninstalled." + exit 0 + fi + + echo -n "Update ${APP}? (y/N): " + read -r update_prompt + if [[ "${update_prompt,,}" =~ ^(y|yes)$ ]]; then + msg_info "Updating ${APP}" + curl -fsSL https://github.com/gtsteffaniak/filebrowser/releases/latest/download/linux-amd64-filebrowser -o "$INSTALL_PATH" + chmod +x "$INSTALL_PATH" + msg_ok "Updated ${APP}" + exit 0 + else + echo -e "${YW}⚠️ Update skipped. Exiting.${CL}" + exit 0 + fi +fi + +echo -e "${YW}⚠️ ${APP} is not installed.${CL}" +echo -n "Enter port number (Default: ${DEFAULT_PORT}): " +read -r PORT +PORT=${PORT:-$DEFAULT_PORT} + +echo -n "Install ${APP}? (y/n): " +read -r install_prompt +if [[ "${install_prompt,,}" =~ ^(y|yes)$ ]]; then + msg_info "Installing ${APP} on ${OS}" + $PKG_MANAGER curl ffmpeg &>/dev/null + curl -fsSL https://github.com/gtsteffaniak/filebrowser/releases/latest/download/linux-amd64-filebrowser -o "$INSTALL_PATH" + chmod +x "$INSTALL_PATH" + msg_ok "Installed ${APP}" + + msg_info "Preparing configuration directory" + mkdir -p /usr/local/community-scripts + chown root:root /usr/local/community-scripts + chmod 755 /usr/local/community-scripts + msg_ok "Directory prepared" + + echo -n "Use No Authentication? (y/N): " + read -r noauth_prompt + + if [[ "${noauth_prompt,,}" =~ ^(y|yes)$ ]]; then + cat <"$CONFIG_PATH" +server: + port: $PORT + sources: + - path: "$SRC_DIR" + config: + disableIndexing: false + indexingIntervalMinutes: 240 + exclude: + folders: + - "/proc" + - "/sys" + - "/dev" + - "/run" + - "/tmp" + - "/lost+found" +auth: + methods: + noauth: true +EOF + msg_ok "Configured with no authentication" + else + cat <"$CONFIG_PATH" +server: + port: $PORT + sources: + - path: "$SRC_DIR" + config: + disableIndexing: false + indexingIntervalMinutes: 240 + exclude: + folders: + - "/proc" + - "/sys" + - "/dev" + - "/run" + - "/tmp" + - "/lost+found" +auth: + adminUsername: admin + adminPassword: helper-scripts.com +EOF + msg_ok "Configured with default admin (admin / helper-scripts.com)" + fi + + msg_info "Creating service" + + if [[ "$OS" == "Debian" ]]; then + cat <"$SERVICE_PATH" +[Unit] +Description=FileBrowser Quantum +After=network.target + +[Service] +User=root +WorkingDirectory=/usr/local/community-scripts +ExecStart=/usr/local/bin/filebrowser -c $CONFIG_PATH +Restart=always + +[Install] +WantedBy=multi-user.target +EOF + systemctl enable --now filebrowser &>/dev/null + else + cat <"$SERVICE_PATH" +#!/sbin/openrc-run + +command="/usr/local/bin/filebrowser" +command_args="-c $CONFIG_PATH" +command_background=true +directory="/usr/local/community-scripts" +pidfile="/usr/local/community-scripts/pidfile" + +depend() { + need net +} +EOF + chmod +x "$SERVICE_PATH" + rc-update add filebrowser default &>/dev/null + rc-service filebrowser start &>/dev/null + fi + + msg_ok "Service created successfully" + echo -e "${CM} ${GN}${APP} is reachable at: ${BL}http://$IP:$PORT${CL}" +else + echo -e "${YW}⚠️ Installation skipped. Exiting.${CL}" + exit 0 +fi