.\" Automatically generated by Pandoc 2.17.0.1
.\"
.TH "PROSODYCTL" "1" "2022-02-02" "" ""
.hy
.SH "نام (NAME)"
.PP
prosodyctl \- مدیریت سرور Prosody XMPP
.SH "خلاصه دستور (SYNOPSIS)"
.IP
.nf
\f[C]
prosodyctl command [--help]
\f[R]
.fi
.SH "توضیحات (DESCRIPTION)"
.PP
دستور prosodyctl ابزار کنترلی برای سرور Prosody XMPP است.
می‌توان از آن برای کنترل دیمن سرور و مدیریت کاربران استفاده کرد.
.PP
ابزار prosodyctl برای اجرای دستورهای خود نیاز دارد با مجوزهای کافی اجرا شود.
این موضوع معمولاً به معنای اجرای prosodyctl با کاربر root است.
اگر کاربری به نام \[lq]prosody\[rq] پیدا شود، prosodyctl پیش از اجرای دستورهای خود هویت خود را به آن کاربر تغییر می‌دهد.
.SH "دستورها (COMMANDS)"
.SS "مدیریت کاربران (User Management)"
.PP
در دستورهای زیر، کاربران با یک شناسهٔ Jabber ID با نام jid و به شکل معمول user\[at]domain مشخص می‌شوند.
.TP
adduser jid
یک کاربر با شناسهٔ Jabber ID داده‌شده به عنوان jid به سرور اضافه می‌کند.
از شما خواسته خواهد شد تا گذرواژهٔ کاربر را وارد کنید.
.TP
passwd jid
گذرواژهٔ یک کاربر موجود با شناسهٔ jid را تغییر می‌دهد.
از شما خواسته خواهد شد تا گذرواژهٔ جدید کاربر را وارد کنید.
.TP
deluser jid
یک کاربر موجود با شناسهٔ jid را از سرور حذف می‌کند.
.SS "مدیریت دیمن (Daemon Management)"
.PP
اگرچه prosodyctl دستورهایی برای مدیریت دیمن prosody دارد، اما چنانچه Prosody را از طریق مخازن بسته توزیع خود نصب کرده‌اید، توصیه می‌شود از امکانات مدیریت دیمن توزیع خود استفاده کنید.
.PP
برای انجام دستورهای کنترل دیمن، prosodyctl نیاز دارد مقدار pidfile در \f[C]/etc/prosody/prosody.cfg.lua\f[R] مشخص شده باشد.
عدم تعیین آن باعث بروز خطای prosodyctl خواهد شد.
.TP
start
دیمن سرور prosody را آغاز می‌کند.
در صورت اجرا به عنوان root، prosodyctl پیش از اجرا تلاش می‌کند تا به کاربری به نام \[lq]prosody\[rq] تغییر هویت دهد.
این عملیات تا پنج ثانیه برای آغاز به کار سرور منتظر می‌ماند و مسدود (block) می‌شود.
.TP
stop
دیمن سرور prosody را متوقف می‌کند.
این عملیات تا پنج ثانیه برای توقف کامل سرور منتظر می‌ماند و مسدود (block) می‌شود.
.TP
restart
دیمن سرور prosody را مجدداً راه‌اندازی می‌کند.
معادل با اجرای prosodyctl stop و سپس prosodyctl start است.
.TP
reload
سیگنالی به دیمن سرور prosody می‌فرستد تا پیکربندی را بازخوانی کرده و فایل‌های ثبت وقایع (log) را دوباره باز کند.
.TP
status
وضعیت کنونی اجرای دیمن سرور prosody را چاپ می‌کند.
.SS "گواهی‌ها (Certificates)"
.PP
ابزار prosodyctl می‌تواند گواهی‌های خودامضا، درخواست‌های صدور گواهی و کلیدهای خصوصی را برای استفاده در Prosody ایجاد کند.
دستورها به شکل \f[C]prosodyctl cert subcommand\f[R] هستند.
این دستورها فهرستی از میزبان‌ها (hosts) را برای گنجانده شدن در گواهی دریافت می‌کنند.
.TP
\f[B]\f[CB]request hosts\f[B]\f[R]
ایجاد یک فایل درخواست صدور گواهی (CSR) برای ارسال به مرجع صدور گواهی (CA).
می‌توان چندین میزبان را مشخص کرد؛ زیردامنه‌ها به‌طور خودکار گنجانده می‌شوند.
.TP
\f[B]\f[CB]generate hosts\f[B]\f[R]
تولید یک گواهی خودامضا (self-signed).
.TP
\f[B]\f[CB]key host [size]\f[B]\f[R]
تولید یک کلید خصوصی با اندازهٔ `size' بیت (پیش‌فرض 2048 است).
در صورت نیاز، به‌طور خودکار توسط `request' و `generate' فراخوانی می‌شود.
.TP
\f[B]\f[CB]config hosts\f[B]\f[R]
تولید یک فایل پیکربندی برای فهرست میزبان‌ها.
در صورت نیاز، به‌طور خودکار توسط `request' و `generate' فراخوانی می‌شود.
.TP
\f[B]\f[CB]import hosts paths\f[B]\f[R]
کپی کردن گواهی‌های مربوط به میزبان‌ها در مسیر گواهی‌ها و بازخوانی مجدد prosody.
.SS "اشکال‌زدایی (Debugging)"
.PP
ابزار prosodyctl همچنین می‌تواند اطلاعاتی را پیرامون محیط، وابستگی‌ها و موارد مشابه جهت کمک به اشکال‌زدایی نمایش دهد.
.TP
\f[B]\f[CB]about\f[B]\f[R]
محیط، مسیرهای گوناگون مورد استفاده توسط Prosody و وابستگی‌های نصب‌شده را نشان می‌دهد.
.TP
\f[B]\f[CB]check [what]\f[B]\f[R]
بررسی‌های سلامت گوناگونی را روی پیکربندی، تنظیمات DNS و گواهی‌های TLS پیکربندی‌شده انجام می‌دهد.
مقدار \f[C]what\f[R] می‌تواند یکی از موارد \f[C]config\f[R]، \f[C]dns\f[R]، \f[C]certs\f[R]، \f[C]disabled\f[R] و \f[C]connectivity\f[R] باشد تا تنها همان بررسی اجرا شود.
.SS "سازگاری با Ejabberd (Ejabberd Compatibility)"
.PP
نرم‌افزار ejabberd یک سرور XMPP دیگر است که ابزار کنترلی مشابه‌ای به نام ejabberdctl را برای هدایت عملیات سرور خود فراهم می‌کند.
ابزار prosodyctl دستورهایی را پیاده‌سازی کرده است که با ejabberdctl سازگار هستند.
برای مشاهدهٔ جزئیات کارکرد این دستورها، به ejabberdctl(8) مراجعه کنید.
.IP
.nf
\f[C]
register user server password

unregister user server
\f[R]
.fi
.SH "گزینه‌ها (OPTIONS)"
.TP
\f[B]\f[CB]--config filename\f[B]\f[R]
استفاده از فایل پیکربندی مشخص‌شده به جای مقدار پیش‌فرض.
.TP
\f[B]\f[CB]--root\f[B]\f[R]
رها نکردن مجوزهای دسترسی کاربر root (برای نمونه زمانی که با sudo اجرا می‌شود).
.TP
\f[B]\f[CB]--help\f[B]\f[R]
نمایش متن راهنما برای دستور مشخص‌شده.
.TP
\f[B]\f[CB]--verbose\f[B]\f[R]
افزایش سطح ثبت وقایع برای نمایش پیام‌های اشکال‌زدایی (debug).
.TP
\f[B]\f[CB]--quiet\f[B]\f[R]
کاهش سطح ثبت وقایع تا تنها خطاها نمایش داده شوند.
.TP
\f[B]\f[CB]--silent\f[B]\f[R]
غیرفعال‌سازی کامل ثبت وقایع، به گونه‌ای که تنها خروجی مستقیم دستور باقی بماند.
.SH "فایل‌ها (FILES)"
.TP
\f[B]\f[CB]/etc/prosody/prosody.cfg.lua\f[B]\f[R]
فایل پیکربندی اصلی prosody.
ابزار prosodyctl این فایل را می‌خواند تا فایل شناسهٔ فرایند (PID) دیمن سرور prosody را شناسایی کرده و پیکربندی بودن یا نبودن یک میزبان را تعیین کند.
.SH "آنلاین (ONLINE)"
.PP
اطلاعات بیشتر را می‌توانید به‌صورت آنلاین در این نشانی بیابید: <https://prosody.im>
.SH "نویسندگان (AUTHORS)"
Dwayne Bent <dbb.1@liqd.org>; Kim Alvefur.