diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guix.texi | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index d59a710e567..0db590aa5f7 100644 --- a/doc/guix.texi +++ b/doc/guix.texi | |||
| @@ -33087,6 +33087,75 @@ strings, see | |||
| 33087 | 33087 | ||
| 33088 | @end deftp | 33088 | @end deftp |
| 33089 | 33089 | ||
| 33090 | @subsubheading Zulip IRC bridge Service | ||
| 33091 | |||
| 33092 | @cindex IRC, bridge to Zulip | ||
| 33093 | @cindex Zulip, bridge to IRC | ||
| 33094 | @url{https://zulip.com/integrations/irc, Zulip IRC integration} is a | ||
| 33095 | Zulip extension to bridge @acronym{IRC, Internet Relay Chat} room to a | ||
| 33096 | stream in the Zulip messaging system. | ||
| 33097 | |||
| 33098 | @defvar zulip-irc-bridge-service-type | ||
| 33099 | This is the service type for the Zulip IRC bridge. Its value is a | ||
| 33100 | @code{zulip-irc-bridge-configuration} configuration instance, which is | ||
| 33101 | documented below. | ||
| 33102 | |||
| 33103 | The following example configures a Zulip integration to bridge an IRC | ||
| 33104 | room to a Zulip stream. | ||
| 33105 | |||
| 33106 | @lisp | ||
| 33107 | (operating-system | ||
| 33108 | |||
| 33109 | ;; @dots{} | ||
| 33110 | |||
| 33111 | (services | ||
| 33112 | (list @dots{} | ||
| 33113 | (service zulip-irc-bridge-service-type | ||
| 33114 | (zulip-irc-bridge-configuration | ||
| 33115 | (irc-server "irc.example.chat") | ||
| 33116 | (channel "#example") | ||
| 33117 | (nick-prefix "irc_mirror") | ||
| 33118 | (stream "test here") | ||
| 33119 | (site "https://example.zulipchat.com") | ||
| 33120 | (user "irc-bot@@example.zulipchat.com") | ||
| 33121 | (api-key "cabba9ecabba9ecabba9ecabba9ecabb")))))) | ||
| 33122 | @end lisp | ||
| 33123 | |||
| 33124 | @end defvar | ||
| 33125 | |||
| 33126 | @c %end of fragment | ||
| 33127 | |||
| 33128 | @deftp {Data Type} zulip-irc-bridge-configuration | ||
| 33129 | Available @code{zulip-irc-bridge-configuration} fields are: | ||
| 33130 | |||
| 33131 | @table @asis | ||
| 33132 | @item @code{irc-mirror} (default: @code{(file-append python-zulip "/share/zulip/integrations/bridge_with_irc/irc-mirror.py")}) (type: file-like) | ||
| 33133 | Path to IRC mirror integration to use for the service. | ||
| 33134 | |||
| 33135 | @item @code{irc-server} (type: string) | ||
| 33136 | The IRC server where to search the room to mirror. | ||
| 33137 | |||
| 33138 | @item @code{channel} (type: string) | ||
| 33139 | The Zulip where to store the topic where IRC will be mirrored. | ||
| 33140 | |||
| 33141 | @item @code{nick-prefix} (type: string) | ||
| 33142 | Bot nickname. | ||
| 33143 | |||
| 33144 | @item @code{stream} (type: string) | ||
| 33145 | The Zulip stream/topic where the mirroring takes place. | ||
| 33146 | |||
| 33147 | @item @code{site} (type: string) | ||
| 33148 | The Zulip server that the IRC bridge integration should operate on. | ||
| 33149 | |||
| 33150 | @item @code{user} (type: string) | ||
| 33151 | The Zulip bot email that the IRC integration service should use. | ||
| 33152 | |||
| 33153 | @item @code{api-key} (type: string) | ||
| 33154 | The API key of the Zulip bot that will send the mirrored messages. | ||
| 33155 | |||
| 33156 | @end table | ||
| 33157 | |||
| 33158 | @end deftp | ||
| 33090 | 33159 | ||
| 33091 | @c %end of fragment | 33160 | @c %end of fragment |
| 33092 | 33161 | ||
