soju-webirc-forward/config.example.ini at main · replicatorbe/soju-webirc-forward · GitHub

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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# soju-webirc-forward example configuration.
#
# This file uses the scfg format (structured configuration) understood by
# upstream Soju. All standard Soju directives are still accepted; the
# blocks below highlight the directives that are specific to this fork.
#
# See the upstream reference at:
#   https://soju.im/doc/soju.1.html
#
# Copy this file to /etc/soju/config (or wherever your deployment stores
# it) and edit it before starting the daemon.

# ---------------------------------------------------------------------------
# Standard Soju directives (unchanged from upstream)
# ---------------------------------------------------------------------------

listen ircs://
listen unix+admin://

hostname irc.example.com
# title "My Bouncer"

tls /etc/ssl/private/example.com.crt /etc/ssl/private/example.com.key

db sqlite3 /var/lib/soju/main.db
message-store fs /var/lib/soju/logs/

# auth internal
# http-origin "https://example.com"
# accept-proxy-ip localhost
# max-user-networks -1
# disable-inactive-user 30d
# enable-user-on-auth false

# ---------------------------------------------------------------------------
# soju-webirc-forward specific directives
# ---------------------------------------------------------------------------

# Password to send with WEBIRC and PASS when connecting to the upstream IRC
# server. When set, every upstream registration forwards the real downstream
# client IP through WEBIRC. When empty (default), no WEBIRC line is sent and
# the network's own configured password is used for PASS instead.
#
# upstream-webirc-password "CHANGE_ME"

# One or more glob patterns (path.Match syntax) matching channel names that
# should never be persisted to the message store. Useful for high-traffic
# service/bot channels. Patterns are compared against the case-mapped
# channel name (usually lower-case).
#
# no-log-channels "#bot-*" "#services" "#logs"

# Auto-create this network for every new user that has none. Leave empty
# (or omit) to disable the auto-provisioning and restore the upstream Soju
# behaviour where the user must add their networks manually.
#
# default-network "ircs://irc.example.com:6697"

# ---------------------------------------------------------------------------
# Optional IRC control bot
# ---------------------------------------------------------------------------
#
# When enabled, soju starts an internal IRC client that joins `channel` on
# the specified server and reacts to BNC events. All fields must be set
# when `enabled true`; when `enabled false` (default) the block is ignored.
#
# control-bot {
#     enabled false
#     server-addr "irc.example.com:6697"
#     use-tls true
#     server-password "CHANGE_ME"
#     webirc-password "CHANGE_ME"
#     webirc-ip "203.0.113.10"
#     nick "ControlBot"
#     username "controlbot"
#     realname "soju control bot"
#     oper-login "CHANGE_ME"
#     oper-password "CHANGE_ME"
#     channel "#services"
#     # admin-hosts "*!*@trusted.example.com" "*!*@ops.example.com"
#
#     # Optional: external HTTP endpoint the control bot calls to authorize
#     # a downstream IP (used by the userConnect flow). Both fields must be
#     # set to enable the feature; otherwise authorizeIPViaAPI is a no-op.
#     # ip-auth-api-url "https://example.com/api/authorize.php"
#     # ip-auth-api-key "CHANGE_ME"
# }