miniserve(1) General Commands Manual miniserve(1)

miniserve - برای مواقعی که واقعاً می‌خواهید همین حالا فایل‌هایی را از طریق HTTP سرو کنید!

miniserve [-v|--verbose] [--temp-directory] [--index] [--spa] [--quiet] [--pretty-urls] [-p|--port] [-i|--interfaces] [--workers] [-a|--auth] [--auth-file] [--route-prefix] [--random-route] [-P|--no-symlinks] [-H|--hidden] [-S|--default-sorting-method] [-O|--default-sorting-order] [-c|--color-scheme] [-d|--color-scheme-dark] [-q|--qrcode] [-u|--upload-files] [--web-upload-files-concurrency] [--chmod] [--directory-size] [-U|--mkdir] [--pastebin] [-m|--media-type] [-M|--raw-media-type] [-o|--on-duplicate-files] [-R|--rm-files] [-r|--enable-tar] [-g|--enable-tar-gz] [-z|--enable-zip] [-C|--compress-response] [-D|--dirs-first] [-t|--title] [--header] [-l|--show-symlink-info] [-F|--hide-version-footer] [--hide-theme-selector] [-W|--show-wget-footer] [--print-completions] [--print-manpage] [--tls-cert] [--tls-key] [--readme] [-I|--disable-indexing] [--enable-webdav] [--size-display] [--file-external-url] [--log-color] [-h|--help] [-V|--version] [PATH]

برای مواقعی که واقعاً می‌خواهید همین حالا فایل‌هایی را از طریق HTTP سرو کنید!

پرگویی در خروجی، شامل ثبت لاگ‌های دسترسی.
مسیری که فایل‌های بارگذاری‌شده پیش از انتقال به مکان اصلی در آن نوشته می‌شوند. عاقلانه است اطمینان حاصل کنید این دایرکتوری روی دیسک نوشته می‌شود نه در حافظه موقت.

این مقدار فقط **در صورتی** استفاده خواهد شد که بارگذاری فایل فعال باشد. اگر این گزینه تنظیم نشود، از دایرکتوری موقت پیش‌فرض سیستم‌عامل استفاده خواهد شد.

نام فایل ایندکس دایرکتوری برای ارائه، مانند "index.html".

به طور معمول، هنگامی که miniserve یک دایرکتوری را ارائه می‌دهد، فهرستی برای آن دایرکتوری ایجاد می‌کند. با این حال، اگر دایرکتوری حاوی این فایل باشد، miniserve به جای آن، فایل مذکور را ارائه خواهد داد.

فعال‌سازی حالت برنامه تک‌صفحه‌ای (SPA).

این گزینه باعث می‌شود فایلی که با --index مشخص شده برای تمام مسیرهای ناموجود فایل ارائه شود. در عمل، هر زمان که خطای 404 رخ دهد، فایل ایندکس سرو می‌شود تا مسیریاب SPA به جای آن به درخواست رسیدگی کند.

کاهش خروجی و بی‌صدا کردن هشدارها.
فعال‌سازی حالت Pretty URLs.

این گزینه موجب می‌شود کارگزار فایل `.html` معادلِ اشاره‌شده توسط مسیر را ارائه دهد.

برای مثال، مسیر `/about` تلاش می‌کند فایل `about.html` را بیابد و ارائه دهد.

درگاه مورد استفاده.
رابط شبکه‌ای که باید روی آن گوش فرا داده شود.
تعداد کارگران (workers) کارگزار.
تنظیم احراز هویت.

قالب‌های پشتیبانی‌شده در حال حاضر: username:password, username:sha256:hash, username:sha512:hash (مانند joe:123, joe:sha256:a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3)

خواندن مقادیر احراز هویت از یک فایل.

نمونه محتوای فایل:

joe:123 bob:sha256:a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3 bill:

استفاده از یک پیشوند مسیر مشخص.
تولید یک مسیر تصادفی با ۶ رقم هگزادسیمال.
مخفی کردن پیوندهای نمادین در فهرست و جلوگیری از دنبال شدن آن‌ها.
نمایش فایل‌های پنهان.
روش مرتب‌سازی پیش‌فرض برای فهرست فایل‌ها.

مقادیر ممکن:

  • name: مرتب‌سازی بر اساس نام
  • size: مرتب‌سازی بر اساس اندازه
  • date: مرتب‌سازی بر اساس آخرین تاریخ تغییر (مرتب‌سازی طبیعی: طبق ترتیب الفبایی‌عددی)
ترتیب مرتب‌سازی پیش‌فرض برای فهرست فایل‌ها.

مقادیر ممکن:

  • asc: ترتیب صعودی
  • desc: ترتیب نزولی
طرح رنگی پیش‌فرض.

مقادیر ممکن:

  • squirrel
  • archlinux
  • ayu-dark
  • zenburn
  • monokai
طرح رنگی تیره پیش‌فرض.

مقادیر ممکن:

  • squirrel
  • archlinux
  • ayu-dark
  • zenburn
  • monokai
فعال‌سازی نمایش کد QR.
فعال‌سازی بارگذاری فایل (و به صورت اختیاری تعیین دایرکتوری مجاز).

مسیر ارائه‌شده یک مسیر فیزیکی در فایل‌سیستم نیست؛ بلکه نسبت به دایرکتوری ارائه‌شده سنجیده می‌شود. برای مثال، اگر دایرکتوری ارائه‌شده '/home/hello' باشد، این مقدار را برابر با '/upload' بگذارید تا اجازه بارگذاری در '/home/hello/upload' داده شود. در صورت تعیین از طریق متغیر محیطی، تعیین مسیر همیشه الزامی است.

تنظیم تعداد بارگذاری‌های هم‌زمان هنگام بازدید از وب‌سایت. برای اثرگذاری این تنظیم، باید گزینه upload-files فعال باشد.

برای مثال، مقدار ۴ به این معنی است که مرورگر وب هنگام استفاده از رابط کاربری وب، تنها ۴ فایل را به طور هم‌زمان روی کارگزار وب بارگذاری خواهد کرد.

هنگامی که مقدار روی ۰ بماند، مرورگر وب سعی می‌کند تمام بارگذاری‌ها را به صورت یک‌باره انجام دهد.

نکته: صفحات وب برای تعداد اتصالات HTTP فعال هم‌زمان محدودیت دارند؛ بنابراین، حتی اگر سقف هم‌زمانی را روی ۱۰۰ بگذارید، مرورگر ممکن است تنها به اندازه حداکثر اتصالات مجاز خود پیشرفت کند.

تنظیم مجوزهای یونیکس برای فایل‌های بارگذاری‌شده.

این گزینه یک عدد در مبنای هشت، برای مثال 0600 دریافت می‌کند. به طور پیش‌فرض مقدار 0666 & ~umask برای شبیه‌سازی رفتار پیش‌فرض سیستم استفاده می‌شود.

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

این قابلیت به طور پیش‌فرض غیرفعال است زیرا عملیاتی است که به طور بالقوه بار ورودی/خروجی (I/O) سنگینی ایجاد می‌کند.

فعال‌سازی ساخت دایرکتوری‌ها.
فعال‌سازی ایجاد یادداشت‌های متنی پیست‌بین ('pastes').

این موارد، فایل‌های متنی ساده‌ای هستند که در دایرکتوری جاری ساخته می‌شوند. ایجاد آن‌ها مستلزم فعال بودن بارگذاری فایل است.

مشخص کردن انواع رسانه‌های قابل بارگذاری.

مقادیر ممکن:

  • image
  • audio
  • video
مشخص کردن صریح عبارت نوع رسانه (media type) قابل بارگذاری.
تعیین اقدام لازم در صورتی که فایلی با همان نام حین بارگذاری وجود داشته باشد.

اگر تغییر نام فایل‌ها را فعال کنید، این کار با افزودن یک پسوند عددی به نام فایل قبل از پسوند پایانی انجام می‌شود. برای مثال file.txt به صورت file-1.txt بارگذاری خواهد شد و این شماره تا زمان یافتن یک نام فایل آزاد افزایش می‌یابد.

مقادیر ممکن:

  • error
  • overwrite
  • rename
فعال‌سازی حذف فایل و دایرکتوری (و تعیین اختیاری دایرکتوری مجاز).
فعال‌سازی ایجاد آرشیو tar غیرفشرده.
فعال‌سازی ایجاد آرشیو tar فشرده‌شده با gz.
فعال‌سازی ایجاد آرشیو zip.

هشدار: ساخت zip از دایرکتوری‌های حجیم می‌تواند منجر به خطای کمبود حافظه (out-of-memory) شود، زیرا تولید zip در حافظه رم انجام می‌گیرد و امکان ارسال در لحظه وجود ندارد.

فشرده‌سازی پاسخ.

هشدار: فعال کردن این گزینه ممکن است به دلیل بار پردازشی روی CPU سرعت انتقال را کاهش دهد؛ بنابراین به صورت پیش‌فرض غیرفعال است.

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

نمایش دایرکتوری‌ها در ابتدای فهرست.
به جای نام میزبان در عنوان و سرآیند صفحه نمایش داده می‌شود.
درج سرآیندهای سفارشی در پاسخ‌ها. هر سرآیند را به صورت یک جفت 'Header:Value' مشخص کنید. از این پارامتر می‌توان چندین بار برای افزودن چندین سرآیند استفاده کرد.

مثال: --header "Header1:Value1" --header "Header2:Value2" (اگر سرآیندی از قبل تنظیم شده یا درج شده باشد، بازنویسی نخواهد شد.)

نمایش اطلاعات پیوندهای نمادین در فهرست دایرکتوری.
مخفی کردن پاورقی نسخه.
مخفی کردن انتخاب‌گر پوسته.
در صورت فعال بودن، یک دستور wget را برای بارگیری بازگشتی دایرکتوری جاری نمایش می‌دهد.
تولید فایل تکمیل خودکار برای یک پوسته.

مقادیر ممکن:

  • bash
  • elvish
  • fish
  • powershell
  • zsh
تولید صفحه راهنما (man page).
گواهی TLS مورد استفاده.
کلید خصوصی TLS مورد استفاده.
فعال‌سازی نمایش README.md در دایرکتوری‌ها.
غیرفعال کردن ایندکس‌گذاری.

این کار از ایجاد فهرست دایرکتوری جلوگیری کرده و در عوض یک خطا برمی‌گرداند.

فعال‌سازی پشتیبانی فقط‌خواندنی WebDAV (درخواست‌های PROPFIND).
نمایش اندازه فایل ارائه‌شده بر حسب بایت دقیق.

مقادیر ممکن:

  • human
  • exact
یک نشانی وب خارجی اختیاری (مانند 'http://external.example.com:8081') که به پیوند فایل‌ها در فهرست اضافه می‌شود.

امکان ارائه فایل‌ها از نشانی متفاوتی نسبت به نمونه مرورگر جاری را فراهم می‌کند. برای تنظیماتی مفید است مانند: داشتن یک نمونه احراز هویت‌شده برای مرور و پیوند دادن فایل‌ها (از طریق این گزینه) به نمونه دومی بدون ایندکس (-I) برای بارگیری مستقیم. این کار فهرست کامل فایل‌ها را در کارگزار بارگیری مخفی می‌کند، در حالی که کاربران همچنان می‌توانند پیوندهای مستقیم فایل‌ها را برای اشتراک‌گذاری کپی کنند. نشانی وب خارجی دقیقاً به همان صورتی که داده شده، به همراه پروتکل، در ابتدای مکان نسبی فایل قرار می‌گیرد. کاربر باید دقت کند که نتیجه یک URL معتبر باشد؛ هیچ بررسی دیگری انجام نمی‌شود.

تنظیم سبک رنگ خروجی لاگ.

مقدار "auto" (پیش‌فرض) تنها در صورتی رنگ‌ها را فعال می‌کند که خروجی یک ترمینال باشد. مقدار "always" همیشه رنگ‌ها را فعال می‌کند. مقدار "never" همیشه رنگ‌ها را غیرفعال می‌کند.

مقادیر ممکن:

  • auto
  • always
  • never
چاپ راهنما (مشاهده خلاصه با '-h').
چاپ نسخه.
[PATH]
مسیری که باید ارائه (سرو) شود.

v0.35.0

Sven-Hendrik Haase <svenstaro@gmail.com>, Boastful Squirrel <boastful.squirrel@gmail.com>

miniserve 0.35.0