IRC Bouncer: Difference between revisions
imported>Sjwhitak (Created page with "= Web configuration = The [https://wiki.znc.in/ZNC IRC bouncer] can easily be configured over the web interface: https://shell.lug.mtu.edu:50000/ == Starting up == Use your browser to connect to https://shell.lug.mtu.edu:50000/ and log in with your <code>shell.lug.mtu.edu</code> username and password. right|thumb|ZNC User settings Click on "Your Settings" to adjust your parameters. You'll default to log in to lug.mtu.edu IRC, but you may w...") |
(Overhaul page now that we use soju) |
||
| Line 1: | Line 1: | ||
= Configuration = |
|||
= Web configuration = |
|||
The [https://wiki.znc.in/ZNC IRC bouncer], since September 2026, has moved from ZNC to soju, meaning there is no longer any web configuration. Configuration can instead be done inside of IRC itself by connecting to the bouncer and then issuing commands to <code>BouncerServ</code> (which can be messaged with <code>/msg BouncerServ [MESSAGE]</code>). See documentation of the commands on the soju manpage [https://soju.im/doc/soju.1.html#IRC_SERVICE here]. |
|||
The [https://wiki.znc.in/ZNC IRC bouncer] can easily be configured over the web interface: https://shell.lug.mtu.edu:50000/ |
|||
== |
== Logging In == |
||
The bouncer runs on <code>shell.lug.mtu.edu:6697</code>, which is the default port for IRC over TLS. We do not support plaintext IRC, '''you''' '''need to use TLS'''. |
|||
Bouncer logins are done through PAM, so your shell account credentials should work for authentication. As for how you log in, that's specific to your client. Check your client's documentation for how to do SASL authentication. |
|||
Use your browser to connect to https://shell.lug.mtu.edu:50000/ and log in with your <code>shell.lug.mtu.edu</code> username and password. |
|||
[[File:ZNC_settings.png|right|thumb|ZNC User settings]] |
|||
Click on "Your Settings" to adjust your parameters. You'll default to log in to lug.mtu.edu IRC, but you may want to change your username or add a different server. |
|||
== Authentication == |
|||
Don't change the username+password sections. It won't change anything. This ZNC bouncer is set up using [https://wiki.znc.in/Cyrusauth PAM] to authenticate through your Linux username and password. I don't actually know what'll happen if you change it. |
|||
== IRC Information == |
== IRC Information == |
||
| Line 20: | Line 13: | ||
{{Note|The other IRC information is not really useful. Just choose an alternative nickname in case someone is trying to impersonate you: register your account to prevent this.}} |
{{Note|The other IRC information is not really useful. Just choose an alternative nickname in case someone is trying to impersonate you: register your account to prevent this.}} |
||
== Networks == |
== Networks == |
||
You can add networks with <code>/msg BouncerServ network create -addr [address] -name [network name]</code>. Note that there are more options than this that can be see with <code>/msg BouncerServ help network create</code>. This will be important if, for example, you needed to log in to an external network with a password (Libera Chat does this!). |
|||
You will default with <code>lug.mtu.edu</code> as a connected IRC with the username <code>changeyourname</code>. |
|||
You can add more networks if you want, but I'd be wary since MTULUG is running this bouncer, so they can see all your logs. |
|||
| ⚫ | |||
You can click on each module to read what each of them do, but I recommend making sure the [https://wiki.znc.in/Log log module] is enabled (else there's really no point to the bouncer). |
|||
If you want personal logging, you'll need to a command on the shell server. Inside the server, type: |
|||
{{UserCmd|sudo setup-znc-logging}} |
|||
This will make a directory, <code>~/irslogs</code> and all your new logs will be added there. You must keep write access to the <code>_znc</code> group so ZNC can write to the logs. |
|||
= IRC connection = |
|||
I'm going to explain this using [https://hexchat.github.io/ HexChat] since it's the simplest. If you want to use irssi or WeChat, you probably already know what's up, or how to look things up. |
|||
Honestly, mostly just follow [https://wiki.znc.in/HexChat ZNC's HexChat setup], but this is specifically for lug.mtu.edu if there's something off. |
|||
[[File:HexChat_settings.png|right|thumb|HexChat Settings]] |
|||
The traditional way to determine your network through the bouncer is to log in with your name as <code>[name]/[network]</code>. This is not necessary with soju! If your client supports the <code>bouncer-networks</code> IRCv3 extension, you can just log in normally and your client will detect the networks that soju is watching automatically. |
|||
# Open up Network List, <code>Ctrl+S</code>. |
|||
# Click Add (adding a new network, the ZNC bouncer) |
|||
## Set name to whatever you want, I use <code>MTULUG Bouncer</code>. |
|||
## Edit this network: |
|||
### Servers value should be: <code>shell.lug.mtu.edu/50000</code> |
|||
### Check the <code>Connect to this network automatically</code> (if you want to connect to this network automatically...). |
|||
### Check the <code>Use SSL for all the servers on this network</code>. |
|||
### Do not accept invalid SSL certificates and do not use global user information. |
|||
### <code>Nickname</code> here is what you set as the nickname on the ZNC web interface. |
|||
### <code>Second choice</code> here is what you set as the alternative nickname on the ZNC web interface. |
|||
### <code>Username</code> is your shell username + /MTULUG or whatever Network Name on the ZNC web interface you chose. |
|||
#### Example: <code>sjwhitak-adm/MTULUG</code> will auto-log in to the <code>MTULUG</code> server on the ZNC bouncer. |
|||
#### Example: <code>sjwhitak-adm/LiberaChat</code> will auto-log in to the <code>LiberaChat</code> server on the ZNC bouncer. |
|||
### <code>Login method</code> set to <code>Server password (/PASS password)</code> |
|||
### <code>Password</code> here you type in your shell.lug.mtu.edu password. |
|||
# Close the configuration, then highlight this network and click <code>Connect</code>. |
|||
| ⚫ | |||
Suppose you have multiple networks, you'll need multiple connections to the ZNC. So, set this all up again but the <code>Username</code> parameter should have the <code><username>/MTULUG</code> value changed to <code><username>/<server></code> where <code><server></code> is the name that you chose in the ZNC Networks list. |
|||
Channels should be added automatically upon joining them through the bouncer. They can also be added manually through <code>/msg BouncerServ channel create [channel]/[network]</code>. These are the channels that the bouncer will actively watch and log messages from. |
|||
Revision as of 23:22, 4 September 2026
Configuration
The IRC bouncer, since September 2026, has moved from ZNC to soju, meaning there is no longer any web configuration. Configuration can instead be done inside of IRC itself by connecting to the bouncer and then issuing commands to BouncerServ (which can be messaged with /msg BouncerServ [MESSAGE]). See documentation of the commands on the soju manpage here.
Logging In
The bouncer runs on shell.lug.mtu.edu:6697, which is the default port for IRC over TLS. We do not support plaintext IRC, you need to use TLS.
Bouncer logins are done through PAM, so your shell account credentials should work for authentication. As for how you log in, that's specific to your client. Check your client's documentation for how to do SASL authentication.
IRC Information
Nickname is the username that will be on IRC. This is not what you log in to, but this is what others will see.
The other IRC information is not really useful. Just choose an alternative nickname in case someone is trying to impersonate you: register your account to prevent this.
Networks
You can add networks with /msg BouncerServ network create -addr [address] -name [network name]. Note that there are more options than this that can be see with /msg BouncerServ help network create. This will be important if, for example, you needed to log in to an external network with a password (Libera Chat does this!).
The traditional way to determine your network through the bouncer is to log in with your name as [name]/[network]. This is not necessary with soju! If your client supports the bouncer-networks IRCv3 extension, you can just log in normally and your client will detect the networks that soju is watching automatically.
Channels
Channels should be added automatically upon joining them through the bouncer. They can also be added manually through /msg BouncerServ channel create [channel]/[network]. These are the channels that the bouncer will actively watch and log messages from.