readme: move quickstart to dedicated doc page
This commit is contained in:
parent
3b41c87a41
commit
53e876eba5
56
README.md
56
README.md
@ -12,58 +12,8 @@ A user-friendly IRC bouncer.
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
See the man page for more information.
|
* [Getting started]
|
||||||
|
* [Man page]
|
||||||
### Server side
|
|
||||||
|
|
||||||
To create an admin user and start soju, run these commands:
|
|
||||||
|
|
||||||
sojuctl create-user <soju username> -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 <znc config file>
|
|
||||||
|
|
||||||
### 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: `<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
|
|
||||||
|
|
||||||
## Building and installing
|
## Building and installing
|
||||||
|
|
||||||
@ -86,6 +36,8 @@ AGPLv3, see LICENSE.
|
|||||||
Copyright (C) 2020 The soju Contributors
|
Copyright (C) 2020 The soju Contributors
|
||||||
|
|
||||||
[soju]: https://soju.im
|
[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
|
[mailing list]: https://lists.sr.ht/~emersion/soju-dev
|
||||||
[GitHub]: https://github.com/emersion/soju
|
[GitHub]: https://github.com/emersion/soju
|
||||||
[issue tracker]: https://todo.sr.ht/~emersion/soju
|
[issue tracker]: https://todo.sr.ht/~emersion/soju
|
||||||
|
52
doc/getting-started.md
Normal file
52
doc/getting-started.md
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
# Getting started
|
||||||
|
|
||||||
|
## Server side
|
||||||
|
|
||||||
|
To create an admin user and start soju, run these commands:
|
||||||
|
|
||||||
|
sojuctl create-user <soju username> -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 <znc config file>
|
||||||
|
|
||||||
|
## 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: `<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
|
Loading…
Reference in New Issue
Block a user