summaryrefslogtreecommitdiff
path: root/doc/en/autogen/user/relay_commands.txt
blob: 4adae3435e7e6097c8200493ffa7fb113231baf3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
[[command_relay_relay]]
[command]*`relay`* relay control::
........................................
/relay  list|listfull|listrelay
        add [ipv4.][ipv6.][ssl.]<protocol.name> <port>
        del [ipv4.][ipv6.][ssl.]<protocol.name>
        raw
        sslcertkey

         list: list relay clients (only active relays)
     listfull: list relay clients (verbose, all relays)
    listrelay: list relays (name and port)
          add: add relay for a protocol + name
          del: remove relay for a protocol + name
         ipv4: force use of IPv4
         ipv6: force use of IPv6
          ssl: enable SSL
protocol.name: protocol and name to relay:
                 - protocol "irc": name is the server to share
                 - protocol "weechat" (name is not used)
         port: port used for relay
          raw: open buffer with raw Relay data
   sslcertkey: set SSL certificate/key using path in option relay.network.ssl_cert_key

Without argument, this command opens buffer with list of relay clients.

Examples:
  irc proxy, for server "freenode":
    /relay add irc.freenode 8000
  irc proxy, for server "freenode", with SSL:
    /relay add ssl.irc.freenode 8001
  weechat protocol:
    /relay add weechat 9000
  weechat protocol with SSL:
    /relay add ssl.weechat 9001
  weechat protocol with SSL, using only IPv4:
    /relay add ipv4.ssl.weechat 9001
  weechat protocol with SSL, using only IPv6:
    /relay add ipv6.ssl.weechat 9001
  weechat protocol with SSL, using IPv4 + IPv6:
    /relay add ipv4.ipv6.ssl.weechat 9001
........................................