MINIFLUX(1)   MINIFLUX(1)

miniflux - خبرخوان سبک، ساده و متنی RSS/Atom تحت وب

miniflux [گزینه‌ها]

miniflux یک خبرخوان سبک، ساده و متنی برای خوراک‌های وب (RSS/Atom) است.

-h, -help

نمایش راهنمای استفاده و خروج.

-config-dump

چاپ مقادیر پیکربندی پردازش‌شده.
این گزینه شامل اطلاعات حساسی مانند گذرواژه‌ها خواهد بود.

-c /path/to/miniflux.conf

بارگذاری فایل پیکربندی.

-config-file /path/to/miniflux.conf

بارگذاری فایل پیکربندی.

-create-admin

ایجاد کاربر مدیر از طریق ترمینال تعاملی.

-debug

تنظیم سطح ثبت گزارش (log level) روی حالت اشکال‌زدایی (debug).

-export-user-feeds <username>

برون‌بری خوراک‌های کاربر (ارائه نام کاربری به عنوان آرگومان).
مثال: 
miniflux -export-user-feeds someone > feeds.xml

-flush-sessions

پاکسازی تمام نشست‌ها (قطع اتصال کاربران).

-healthcheck <endpoint>

انجام بررسی سلامت روی نقطه پایانی مشخص‌شده.
مقدار "auto" تلاش می‌کند نقطه پایانی بررسی سلامت را حدس بزند.

-i

نمایش اطلاعات ساخت (Build Information).

-info

نمایش اطلاعات ساخت (Build Information).

-migrate

اجرای مهاجرت‌های پایگاه داده SQL.

-refresh-feeds

بازآوری دسته‌ای از خوراک‌ها و خروج.

-reset-feed-errors

پاک کردن تمام خطاهای خوراک برای همه کاربران.

-reset-feed-next-check-at

بازنشانی زمان بررسی بعدی برای تمامی خوراک‌ها.

-reset-password

بازنشانی گذرواژه کاربر.

-run-cleanup-tasks

اجرای وظایف پاکسازی (حذف نشست‌های قدیمی و بایگانی ورودی‌های قدیمی).

-v

نمایش نسخه برنامه.

-version

نمایش نسخه برنامه.

فایل پیکربندی یک فایل متنی است که از این قوانین پیروی می‌کند:

- برنامه Miniflux انتظار دارد هر خط در قالب KEY=VALUE باشد.
- خطوطی که با # شروع می‌شوند به عنوان توضیح (کامنت) در نظر گرفته شده و نادیده گرفته می‌شوند.
- خطوط خالی نادیده گرفته می‌شوند.
- هیچ جایگزینی متغیری (interpolation) وجود ندارد.

کلیدها همان متغیرهای محیطی شرح‌داده‌شده در زیر هستند.
متغیرهای محیطی مقادیر تعریف‌شده در فایل پیکربندی را بازنویسی می‌کنند.

گزینه‌های بولی مقادیر زیر را می‌پذیرند (بدون حساسیت به حروف بزرگ و کوچک): 1/0, yes/no, true/false, on/off.
برای متغیرهایی که به _FILE ختم می‌شوند، مقدار برابر با مسیر فایلی است که حاوی مقدار محرمانه مربوطه است.

گذرواژه کاربر مدیر، تنها در صورتی استفاده می‌شود که CREATE_ADMIN فعال باشد.
پیش‌فرض خالی است.
مسیر کلید محرمانه ارائه‌شده به عنوان یک فایل؛ باید حاوی مقدار ADMIN_PASSWORD باشد.
پیش‌فرض خالی است.
نام کاربری مدیر، تنها در صورتی استفاده می‌شود که CREATE_ADMIN فعال باشد.
پیش‌فرض خالی است.
مسیر کلید محرمانه ارائه‌شده به عنوان یک فایل؛ باید حاوی مقدار ADMIN_USERNAME باشد.
پیش‌فرض خالی است.
سرآیند HTTP احراز هویت پروکسی.
گزینه TRUSTED_REVERSE_PROXY_NETWORKS باید پیکربندی شود تا به پروکسی اجازه احراز هویت کاربران داده شود.
پیش‌فرض خالی است.
تنظیم روی ۱ برای ایجاد کاربران بر اساس اطلاعات احراز هویت پروکسی.
در صورت غیرفعال بودن، کاربران برای ورود از طریق پروکسی باید از قبل در Miniflux وجود داشته باشند.
به صورت پیش‌فرض غیرفعال است.
نشانی وب پایه برای تولید پیوندهای HTML و مسیر پایه کوکی‌ها.
پیش‌فرض http://localhost است.
تعداد خوراک‌های ارسالی به صف در هر بازه زمانی.
پیش‌فرض ۱۰۰ خوراک است.
استفاده از Let's Encrypt برای دریافت خودکار گواهی امنیتی برای این دامنه.
پیش‌فرض خالی است.
مسیر گواهی امنیتی SSL.
پیش‌فرض خالی است.
تعداد ورودی‌ها برای بایگانی در هر بازه اجرای وظیفه.
پیش‌فرض ۱۰۰۰۰ ورودی است.
تعداد روزها پیش از اینکه وظیفه پاکسازی ورودی‌های خوانده‌شده را بایگانی کند.
بایگانی کردن، ورودی‌های خوانده‌شده‌ای را که نشانه‌گذاری یا همرسانی نشده‌اند از پایگاه داده حذف کرده و یک نشانه حذف (tombstone) ثبت می‌کند تا از ورود مجدد همان ورودی در بازآوری‌های بعدی خوراک جلوگیری شود.
برای غیرفعال کردن بایگانی خودکار ورودی‌های خوانده‌شده روی -1 تنظیم کنید.
پیش‌فرض ۶۰ روز است.
تعداد روزها پیش از اینکه وظیفه پاکسازی ورودی‌های خوانده‌نشده را بایگانی کند.
بایگانی کردن، ورودی‌های خوانده‌نشده‌ای را که نشانه‌گذاری یا همرسانی نشده‌اند از پایگاه داده حذف کرده و یک نشانه حذف (tombstone) ثبت می‌کند تا از ورود مجدد همان ورودی در بازآوری‌های بعدی خوراک جلوگیری شود.
برای غیرفعال کردن بایگانی خودکار ورودی‌های خوانده‌نشده روی -1 تنظیم کنید.
پیش‌فرض ۱۸۰ روز است.
بسامد اجرای وظیفه پاکسازی؛ حذف نشست‌های قدیمی و بایگانی ورودی‌ها.
پیش‌فرض ۲۴ ساعت است.
تعداد روزها برای نگهداری نشست‌ها پیش از حذف نشست‌های قدیمی از پایگاه داده.
پیش‌فرض ۳۰ روز است.
تنظیم روی ۱ برای ایجاد کاربر مدیر از طریق متغیرهای محیطی.
به صورت پیش‌فرض غیرفعال است.
تنظیم حداکثر مدت زمانی که یک اتصال می‌تواند مجدداً استفاده شود.
پیش‌فرض ۵ دقیقه است.
حداکثر تعداد اتصالات پایگاه داده.
پیش‌فرض ۲۰ است.
حداقل تعداد اتصالات پایگاه داده.
پیش‌فرض ۱ است.
پارامترهای اتصال به پایگاه داده PostgreSQL.
پیش‌فرض "user=postgres password=postgres dbname=miniflux2 sslmode=disable" است.
مسیر کلید محرمانه ارائه‌شده به عنوان یک فایل؛ باید حاوی مقدار DATABASE_URL باشد.
پیش‌فرض خالی است.
غیرفعال کردن رابط برنامه‌نویسی کاربردی (API) در Miniflux.
پیش‌فرض false است (API فعال است).
غیرفعال کردن سرآیند امنیت انتقال سخت‌گیرانه HTTP (HSTS) در صورت تنظیم HTTPS.
پیش‌فرض false است (HSTS فعال است).
مقدار را روی ۱ تنظیم کنید تا سرویس HTTP غیرفعال شود.
پیش‌فرض false است (سرویس HTTP فعال است).
غیرفعال کردن احراز هویت محلی.
هنگامی که روی true تنظیم شود، فرم نام کاربری/گذرواژه از صفحه ورود مخفی شده و گزینه‌های تغییر نام کاربری/گذرواژه یا قطع پیوند حساب OAuth2 از صفحه تنظیمات پنهان می‌شوند.
این گزینه نیازمند یک منبع احراز هویت جایگزین مانند OAuth2 یا پروکسی احراز هویت است.
اگر ایجاد کاربر از راه دور غیرفعال باشد، فقط کاربران موجود می‌توانند وارد شوند.
پیش‌فرض false است.
مقدار را روی ۱ تنظیم کنید تا سرویس زمان‌بندی داخلی غیرفعال شود.
پیش‌فرض false است (سرویس زمان‌بندی داخلی فعال است).
تنظیم روی ۱ برای مجاز کردن درخواست‌های برون‌رفت واکش‌گر (fetcher) به شبکه‌های خصوصی یا لوپ‌بک (loopback).
به صورت پیش‌فرض غیرفعال است و شبکه‌های خصوصی رد می‌شوند.
مقدار را روی ۱ تنظیم کنید تا مدت‌زمان ویدیو از وب‌سایت Bilibili استخراج شده و به عنوان زمان مطالعه استفاده شود.
به صورت پیش‌فرض غیرفعال است.
مقدار را روی ۱ تنظیم کنید تا مدت‌زمان ویدیو از وب‌سایت Nebula استخراج شده و به عنوان زمان مطالعه استفاده شود.
به صورت پیش‌فرض غیرفعال است.
مقدار را روی ۱ تنظیم کنید تا مدت‌زمان ویدیو از وب‌سایت Odysee استخراج شده و به عنوان زمان مطالعه استفاده شود.
به صورت پیش‌فرض غیرفعال است.
مقدار را روی ۱ تنظیم کنید تا مدت‌زمان ویدیو از وب‌سایت یوتیوب (YouTube) استخراج شده و به عنوان زمان مطالعه استفاده شود.
به صورت پیش‌فرض غیرفعال است.
حداقل بازه زمانی برای بازآوری دستی.
پیش‌فرض ۳۰ دقیقه است.
حداکثر اندازه بدنه برای درخواست‌های HTTP بر حسب مبی‌بایت (MiB).
پیش‌فرض 15 MiB است.
فعال کردن چرخش پروکسی برای درخواست‌های برون‌رفت با ارائه فهرستی از نشانی‌های پروکسی جداشده با کاما.
پیش‌فرض خالی است.
نشانی وب پروکسی برای استفاده در زمانی که گزینه "واکشی از طریق پروکسی" برای خوراک فعال است.
پیش‌فرض خالی است.
محدودیت زمانی بر حسب ثانیه پیش از اینکه کلاینت HTTP درخواست را لغو کند.
پیش‌فرض ۲۰ ثانیه است.
سرآیند پیش‌فرض User-Agent برای کلاینت HTTP. می‌تواند در تنظیمات اختصاصی هر خوراک بازنویسی شود.
هنگامی که خالی باشد، Miniflux از یک User-Agent پیش‌فرض شامل نسخه برنامه استفاده می‌کند.
پیش‌فرض خالی است.
مهلت زمانی خواندن، نوشتن و بیکاری بر حسب ثانیه برای سرور HTTP.
پیش‌فرض ۳۰۰ ثانیه است.
اجبار کوکی‌ها به استفاده از فلگ امنیتی (secure) و ارسال سرآیند HSTS.
به صورت پیش‌فرض غیرفعال است.
تنظیم روی ۱ برای مجاز کردن درخواست‌های یکپارچه‌سازی برون‌رفت به شبکه‌های خصوصی یا لوپ‌بک.
به صورت پیش‌فرض غیرفعال است و شبکه‌های خصوصی رد می‌شوند.
تنظیم نمونه (instance) سفارشی Invidious برای استفاده.
پیش‌فرض yewtu.be است.
مسیر کلید خصوصی SSL.
پیش‌فرض خالی است.
آدرس برای شنود (Listen). برای شنود روی سوکت یونیکس از مسیر مطلق استفاده کنید (/var/run/miniflux.sock).
می‌توان چندین آدرس را با کاما جدا کرد؛ به عنوان مثال: 127.0.0.1:8080, 127.0.0.1:8081.
پیش‌فرض 127.0.0.1:8080 است.
نمایش تاریخ و زمان در پیام‌های گزارش (log).
به صورت پیش‌فرض غیرفعال است.
مقادیر پشتیبانی‌شده عبارتند از "stderr"، "stdout" یا یک نام فایل.
پیش‌فرض "stderr" است.
قالب‌های گزارش پشتیبانی‌شده عبارتند از "text" یا "json".
پیش‌فرض "text" است.
مقادیر پشتیبانی‌شده عبارتند از "debug"، "info"، "warning" یا "error".
پیش‌فرض "info" است.
تعریف پیام نگهداری سفارشی.
پیش‌فرض "Miniflux is currently under maintenance" است.
تنظیم روی ۱ برای فعال‌سازی حالت نگهداری.
به صورت پیش‌فرض غیرفعال است.
تنظیم یک سرور خارجی برای عبور دادن پروکسی رسانه‌ها.
پیش‌فرض خالی است و Miniflux پروکسی را انجام می‌دهد.
محدودیت زمانی بر حسب ثانیه پیش از اینکه کلاینت HTTP پروکسی رسانه درخواست را لغو کند.
پیش‌فرض ۱۲۰ ثانیه است.
فهرستی جداشده با کاما از انواع رسانه برای پروکسی شدن. مقادیر پشتیبانی‌شده عبارتند از: image, audio, video.
پیش‌فرض image است.
مقادیر ممکن: http-only, all یا none.
پیش‌فرض http-only است.
تنظیم کلید خصوصی سفارشی برای امضای نشانی‌های وب رسانه‌های پروکسی‌شده.
به صورت پیش‌فرض، یک کلید محرمانه به صورت تصادفی هنگام راه‌اندازی تولید می‌شود.
فهرست شبکه‌های مجاز برای دسترسی به نقطه پایانی سنجه‌ها (مقادیر جداشده با کاما).
پیش‌فرض 127.0.0.1/8 است.
تنظیم روی ۱ برای فعال‌سازی گردآورنده سنجه‌ها و انتشار یک نقطه پایانی /metrics برای Prometheus.
به صورت پیش‌فرض غیرفعال است.
گذرواژه نقطه پایانی سنجه‌ها برای احراز هویت پایه HTTP.
پیش‌فرض خالی است.
مسیر فایلی که حاوی گذرواژه احراز هویت HTTP نقطه پایانی سنجه‌ها است.
پیش‌فرض خالی است.
بازه زمانی بازآوری برای جمع‌آوری سنجه‌های پایگاه داده.
پیش‌فرض ۶۰ ثانیه است.
نام کاربری نقطه پایانی سنجه‌ها برای احراز هویت پایه HTTP.
پیش‌فرض خالی است.
مسیر فایلی که حاوی نام کاربری احراز هویت HTTP نقطه پایانی سنجه‌ها است.
پیش‌فرض خالی است.
شناسه کلاینت OAuth2.
پیش‌فرض خالی است.
مسیر کلید محرمانه ارائه‌شده به عنوان یک فایل؛ باید حاوی مقدار OAUTH2_CLIENT_ID باشد.
پیش‌فرض خالی است.
کلید محرمانه کلاینت OAuth2.
پیش‌فرض خالی است.
مسیر کلید محرمانه ارائه‌شده به عنوان یک فایل؛ باید حاوی مقدار OAUTH2_CLIENT_SECRET باشد.
پیش‌فرض خالی است.
نقطه پایانی کشف OpenID Connect.
پیش‌فرض خالی است.
نام نمایشی برای ارائه‌دهنده OIDC.
پیش‌فرض "OpenID Connect" است.
مقادیر ممکن "google" یا "oidc" هستند.
پیش‌فرض خالی است.
نشانی وب بازگشتی (Redirect URL) در OAuth2.
این نشانی باید نزد ارائه‌دهنده ثبت شود و مقداری مانند https://miniflux.example.org/oauth2/oidc/callback دارد.
پیش‌فرض خالی است.
تنظیم روی ۱ برای مجاز کردن ایجاد کاربر از طریق OAuth2.
در صورت غیرفعال بودن، کاربران برای ورود باید از قبل در Miniflux وجود داشته باشند یا حساب OAuth2 متصل داشته باشند.
به صورت پیش‌فرض غیرفعال است.
بازه زمانی بر حسب دقیقه برای زمان‌بند وظایف پس‌زمینه.
تعیین می‌کند که هر چند وقت یک‌بار دسته‌ای از خوراک‌ها بر اساس آخرین زمان بازآوری‌شان برای به‌روزرسانی انتخاب شوند.
پیش‌فرض ۶۰ دقیقه است.
محدود کردن تعداد درخواست‌های همزمان به یک نام میزبان (hostname) یکسان هنگام بررسی خوراک‌ها.
این گزینه از تحمیل بار بیش از حد به یک سرور منفرد در طول پردازش دسته‌ای توسط استخر کارگران (worker pool) جلوگیری می‌کند.
پیش‌فرض ۰ است (غیرفعال).
حداکثر تعداد خطاهای تجزیه که برنامه پیش از متوقف کردن بررسی یک خوراک تلاش می‌کند.
پس از رسیدن به این حد، کاربر باید خوراک را به صورت دستی بازآوری کند. برای حالت نامحدود روی ۰ تنظیم کنید.
پیش‌فرض ۳ است.
راهبرد مورد استفاده برای زمان‌بندی بررسی خوراک‌ها را تعیین می‌کند.
مقادیر پشتیبانی‌شده عبارتند از "round_robin" و "entry_frequency".
- "round_robin": خوراک‌ها به ترتیبی ثابت و چرخشی بررسی می‌شوند.
- "entry_frequency": بازه بررسی هر خوراک بر اساس میانگین بسامد به‌روزرسانی در طول هفته گذشته تعیین می‌شود.
تعداد خوراک‌های بررسی‌شده در یک دوره مشخص با تنظیمات POLLING_FREQUENCY و BATCH_SIZE محدود می‌شود.
صرف‌نظر از زمان‌بند مورد استفاده، تعداد کل خوراک‌های بررسی‌شده از حداکثر مجاز در هر چرخه فراتر نخواهد رفت.
پیش‌فرض "round_robin" است.
بازنویسی LISTEN_ADDR به 0.0.0.0:$PORT.
پیش‌فرض خالی است.
تنظیم روی ۱ برای اجرای مهاجرت‌های پایگاه داده.
به صورت پیش‌فرض غیرفعال است.
ضریب افزایش بسامد بازآوری برای زمان‌بند بسامد ورودی.
پیش‌فرض ۱ است.
حداکثر بازه زمانی بر حسب دقیقه برای زمان‌بند بسامد ورودی.
پیش‌فرض ۱۴۴۰ دقیقه (۲۴ ساعت) است.
حداقل بازه زمانی بر حسب دقیقه برای زمان‌بند بسامد ورودی.
پیش‌فرض ۵ دقیقه است.
حداکثر بازه زمانی بر حسب دقیقه برای زمان‌بند نوبت‌گردشی (round robin).
پیش‌فرض ۱۴۴۰ دقیقه (۲۴ ساعت) است.
حداقل بازه زمانی بر حسب دقیقه برای زمان‌بند نوبت‌گردشی.
پیش‌فرض ۶۰ دقیقه است.
فهرستی جداشده با کاما از شبکه‌ها (نمادگذاری CIDR) که مجاز به استفاده از سرآیند احراز هویت پروکسی، سرآیندهای X-Forwarded-For، X-Forwarded-Proto و X-Real-Ip هستند.
پیش‌فرض خالی است.
فعال یا غیرفعال کردن سگ‌نگهبان (watchdog) در Systemd.
به صورت پیش‌فرض فعال است.
فعال یا غیرفعال کردن احراز هویت WebAuthn/Passkey.
اگر از کلیدهای غیرمسکونی استفاده می‌کنید، باید در صفحه ورود یک نام کاربری ارائه دهید. با این حال، این مورد برای اعتبارنامه‌های قابل کشف الزامی نیست.
به صورت پیش‌فرض غیرفعال است.
تعداد کارگران پس‌زمینه (workers).
پیش‌فرض ۱۶ کارگر است.
کلید API یوتیوب برای استفاده با FETCH_YOUTUBE_WATCH_TIME. اگر خالی نباشد، مدت‌زمان از طریق API یوتیوب دریافت می‌شود؛ در غیر این صورت، مدت‌زمان از وب‌سایت یوتیوب استخراج خواهد شد.
پیش‌فرض خالی است.
نشانی وب یوتیوب برای استفاده در جاسازی‌ها (embeds).
پیش‌فرض https://www.youtube-nocookie.com/embed است.

برنامه Miniflux توسط Frédéric Guillot با مشارکت جامعه کاربری Miniflux توسعه داده شده و نگهداری می‌شود.

برنامه Miniflux تحت مجوز Apache 2.0 منتشر شده است.

April 18, 2026