Soju

This article is a stub. Please help out by expanding it - how to get started.

Resources

Home

Official documentation

soju is a user-friendly IRC bouncer:

soju connects to upstream IRC servers on behalf of the user to provide extra functionality. soju supports many features such as multiple users, numerous IRCv3 extensions, chat history playback and detached channels.

Installation

USE flags

USE flags for net-irc/soju soju is a user-friendly IRC bouncer

`+sqlite`	Add support for sqlite - embedded sql database
`moderncsqlite`	Use moderncsqlite, a cgo-free port of SQLite
`pam`	Add support for PAM (Pluggable Authentication Modules) - DANGEROUS to arbitrarily flip

Data provided by the Gentoo Package Database · Last update: 2024-10-30 15:10 More information about USE flags

Emerge

root #emerge --ask net-irc/soju

Configuration

An example configuration file is provided below; refer to the soju(1) man page for a detailed list of configuration options.

FILE /etc/soju/configExample configuration

db sqlite3 /var/lib/soju/main.db
message-store fs /var/lib/soju/logs/
listen irc+insecure://192.168.0.1:6667

Service

OpenRC

To start the soju OpenRC service:

root #rc-service soju start

To start the soju service on system boot, add it to the default runlevel:

root #rc-update add soju default

systemd

To start the soju systemd service:

root #systemctl start soju.service

To start the soju systemd service at boot, enable it:

root #systemctl enable soju.service

Adding networks

Once the soju service is running, connect to it via an IRC client, and send a "help" message to the BouncerServ service to get a list of available commands:

/msg BouncerServ help

The BouncerServ channel can be used to ask for help on specific commands:

<user> help network create
<BouncerServ> network create -addr <addr> [-name name] [-username username]
              [-pass pass] [-realname realname] [-certfp fingerprint] [-nick
              nick] [-auto-away auto-away] [-enabled enabled]
              [-connect-command command]...: add a new network

and to run those commands.

For example, to add the Libera.chat network:

<user> network create -addr ircs://irc.libera.chat -name libera -nick <nick> -enabled true -connect-command "PRIVMSG NickServ :IDENTIFY <nick-password>" -connect-command "PRIVMSG NickServ :RELEASE <nick>" -connect-command "PRIVMSG NickServ :REGAIN <nick>"

Note that the -name and -username options are for server access, not nick management; however, the default value for -nick is the value of -username.

External resources

soju(1) man page
soju client list – Instructions for setting up various IRC clients to connect to soju

References