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