Linux command
matrirc 命令
文本
复制后可按需替换文件名、目录或参数。
常用示例
Run the server
matrirc --allow-register
Run the server
matrirc
Configure
matrirc --media-dir [path/to/media]
Set the URL prefix
matrirc --media-url [https://media.example.com/]
说明
matrirc is a small, single-binary IRC gateway that lets a standard IRC client connect to a Matrix homeserver. Unlike a server-side application service such as matrix-appservice-irc, matrirc runs locally in front of the user's IRC client and translates between the two protocols. It supports Matrix end-to-end encryption (Olm/Megolm) and cross-signing device verification, so encrypted rooms remain readable. On first launch with --allow-register, the server prompts for Matrix login credentials when an IRC client connects with a chosen nick and password. After successful login the nick/password pair is bound to the Matrix session, and subsequent reconnections restore the session without going through registration again. Encrypted media attachments can be decrypted and exposed to the IRC client through a local directory served behind a configurable URL prefix. The project is written in Rust and aimed at users who prefer the IRC client experience but participate in Matrix rooms.
参数
- --allow-register
- Allow new IRC clients to bind a Matrix account on first connection. Once a nick/password is bound, restart without this flag for normal operation.
- --media-dir _path_
- Local directory where encrypted Matrix media is decrypted and stored when downloaded for IRC clients.
- --media-url _url_
- URL prefix substituted into messages so IRC clients receive a clickable link to media saved in --media-dir.
FAQ
What is the matrirc command used for?
matrirc is a small, single-binary IRC gateway that lets a standard IRC client connect to a Matrix homeserver. Unlike a server-side application service such as matrix-appservice-irc, matrirc runs locally in front of the user's IRC client and translates between the two protocols. It supports Matrix end-to-end encryption (Olm/Megolm) and cross-signing device verification, so encrypted rooms remain readable. On first launch with --allow-register, the server prompts for Matrix login credentials when an IRC client connects with a chosen nick and password. After successful login the nick/password pair is bound to the Matrix session, and subsequent reconnections restore the session without going through registration again. Encrypted media attachments can be decrypted and exposed to the IRC client through a local directory served behind a configurable URL prefix. The project is written in Rust and aimed at users who prefer the IRC client experience but participate in Matrix rooms.
How do I run a basic matrirc example?
Run `matrirc --allow-register` in a terminal, then adjust file names, paths, flags, or remote targets for your system.
What does --allow-register do in matrirc?
Allow new IRC clients to bind a Matrix account on first connection. Once a nick/password is bound, restart without this flag for normal operation.