A user-friendly IRC bouncer https://soju.im
Find a file
delthas a30cda7406
All checks were successful
builds.sr.ht Job completed
Add support for channel pinned/muted status through METADATA
First, this implements support for the metadata-2 specification
[1].

The METADATA implementation is bouncer-only (namely, it does not
interact with any upstream METADATA).

The implementation is specific in that there are only 2 supported
keys: "soju.im/pinned" and "soju.im/muted". The user cannot set
any other keys. Those keys can only be "0" or "1", representing
a boolean.

This enables downstreams to get/set two flags on each "message
target" (which can be either users or channels): pinned and muted.

- "soju.im/pinned" is "1" when the channel should be pinned in
  the client, e.g. shown at the top of the channel list
- "soju.im/muted" is "1" when the channel should be muted, e.g.
  have its notifications on non-highlights hidden

The actual specific client behavior for the keys is not
defined here. This just enables clients to get/set the flags.

Last, we only properly support channel targets at the moment.
User targets will be added in a later patch.

[1]: https://github.com/ircv3/ircv3-specifications/blob/master/extensions/metadata.md
2024-12-12 16:46:57 +01:00
auth Enable using both a plain & an oauth auth backend at once 2024-10-17 15:39:51 +00:00
cmd cmd/soju: close HTTP servers on shutdown 2024-12-12 11:50:35 +01:00
config config: bail out if a source is given when a driver doesn't need it 2024-12-02 11:02:02 +01:00
contrib contrib/znc-import: recommend using sojudb for changing user passwords 2024-07-31 20:08:41 +02:00
database Add support for channel pinned/muted status through METADATA 2024-12-12 16:46:57 +01:00
doc doc/file-uploads: new article 2024-12-06 15:04:23 +01:00
fileupload fileupload: Forward HTTP store response on error 2024-11-07 16:05:56 +00:00
identd identd: use UNKNOWN for OS name 2023-02-23 13:27:25 +01:00
msgstore Migrate to Codeberg 2024-07-04 21:28:11 +02:00
xirc Add support for channel pinned/muted status through METADATA 2024-12-12 16:46:57 +01:00
.build.yml Migrate to Codeberg 2024-07-04 21:28:11 +02:00
.editorconfig Add .editorconfig 2020-11-30 11:39:41 +01:00
.gitignore gitignore: add doc/sojuctl.1 2023-04-05 10:56:36 +02:00
certfp.go Split CertFP logic into separate file 2021-10-08 09:47:25 +02:00
config.in Listen on the default unix admin endpoint in the default configuration 2023-02-06 15:15:09 +01:00
conn.go Support soju.im/SAFERATE ISUPPORT 2024-10-10 17:44:30 +02:00
downstream.go Add support for channel pinned/muted status through METADATA 2024-12-12 16:46:57 +01:00
go.mod Upgrade dependencies 2024-11-22 19:13:16 +01:00
go.sum Upgrade dependencies 2024-11-22 19:13:16 +01:00
irc.go Migrate to Codeberg 2024-07-04 21:28:11 +02:00
irc_test.go Ignore highlights in URLs 2024-03-01 11:33:01 +01:00
LICENSE Switch license to AGPLv3 2020-02-07 17:41:51 +01:00
Makefile Migrate to Codeberg 2024-07-04 21:28:11 +02:00
rate.go Add exponential backoff when re-connecting to upstream 2021-12-02 12:14:35 +01:00
README.md Migrate to Codeberg 2024-07-04 21:28:11 +02:00
server.go service: add server debug 2024-11-22 18:40:06 +01:00
server_test.go service: add server debug 2024-11-22 18:40:06 +01:00
service.go service: add server debug 2024-11-22 18:40:06 +01:00
service_test.go Hand-made word splitter for BouncerServ 2021-06-24 19:33:46 +02:00
upstream.go upstream: don't send push notifications for TAGMSG 2024-12-12 11:18:52 +01:00
user.go Fix attempting to store last message ID with no backlog clients 2024-11-10 15:24:04 +01:00

soju

soju is a user-friendly IRC bouncer. soju connects to upstream IRC servers on behalf of the user to provide extra functionality. soju supports many features such as multiple users, numerous IRCv3 extensions, chat history playback and detached channels. It is well-suited for both small and large deployments.

Usage

Building and installing

Dependencies:

  • Go
  • BSD or GNU make
  • a C89 compiler (optional, for SQLite)
  • scdoc (optional, for man pages)

For end users, a Makefile is provided:

make
sudo make install

For development, you can use go run ./cmd/soju as usual.

To link with the system libsqlite3, set GOFLAGS="-tags=libsqlite3". To disable SQLite support, set GOFLAGS="-tags=nosqlite". To use an alternative SQLite library that does not require CGO, set GOFLAGS="-tags=moderncsqlite". To build with PAM authentication support, set GOFLAGS="-tags=pam".

Contributing

Send patches on Codeberg or on GitHub, report bugs on the issue tracker. Discuss in #soju on Libera Chat.

License

AGPLv3, see LICENSE.

Copyright (C) 2020 The soju Contributors