Changeset 522 in code for trunk/README.md


Ignore:
Timestamp:
May 21, 2021, 10:01:06 PM (4 years ago)
Author:
contact
Message:

readme: move quickstart to dedicated doc page

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/README.md

    r504 r522  
    1313## Usage
    1414
    15 See the man page for more information.
    16 
    17 ### Server side
    18 
    19 To create an admin user and start soju, run these commands:
    20 
    21     sojuctl create-user <soju username> -admin
    22     soju -listen irc+insecure://127.0.0.1:6667
    23 
    24 If you're migrating from ZNC, a tool is available to import users, networks and
    25 channels from a ZNC config file:
    26 
    27     go run ./contrib/znc-import.go <znc config file>
    28 
    29 ### Client side
    30 
    31 soju can operate in two different modes: multi upstream and single upstream.
    32 
    33 #### Single upstream mode
    34 
    35 In this mode, 1 upstream connection to a irc server = 1 connection to your soju
    36 bouncer.
    37 
    38 The easiest and fastest way to use this is to specify the address of the server
    39 in your username in your client configuration. For example to connect to
    40 Freenode, your username will be: `<soju username>/chat.freenode.net`. Also set
    41 your soju password in the password field of your client configuration.
    42 
    43 This will autoconfigure soju by adding a network with the address
    44 `chat.freenode.net` and then autoconnect to it. You will now be able to join
    45 any channel like you would normally do.
    46 
    47 #### Multi upstream mode
    48 
    49 In this mode, a single connection to your soju bouncer can handle multiple
    50 upstream connections. You will need to manually configure each upstream
    51 connection using the the special `BouncerServ` user.
    52 
    53 Connect to your soju server by specifying your soju username in the username
    54 field in your client and your password in the password field.
    55 
    56 You should now be able to send private messages to the `BouncerServ`. You can
    57 send it commands to configure soju. Create new networks:
    58 
    59     /msg BouncerServ network create -addr chat.freenode.net -name freenode
    60     /msg BouncerServ network create -addr irc.rizon.net -name rizon
    61 
    62 You will now be able to join channels on these networks by specifying their
    63 name:
    64 
    65     /join #soju/freenode
    66     /join #somechannel/rizon
     15* [Getting started]
     16* [Man page]
    6717
    6818## Building and installing
    … …  
    8737
    8838[soju]: https://soju.im
     39[Getting started]: doc/getting-started.md
     40[Man page]: doc/soju.1.scd
    8941[mailing list]: https://lists.sr.ht/~emersion/soju-dev
    9042[GitHub]: https://github.com/emersion/soju
Note: See TracChangeset for help on using the changeset viewer.