arch/soju
1
0
Fork 0
Code Issues Pull requests 1 Actions Packages Projects Releases Wiki Activity
soju/README.md

37 lines
1,011 B
Markdown
Raw Normal View History

readme: add link to website
2020-06-10 22:00:50 +01:00
# [soju]
Add LICENSE and README.md
2020-02-04 09:50:28 +00:00
readme: add CI badge
2020-05-01 20:58:29 +01:00
[![builds.sr.ht status](https://builds.sr.ht/~emersion/soju/.build.yml.svg)](https://builds.sr.ht/~emersion/soju/.build.yml?)
readme: add some high-level goals, add contributing links
2020-02-17 11:19:27 +00: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
readme: add instructions to initialize database
2020-03-04 17:27:33 +00:00
## Usage
sojuctl: Add support for creating admin users This adds a new flag, `-admin` for creating admin users, which can access admin service commands, among which create-user to create other users on-the-fly. Since the person running the commands in the README will be the local soju administrator, the user they create should be admin as well, hence the README update.
2020-06-07 00:32:50 +01:00
go run ./cmd/sojuctl create-user <username> -admin
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.
2020-06-04 19:10:17 +01:00
go run ./cmd/soju -listen irc+insecure://127.0.0.1:6667
readme: add instructions to initialize database
2020-03-04 17:27:33 +00:00
readme: advise connecting with "<username>/<network>" This matches znc's behavior and is more consistent with the multiple-upstream mode (where channels and nicks are suffixed with "/<network>" as well).
2020-03-31 17:41:14 +01:00
Then connect with username `<username>/chat.freenode.net` and join `#soju`.
Auto-save IRC networks
2020-03-12 20:28:09 +00:00
readme: fix ref to manpage
2020-04-16 17:55:21 +01:00
See the man page at `doc/soju.1.scd` for more information.
readme: add ref to man page, add link to GitHub repo
2020-03-19 13:33:49 +00:00
readme: add some high-level goals, add contributing links
2020-02-17 11:19:27 +00:00
## Contributing
readme: add ref to man page, add link to GitHub repo
2020-03-19 13:33:49 +00:00
Send patches on the [mailing list] or on [GitHub], report bugs on the
Fix deadlocks in single-upstream mode
2020-03-20 09:42:17 +00:00
[issue tracker]. Discuss in #soju on Freenode.
Add LICENSE and README.md
2020-02-04 09:50:28 +00:00
## License
Switch license to AGPLv3
2020-02-07 16:41:51 +00:00
AGPLv3, see LICENSE.
readme: extend copyright notice to all contributors soju now has multiple contributors. Even if they weren't explicitly listed as copyright holders, they still retain copyright ownership for their contributions. Make this clear. See [1]. [1]: https://www.linuxfoundation.org/blog/2020/01/copyright-notices-in-open-source-software-projects/
2020-06-12 13:37:43 +01:00
Copyright (C) 2020 The soju Contributors
readme: add some high-level goals, add contributing links
2020-02-17 11:19:27 +00:00
readme: add link to website
2020-06-10 22:00:50 +01:00
[soju]: https://soju.im
readme: add some high-level goals, add contributing links
2020-02-17 11:19:27 +00:00
[mailing list]: https://lists.sr.ht/~emersion/public-inbox
readme: add ref to man page, add link to GitHub repo
2020-03-19 13:33:49 +00:00
[GitHub]: https://github.com/emersion/soju
Rename project to soju
2020-03-13 17:13:03 +00:00
[issue tracker]: https://todo.sr.ht/~emersion/soju
Reference in a new issue Copy permalink