Prosodyのソースを表示

[[Category:XMPP]]
[[de:Prosody]]
[[en:Prosody]]
[https://prosody.im/ 公式ウェブサイト] より:

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

==インストール==

{{Pkg|prosody}} パッケージを[[インストール]]してください。

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

; TLS/SSL サポート (推奨)
: 盗聴されないように Prosody でストリームを暗号化できるようになります。<br>''必要パッケージ:'' {{Pkg|lua52-sec}}

; MySQL/Postgresql バックエンド
: MySQL/mariadb/Postgresql バックエンドを Prosody で使えるようになり拡張性やパフォーマンスが上がります。<br>''必要パッケージ:'' {{Pkg|lua52-dbi}}
{{Warning|
* {{Pkg|lua51-dbi}} は上流からは外されています。{{Bug|53081}} を参照してください。
* 有効にすると Prosody はデフォルトでデータベースに平文でパスワードを保存します。[https://prosody.im/doc/modules/mod_auth_internal_hashed mod_auth_internal_hashed] などのハッシュ化認証モジュールを使うことを推奨します。}}

; 接続スケーリングの向上 (推奨)
: [http://www.monkey.org/~provos/libevent/ libevent] を使うことで大量の同時接続を処理できるようになります。<br>''必要パッケージ:'' {{AUR|lua52-event}}
{{Note|luaevent を有効にすると全ての s2s 機能が破壊されるバグが存在しましたが、v0.10 で修正されました [https://prosody.im/issues/issue/555]。}}

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

==設定==

{{Note|The {{Ic|posix}} module and {{Ic|pidfile}} setting contained in the default configuration file are required for Prosody's proper operation.}}

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

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

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

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

==制御==
	
systemd サービスの {{ic|prosody.service}} を[[起動]]・[[有効化]]してください。

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

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

 # prosodyctl adduser ''<JID>''

{{Tip|You will likely want to make at least one user an administrator by adding their Jabber ID to the {{Ic|admins}} list in the configuration file.}}

詳しくは {{man|1|prosodyctl}} を参照してください。

===セキュリティ===
====ユーザー登録====
Prosody は XMPP のインバンド登録 [http://xmpp.org/extensions/xep-0077.html 標準] に対応しており、ユーザーは XMPP クライアントを使って登録を行ったりパスワードを変更することができます。ユーザーにとっては便利ですが、管理者は新しいユーザーの登録を止めることができません。そのため、デフォルト設定では {{Ic|register}} モジュールは有効になっていますが {{Ic|allow_registration}} は {{Ic|false}} に設定されています。クライアントからユーザーができるのはパスワードを変更することだけで、新しいユーザーを登録することはできなくなっています。

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

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

以下を設定ファイルに追加することでクライアントからサーバーへの通信の暗号化を必須にできます:
{{hc|/etc/prosody/prosody.cfg.lua|2=
Host "*"

    c2s_require_encryption = true
}}

同じように、サーバーからサーバーへの通信を暗号化するには:
{{hc|/etc/prosody/prosody.cfg.lua|2=
Host "*"

    s2s_require_encryption = true
}}

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

===ユーザーの表示===
登録されているユーザーのリストを確認するには:
 # ls -l /var/lib/prosody/*/accounts/*

もしくは [https://prosody.im/files/mod_listusers.lua mod_listusers.lua] モジュールをダウンロードして以下のように使うこともできます:
 # prosodyctl mod_listusers

==削除==

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

==ヒントとテクニック==
===コンポーネント===

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

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

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

{{hc|/etc/prosody/prosody.cfg.lua|2=
component_ports = {}
}}

====マルチユーザーチャット====

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:

{{hc|/etc/prosody/prosody.cfg.lua|
Component "conference.example.com" "muc"
}}

This will enable the MUC component on host {{Ic|conference.example.com}}.

===Prosody モジュール===
[https://prosody.im/community_modules 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 {{Ic|[https://code.google.com/p/prosody-modules/wiki/mod_pastebin 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, {{Ic|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:

;Prosody 0.9+
{{Ic|$ hg clone <nowiki>https://hg.prosody.im/prosody-modules/ prosody-modules</nowiki>}}

;Prosody 0.8
{{Ic|$ hg clone <nowiki>http://0-8.prosody-modules.googlecode.com/hg/ prosody-modules</nowiki>}}

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

{{hc|/etc/prosody/prosody.cfg.lua|2=
Component "conference.example.com" "muc"
    modules_enabled = { "pastebin" }
}}

{{Note|An enforced Prosody convention is that modules are named {{Ic|mod_''foo''.lua}} but simply enabled by adding {{Ic|''foo''}} to the {{Ic|modules_enabled}} list.}}

===コンソール===
{{Warning|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 {{Ic|console}} module on a multi-user system.}}

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

{{Ic|$ telnet localhost 5582}}

You of course need the {{Ic|telnet}} program provided by the {{Ic|inetutils}} package. Use the {{Ic|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 {{Ic|>}}. For example to see if a client connection is compressed:

{{Ic|> full_sessions["romeo@montague.lit/Resource"].compressed}}

Will return {{Ic|true}} if the connection is compressed or {{Ic|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'''<br>Look at the [https://prosody.im/doc/release release notes] for your Prosody version to see if your issue is listed as a known issue. Also check the [https://prosody.im/issues/list issue tracker] to see if your issue has already been reported.
* '''Check configuration syntax'''<br>Run {{Ic|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'''<br>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'''<br>The Prosody package should add a new {{Ic|prosody}} user and group to your system and set appropriate permissions, but it is always good to double check. Ensure that {{ic|/etc/prosody}} and {{ic|/var/lib/prosody}} are owned by the {{Ic|prosody}} user and that the user has appropriate permissions to read and write to those paths and all contained files.
* '''Check listening ports'''<br>When troubleshooting connection issues make sure that Prosody is actually listening for connections. You may do so by running {{Ic|ss -tul}} and making sure that {{Ic|xmpp-client}} (port 5222) and {{Ic|xmpp-server}} (port 5269) are listed.
* '''Restart'''<br>Like most things, it does not hurt to restart Prosody ({{Ic|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:

# XMPP カンファレンス: {{Ic|prosody@conference.prosody.im}}
# メーリングリスト: {{ic|prosody-users@googlegroups.com}}, [https://groups.google.com/forum/#!forum/prosody-users web interface]
# [https://bbs.archlinux.org/viewforum.php?id=4 Arch フォーラム] (パッケージの問題についてのみ)

==開発==

Two development packages are maintained for Prosody in the AUR, {{AUR|prosody-devel}}{{Broken package link|{{aur-mirror|prosody-devel}}}} and {{AUR|prosody-hg}}. {{Ic|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. {{Ic|prosody-hg}} tracks the [http://www.selenic.com/mercurial/wiki/ 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.

==コミュニティ==
* メーリングリスト: [https://groups.google.com/forum/#!forum/prosody-dev prosody-dev], [https://groups.google.com/forum/#!forum/prosody-users prosody-users]
* カンファレンス: {{Ic|prosody@conference.prosody.im}}
* ブログ: [https://blog.prosody.im/ Prosodical Thoughts]

== 参照 ==

* [https://prosody.im/doc 公式ドキュメント]
* [https://blog.prosody.im/ Prosodical Thoughts] (ブログ)
* [https://prosody.im/issues/ Issue Tracker]
* [https://hg.prosody.im/prosody-modules/ Prosody Modules] (追加モジュール)