Prosody

Prosody (発音: 1, 2) は Lua プログラミング言語で書かれた XMPP サーバーです。Prosody は軽量で簡単に拡張できるように設計されています。制限の緩い MIT ライセンス でライセンスされています。Prosody は Arch Linux の Community リポジトリからインストールすることができ、Arch User Repository には複数の任意の依存パッケージがあります。

このガイドを読むときは、AUR のパッケージのビルド・インストール方法と XMPP の基礎知識を知っておくと役に立ちます。

インストール

公式リポジトリから prosody をインストールしてください。

任意の依存パッケージ

Prosody を実行するのに必ずしも必要ではないが、便利な機能を提供する依存パッケージです。これらの依存パッケージの中には AUR からビルド・インストールする必要があるものも含まれています。AUR のパッケージのインストール・ビルドの方法を知らない場合は AUR#パッケージのインストール を見て下さい。

TLS/SSL サポート (推奨)

盗聴されないように Prosody でストリームを暗号化できるようになります。
必要パッケージ: lua51-sec (Community)

MySQL バックエンド

mariadb などの MySQL バックエンドを Prosody で使えるようになり拡張性やパフォーマンスが上がります。
必要パッケージ: lua-sql-mysql (Community)

接続スケーリングの向上 (推奨)

libevent を使うことで大量の同時接続を処理できるようになります。
必要パッケージ: lua51-event^AUR (AUR)

ストリームの圧縮

クライアントからサーバーへのストリームを圧縮して対応するクライアントで帯域を節約することができます。
必要パッケージ: lua51-zlib (Community)

Cyrus SASL サポート

Cyrus SASL ライブラリを使って Prosody で認証ができるようになります。
必要パッケージ: lua-cyrussasl^AUR (AUR)

設定

ノート: The posix module and pidfile setting contained in the default configuration file are required for Prosody's proper operation on Arch Linux. Please do not disable or alter them.

The main configuration file is located at /etc/prosody/prosody.cfg.lua, information on how to configure Prosody can be found in Prosody's documentation. The syntax of the configuration file can be checked after any changes are made by running:

$ luac5.1 -p /etc/prosody/prosody.cfg.lua

No output means the syntax is correct.

ログ

Arch Linux の Prosody は syslog にログを出力するようにあらかじめ設定されています。したがって、デフォルトで、Prosody のログメッセージは systemd journal で確認できます。

制御

You can start Prosody through the included Systemd script:

# systemctl start prosody

To automatically start Prosody at boot execute:

# systemctl enable prosody

Prosody uses the default XMPP ports, 5222 and 5269, for client-to-server and server-to-server communications respectively. Configure your firewall as necessary.

You can manipulate Prosody users by using the prosodyctl program. To add a user:

# prosodyctl adduser <JID>

ヒント: You will likely want to make at least one user an administrator by adding their Jabber ID to the admins list in the configuration file.

Issue man prosodyctl to see the man page for prosodyctl.

セキュリティ

ユーザー登録

Prosody supports XMPP's in-band registration standard, which allows users to register with an XMPP client from within their client and change their passwords. While this is convenient for users it does not allow administrators to moderate the registration of new users. As such, the register module is enabled in the default configuration but allow_registration is set to false. This allows existing users to change their passwords from within their client but does not allow new users to register themselves.

ヒント: If you do decide to support new in-band registrations, you will likely find the watchregistrations and welcome modules useful.

ストリームの暗号化

Prosody can utilize TLS certificates to encrypt client-to-server communications (if the proper dependencies are installed). See the relevant sections of prosody.cfg.lua to configure Prosody to utilize these certificates.

To require encryption for client-to-server communications add the following to your configuration file:

/etc/prosody/prosody.cfg.lua

Host "*"

    c2s_require_encryption = true

Similarly, for server-to-server communications you may do:

/etc/prosody/prosody.cfg.lua

Host "*"

    s2s_require_encryption = true

While requiring client-to-server encryption is generally a good idea, please keep in mind that some popular XMPP services such as Google Talk/Gmail do not support server-to-server encryption.

ユーザーの表示

A simple way to see a list of the registered users is

# ls -l /var/lib/prosody/*/accounts/*

alternatively, you can download the module mod_listusers.lua, and use it as

# prosodyctl mod_listusers

削除

After normally uninstalling Prosody with pacman, the /etc/prosody and /var/lib/prosody directories may be left on your filesystem, and you may want to remove them if you do not plan on reinstalling Prosody.

Tips and tricks

コンポーネント

Prosody supports XMPP components, which provide extra services to clients. Components are either provided internally by special Prosody modules or externally using the protocol specified in XEP-0114.

ノート: Components must use a different hostname from the VirtualHost names defined in prosody.cfg.lua. Attempting to host a component on the same hostname as a defined VirtualHost will result in errors.

By default, Prosody will listen for external components. If you do not plan to use any external components with Prosody you can disable this behavior by adding the following your configuration:

/etc/prosody/prosody.cfg.lua

component_ports = {}

Multi-User Chat

A common component used with XMPP servers is Multi-User Chat (MUC), which allows conferences between multiple users. MUC is provided as an internal component with Prosody. To enable MUC add the following to your configuration file:

/etc/prosody/prosody.cfg.lua

Component "conference.example.com" "muc"

This will enable the MUC component on host conference.example.com.

Prosody モジュール

Prosody Modules is a collection of extra modules not distributed with Prosody. These modules are in various states of development from highly experimental to relatively stable. You should consult a given module's wiki page for more information. An example of an extra module is pastebin, which when loaded will intercept long messages (for example, log file output) and replace them with a link to a pastebin hosted using Prosody's internal HTTP server (provided by the core module, httpserver).

To use an extra module download its raw file(s) from the source browser (when viewing a file, search for the link "View raw file"). Alternatively and likely easier, use Mercurial to clone the entire repository:

$ hg clone https://prosody-modules.googlecode.com/hg/ prosody-modules

Now you can copy the module (and any additional files it needs) to Prosody's module directory at /usr/lib/prosody/modules. To enable the module add it to your modules_enabled list in your prosody.cfg.lua for the host or component you wish to use it for. For example, to use the pastebin module on a MUC component:

/etc/prosody/prosody.cfg.lua

Component "conference.example.com" "muc"
    modules_enabled = { "pastebin" }

ノート: An enforced Prosody convention is that modules are named mod_foo.lua but simply enabled by adding foo to the modules_enabled list.

コンソール

警告: The console does not require any authentication so any user on a multi-user system can connect and issue commands on the console. Therefore it is not recommended to enable the console module on a multi-user system.

The console module provides a telnet console from which administrative operations and queries can be performed. You can connect to the console by issuing:

$ telnet localhost 5582

You of course need the telnet program provided by the inetutils package. Use the help command in the console to get usage help.

The console even allows you to execute Lua commands directly on the server by preceding a command with >. For example to see if a client connection is compressed:

> full_sessions["romeo@montague.lit/Resource"].compressed

Will return true if the connection is compressed or nil if it is not.

トラブルシューティング

One of Prosody's primary design principles is to be simple to use and configure. However, issues can still arise (and likely will as is the case with any complex software). If you encounter a problem there are a variety of steps you can take to narrow down the cause:

• Check for known issues
  Look at the release notes for your Prosody version to see if your issue is listed as a known issue. Also check the issue tracker to see if your issue has already been reported.
• Check configuration syntax
  Run luac5.1 -p /etc/prosody/prosody.cfg.lua to check for any syntax errors in your configuration file. If there is no output your syntax is fine.
• Check the log
  Errors are only logged if there is a critical problem so always address those issues. If you think you have a very low level issue (like protocol compatibility between clients and servers with Prosody) then you can enable the very verbose debug level logging.
• Check permissions
  The Prosody package should add a new prosody user and group to your system and set appropriate permissions, but it is always good to double check. Ensure that /etc/prosody and /var/lib/prosody are owned by the prosody user and that the user has appropriate permissions to read and write to those paths and all contained files.
• Check listening ports
  When troubleshooting connection issues make sure that Prosody is actually listening for connections. You may do so by running ss -tul and making sure that xmpp-client (port 5222) and xmpp-server (port 5269) are listed.
• Restart
  Like most things, it does not hurt to restart Prosody (systemctl restart prosody) to see if it resolves an issue.

If you are unable to resolve your issue yourself there are a variety of resources you can use to seek help. In order of immediacy with which you will likely receive help:

1. XMPP Conference: prosody@conference.prosody.im
2. Mailing List: Web Interface, Email
3. Arch Forums (for package issues)

開発

Two development packages are maintained for Prosody in the AUR, prosody-devel^AUR and prosody-hg^AUR. prosody-devel tracks the latest source release of a development version (alpha, beta, release candidate) and will actually be behind the stable version if a final version of the development version is released. prosody-hg tracks the Mercurial repository tip for Prosody and will always contain the latest code as it is checked in. Both packages are built similarly to the stable package.

コミュニティ

• メーリングリスト: prosody-dev, prosody-users
• カンファレンス: prosody@conference.prosody.im
• ブログ: Prosodical Thoughts

参照

• 公式ドキュメント
• Prosodical Thoughts (Blog)
• Issue Tracker
• Prosody Modules (Extra Modules)