2020-06-10 14:00:50 -07:00
|
|
|
# [soju]
|
2020-02-04 01:50:28 -08:00
|
|
|
|
2022-04-28 05:12:31 -07:00
|
|
|
[](https://builds.sr.ht/~emersion/soju/commits/master?)
|
2020-05-01 12:58:29 -07:00
|
|
|
|
2022-06-27 05:30:28 -07:00
|
|
|
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.
|
2020-02-17 03:19:27 -08:00
|
|
|
|
2020-03-04 09:27:33 -08:00
|
|
|
## Usage
|
|
|
|
|
|
2021-05-21 15:01:06 -07:00
|
|
|
* [Getting started]
|
|
|
|
|
* [Man page]
|
2020-06-12 05:06:15 -07:00
|
|
|
|
2021-04-19 07:35:18 -07:00
|
|
|
## Building and installing
|
2020-06-12 05:06:15 -07:00
|
|
|
|
2021-06-24 12:32:54 -07:00
|
|
|
Dependencies:
|
|
|
|
|
|
|
|
|
|
- Go
|
2022-02-08 07:10:19 -08:00
|
|
|
- BSD or GNU make
|
2022-09-11 04:57:00 -07:00
|
|
|
- a C89 compiler (optional, for SQLite)
|
2021-06-24 12:32:54 -07:00
|
|
|
- scdoc (optional, for man pages)
|
|
|
|
|
|
2021-04-19 07:35:18 -07:00
|
|
|
For end users, a `Makefile` is provided:
|
|
|
|
|
|
|
|
|
|
make
|
|
|
|
|
sudo make install
|
|
|
|
|
|
|
|
|
|
For development, you can use `go run ./cmd/soju` as usual.
|
2020-03-19 06:33:49 -07:00
|
|
|
|
2022-09-11 04:57:00 -07:00
|
|
|
To link with the system libsqlite3, set `GOFLAGS="-tags=libsqlite3"`. To disable
|
2023-02-22 12:12:22 -08:00
|
|
|
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"`.
|
2022-09-26 10:21:06 -07:00
|
|
|
|
2020-02-17 03:19:27 -08:00
|
|
|
## Contributing
|
|
|
|
|
|
2020-03-19 06:33:49 -07:00
|
|
|
Send patches on the [mailing list] or on [GitHub], report bugs on the
|
2021-05-21 15:04:22 -07:00
|
|
|
[issue tracker]. Discuss in [#soju on Libera Chat][IRC channel].
|
2020-02-04 01:50:28 -08:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
2020-02-07 08:41:51 -08:00
|
|
|
AGPLv3, see LICENSE.
|
|
|
|
|
|
2020-06-12 05:37:43 -07:00
|
|
|
Copyright (C) 2020 The soju Contributors
|
2020-02-17 03:19:27 -08:00
|
|
|
|
2020-06-10 14:00:50 -07:00
|
|
|
[soju]: https://soju.im
|
2021-05-21 15:01:06 -07:00
|
|
|
[Getting started]: doc/getting-started.md
|
2021-05-23 12:41:01 -07:00
|
|
|
[Man page]: https://soju.im/doc/soju.1.html
|
2020-07-24 00:49:54 -07:00
|
|
|
[mailing list]: https://lists.sr.ht/~emersion/soju-dev
|
2020-03-19 06:33:49 -07:00
|
|
|
[GitHub]: https://github.com/emersion/soju
|
2020-03-13 10:13:03 -07:00
|
|
|
[issue tracker]: https://todo.sr.ht/~emersion/soju
|
2021-05-21 15:04:22 -07:00
|
|
|
[IRC channel]: ircs://irc.libera.chat/#soju
|
2022-06-27 05:30:28 -07:00
|
|
|
[IRCv3]: https://ircv3.net/
|
