نام (NAME)

kiwix-serve - سرور HTTP محلی برای سرویس‌دهی فایل‌های ZIM نرم‌افزار Kiwix

خلاصه دستور (SYNOPSIS)

kiwix-serve --library [گزینه‌ها] LIBRARY_FILE_PATH
kiwix-serve [گزینه‌ها] ZIM_FILE_PATH ...

توضیحات (DESCRIPTION)

دستور kiwix-serve برای اجرای یک سرور HTTP مستقل به منظور ارائه و سرویس‌دهی محتوای ZIM روی شبکه استفاده می‌شود.

آرگومان‌ها (ARGUMENTS)

LIBRARY_FILE_PATH: مسیر فایل کتابخانه XML که فهرست فایل‌های ZIM را برای سرویس‌دهی نگهداری می‌کند. فقط همراه با گزینه --library استفاده می‌شود. چندین فایل کتابخانه را می‌توان به صورت فهرستی جداشده با نقطه ویرگول (;) مشخص کرد.
ZIM_FILE_PATH ...: مسیر فایل(های) ZIM. استفاده از چندین آرگومان مجاز است.

گزینه‌ها (OPTIONS)

--library: به طور پیش‌فرض، kiwix-serve انتظار فهرستی از فایل‌های ZIM را به عنوان آرگومان‌های خط فرمان دارد. ارائه گزینه --library به kiwix-serve اعلام می‌کند که آرگومان خط فرمان، یک فایل کتابخانه XML است.
-i ADDR, --address=ADDR: شنود فقط روی این آدرس IP. به طور پیش‌فرض، سرور روی تمام آدرس‌های IP موجود شنود می‌کند. از طرف دیگر، می‌توانید از مقادیر ویژه زیر برای تعیین انواع اتصال‌های پذیرفته‌شده استفاده کنید:

all : شنود برای اتصال‌ها روی تمام آدرس‌های IP (IPv4 و IPv6).
ipv4 : شنود برای اتصال‌ها روی تمام آدرس‌های IPv4.
ipv6 : شنود برای اتصال‌ها روی تمام آدرس‌های IPv6.

-p PORT, --port=PORT: پورت TCP برای شنود درخواست‌های HTTP (پیش‌فرض: 80).
-r ROOT, --urlRootLocation=ROOT: پیشوند URL که محتوا باید تحت آن در دسترس قرار گیرد (پیش‌فرض: خالی).
-d, --daemon: جدا کردن دیمن سرور HTTP از فرآیند اصلی (اجرا در پس‌زمینه).
-a PID, --attachToProcess=PID: خروج در صورت متوقف شدن فرآیند با شناسه PID.
-M, --monitorLibrary: پایش فایل کتابخانه XML و بارگذاری مجدد خودکار آن هنگام تغییر یافتن.

بارگذاری مجدد کتابخانه در هر زمان با ارسال سیگنال SIGHUP به فرآیند “kiwix-serve” امکان‌پذیر است (این قابلیت صرف نظر از وجود گزینه “--monitorLibrary”/“-M” کار می‌کند).

-m, --nolibrarybutton: غیرفعال کردن دکمه صفحه اصلی کتابخانه در نوار ابزار نمایش‌دهنده ZIM.
-n, --nosearchbar: غیرفعال کردن کادر جستجو در نوار ابزار نمایش‌دهنده ZIM.
-b, --blockexternal: جلوگیری از پیمایش مستقیم کاربران به منابع خارجی از طریق پیوندهای موجود در محتوای ZIM.
-t N, --threads=N: تعداد نخ‌های پردازشی برای اجرای موازی (پیش‌فرض: 4).
-s N, --searchLimit=N: حداکثر تعداد فایل‌های ZIM در یک جستجوی تمام‌متنی میان چندین فایل ZIM (پیش‌فرض: بدون محدودیت).
-z, --nodatealiases: ایجاد نام‌های مستعار URL برای هر محتوا از طریق حذف تاریخ درج‌شده در نام فایل.

فرمت مورد انتظار برای تاریخ در نام فایل به صورت “_YYYY-MM” است. برای مثال، یک فایل ZIM با نام “wikipedia_en_all_2020-08.zim” هم از طریق “wikipedia_en_all_2020-08” و هم از طریق “wikipedia_en_all” قابل دسترسی خواهد بود.

-c PATH, --customIndex=PATH: جایگزین کردن صفحه خوش‌آمدگویی با یک فایل HTML سفارشی.
-L N, --ipConnectionLimit=N: حداکثر تعداد اتصال‌های (همزمان) به ازای هر IP (پیش‌فرض: نامحدود، مقدار پیشنهادی: >= 6).
-k, --skipInvalid: راه‌اندازی سرور حتی در صورت نامعتبر بودن برخی فایل‌های ZIM (فایل‌های نامعتبر نادیده گرفته می‌شوند).
-v, --verbose: چاپ گزارش‌های اشکال‌زدایی در خروجی استاندارد (STDOUT).
-V, --version: نمایش نسخه نرم‌افزار.
-h, --help: نمایش پیام راهنما.

مثال‌ها (EXAMPLES)

سرویس‌دهی یک فایل ZIM منفرد:

kiwix-serve myzim.zim

سرویس‌دهی چندین فایل ZIM:

kiwix-serve zim1.zim zim2.zim zim3.zim

سرویس‌دهی فایل‌های ZIM از روی یک کتابخانه:

kiwix-serve --library library.xml

مستندات (DOCUMENTATION)

مستندات برخط: https://kiwix-tools.readthedocs.io/en/latest/kiwix-serve.html
کد منبع: https://github.com/kiwix/kiwix-tools
اطلاعات بیشتر: https://wiki.kiwix.org/wiki/Kiwix-serve

نویسندگان (AUTHORS)

Emmanuel Engelhart <kelson@kiwix.org>
Vasudev Kamath <kamathvasudev@gmail.com>