From 53e876eba501a87b2fd51dd049dc8550ced8db48 Mon Sep 17 00:00:00 2001 From: Simon Ser Date: Sat, 22 May 2021 00:01:06 +0200 Subject: [PATCH] readme: move quickstart to dedicated doc page --- README.md | 56 +++--------------------------------------- doc/getting-started.md | 52 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+), 52 deletions(-) create mode 100644 doc/getting-started.md diff --git a/README.md b/README.md index 6698adc..43232ab 100644 --- a/README.md +++ b/README.md @@ -12,58 +12,8 @@ A user-friendly IRC bouncer. ## Usage -See the man page for more information. - -### Server side - -To create an admin user and start soju, run these commands: - - sojuctl create-user -admin - soju -listen irc+insecure://127.0.0.1:6667 - -If you're migrating from ZNC, a tool is available to import users, networks and -channels from a ZNC config file: - - go run ./contrib/znc-import.go - -### Client side - -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: `/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 +* [Getting started] +* [Man page] ## Building and installing @@ -86,6 +36,8 @@ AGPLv3, see LICENSE. Copyright (C) 2020 The soju Contributors [soju]: https://soju.im +[Getting started]: doc/getting-started.md +[Man page]: doc/soju.1.scd [mailing list]: https://lists.sr.ht/~emersion/soju-dev [GitHub]: https://github.com/emersion/soju [issue tracker]: https://todo.sr.ht/~emersion/soju diff --git a/doc/getting-started.md b/doc/getting-started.md new file mode 100644 index 0000000..897b62b --- /dev/null +++ b/doc/getting-started.md @@ -0,0 +1,52 @@ +# Getting started + +## Server side + +To create an admin user and start soju, run these commands: + + sojuctl create-user -admin + soju -listen irc+insecure://127.0.0.1:6667 + +If you're migrating from ZNC, a tool is available to import users, networks and +channels from a ZNC config file: + + go run ./contrib/znc-import.go + +## Client side + +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: `/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