Experimental IRC client, daemon and bot
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.adoc 4.7KB

5 years ago
4 years ago
4 years ago
5 years ago
4 years ago
4 years ago
5 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. uirc3
  2. =====
  3. :compact-option:
  4. The unethical IRC trinity. This project consists of an experimental IRC client,
  5. daemon, and bot. It's all you're ever going to need for chatting.
  6. All of them have these potentially interesting properties:
  7. - full IPv6 support
  8. - TLS support, including client certificates
  9. - minimal dependencies
  10. - very compact and easy to hack on
  11. - permissive license
  12. degesch
  13. -------
  14. The IRC client. It is largely defined by being built on top of GNU Readline.
  15. Its interface should however feel familiar for weechat or irssi users.
  16. This is the youngest and largest application within the project. It has most of
  17. the stuff you'd expect of an IRC client, such as being able to set up multiple
  18. servers, powerful configuration system, integrated help, mIRC text formatting,
  19. CTCP queries, automatic splitting of overlong messages, autocomplete, logging
  20. to file, and command aliases.
  21. kike
  22. ----
  23. The IRC daemon. It is designed to be used as a regular user application rather
  24. than a system-wide daemon. If all you want is a decent, minimal IRCd for
  25. a small network of respectful users (or bots), or testing, this one will do it.
  26. Notable features:
  27. - TLS autodetection (why doesn't everyone have this?)
  28. - IRCop authentication through TLS client certificates
  29. - epoll/kqueue support; it should be able to handle quite a number of users
  30. - partial IRCv3 support
  31. Not supported:
  32. - server linking (which also means no services); I consider existing protocols
  33. for this purpose ugly and tricky to implement correctly
  34. - online changes to configuration; the config system from degesch could be used
  35. - limits of almost any kind, just connections and mode `+l`
  36. ZyklonB
  37. -------
  38. The IRC bot. It builds upon the concept of my other VitaminA IRC bot. The main
  39. characteristic of these two bots is that they run plugins as coprocesses, which
  40. allows for enhanced reliability and programming language freedom.
  41. While originally intended to be a simple C99 rewrite of the original bot, which
  42. was written in the GNU dialect of AWK, it fairly quickly became a playground
  43. where I added everything that seemed nice, and it eventually got me into writing
  44. the rest of this package.
  45. Notable features:
  46. - resilient against crashes, server disconnects and timeouts
  47. - SOCKS support (even though socksify can add that easily to any program)
  48. Building
  49. --------
  50. Build dependencies: CMake, pkg-config, help2man, awk, sh, liberty (included) +
  51. Runtime dependencies: openssl, curses (degesch),
  52. readline or libedit >= 2013-07-12 (degesch)
  53. $ git clone --recursive https://github.com/pjanouch/uirc3.git
  54. $ mkdir uirc3/build
  55. $ cd uirc3/build
  56. $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug \
  57. -DWANT_READLINE=ON -DWANT_LIBEDIT=OFF
  58. $ make
  59. To install the application, you can do either the usual:
  60. # make install
  61. Or you can try telling CMake to make a package for you. For Debian it is:
  62. $ cpack -G DEB
  63. # dpkg -i uirc3-*.deb
  64. Note that for versions of CMake before 2.8.9, you need to prefix `cpack` with
  65. `fakeroot` or file ownership will end up wrong.
  66. Running
  67. -------
  68. 'degesch' has in-program configuration. Just run it and read the instructions.
  69. For the rest you might want to generate a configuration file:
  70. $ zyklonb --write-default-config
  71. $ kike --write-default-config
  72. After making any necessary edits to the file (there are comments to aid you in
  73. doing that), simply run the appropriate program with no arguments:
  74. $ zyklonb
  75. $ kike
  76. 'ZyklonB' stays running in the foreground, therefore I recommend launching it
  77. inside a Screen or tmux session.
  78. 'kike', on the other hand, immediately forks into the background. Use the PID
  79. file or something like `killall` if you want to terminate it. You can run it
  80. as a `forking` type systemd user service.
  81. Client Certificates
  82. -------------------
  83. 'kike' uses SHA1 fingerprints of TLS client certificates to authenticate users.
  84. To get the fingerprint from a certificate file in the required form, use:
  85. $ openssl x509 -in public.pem -outform DER | sha1sum
  86. Contributing and Support
  87. ------------------------
  88. Use this project's GitHub to report any bugs, request features, or submit pull
  89. requests. If you want to discuss this project, or maybe just hang out with
  90. the developer, feel free to join me at irc://anathema.irc.so, channel #anathema.
  91. Disclaimer
  92. ----------
  93. I am not an antisemitist, I'm just being an offensive asshole with the naming.
  94. And no, I'm not going to change the names.
  95. License
  96. -------
  97. 'uirc3' is written by Přemysl Janouch <p.janouch@gmail.com>.
  98. You may use the software under the terms of the ISC license, the text of which
  99. is included within the package, or, at your option, you may relicense the work
  100. under the MIT or the Modified BSD License, as listed at the following site:
  101. http://www.gnu.org/licenses/license-list.html