From 72ad956cd90cca130e7adc172c87365f4b45e8dd Mon Sep 17 00:00:00 2001 From: Omer Naveed <198643919+omernaveedxyz@users.noreply.github.com> Date: Thu, 30 Oct 2025 17:14:51 -0500 Subject: [PATCH] Add Miniflux script (#935) * Add Miniflux script * Delete ct/headers/miniflux This will get auto-generated by our func * Minor fixes to Miniflux scripts - run `apt update` before `apt upgrade miniflux` - use selfh.st/icons for logo - remove `[trusted=yes]` from miniflux source - remove extra spaces - change `apt-get` to `apt` * Move Miniflux DB creds Move Miniflux database credentials from a separate file, to directly inside of the `/etc/minflux.conf` file. * Update Miniflux source to be trusted automatically * Store ~/.pgpass for db backups using pg_dump * Use GitHub Release binary instead of UNSIGNED apt source * Add apt -y clean * Make recommended changes * Added notes * Set `LISTEN_ADDR=0.0.0.0:8080` by default * Finishing touches. Removed some unneeded msg blocks --------- Co-authored-by: Tobias <96661824+CrazyWolf13@users.noreply.github.com> Co-authored-by: Michel Roegl-Brunner <73236783+michelroegl-brunner@users.noreply.github.com> --- ct/miniflux.sh | 48 +++++++++++++++++++++++ frontend/public/json/miniflux.json | 40 +++++++++++++++++++ install/miniflux-install.sh | 63 ++++++++++++++++++++++++++++++ 3 files changed, 151 insertions(+) create mode 100644 ct/miniflux.sh create mode 100644 frontend/public/json/miniflux.json create mode 100644 install/miniflux-install.sh diff --git a/ct/miniflux.sh b/ct/miniflux.sh new file mode 100644 index 000000000..bb79d9a8e --- /dev/null +++ b/ct/miniflux.sh @@ -0,0 +1,48 @@ +#!/usr/bin/env bash +source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main/misc/build.func) +# Copyright (c) 2021-2025 community-scripts ORG +# Author: omernaveedxyz +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://miniflux.app/ + +APP="Miniflux" +var_tags="${var_tags:-media}" +var_cpu="${var_cpu:-2}" +var_ram="${var_ram:-2048}" +var_disk="${var_disk:-8}" +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 [[ ! -f /etc/systemd/system/miniflux.service ]]; then + msg_error "No ${APP} Installation Found!" + exit + fi + + msg_info "Updating ${APP} LXC" + $STD miniflux -flush-sessions -config-file /etc/miniflux.conf + $STD systemctl stop miniflux + fetch_and_deploy_gh_release "miniflux" "miniflux/v2" "binary" "latest" + $STD miniflux -migrate -config-file /etc/miniflux.conf + $STD systemctl start miniflux + msg_ok "Updated Successfully" + 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}:8080${CL}" diff --git a/frontend/public/json/miniflux.json b/frontend/public/json/miniflux.json new file mode 100644 index 000000000..75a6f2551 --- /dev/null +++ b/frontend/public/json/miniflux.json @@ -0,0 +1,40 @@ +{ + "name": "Miniflux", + "slug": "miniflux", + "categories": [ + 13 + ], + "date_created": "2025-09-24", + "type": "ct", + "updateable": true, + "privileged": false, + "config_path": "/etc/miniflux.conf", + "interface_port": 8080, + "documentation": "https://miniflux.app/docs/index.html", + "website": "https://miniflux.app/", + "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons/webp/miniflux-light.webp", + "description": "Miniflux is a minimalist and opinionated feed reader.", + "install_methods": [ + { + "type": "default", + "script": "ct/miniflux.sh", + "resources": { + "cpu": 2, + "ram": 2048, + "hdd": 8, + "os": "Debian", + "version": "13" + } + } + ], + "default_credentials": { + "username": "admin", + "password": "randomly generated during installation process" + }, + "notes": [ + { + "text": "Admin password available as `ADMIN_PASSWORD` in `~/miniflux.creds`", + "type": "info" + } + ] +} diff --git a/install/miniflux-install.sh b/install/miniflux-install.sh new file mode 100644 index 000000000..84ea96660 --- /dev/null +++ b/install/miniflux-install.sh @@ -0,0 +1,63 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2025 community-scripts ORG +# Author: omernaveedxyz +# License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE +# Source: https://miniflux.app/ + +source /dev/stdin <<<"$FUNCTIONS_FILE_PATH" +color +verb_ip6 +catch_errors +setting_up_container +network_check +update_os + + +PG_VERSION=17 setup_postgresql +DB_NAME=miniflux +DB_USER=miniflux +DB_PASS="$(openssl rand -base64 18 | cut -c1-13)" +$STD sudo -u postgres psql -c "CREATE ROLE $DB_USER WITH LOGIN PASSWORD '$DB_PASS';" +$STD sudo -u postgres psql -c "CREATE DATABASE $DB_NAME WITH OWNER $DB_USER;" +$STD sudo -u postgres psql -d "$DB_NAME" -c "CREATE EXTENSION hstore;" + + + +fetch_and_deploy_gh_release "miniflux" "miniflux/v2" "binary" "latest" + + +msg_info "Configuring Miniflux" +ADMIN_NAME=admin +ADMIN_PASS="$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | head -c13)" +cat </etc/miniflux.conf +# See https://miniflux.app/docs/configuration.html +DATABASE_URL=postgres://$DB_USER:$DB_PASS@localhost/$DB_NAME?sslmode=disable +CREATE_ADMIN=1 +ADMIN_USERNAME=$ADMIN_NAME +ADMIN_PASSWORD=$ADMIN_PASS +LISTEN_ADDR=0.0.0.0:8080 +EOF + +{ + echo "Application Credentials" + echo "DB_NAME: $DB_NAME" + echo "DB_USER: $DB_USER" + echo "DB_PASS: $DB_PASS" + echo "ADMIN_USERNAME: $ADMIN_NAME" + echo "ADMIN_PASSWORD: $ADMIN_PASS" +} >>~/miniflux.creds + +miniflux -migrate -config-file /etc/miniflux.conf + +systemctl enable -q --now miniflux +msg_ok "Configured Miniflux" + +motd_ssh +customize + +msg_info "Cleaning up" +$STD apt -y autoremove +$STD apt -y autoclean +$STD apt -y clean +msg_ok "Cleaned"