mod_adhoc

def:ad-hoc command

: دستوری که می‌تواند توسط یک کلاینت XMPP با استفاده از XEP-0050 اجرا شود.

این ماژول XEP-0050: Ad-Hoc Commands را پیاده‌سازی می‌کند. یک ماژول کمکی است و تنها توسط برخی از ماژول‌های دیگر مورد نیاز است.

گزینه‌های موجود:

mod_adhoc_api

توجه درباره این گزینه: در نسخه 25.03 اضافه شده است.

اجرای (def:API commands) در یک کلاینت XMPP با استفاده از XEP-0050: Ad-Hoc Commands. این ماژول به mod_adhoc (برای اجرای دستورات) نیاز دارد، و استفاده از mod_disco (برای کشف دستورات) را توصیه می‌کند.

گزینه‌های موجود:

مثال:

acl:
  admin:
    user: jan@localhost
api_permissions:
  "adhoc commands":
    from: mod_adhoc_api
    who: admin
    what:
      - "[tag:roster]"
      - "[tag:session]"
      - stats
      - status
modules:
  mod_adhoc_api:
    default_version: 2

mod_admin_extra

این ماژول دستورات مدیریتی اضافی فراهم می‌کند.

جزئیات برخی دستورات:

ban_account API: این دستور تمام نشست‌های متصل حساب کاربری را از سرور قطع می‌کند. همچنین رمز عبور آن‌ها را به یک رمز تصادفی تغییر می‌دهد تا دیگر نتوانند وارد شوند مگر اینکه مدیر سرور رمز عبور آن‌ها را مجدداً تغییر دهد. امکان تعریف دلیل مسدودسازی وجود دارد. رمز عبور جدید نیز شامل دلیل و تاریخ و زمان مسدودسازی است. مثالی در زیر آمده است.

push_roster API (و push_roster_all API): فایل roster باید در صورت استفاده از Windows، در دایرکتوری نصب ejabberd قرار گیرد: C:/Program Files/ejabberd یا مشابه آن. در صورت استفاده از سیستم‌عامل دیگر، فایل را در همان دایرکتوری که فایل‌های .beam نصب شده‌اند قرار دهید. در زیر یک فایل roster نمونه آمده است.

srg_create API: اگر می‌خواهید نام گروه را با فاصله وارد کنید، از کاراکترهای "' و '" برای مشخص کردن شروع و پایان نام استفاده کنید. مثالی در زیر آمده است.

این ماژول گزینه‌ای ندارد.

مثال‌ها:

acl:
  adminextraresource:
    - resource: "modadminextraf8x,31ad"
access_rules:
  vcard_set:
    - allow: adminextraresource
modules:
  mod_admin_extra: {}
  mod_vcard:
    access_set: vcard_set

[{<<"bob">>, <<"example.org">>, <<"workers">>, <<"Bob">>},
{<<"mart">>, <<"example.org">>, <<"workers">>, <<"Mart">>},
{<<"Rich">>, <<"example.org">>, <<"bosses">>, <<"Rich">>}].

ejabberdctl vhost example.org ban_account boby "Spammed rooms"

ejabberdctl srg_create g1 example.org "'Group number 1'" this_is_g1 g1

mod_admin_update_sql

از این ماژول می‌توان برای تبدیل پایگاه داده SQL موجود از طرح‌واره تک‌میزبانه به چندمیزبانه استفاده کرد. برای جزئیات بخش database.md#singlehost-or-multihost|Singlehost or Multihost را بررسی کنید. توجه داشته باشید که تنها MS SQL، MySQL و PostgreSQL پشتیبانی می‌شوند. پس از بارگذاری ماژول از update_sql API استفاده کنید.

این ماژول گزینه‌ای ندارد.

mod_announce

این ماژول به کاربران پیکربندی‌شده امکان می‌دهد اعلان‌ها را پخش کنند و پیام روز (MOTD) را تنظیم کنند. کاربران پیکربندی‌شده می‌توانند این اعمال را با یک کلاینت XMPP، یا از طریق Ad-Hoc Commands یا ارسال پیام به JIDهای خاص انجام دهند. دستورات معادل API نیز موجود هستند.

برای ارسال اعلان‌ها با استفاده از XEP-0050: Ad-Hoc Commands، این ماژول به mod_adhoc (برای اجرای دستورات) نیاز دارد، و استفاده از mod_disco (برای کشف دستورات) را توصیه می‌کند.

برای ارسال اعلان‌ها از طریق ارسال پیام به JIDهای خاص، JIDهای مقصد به شرح زیر هستند:

JIDهای مقصد مشابهی برای اعمال بر تمام میزبان‌های مجازی در ejabberd وجود دارد:

گزینه‌های موجود:

mod_antispam

توجه درباره این گزینه: در نسخه 25.07 اضافه شده است.

پیام‌های هرزنامه و درخواست‌های اشتراک دریافتی از سرورهای راه دور را بر اساس فهرست‌های بلوک بلادرنگ (RTBL)، فهرست‌های JID های اسپمر شناخته‌شده و/یا URLهای ذکرشده در پیام‌های هرزنامه فیلتر می‌کند. ترافیک طبقه‌بندی‌شده به عنوان هرزنامه با یک خطا رد می‌شود (و یک پیام [info] ثبت می‌گردد) مگر اینکه فرستنده در حضور گیرنده مشترک باشد.

گزینه‌های موجود:

rtbl_services:
  - pubsub.server1.localhost:
      spam_source_domains_node: actual_custom_pubsub_node

مثال:

modules:
  mod_antispam:
    rtbl_services:
      - xmppbl.org
    spam_jids_file: "@CONFIG_PATH@/spam_jids.txt"
    spam_dump_file: "@LOG_PATH@/spam/host-@HOST@.log"

mod_auth_fast 🟠

توجه درباره این گزینه: در نسخه 26.07 بهبود یافته است.

این ماژول پشتیبانی از XEP-0484: Fast Authentication Streamlining Tokens را اضافه می‌کند که به کاربران اجازه می‌دهد با استفاده از توکن‌های خودمدیریتی احراز هویت کنند.

گزینه‌های موجود:

مثال:

modules:
  mod_auth_fast:
    token_lifetime: 14days

mod_avatar

هدف این ماژول رسیدگی به کلاینت‌های XMPP قدیمی و مدرنی است که آواتار ارسال می‌کنند. این فرآیند در XEP-0398: User Avatar to vCard-Based Avatars Conversion توضیح داده شده است.

همچنین، این ماژول از تبدیل بین فرمت‌های تصویر آواتار به صورت آنی پشتیبانی می‌کند.

این ماژول به mod_vcard، mod_vcard_xupdate و mod_pubsub وابسته است.

گزینه‌های موجود:

convert:
  webp: jpg
  default: png

mod_block_strangers

این ماژول هر پیامی که از یک موجودیت ناشناخته می‌آید را مسدود و ثبت می‌کند. اگر یک موجودیت نویسنده در لیست مخاطبین شما نباشد، می‌توانید اجازه دهید این ماژول پیام را رد کند و/یا ثبت کند. به طور پیش‌فرض پیام از آن موجودیت دریافت نخواهید کرد. اگر می‌خواهید پیام‌های هرزنامه را رد کنید این ماژول را فعال کنید.

گزینه‌های موجود:

mod_blocking

این ماژول XEP-0191: Blocking Command را پیاده‌سازی می‌کند.

این ماژول به mod_privacy وابسته است که در آن همه پیکربندی‌ها انجام می‌شود.

این ماژول هیچ گزینه‌ای ندارد.

mod_bosh

این ماژول XMPP over BOSH را همان‌طور که در XEP-0124 و XEP-0206 تعریف شده پیاده‌سازی می‌کند. BOSH مخفف Bidirectional-streams Over Synchronous HTTP است. این امکان را فراهم می‌کند که اتصالات طولانی‌مدت مورد نیاز XMPP را از طریق پروتکل HTTP شبیه‌سازی کنید. در عمل، این ماژول امکان استفاده از XMPP را در مرورگر بدون پشتیبانی WebSocket فراهم می‌کند و به طور کلی راهی برای استفاده از XMPP در عبور از پروکسی HTTP است.

گزینه‌های موجود:

مثال:

listen:
  -
    port: 5222
    module: ejabberd_c2s
  -
    port: 5443
    module: ejabberd_http
    request_handlers:
      /bosh: mod_bosh
modules:
  mod_bosh: {}

mod_caps

این ماژول XEP-0115: Entity Capabilities را پیاده‌سازی می‌کند. هدف اصلی این ماژول ارائه قابلیت PEP است (به mod_pubsub مراجعه کنید).

گزینه‌های موجود:

mod_carboncopy

این ماژول XEP-0280: Message Carbons را پیاده‌سازی می‌کند. این ماژول پیام‌ها را در تمام منابع (دستگاه‌های) متصل کاربر پخش می‌کند.

این ماژول هیچ گزینه‌ای ندارد.

mod_client_state

این ماژول امکان صف‌بندی انواع خاصی از استانزاها را فراهم می‌کند، زمانی که کلاینت نشان می‌دهد که کاربر در حال حاضر به‌طور فعال از کلاینت استفاده نمی‌کند (به XEP-0352: Client State Indication مراجعه کنید). این قابلیت می‌تواند پهنای باند و منابع را صرفه‌جویی کند.

یک استانزا از صف حذف می‌شود اگر به‌طور مؤثر توسط یک استانزای جدید منسوخ شود (مثلاً یک استانزای حضور جدید، استانزای قدیمی از همان کلاینت را جایگزین می‌کند). صف خالی می‌شود اگر استانزایی برسد که در صف قرار نمی‌گیرد، یا اگر اندازه صف به حد معینی برسد (در حال حاضر ۱۰۰ استانزا)، یا اگر کلاینت دوباره فعال شود.

گزینه‌های موجود:

mod_configure

توجه درباره این گزینه: در نسخه ۲۵.۱۰ بهبود یافته است.

این ماژول قابلیت‌های پیکربندی کارگزار را با استفاده از XEP-0030: Service Discovery و XEP-0050: Ad-Hoc Commands فراهم می‌کند:

دستورات ad-hoc از XEP-0133 که رفتار متفاوتی نسبت به XEP دارند:

آن دستورات ad-hoc از XEP-0133 که کلاینت اجراکننده دستور را در پاسخ شامل نمی‌شوند:

آن دستورات ad-hoc از XEP-0133 که پیاده‌سازی نشده‌اند:

این ماژول به mod_adhoc (برای اجرای دستورات) نیاز دارد، و استفاده از mod_disco (برای کشف دستورات) توصیه می‌شود.

توجه داشته باشید که تمام دستورات ad-hoc پیاده‌سازی‌شده توسط این ماژول، معادل یک دستور API دارند که می‌توانید با استفاده از mod_adhoc_api یا هر رابط API دیگری اجرا کنید.

گزینه‌های موجود:

مثال:

acl:
  admin:
    user: sun@localhost
access_rules:
  configure:
    allow: admin
modules:
  mod_configure:
    access: configure

mod_conversejs

توجه درباره این گزینه: در نسخه ۲۵.۰۷ بهبود یافته است.

این ماژول یک صفحه ساده برای کلاینت وب XMPP به نام Converse ارائه می‌دهد.

برای استفاده از این ماژول، علاوه بر افزودن آن به بخش modules، باید آن را در listen → ejabberd_http → listen-options.md#request_handlers|request_handlers نیز فعال کنید.

مطمئن شوید که mod_bosh یا listen.md#ejabberd_http_ws|ejabberd_http_ws حداقل در یک request_handlers فعال باشد.

وقتی conversejs_css و conversejs_script روی auto تنظیم شده‌اند، به‌طور پیش‌فرض به کلاینت عمومی Converse اشاره می‌کنند.

وقتی این ماژول در modules فعال می‌شود، به‌طور خودکار یک request handler و لینک در WebAdmin اضافه می‌کند. .

این ماژول از نسخه ejabberd 21.12 در دسترس است.

گزینه‌های موجود:

مثال‌ها:

listen:
  -
    port: 5280
    module: ejabberd_http
    request_handlers:
      /bosh: mod_bosh
      /websocket: ejabberd_http_ws
      /conversejs: mod_conversejs
modules:
  mod_bosh: {}
  mod_conversejs:
    websocket_url: "ws://@HOST@:5280/websocket"

listen:
  -
    port: 443
    module: ejabberd_http
    tls: true
    request_handlers:
      /websocket: ejabberd_http_ws
      /conversejs: mod_conversejs
modules:
  mod_conversejs:
    conversejs_resources: "/home/ejabberd/conversejs-x.y.z/package/dist"
    conversejs_plugins: ["libsignal-protocol.min.js"]
    # File path is: /home/ejabberd/conversejs-x.y.z/package/dist/plugins/libsignal-protocol.min.js

modules:
  mod_conversejs:
    websocket_url: auto
    conversejs_options:
      auto_away: 30
      clear_cache_on_logout: true
      i18n: "pt"
      locked_domain: "@HOST@"
      message_archiving: always
      theme: dracula

mod_delegation

این ماژول پیاده‌سازی XEP-0355: Namespace Delegation است. تاکنون تنها حالت مدیریتی (admin mode) پیاده‌سازی شده است. واگذاری فضای نام (Namespace delegation) به سرویس‌های خارجی اجازه می‌دهد تا IQ با فضای نام مشخصی را مدیریت کنند. این قابلیت ممکن است برای سرویس PEP خارجی به کار رود.

گزینه‌های موجود:

مثال‌ها:

access_rules:
  external_pubsub:
    allow: external_component
  external_mam:
    allow: external_component
acl:
  external_component:
    server: sat-pubsub.example.org
modules:
  mod_delegation:
    namespaces:
      urn:xmpp:mam:1:
        access: external_mam
      http://jabber.org/protocol/pubsub:
        access: external_pubsub

mod_disco

این ماژول پشتیبانی از XEP-0030: Service Discovery را اضافه می‌کند. با فعال بودن این ماژول، سرویس‌های موجود در کارگزار شما توسط کلاینت‌های XMPP قابل کشف هستند.

گزینه‌های موجود:

server_info:
  -
    modules: all
    name: abuse-addresses
    urls: ["mailto:abuse@shakespeare.lit"]
  -
    modules: [mod_muc]
    name: "Web chatroom logs"
    urls: ["http://www.example.org/muc-logs"]
  -
    modules: [mod_disco]
    name: feedback-addresses
    urls:
      - http://shakespeare.lit/feedback.php
      - mailto:feedback@shakespeare.lit
      - xmpp:feedback@shakespeare.lit
  -
    modules:
      - mod_disco
      - mod_vcard
    name: admin-addresses
    urls:
      - mailto:xmpp@shakespeare.lit
      - xmpp:admins@shakespeare.lit

mod_fail2ban

این ماژول آدرس‌های IP که نشانه‌های مخرب نشان می‌دهند را مسدود می‌کند. در حال حاضر تنها شکست‌های احراز هویت C2S شناسایی می‌شوند.

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

گزینه‌های موجود:

mod_host_meta

توجه درباره این گزینه: در نسخه 22.05 اضافه شده است.

این ماژول فایل‌های کوچک host-meta را همان‌طور که در XEP-0156: Discovering Alternative XMPP Connection Methods توضیح داده شده، ارائه می‌دهد.

برای استفاده از این ماژول، علاوه بر افزودن آن به بخش modules، باید آن را در listen → ejabberd_http → listen-options.md#request_handlers|request_handlers نیز فعال کنید.

توجه داشته باشید که این ماژول تنها زمانی کار می‌کند که listen.md#ejabberd_http|ejabberd_http دارای listen-options.md#tls|tls فعال باشد.

گزینه‌های موجود:

مثال:

listen:
  -
    port: 443
    module: ejabberd_http
    tls: true
    request_handlers:
      /bosh: mod_bosh
      /websocket: ejabberd_http_ws
      /.well-known/host-meta: mod_host_meta
      /.well-known/host-meta.json: mod_host_meta
modules:
  mod_bosh: {}
  mod_host_meta:
    bosh_service_url: "https://@HOST@:5443/bosh"
    websocket_url: "wss://@HOST@:5443/websocket"

mod_http_api

این ماژول یک رابط ReST برای فراخوانی دستورات ../../developer/ejabberd-api/index.md|ejabberd API با استفاده از داده‌های JSON فراهم می‌کند.

برای استفاده از این ماژول، علاوه بر افزودن آن به بخش modules، باید آن را در listen → ejabberd_http → listen-options.md#request_handlers|request_handlers نیز فعال کنید.

برای استفاده از نسخه API خاص N، هنگام تعریف مسیر URL در request_handlers، یک vN اضافه کنید. به عنوان مثال: /api/v2: mod_http_api.

برای اجرای یک دستور، یک درخواست POST به URL مربوطه ارسال کنید: http://localhost:5280/api/COMMAND-NAME

گزینه‌های موجود:

مثال:

listen:
  -
    port: 5280
    module: ejabberd_http
    request_handlers:
      /api: mod_http_api
modules:
  mod_http_api:
    default_version: 2

mod_http_fileserver

توجه درباره این گزینه: بهبود docroot در نسخه ۲۶.۰۱.

این ماژول ساده، فایل‌ها را از دیسک محلی از طریق HTTP ارائه می‌دهد.

گزینه‌های موجود:

content_types:
  .avi: video/avi
  .bmp: image/bmp
  .bz2: application/x-bzip2
  .css: text/css
  .gif: image/gif
  .gz: application/x-gzip
  .html: text/html
  .ico: image/vnd.microsoft.icon
  .jar: application/java-archive
  .jpeg: image/jpeg
  .jpg: image/jpeg
  .js: text/javascript
  .json: application/json
  .m4a: audio/mp4
  .map: application/json
  .mp3: audio/mpeg
  .mp4: video/mp4
  .mpeg: video/mpeg
  .mpg: video/mpeg
  .ogg: application/ogg
  .pdf: application/pdf
  .png: image/png
  .rtf: application/rtf
  .svg: image/svg+xml
  .tiff: image/tiff
  .ttf: font/ttf
  .txt: text/plain
  .wav: audio/wav
  .wasm: application/wasm
  .webp: image/webp
  .woff: font/woff
  .woff2: font/woff2
  .xml: application/xml
  .xpi: application/x-xpinstall
  .xul: application/vnd.mozilla.xul+xml
  .xz: application/x-xz
  .zip: application/zip

listen:
  -
    port: 5280
    module: ejabberd_http
    request_handlers:
      /pub/content: mod_http_fileserver
      /share: mod_http_fileserver
      /: mod_http_fileserver
modules:
  mod_http_fileserver:
    docroot:
      /pub/content: /var/service/www
      /share: /usr/share/javascript
      /: /var/www

مثال‌ها:

listen:
  -
    port: 5280
    module: ejabberd_http
    request_handlers:
      /pub/content: mod_http_fileserver
modules:
  mod_http_fileserver:
    docroot: /var/www
    accesslog: /var/log/ejabberd/access.log
    directory_indices:
      - index.html
      - main.htm
    custom_headers:
      X-Powered-By: Erlang/OTP
      X-Fry: "It's a widely-believed fact!"
    content_types:
      .ogg: audio/ogg
      .png: image/png
    default_content_type: text/html

mod_http_upload

توجه درباره این گزینه: content_types در نسخه ۲۶.۰۱ اضافه شد.

این ماژول امکان درخواست مجوز برای آپلود فایل از طریق HTTP را فراهم می‌کند، طبق XEP-0363: HTTP File Upload. اگر درخواست پذیرفته شود، کلاینت یک URL برای آپلود فایل و یک URL دیگر برای دانلود آن فایل دریافت می‌کند.

برای استفاده از این ماژول، باید در listen → ejabberd_http → listen-options.md#request_handlers|request_handlers فعال‌سازی شود.

گزینه‌های موجود:

modules:
  mod_http_upload:
    hosts:
      - service1.@HOST@
      - service2.@HOST@
    name: "Service General"
    append_module_config:
      service1.localhost:
        name: "Service 1"
      service2.example.net:
        name: "Service 2"

# This XML representation of vCard:
#   <vCard xmlns='vcard-temp'>
#     <FN>Conferences</FN>
#     <ADR>
#       <WORK/>
#       <STREET>Elm Street</STREET>
#     </ADR>
#   </vCard>
#
# is translated to:
vcard:
  fn: Conferences
  adr:
    -
      work: true
      street: Elm Street

مثال:

listen:
  -
    port: 5443
    module: ejabberd_http
    tls: true
    request_handlers:
      /upload: mod_http_upload
modules:
  mod_http_upload:
    docroot: /ejabberd/upload
    put_url: "https://@HOST@:5443/upload"

mod_http_upload_quota

این ماژول پشتیبانی از سهمیه (quota) را برای mod_http_upload اضافه می‌کند.

این ماژول به mod_http_upload وابسته است.

گزینه‌های موجود:

مثال‌ها:

shaper_rules:
  soft_upload_quota:
    1000: all # MiB
  hard_upload_quota:
    1100: all # MiB
modules:
  mod_http_upload: {}
  mod_http_upload_quota:
    max_days: 100

mod_invites 🟠

توجه در مورد این گزینه: بهبودیافته در نسخه 26.07.

این ماژول دعوت‌نامه کاربر و ایجاد حساب کاربری را برای ایجاد لینک‌های خارج از باند (out-of-band) جهت عضویت دیگران در شبکه XMPP و برقراری اشتراک متقابل فراهم می‌کند. این ماژول XEP-0379: Pre-Authenticated Roster Subscription، XEP-0401: Ad-hoc Account Invitation Generation و XEP-0445: Pre-Authenticated In-Band Registration را پیاده‌سازی می‌کند.

این دعوت‌نامه‌ها به صورت URI های XMPP، از طریق دستورات ad-hoc یا دستورات API (مانند API generate_invite و API generate_invite_with_username) ایجاد می‌شوند و سپس قرار است به صورت خارج از باند ارسال شوند.

کاربر دریافت‌کننده باید یک کلاینت نصب کرده باشد که از این دعوت‌نامه‌ها پشتیبانی کند. از آنجا که این موضوع به یک مانع رایج برای استقرار آسان تبدیل شده است، این ماژول با یک پارامتر صفحه فرود اختیاری ارائه می‌شود که می‌تواند یا یک سرویس خارجی مانند نصب easy-xmpp-invitation، یک سرویس شخص ثالث مانند JoinJabber یا برای راحتی یک سرویس داخلی باشد. این صفحه فرود سپس گیرنده را در راه‌اندازی یک کلاینت و در صورت نیاز ایجاد یک حساب کاربری راهنمایی می‌کند.

برای استفاده از قابلیت صفحه فرود داخلی، باید landing_page را روی auto یا یک قالب URL مانند https://{{ host }}/invites/{{ invite.token }} تنظیم کنید، اگر تنظیمات سرور شما شامل یک پروکسی معکوس (reverse proxy) است. علاوه بر این، باید این ماژول را به عنوان یک هندلر برای شنونده ejabberd_http متصل کنید، همانطور که در مثال زیر نشان داده شده است.

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

اگر ترجیح می‌دهید از یک سرویس خارجی استفاده کنید، landing_page را روی چیزی مانند http://{{ host }}:8080/easy-xmpp-invites/#{{ invite.uri|strip_protocol }} یا https://invites.joinjabber.org/#{{ invite.uri|strip_protocol }} تنظیم کنید.

گزینه‌های موجود:

mod_invites:
  access_create_account: local

مثال‌ها:

listen:
  -
    port: 5281
    module: ejabberd_http
    request_handlers:
      /invites: mod_invites
# [...]
modules:
  mod_invites:
    landing_page: auto

acl:
  admin:
    - user: "my_admin_user@example.com"
access_rules:
  register:
    allow: admin
modules:
  mod_invites:
    landing_page: auto
  mod_register:
    allow_modules:
      - mod_invites

acl:
  local:
    user_regexp: ""
access_rules:
  create_account_invite:
    allow: local
modules:
  mod_invites:
    access_create_account: create_account_invite
    landing_page: auto
  mod_register:
    allow_modules:
      - mod_invites

mod_jidprep

این ماژول به کلاینت‌های XMPP اجازه می‌دهد از سرور بخواهند که یک JID را طبق قوانین مشخص‌شده در RFC 6122: XMPP Address Format نرمال‌سازی کند. این ممکن است برای کلاینت‌هایی در محیط‌های محدود خاص، یا برای اهداف آزمایشی مفید باشد.

گزینه‌های موجود:

mod_last

این ماژول پشتیبانی از XEP-0012: Last Activity را اضافه می‌کند. می‌توان از آن برای کشف آخرین زمان دسترسی یک کاربر قطع‌شده به سرور، دانستن آخرین فعالیت یک کاربر متصل روی سرور، یا پرس‌وجو از مدت زمان فعالیت سرور ejabberd استفاده کرد.

گزینه‌های موجود:

mod_legacy_auth

این ماژول XEP-0078: Non-SASL Authentication را پیاده‌سازی می‌کند.

این ماژول هیچ گزینه‌ای ندارد.

mod_mam

این ماژول XEP-0313: Message Archive Management و XEP-0441: Message Archive Management Preferences را پیاده‌سازی می‌کند. کلاینت‌های XMPP سازگار می‌توانند از آن برای ذخیره تاریخچه چت خود در سرور استفاده کنند.

گزینه‌های موجود:

mod_matrix_gw

توجه درباره این گزینه: بهبودیافته در نسخه ۲۵.۰۸.

دروازه Matrix. از نسخه‌های اتاق ۹، ۱۰ و ۱۱ از ejabberd 25.03 پشتیبانی می‌کند؛ از نسخه‌های اتاق ۴ و بالاتر از ejabberd 25.07؛ از نسخه اتاق ۱۲ (اتاق‌های hydra) از ejabberd 25.08. برای استفاده از این ماژول، Erlang/OTP 25 یا بالاتر لازم است. این ماژول از ejabberd 24.02 در دسترس است.

گزینه‌های موجود:

مثال:

listen:
  -
    port: 8448
    module: ejabberd_http
    tls: true
    request_handlers:
      "/_matrix": mod_matrix_gw
modules:
  mod_matrix_gw:
    key_name: "key1"
    key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    matrix_id_as_jid: true

mod_metrics

این ماژول رویدادها را به پشتیبان خارجی ارسال می‌کند (در حال حاضر فقط grapherl پشتیبانی می‌شود). رویدادهای پشتیبانی‌شده عبارتند از:

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

گزینه‌های موجود:

mod_mix

توجه درباره این گزینه: اضافه‌شده در ۱۶.۰۳ و بهبودیافته در ۱۹.۰۲.

این ماژول یک پیاده‌سازی آزمایشی از XEP-0369: Mediated Information eXchange (MIX) است. ادعا می‌شود که پروتکل MIX در آینده جایگزین پروتکل MUC خواهد شد (نگاه کنید به mod_muc).

برای آشنایی بیشتر با نحوه استفاده از این قابلیت، می‌توانید به آموزش ما مراجعه کنید: ../../tutorials/mix-010.md|Getting started with MIX

این ماژول به mod_mam وابسته است.

گزینه‌های موجود:

mod_mix_pam

این ماژول XEP-0405: Mediated Information eXchange (MIX): Participant Server Requirements را پیاده‌سازی می‌کند. این ماژول در صورتی لازم است که کلاینت‌های سازگار با MIX روی سرور شما قصد پیوستن به کانال‌های MIX را داشته باشند (چه روی سرور شما و چه روی سرورهای راه دور).

گزینه‌های موجود:

mod_mqtt

این ماژول پشتیبانی از پروتکل ../guide/mqtt/index.md|MQTT نسخه‌های 3.1.1 و 5.0 را اضافه می‌کند. به یاد داشته باشید که mod_mqtt را در بخش‌های modules و listen پیکربندی کنید.

گزینه‌های موجود:

mod_mqtt_bridge

این ماژول قابلیت همگام‌سازی موضوعات (topics) محلی MQTT با داده‌های روی سرورهای راه‌دور را اضافه می‌کند. می‌تواند هنگامی که کاربر محلی موضوع محلی را به‌روز می‌کند، موضوعات را روی سرورهای راه‌دور به‌روز کند، یا می‌تواند مشترک تغییرات سرور راه‌دور شود و نسخه محلی را هنگام به‌روزرسانی داده‌های راه‌دور به‌روز کند. این ماژول از ejabberd 23.01 در دسترس است.

گزینه‌های موجود:

مثال:

modules:
  mod_mqtt_bridge:
    replication_user: "mqtt@xmpp.server.com"
    servers:
      "mqtt://server.com":
        authentication:
          certfile: "/etc/ejabberd/mqtt_server.pem"
        publish:
          "localA": "remoteA" # local changes to 'localA' will be replicated on remote server as 'remoteA'
          "topicB": "topicB"
        subscribe:
          "remoteB": "localB" # changes to 'remoteB' on remote server will be stored as 'localB' on local server

mod_muc

توجه درباره این گزینه: ماژول mod_muc_occupantid در نسخه 26.02 ادغام شد.

این ماژول پشتیبانی از چت چندکاربره (MUC) را فراهم می‌کند. کاربران می‌توانند اتاق‌های موجود را کشف کنند، به آن‌ها بپیوندند یا اتاق جدید ایجاد کنند. حاضران در اتاق می‌توانند به صورت عمومی چت کنند یا مکالمات خصوصی داشته باشند.

پروتکل‌های پیاده‌سازی شده در این ماژول:

سرویس MUC به هر Jabber ID اجازه می‌دهد یک نام‌مستعار (nickname) ثبت کند تا هیچ‌کس دیگری نتواند از آن نام‌مستعار در هیچ اتاقی در سرویس MUC استفاده کند. برای ثبت نام‌مستعار، کشف سرویس را در کلاینت XMPP خود باز کنید و در سرویس MUC ثبت‌نام کنید.

همچنین امکان ثبت نام‌مستعار در یک اتاق وجود دارد تا هیچ‌کس دیگری نتواند از آن نام‌مستعار در آن اتاق استفاده کند. اگر یک نام‌مستعار در سرویس MUC ثبت شده باشد، نمی‌توان آن نام‌مستعار را در هیچ اتاقی ثبت کرد، و بالعکس: نام‌مستعاری که در یک اتاق ثبت شده، نمی‌تواند در سرویس MUC ثبت شود.

این ماژول از خوشه‌بندی و توازن بار پشتیبانی می‌کند. یک نمونه ماژول می‌تواند برای هر گره خوشه راه‌اندازی شود. اتاق‌ها در زمان ایجاد بر روی تمام نمونه‌های ماژول MUC موجود توزیع می‌شوند. ماژول چت چندکاربره خوشه‌بندی شده است اما خود اتاق‌ها نه خوشه‌بندی شده‌اند و نه مقاوم در برابر خرابی: اگر گره مدیریت‌کننده مجموعه‌ای از اتاق‌ها خاموش شود، اتاق‌ها حذف می‌شوند و در اولین تلاش برای اتصال روی گره موجود دیگری بازسازی خواهند شد.

گزینه‌های موجود:

modules:
  mod_muc:
    hosts:
      - service1.@HOST@
      - service2.@HOST@
    name: "Service General"
    append_module_config:
      service1.localhost:
        name: "Service 1"
      service2.example.net:
        name: "Service 2"

presence_broadcast:
  - moderator
  - participant
  - visitor

# This XML representation of vCard:
#   <vCard xmlns='vcard-temp'>
#     <FN>Conferences</FN>
#     <ADR>
#       <WORK/>
#       <STREET>Elm Street</STREET>
#     </ADR>
#   </vCard>
#
# is translated to:
vcard:
  fn: Conferences
  adr:
    -
      work: true
      street: Elm Street

mod_muc_admin

این ماژول دستوراتی برای مدیریت سرویس‌های MUC محلی و اتاق‌های MUC آن‌ها فراهم می‌کند. همچنین صفحات ساده WebAdmin برای مشاهده اتاق‌های موجود ارائه می‌دهد.

این ماژول به mod_muc وابسته است.

گزینه‌های موجود:

mod_muc_log

این ماژول ثبت اختیاری مکالمات عمومی Multi-User Chat (MUC) در قالب HTML را فعال می‌کند. پس از فعال‌سازی این ماژول، کاربران می‌توانند با استفاده از یک کلاینت XMPP با قابلیت MUC به اتاق بپیوندند و در صورت داشتن دسترسی‌های لازم، می‌توانند فرم پیکربندی را درخواست کنند که در آن می‌توانند گزینه فعال‌سازی ثبت اتاق را تنظیم کنند.

ویژگی‌ها:

این ماژول به mod_muc وابسته است.

گزینه‌های موجود:

file_permissions:
  mode: 644
  group: 33

top_link:
  /: Home

mod_muc_rtbl

توجه درباره این ماژول: در نسخه 23.04 اضافه شده است.

این ماژول لیست‌های مسدودسازی بلادرنگ (Real-time blocklists) را برای اتاق‌های MUC پیاده‌سازی می‌کند.

با مشاهده گره pubsub راه دور مطابق با مشخصات توصیف شده در https://xmppbl.org کار می‌کند.

گزینه‌های موجود:

mod_multicast

این ماژول یک سرویس برای XEP-0033: Extended Stanza Addressing پیاده‌سازی می‌کند.

گزینه‌های موجود:

# Default values:
local:
  message: 100
  presence: 100
remote:
  message: 20
  presence: 20

مثال:

# Only admins can send packets to multicast service
access_rules:
  multicast:
    - allow: admin
# If you want to allow all your users:
access_rules:
  multicast:
    - allow
# This allows both admins and remote users to send packets,
# but does not allow local users
acl:
  allservers:
    server_glob: "*"
access_rules:
  multicast:
    - allow: admin
    - deny: local
    - allow: allservers
modules:
  mod_multicast:
     host: multicast.example.org
     access: multicast
     limits:
       local:
         message: 40
         presence: infinite
       remote:
         message: 150

mod_offline

این ماژول پیاده‌سازی XEP-0160: بهترین روش‌ها برای مدیریت پیام‌های آفلاین و XEP-0013: بازیابی انعطاف‌پذیر پیام‌های آفلاین را فراهم می‌کند. این بدان معناست که تمام پیام‌های ارسالی به کاربر آفلاین تا زمانی که آن کاربر دوباره آنلاین شود در کارگزار ذخیره خواهند شد. بنابراین بسیار شبیه به نحوه کارکرد ایمیل است. یک کاربر آفلاین در نظر گرفته می‌شود اگر هیچ نشستی با اولویت presence بزرگ‌تر از ۰ در حال حاضر باز نباشد.

API delete_expired_messages امکان حذف پیام‌های منقضی شده را می‌دهد، و API delete_old_messages پیام‌های قدیمی‌تر را حذف می‌کند.

گزینه‌های موجود:

مثال‌ها:

acl:
  admin:
    user:
      - admin1@localhost
      - admin2@example.org
  poweruser:
    user:
      - bob@example.org
      - jane@example.org
shaper_rules:
  max_user_offline_messages:
    - 5000: poweruser
    - 2000: admin
    - 100
modules:
  ...
  mod_offline:
    access_max_user_messages: max_user_offline_messages
  ...

mod_ping

این ماژول پشتیبانی از XEP-0199: XMPP Ping و keepalive‌های دوره‌ای را پیاده‌سازی می‌کند. هنگامی که این ماژول فعال است، ejabberd به درستی به درخواست‌های ping پاسخ می‌دهد، همانطور که در پروتکل تعریف شده است.

گزینه‌های موجود:

مثال:

modules:
  mod_ping:
    send_pings: true
    ping_interval: 4 min
    timeout_action: kill

mod_pres_counter

این ماژول سیل/هرزنامه در ترافیک اشتراک‌های presence را تشخیص می‌دهد. اگر یک کاربر در یک بازه زمانی مشخص بیش از حد مجاز از این stanza‌ها ارسال یا دریافت کند، stanza‌های اضافی بی‌صدا دور انداخته می‌شوند و یک هشدار در گزارش ثبت می‌شود.

گزینه‌های موجود:

مثال:

modules:
  mod_pres_counter:
    count: 5
    interval: 30 secs

mod_privacy

این ماژول پیاده‌سازی XEP-0016: Privacy Lists است.

گزینه‌های موجود:

mod_private

این ماژول پشتیبانی از XEP-0049: Private XML Storage را اضافه می‌کند.

با استفاده از این روش، موجودیت‌های XMPP می‌توانند داده‌های خصوصی را روی سرور ذخیره کنند، هر زمان که لازم بود آن‌ها را بازیابی کنند و بین چندین کلاینت متصل یک کاربر به اشتراک بگذارند. داده‌های ذخیره‌شده می‌توانند هر چیزی باشند، تا زمانی که XML معتبر باشند. یک کاربرد رایج، ذخیره نشانک‌های کنفرانس‌های کاربر است (XEP-0048: Bookmarks).

همچنین تبدیل نشانک‌های توصیف‌شده در XEP-0402: PEP Native Bookmarks را پیاده‌سازی می‌کند، به API bookmarks_to_pep مراجعه کنید.

گزینه‌های موجود:

mod_privilege

توجه درباره این گزینه: در نسخه 24.10 بهبود یافته است.

این ماژول پیاده‌سازی XEP-0356: Privileged Entity است. این افزونه به کامپوننت‌ها امکان می‌دهد دسترسی ممتاز به داده‌های موجودیت‌های دیگر داشته باشند (ارسال پیام از طرف سرور یا از طرف کاربر، دریافت/تنظیم لیست مخاطبین کاربر، دسترسی به اطلاعات حضور و غیره). این ویژگی ممکن است برای نوشتن کامپوننت‌های خارجی قدرتمند مورد استفاده قرار گیرد، مانند پیاده‌سازی یک سرویس PEP یا MAM خارجی.

به طور پیش‌فرض یک کامپوننت هیچ دسترسی ممتازی ندارد. شایان ذکر است که مجوزها به کامپوننت دسترسی به یک نوع داده خاص برای تمام کاربران هاست مجازی‌ای که mod_privilege روی آن بارگذاری شده است را می‌دهند.

مطمئن شوید که یک شنونده برای اتصال کامپوننت پیکربندی کرده‌اید. برای اطلاعات بیشتر بخش مربوط به پورت‌های شنونده را بررسی کنید.

گزینه‌های موجود:

مثال:

modules:
  mod_privilege:
    iq:
      http://jabber.org/protocol/pubsub:
        get: all
    roster:
      get: all
    presence:
      managed_entity: all
    message:
      outgoing: all

mod_providers

توجه درباره این گزینه: در نسخه 25.08 اضافه شده است.

این ماژول فایل‌های JSON provider API نسخه v2 را همان‌طور که توسط XMPP Providers توصیف شده، ارائه می‌دهد.

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

برای استفاده از این ماژول، علاوه بر افزودن آن به بخش modules، باید آن را در listen → ejabberd_http → listen-options.md#request_handlers|request_handlers نیز فعال کنید. توجه داشته باشید که باید در listen.md#ejabberd_http|ejabberd_http گزینه listen-options.md#tls|tls را فعال کنید.

گزینه‌های موجود:

مثال:

listen:
  -
    port: 443
    module: ejabberd_http
    tls: true
    request_handlers:
      /.well-known/xmpp-provider-v2.json: mod_providers
modules:
  mod_providers:
    alternativeJids: ["example1.com", "example2.com"]
    busFactor: 1
    freeOfCharge: true
    languages: [ag, ao, bg, en]
    legalNotice: "http://@HOST@/legal/@LANGUAGE_URL@"
    maximumHttpFileUploadStorageTime: 0
    maximumHttpFileUploadTotalSize: 0
    maximumMessageArchiveManagementStorageTime: 0
    organization: "non-governmental"
    passwordReset: "http://@HOST@/reset/@LANGUAGE_URL@"
    professionalHosting: true
    serverLocations: [ao, bg]
    serverTesting: true
    since: "2025-12-31"
    website: "http://@HOST@/website/@LANGUAGE_URL@"

mod_proxy65

این ماژول XEP-0065: SOCKS5 Bytestreams را پیاده‌سازی می‌کند. این ماژول به ejabberd اجازه می‌دهد به عنوان یک پروکسی انتقال فایل بین دو کلاینت XMPP عمل کند.

گزینه‌های موجود:

modules:
  mod_proxy65:
    hosts:
      - service1.@HOST@
      - service2.@HOST@
    name: "Service General"
    append_module_config:
      service1.localhost:
        name: "Service 1"
      service2.example.net:
        name: "Service 2"

مثال:

acl:
  admin:
    user: admin@example.org
  proxy_users:
    server: example.org
access_rules:
  proxy65_access:
    allow: proxy_users
shaper_rules:
  proxy65_shaper:
    none: admin
  proxyrate: proxy_users
shaper:
  proxyrate: 10240
modules:
  mod_proxy65:
    host: proxy1.example.org
    name: "File Transfer Proxy"
    ip: 200.150.100.1
    port: 7778
    max_connections: 5
    access: proxy65_access
    shaper: proxy65_shaper
    recbuf: 10240
    sndbuf: 10240

mod_pubsub

این ماژول سرویسی برای XEP-0060: Publish-Subscribe ارائه می‌دهد. قابلیت‌های mod_pubsub می‌توانند با استفاده از افزونه‌ها گسترش یابند. افزونه‌ای که PEP (XEP-0163: Personal Eventing via Pubsub) را پیاده‌سازی می‌کند در فایل پیکربندی پیش‌فرض ejabberd فعال است و به mod_caps نیاز دارد.

گزینه‌های موجود:

modules:
  mod_pubsub:
    hosts:
      - service1.@HOST@
      - service2.@HOST@
    name: "Service General"
    append_module_config:
      service1.localhost:
        name: "Service 1"
      service2.example.net:
        name: "Service 2"

force_node_config:
  ## Avoid buggy clients to make their bookmarks public
  storage:bookmarks:
    access_model: whitelist

modules:
  ...
  mod_pubsub:
    pep_mapping:
      http://jabber.org/protocol/tune: tune
  ...

# This XML representation of vCard:
#   <vCard xmlns='vcard-temp'>
#     <FN>Conferences</FN>
#     <ADR>
#       <WORK/>
#       <STREET>Elm Street</STREET>
#     </ADR>
#   </vCard>
#
# is translated to:
vcard:
  fn: Conferences
  adr:
    -
      work: true
      street: Elm Street

مثال‌ها:

modules:
  mod_pubsub:
    access_createnode: pubsub_createnode
    max_subscriptions_node: 100
    default_node_config:
      notification_type: normal
      notify_retract: false
      max_items: 4
    plugins:
      - flat
      - pep

modules:
  mod_pubsub:
    db_type: sql
    access_createnode: pubsub_createnode
    ignore_pep_from_offline: true
    last_item_cache: false
    plugins:
      - flat
      - pep

mod_pubsub_serverinfo

توجه درباره این گزینه: در نسخه 25.07 اضافه شده است.

این ماژول پشتیبانی از XEP-0485: PubSub Server Information را برای افشای اطلاعات S2S از طریق سرویس Pub/Sub اضافه می‌کند.

اتصالات فعال S2S در یک گره PubSub محلی منتشر می‌شوند. در حال حاضر نام گره به صورت ثابت "serverinfo" تعریف شده است.

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

توجه داشته باشید که این ماژول فقط اتصالات S2S برقرارشده در حین اجرای ماژول را نشان می‌دهد. اگر ماژول را در زمان اجرا نصب کنید، API stop_s2s_connections را اجرا کنید یا ejabberd را مجدداً راه‌اندازی کنید تا اتصالات S2S مجدداً برقرار شوند و ماژول آن‌ها را شناسایی و منتشر کند.

این ماژول به mod_pubsub و mod_disco وابسته است.

گزینه‌های موجود:

مثال:

modules:
  mod_pubsub_serverinfo:
    pubsub_host: custom.pubsub.domain.local

mod_push

این ماژول بخش کارگزار XMPP از راه‌حل اعلان‌های فشاری مشخص‌شده در XEP-0357: Push Notifications را پیاده‌سازی می‌کند. به عنوان مثال، اعلان‌های APNS یا FCM را مستقیماً تولید نمی‌کند. در عوض، طراحی شده تا با به اصطلاح "سرورهای برنامه" که توسط فروشندگان شخص ثالث اپلیکیشن‌های موبایل اداره می‌شوند کار کند. آن سرورهای برنامه معمولاً تحویل اعلان به دستگاه موبایل کاربر را با استفاده از سرویس‌های بک‌اند وابسته به پلتفرم مانند FCM یا APNS فعال می‌کنند.

گزینه‌های موجود:

mod_push_keepalive

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

این ماژول به mod_push وابسته است.

گزینه‌های موجود:

mod_register

این ماژول پشتیبانی از XEP-0077: In-Band Registration را اضافه می‌کند. این پروتکل به کاربران نهایی امکان می‌دهد از یک کلاینت XMPP برای موارد زیر استفاده کنند:

این ماژول همچنین گزینه سطح بالای registration_timeout که به صورت سراسری برای کارگزار تعریف شده را می‌خواند، بنابراین مستندات آن گزینه را نیز بررسی کنید.

گزینه‌های موجود:

modules:
  mod_register:
    welcome_message:
      subject: "Welcome!"
      body: |-
        Hi!
        Welcome to this XMPP server

mod_register_web

این ماژول یک صفحه وب فراهم می‌کند که کاربران می‌توانند در آن:

این ماژول از basic.md#captcha|CAPTCHA برای ثبت حساب کاربری جدید پشتیبانی می‌کند. برای فعال کردن این ویژگی، گزینه‌های سطح بالای captcha_cmd و captcha_url را پیکربندی کنید.

به عنوان مثال کاربرد، کاربران میزبان localhost می‌توانند از صفحه: https://localhost:5280/register/ بازدید کنند. مهم است که کاراکتر / پایانی را در URL درج کنید، در غیر این صورت آدرس زیرصفحات اشتباه خواهد بود.

این ماژول در listen → ejabberd_http → listen-options.md#request_handlers|request_handlers فعال می‌شود.

نیازی به فعال کردن این ماژول در modules نیست، اما یک لینک به صفحه ثبت‌نام در منوی WebAdmin اضافه می‌کند. این ماژول به mod_register وابسته است که تمام پیکربندی در آن انجام می‌شود.

این ماژول هیچ گزینه‌ای ندارد.

مثال:

listen:
  -
    port: 5280
    module: ejabberd_http
    request_handlers:
      /register: mod_register_web
modules:
  mod_register: {}

mod_roster

این ماژول مدیریت فهرست مخاطبین را طبق تعریف در RFC6121 بخش ۲ پیاده‌سازی می‌کند. این ماژول همچنین پشتیبانی از XEP-0237: Roster Versioning را اضافه می‌کند.

گزینه‌های موجود:

مثال:

modules:
  mod_roster:
    versioning: true
    store_current_id: false

mod_s2s_bidi

توجه درباره این گزینه: در نسخه 24.10 اضافه شده است.

این ماژول پشتیبانی از XEP-0288: Bidirectional Server-to-Server Connections را اضافه می‌کند که امکان استفاده از یک اتصال s2s برای ارتباط در هر دو جهت را فراهم می‌کند.

این ماژول هیچ گزینه‌ای ندارد.

مثال:

modules:
  mod_s2s_bidi: {}

mod_s2s_dialback

این ماژول پشتیبانی از XEP-0220: Server Dialback را برای فراهم کردن تأیید هویت کارگزار بر اساس DNS اضافه می‌کند.

گزینه‌های موجود:

مثال:

modules:
  mod_s2s_dialback:
    access:
      allow:
        server: legacy.domain.tld
        server: invalid-cert.example.org
      deny: all

mod_scram_upgrade

توجه درباره این گزینه: در نسخه 24.10 اضافه شده است.

این ماژول پشتیبانی از XEP-0480: SASL Upgrade Tasks را اضافه می‌کند که به کاربران اجازه می‌دهد رمزهای عبور خود را به نمایش امن‌تری ارتقا دهند.

گزینه‌های موجود:

مثال:

modules:
  mod_scram_upgrade:
    offered_upgrades:
      - sha256
      - sha512

mod_service_log

این ماژول نسخه‌هایی از تمام stanza‌ها را به سرورها یا اجزای XMPP از راه دور ارسال می‌کند. هر stanza در قالب عنصر <forwarded/> طبق توضیحات XEP-0297: Stanza Forwarding کپسوله می‌شود.

گزینه‌های موجود:

مثال:

modules:
  mod_service_log:
    loggers:
      - xmpp-server.tld
      - component.domain.tld

mod_shared_roster

این ماژول به شما امکان می‌دهد گروه‌های فهرست مخاطبین مشترک ایجاد کنید: گروه‌هایی از حساب‌های کاربری که می‌توانند اعضای گروه‌های (دیگر) را در فهرست مخاطبین خود ببینند.

مزیت‌های بزرگ این ویژگی این است که کاربران نهایی نیازی به افزودن دستی همه کاربران به فهرست مخاطبین خود ندارند و نمی‌توانند کاربران را به‌طور دائم از گروه‌های فهرست مشترک حذف کنند. یک گروه فهرست مشترک می‌تواند اعضایی از هر سرور XMPP داشته باشد، اما حضور تنها از اعضای همان میزبان مجازی که گروه در آن ایجاد شده است، در دسترس خواهد بود. این ویژگی همچنان به کاربران اجازه می‌دهد مخاطبین خود را داشته باشند یا اضافه کنند، زیرا جایگزین فهرست مخاطبین استاندارد نمی‌شود. در عوض، مخاطبین فهرست مشترک هنگام بازیابی به فهرست مخاطبین کاربران مربوطه ادغام می‌شوند. بنابراین فهرست مخاطبین استاندارد کاربر بدون تغییر باقی می‌ماند.

گروه‌های فهرست مشترک را می‌توان از طریق پنل مدیریت وب ویرایش کرد و برخی دستورات API با پیشوند srg_، مانند API srg_add وجود دارند. هر گروه یک نام منحصربه‌فرد و این پارامترها دارد:

این ماژول به mod_roster وابسته است. اگر فعال نباشد، پرسش‌های فهرست مخاطبین خطای 503 برمی‌گردانند.

گزینه‌های موجود:

مثال‌ها:

Name: club_members
Label: Club Members
Description: Members from the computer club
Members: member1@example.org, member2@example.org, member3@example.org
Displayed Groups: club_members

First list:
Name: management
Label: Management
Description: Management
Members: manager1@example.org, manager2@example.org
Displayed: management, marketing, sales
Second list:
Name: marketing
Label: Marketing
Description: Marketing
Members: marketeer1@example.org, marketeer2@example.org, marketeer3@example.org
Displayed: management, marketing
Third list:
Name: sales
Label: Sales
Description: Sales
Members: salesman1@example.org, salesman2@example.org, salesman3@example.org
Displayed: management, sales

mod_shared_roster_ldap

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

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

همچنین برای جزئیات بازیابی فهرست مخاطبین و مثال‌های پیکربندی شامل Flat DIT و Deep DIT، بخش ldap.md#ldap-examples|Configuration examples را بررسی کنید.

گزینه‌های موجود:

mod_sic

این ماژول پشتیبانی از XEP-0279: Server IP Check را اضافه می‌کند. این پروتکل به کلاینت امکان می‌دهد آدرس IP خارجی خود را کشف کند.

این ماژول هیچ گزینه‌ای ندارد.

mod_sip

این ماژول پشتیبانی از پراکسی/ثبت‌کننده SIP را برای هاست مجازی مربوطه اضافه می‌کند.

گزینه‌های موجود:

مثال:

modules:
  mod_sip:
    always_record_route: false
    record_route: "sip:example.com;lr"
    routes:
      - "sip:example.com;lr"
      - "sip:sip.example.com;lr"
    flow_timeout_udp: 30 sec
    flow_timeout_tcp: 1 min
    via:
      - tls://sip-tls.example.com:5061
      - tcp://sip-tcp.example.com:5060
      - udp://sip-udp.example.com:5060

mod_stats

این ماژول پشتیبانی از XEP-0039: Statistics Gathering را اضافه می‌کند. این پروتکل به شما امکان می‌دهد آمارهای زیر را از سرور ejabberd خود دریافت کنید:

این ماژول هیچ گزینه‌ای ندارد.

mod_stream_mgmt

این ماژول پشتیبانی از XEP-0198: Stream Management را اضافه می‌کند. این پروتکل امکان مدیریت فعال یک جریان XML بین دو موجودیت XMPP را فراهم می‌کند، از جمله ویژگی‌هایی برای تأیید استانزا و از سرگیری جریان.

گزینه‌های موجود:

mod_stun_disco

توجه درباره این گزینه: در نسخه 20.04 اضافه شده است.

این ماژول به کلاینت‌های XMPP امکان می‌دهد سرویس‌های STUN/TURN را کشف کنند و اعتبارنامه‌های موقت برای استفاده از آن‌ها طبق XEP-0215: External Service Discovery دریافت کنند.

گزینه‌های موجود:

services:
  -
    host: 203.0.113.3
    port: 3478
    type: stun
    transport: udp
    restricted: false
  -
    host: 203.0.113.3
    port: 3478
    type: turn
    transport: udp
    restricted: true
  -
    host: 2001:db8::3
    port: 3478
    type: stun
    transport: udp
    restricted: false
  -
    host: 2001:db8::3
    port: 3478
    type: turn
    transport: udp
    restricted: true
  -
    host: server.example.com
    port: 5349
    type: turns
    transport: tcp
    restricted: true

mod_time

این ماژول پشتیبانی از XEP-0202: Entity Time را اضافه می‌کند. به عبارت دیگر، ماژول زمان سیستم سرور را گزارش می‌دهد.

این ماژول هیچ گزینه‌ای ندارد.

mod_vcard

این ماژول به کاربران نهایی اجازه می‌دهد vCard خود را ذخیره و بازیابی کنند، و vCard سایر کاربران را نیز بازیابی نمایند، همان‌طور که در XEP-0054: vcard-temp تعریف شده است. همچنین این ماژول یک دایرکتوری ساده کاربران Jabber بر اساس vCard این کاربران پیاده‌سازی می‌کند. علاوه بر این، سرور را قادر می‌سازد تا در صورت درخواست، vCard خود را ارسال کند.

گزینه‌های موجود:

modules:
  mod_vcard:
    hosts:
      - service1.@HOST@
      - service2.@HOST@
    name: "Service General"
    append_module_config:
      service1.localhost:
        name: "Service 1"
      service2.example.net:
        name: "Service 2"

# This XML representation of vCard:
#
#   <vCard xmlns='vcard-temp'>
#     <FN>Conferences</FN>
#     <ADR>
#       <WORK/>
#       <STREET>Elm Street</STREET>
#     </ADR>
#   </vCard>
#
# is translated to:
#
vcard:
  fn: Conferences
  adr:
    -
      work: true
      street: Elm Street

گزینه‌های موجود برای پشتیبان ldap:

User: "%u"
"Full Name": displayName
"Given Name": givenName
"Middle Name": initials
"Family Name": sn
Nickname: "%u"
Birthday: birthDay
Country: c
City: l
Email: mail
"Organization Name": o
"Organization Unit": ou

"Full Name": FN
"Given Name": FIRST
"Middle Name": MIDDLE
"Family Name": LAST
"Nickname": NICKNAME
"Birthday": BDAY
"Country": CTRY
"City": LOCALITY
"Email": EMAIL
"Organization Name": ORGNAME
"Organization Unit": ORGUNIT

NICKNAME: {"%u": []}
FN: {"%s": [displayName]}
LAST: {"%s": [sn]}
FIRST: {"%s": [givenName]}
MIDDLE: {"%s": [initials]}
ORGNAME: {"%s": [o]}
ORGUNIT: {"%s": [ou]}
CTRY: {"%s": [c]}
LOCALITY: {"%s": [l]}
STREET: {"%s": [street]}
REGION: {"%s": [st]}
PCODE: {"%s": [postalCode]}
TITLE: {"%s": [title]}
URL: {"%s": [labeleduri]}
DESC: {"%s": [description]}
TEL: {"%s": [telephoneNumber]}
EMAIL: {"%s": [mail]}
BDAY: {"%s": [birthDay]}
ROLE: {"%s": [employeeType]}
PHOTO: {"%s": [jpegPhoto]}

گزینه‌های موجود برای پشتیبان mnesia:

mod_vcard_xupdate

کلاینت کاربر می‌تواند یک آواتار را در vCard کاربر ذخیره کند. پروتکل آواتارهای مبتنی بر vCard (XEP-0153) روشی برای کلاینت‌ها فراهم می‌کند تا به مخاطبین اطلاع دهند که مقدار هش آواتار چیست. با این حال، کلاینت‌های ساده یا کوچک ممکن است این پروتکل را پیاده‌سازی نکنند.

اگر این ماژول فعال باشد، تمام استانزاهای presence خروجی کلاینت به‌طور خودکار هش آواتار را از طرف کلاینت دریافت می‌کنند. بنابراین، مخاطبین استانزاهای presence را با Update Data شرح‌داده‌شده در XEP-0153 دریافت می‌کنند، انگار که کلاینت خودش آن را درج کرده بود. اگر کلاینت از قبل چنین عنصری را در استانزای presence قرار داده بود، با عنصر تولیدشده توسط ejabberd جایگزین می‌شود.

با فعال‌سازی این ماژول، هر تغییر در vCard موجب محاسبه مجدد هش می‌شود، و هر presence ارسال‌شده توسط کلاینت موجب بازیابی هش و بازنویسی استانزای presence می‌شود. به همین دلیل، فعال‌سازی این ماژول سربار محاسباتی را در سرورهایی با کلاینت‌هایی که به‌طور مکرر presence خود را تغییر می‌دهند افزایش می‌دهد. با این حال، استفاده از حافظه نهان این سربار را به‌طور قابل توجهی کاهش می‌دهد، بنابراین احتمالاً نمی‌خواهید use_cache را روی false تنظیم کنید.

این ماژول به mod_vcard وابسته است.

گزینه‌های موجود:

mod_version

این ماژول XEP-0092: Software Version را پیاده‌سازی می‌کند. در نتیجه، هنگام دریافت درخواست، نسخه ejabberd را پاسخ می‌دهد.

گزینه‌های موجود: