8f29ae41a2
For now, these can be used as cursors in the logs. Future patches will introduce functions that perform log queries with message IDs. The IDs are state-less tokens containing all the required information to refer to an on-disk log line: network name, entity name, date and byte offset. The byte offset doesn't need to point to the first byte of the line, any byte will do (note, this makes it so message IDs aren't necessarily unique, we may want to change that in the future). These internal message IDs are not exposed to clients because we don't support upstream message IDs yet. |
||
|---|---|---|
| cmd | ||
| config | ||
| contrib | ||
| doc | ||
| .build.yml | ||
| .gitignore | ||
| bridge.go | ||
| conn.go | ||
| db.go | ||
| downstream.go | ||
| go.mod | ||
| go.sum | ||
| ident.go | ||
| irc.go | ||
| LICENSE | ||
| logger.go | ||
| Makefile | ||
| README.md | ||
| ring.go | ||
| server.go | ||
| service.go | ||
| upstream.go | ||
| user.go | ||
soju
A user-friendly IRC bouncer.
- Multi-user
- Support multiple clients for a single user, with proper backlog synchronization
- Support connecting to multiple upstream servers via a single IRC connection to the bouncer
Usage
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
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
Notes
soju will automatically save and restore the channels you were connected to.
Contributing
Send patches on the mailing list or on GitHub, report bugs on the issue tracker. Discuss in #soju on Freenode.
License
AGPLv3, see LICENSE.
Copyright (C) 2020 The soju Contributors