source: code/trunk/README.md@ 320

Last change on this file since 320 was 317, checked in by contact, 5 years ago

Allow multiple listeners, default to ircs

Users can now specify multiple "listen" directives in their
configuration file. If -listen is specified on the CLI, it's added to
the list of listeners.

Listeners are now parsed as URLs. If the scheme is missing "ircs" is
assumed. URLs allow to enable/disable TLS on a per-listener basis and
will be used for Unix sockets too.

The default listening address is changed from irc+insecure://:6667 to
ircs://:6697. This avoids setting up an insecure listener opened to
everybody.

File size: 966 bytes
Line 
1# soju
2
3[![builds.sr.ht status](https://builds.sr.ht/~emersion/soju/.build.yml.svg)](https://builds.sr.ht/~emersion/soju/.build.yml?)
4
5A user-friendly IRC bouncer.
6
7- Multi-user
8- Support multiple clients for a single user, with proper backlog
9 synchronization
10- Support connecting to multiple upstream servers via a single IRC connection
11 to the bouncer
12
13## Usage
14
15 go run ./cmd/sojuctl create-user <username>
16 go run ./cmd/soju -listen irc+insecure://127.0.0.1:6667
17
18Then connect with username `<username>/chat.freenode.net` and join `#soju`.
19
20See the man page at `doc/soju.1.scd` for more information.
21
22## Contributing
23
24Send patches on the [mailing list] or on [GitHub], report bugs on the
25[issue tracker]. Discuss in #soju on Freenode.
26
27## License
28
29AGPLv3, see LICENSE.
30
31Copyright (C) 2020 Simon Ser
32
33[mailing list]: https://lists.sr.ht/~emersion/public-inbox
34[GitHub]: https://github.com/emersion/soju
35[issue tracker]: https://todo.sr.ht/~emersion/soju
Note: See TracBrowser for help on using the repository browser.