| 1 | # Getting started
|
|---|
| 2 |
|
|---|
| 3 | ## Server side
|
|---|
| 4 |
|
|---|
| 5 | To create an admin user and start soju, run these commands:
|
|---|
| 6 |
|
|---|
| 7 | sojuctl create-user <soju username> -admin
|
|---|
| 8 | soju -listen irc+insecure://127.0.0.1:6667
|
|---|
| 9 |
|
|---|
| 10 | If you're migrating from ZNC, a tool is available to import users, networks and
|
|---|
| 11 | channels from a ZNC config file:
|
|---|
| 12 |
|
|---|
| 13 | go run ./contrib/znc-import.go <znc config file>
|
|---|
| 14 |
|
|---|
| 15 | ## Client side
|
|---|
| 16 |
|
|---|
| 17 | soju can operate in two different modes: multi upstream and single upstream.
|
|---|
| 18 |
|
|---|
| 19 | ### Single upstream mode
|
|---|
| 20 |
|
|---|
| 21 | In this mode, 1 upstream connection to a irc server = 1 connection to your soju
|
|---|
| 22 | bouncer.
|
|---|
| 23 |
|
|---|
| 24 | The easiest and fastest way to use this is to specify the address of the server
|
|---|
| 25 | in your username in your client configuration. For example to connect to
|
|---|
| 26 | Libera Chat, your username will be: `<soju username>/irc.libera.chat`. Also set
|
|---|
| 27 | your soju password in the password field of your client configuration.
|
|---|
| 28 |
|
|---|
| 29 | This will autoconfigure soju by adding a network with the address
|
|---|
| 30 | `irc.libera.chat` and then autoconnect to it. You will now be able to join
|
|---|
| 31 | any channel like you would normally do.
|
|---|
| 32 |
|
|---|
| 33 | ### Multi upstream mode
|
|---|
| 34 |
|
|---|
| 35 | In this mode, a single connection to your soju bouncer can handle multiple
|
|---|
| 36 | upstream connections. You will need to manually configure each upstream
|
|---|
| 37 | connection using the the special `BouncerServ` user.
|
|---|
| 38 |
|
|---|
| 39 | Connect to your soju server by specifying your soju username in the username
|
|---|
| 40 | field in your client and your password in the password field.
|
|---|
| 41 |
|
|---|
| 42 | You should now be able to send private messages to the `BouncerServ`. You can
|
|---|
| 43 | send it commands to configure soju. Create new networks:
|
|---|
| 44 |
|
|---|
| 45 | /msg BouncerServ network create -addr irc.libera.chat -name libera
|
|---|
| 46 | /msg BouncerServ network create -addr irc.rizon.net -name rizon
|
|---|
| 47 |
|
|---|
| 48 | You will now be able to join channels on these networks by specifying their
|
|---|
| 49 | name:
|
|---|
| 50 |
|
|---|
| 51 | /join #soju/libera
|
|---|
| 52 | /join #somechannel/rizon
|
|---|
