|
All checks were successful
builds.sr.ht Job completed
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 |
||
|---|---|---|
| auth | ||
| cmd | ||
| config | ||
| contrib | ||
| database | ||
| doc | ||
| fileupload | ||
| identd | ||
| msgstore | ||
| xirc | ||
| .build.yml | ||
| .editorconfig | ||
| .gitignore | ||
| certfp.go | ||
| config.in | ||
| conn.go | ||
| downstream.go | ||
| go.mod | ||
| go.sum | ||
| irc.go | ||
| irc_test.go | ||
| LICENSE | ||
| Makefile | ||
| rate.go | ||
| README.md | ||
| server.go | ||
| server_test.go | ||
| service.go | ||
| service_test.go | ||
| upstream.go | ||
| user.go | ||
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