Changeset 366 in code for trunk/README.md

Timestamp:

Jul 22, 2020, 11:06:03 AM (5 years ago)

Author:

nomeji

Message:

readme: expand usage

File:

• trunk/README.md (modified) (1 diff)

trunk/README.md

@@ -13 +13 @@
 ## Usage
 
-    go run ./cmd/sojuctl create-user <username> -admin
+See the man page at `doc/soju.1.scd` for more information.
+
+### Server side
+
+To create an admin user and start soju, run these commands:
+
+    go run ./cmd/sojuctl create-user <soju username> -admin
     go run ./cmd/soju -listen irc+insecure://127.0.0.1:6667
 
-Then connect with username `<username>/chat.freenode.net` and join `#soju`.
+### Client side
 
-See the man page at `doc/soju.1.scd` for more information.
+soju can operate in two different modes: multi upstream and single upstream.
+
+#### Single upstream mode
+
+In this mode, 1 upstream connection to a irc server = 1 connection to your soju
+bouncer.
+
+The easiest and fastest way to use this is to specify the address of the server
+in your username in your client configuration. For example to connect to
+Freenode, your username will be: `<soju username>/chat.freenode.net`. Also set
+your soju password in the password field of your client configuration.
+
+This will autoconfigure soju by adding a network with the address
+`chat.freenode.net` and then autoconnect to it. You will now be able to join
+any channel like you would normally do.
+
+#### Multi upstream mode
+
+In this mode, a single connection to your soju bouncer can handle multiple
+upstream connections. You will need to manually configure each upstream
+connection using the the special `BouncerServ` user.
+
+Connect to your soju server by specifying your soju username in the username
+field in your client and your password in the password field.
+
+You should now be able to send private messages to the `BouncerServ`. You can
+send it commands to configure soju. Create new networks:
+
+    /msg BouncerServ network create -addr chat.freenode.net -name freenode
+    /msg BouncerServ network create -addr irc.rizon.net -name rizon
+
+You will now be able to join channels on these networks by specifying their
+name:
+
+    /join #soju/freenode
+    /join #somechannel/rizon
+
+#### Notes
+
+soju will automatically save and restore the channels you were connected to.
 
 ## Contributing