Prosody

公式ウェブサイト より:

Prosody は近代的な XMPP 通信サーバーです。簡単にセットアップ・設定ができ、効率的にシステムリソースを使用するように作られています。さらに、開発者が簡単に拡張できる柔軟性のあるシステムとして設計されており、機能の追加や新しいプロトコルのプロトタイプ作成を素早く行うことができます。

インストール

prosody パッケージをインストールしてください。

任意の依存パッケージ

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

TLS/SSL サポート (推奨)

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

MySQL/Postgresql バックエンド

MySQL/mariadb/Postgresql バックエンドを Prosody で使えるようになり拡張性やパフォーマンスが上がります。
必要パッケージ: lua52-dbi

警告:

• lua51-dbi は上流からは外されています。FS#53081 を参照してください。
• 有効にすると Prosody はデフォルトでデータベースに平文でパスワードを保存します。mod_auth_internal_hashed などのハッシュ化認証モジュールを使うことを推奨します。

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

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

ノート: luaevent を有効にすると全ての s2s 機能が破壊されるバグが存在しましたが、v0.10 で修正されました [1]。

ストリームの圧縮

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

設定

ノート: The posix module and pidfile setting contained in the default configuration file are required for Prosody's proper operation.

メイン設定ファイルは /etc/prosody/prosody.cfg.lua です。Prosody の設定方法は Prosody の ドキュメント に載っています。以下のコマンドを実行することで設定ファイルの構文チェックをすることができます:

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

構文が正しければ何も出力されません。

ログ

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

制御

systemd サービスの prosody.service を起動・有効化してください。

Prosody はデフォルトの XMPP ポートである 5222 (クライアントからサーバーへの通信) と 5269 (サーバーからサーバーへの通信) を使用します。必要に応じてファイアウォールを設定してください。

prosodyctl プログラムを使うことで Prosody ユーザーを操作できます。ユーザーを追加するには:

# 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.

詳しくは prosodyctl(1) を参照してください。

セキュリティ

ユーザー登録

Prosody は XMPP のインバンド登録 標準 に対応しており、ユーザーは XMPP クライアントを使って登録を行ったりパスワードを変更することができます。ユーザーにとっては便利ですが、管理者は新しいユーザーの登録を止めることができません。そのため、デフォルト設定では register モジュールは有効になっていますが allow_registration は false に設定されています。クライアントからユーザーができるのはパスワードを変更することだけで、新しいユーザーを登録することはできなくなっています。

ヒント: インバンド登録を有効にする場合、watchregistrations と welcome モジュールが役に立つでしょう。

ストリームの暗号化

Prosody では TLS 証明書を使ってクライアントからサーバーへの通信を暗号化することができます (依存パッケージのインストールが必要です)。prosody.cfg.lua の該当セクションを参照して証明書を使うように Prosody を設定してください。

以下を設定ファイルに追加することでクライアントからサーバーへの通信の暗号化を必須にできます:

/etc/prosody/prosody.cfg.lua

Host "*"

    c2s_require_encryption = true

同じように、サーバーからサーバーへの通信を暗号化するには:

/etc/prosody/prosody.cfg.lua

Host "*"

    s2s_require_encryption = true

クライアントからサーバーへの暗号化を必須にすることは問題ありませんが、サーバーからサーバーへの暗号化は Google Talk/Gmail など人気の XMPP サービスが対応していないので注意してください。

ユーザーの表示

登録されているユーザーのリストを確認するには:

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

もしくは mod_listusers.lua モジュールをダウンロードして以下のように使うこともできます:

# prosodyctl mod_listusers

削除

pacman で Prosody をアンインストールしても /etc/prosody と /var/lib/prosody ディレクトリは消えません。Prosody を再インストールすることがないのであれば削除すると良いでしょう。

ヒントとテクニック

コンポーネント

Prosody は XMPP コンポーネントをサポートしており、これによりクライアントに追加サービスを提供します。コンポーネントは、特別な Prosody モジュールによって内部で提供されるか、XEP-0114 で指定されたプロトコルを使用して外部で提供されます。

ノート: コンポーネントは prosody.cfg.lua に定義された VirtualHost 名とは異なるホスト名を使用する必要があります。定義された VirtualHost と同じホスト名でコンポーネントをホストしようとすると、エラーが発生します。

デフォルトでは、Prosody は外部コンポーネントを待ち受けます。Prosody で外部コンポーネントを使用する予定がない場合は、次の設定を追加することでこの動作を無効にできます：

/etc/prosody/prosody.cfg.lua

component_ports = {}

マルチユーザーチャット

XMPP サーバーで一般的に使用されるコンポーネントの一つに Multi-User Chat (MUC) があります。これは複数のユーザー間での会議を可能にします。MUC は Prosody の内部コンポーネントとして提供されています。MUC を有効にするには、次の設定を構成ファイルに追加します：

/etc/prosody/prosody.cfg.lua

Component "conference.example.com" "muc"

これにより、ホスト conference.example.com で MUC コンポーネントが有効になります。

Prosody モジュール

Prosody Modules は、Prosody に同梱されていない追加モジュールのコレクションです。これらのモジュールは、高度に実験的なものから比較的安定したものまでさまざまな開発段階にあります。各モジュールの詳細については、そのモジュールの wiki ページを参照してください。追加モジュールの一例として pastebin があり、これを読み込むと長いメッセージ（例えば、ログファイルの出力）をインターセプトし、Prosody の内部 HTTP サーバー（コアモジュール httpserver によって提供）を使用してホストされた pastebin へのリンクに置き換えます。

追加モジュールを使用するには、ソースブラウザから生ファイルをダウンロードします（ファイルを表示中に「View raw file」というリンクを探します）。あるいは、おそらくより簡単な方法として、Mercurial を使用してリポジトリ全体をクローンします：

Prosody 0.9+

$ hg clone https://hg.prosody.im/prosody-modules/ prosody-modules

Prosody 0.8

$ hg clone http://0-8.prosody-modules.googlecode.com/hg/ prosody-modules

これで、モジュール（および必要な追加ファイル）を Prosody のモジュールディレクトリ /usr/lib/prosody/modules にコピーできます。モジュールを有効にするには、使用するホストまたはコンポーネントの prosody.cfg.lua 内の modules_enabled リストに追加します。例えば、MUC コンポーネントで pastebin モジュールを使用するには：

/etc/prosody/prosody.cfg.lua

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

ノート: Prosody の規則として、モジュールは mod_foo.lua という名前になりますが、単に modules_enabled リストに foo を追加することで有効化されます。

コンソール

警告: コンソールは認証を必要としないため、マルチユーザーシステム上の任意のユーザーが接続してコンソール上でコマンドを実行できます。したがって、マルチユーザーシステムで console モジュールを有効にすることは推奨されません。

console モジュールは、管理操作やクエリを実行できる telnet コンソールを提供します。コンソールに接続するには、以下のコマンドを実行します：

$ telnet localhost 5582

もちろん、inetutils パッケージで提供される telnet プログラムが必要です。コンソールで help コマンドを使用して使用方法のヘルプを取得できます。

コンソールでは、コマンドの前に > を付けることで Lua コマンドを直接サーバー上で実行することもできます。例えば、クライアント接続が圧縮されているかどうかを確認するには：

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

接続が圧縮されている場合は true、されていない場合は nil が返されます。

トラブルシューティング

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 カンファレンス: prosody@conference.prosody.im
2. メーリングリスト: prosody-users@googlegroups.com, web interface
3. Arch フォーラム (パッケージの問題についてのみ)

開発

Two development packages are maintained for Prosody in the AUR, prosody-devel^{AUR[リンク切れ: アーカイブ: aur-mirror]} 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 (ブログ)
• Issue Tracker
• Prosody Modules (追加モジュール)