soju forked to be LESS SHIT
Go to file
Kalyan Sriram 586c7ee336
sojuctl: change-password: check if user exists
When changing the password, checks if the user exists *before* prompting
for a password change, instead of after.
2020-11-26 19:27:08 +01:00
cmd sojuctl: change-password: check if user exists 2020-11-26 19:27:08 +01:00
config Don't accept any IP as a proxy by default 2020-10-25 18:22:12 +01:00
contrib Switch DB API to user IDs 2020-10-24 15:14:23 +02:00
doc Don't accept any IP as a proxy by default 2020-10-25 18:22:12 +01:00
.build.yml ci: check scdoc is happy 2020-06-10 16:15:20 +02:00
.gitignore doc: document "network delete" 2020-04-01 17:38:09 +02:00
bridge.go Forward RPL_TOPICWHOTIME to downstreams 2020-08-20 11:12:54 +02:00
conn.go Make sure that WebSocket messages are valid UTF-8 2020-09-02 17:09:32 +02:00
db.go Switch to sql.NullString 2020-10-24 15:47:53 +02:00
downstream.go Uphold echo-message even with BouncerServ 2020-11-24 14:25:19 +01:00
go.mod Upgrade dependencies 2020-10-25 18:15:54 +01:00
go.sum Upgrade dependencies 2020-10-25 18:15:54 +01:00
ident.go ident: remove leftover debug log 2020-08-18 17:57:12 +02:00
irc.go Format CTCP ACTION messages in logs 2020-08-17 15:01:53 +02:00
LICENSE Switch license to AGPLv3 2020-02-07 17:41:51 +01:00
Makefile Move man page to doc/ 2020-03-27 19:23:41 +01:00
msgstore.go Add message store abstraction 2020-10-25 17:47:38 +01:00
README.md readme: update mailing list link 2020-07-24 09:49:54 +02:00
server.go Nuke in-memory ring buffer 2020-08-20 20:05:01 +02:00
service.go Switch DB API to user IDs 2020-10-24 15:14:23 +02:00
upstream.go Implement delivery receipts via PING messages 2020-11-24 14:13:24 +01:00
user.go Add message store abstraction 2020-10-25 17:47:38 +01:00

soju

builds.sr.ht status

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