nmdc-ircfrontend/_dist/README.txt

An IRC protocol frontend for an NMDC server.

This program 'wraps' an NMDC server to make it available to IRC clients. It implements the IRC server protocol, but is not itself an IRC server, deferring to the upstream NMDC server in all salient cases. From a layering perspective it occupies the same position as the web interface.

The intent of this project is to expand client library and application support on platforms where the NMDC community has not been able to spend effort (e.g. Apple iOS client, ruby/rust/erlang libraries, greater choice in web interfaces).

TLS (SSL) support is not integrated. To host the IRC frontend over TLS, please use a reverse proxy in much the same manner as for NMDCS.

This program uses some code from the AGPLv3 project https://github.com/eXeC64/Rosella , from which it inherits the Affero GPLv3 license. Anyone hosting a modified version of this software is required to release their changes under the terms of the AGPLv3.

Written in golang

Tags: nmdc, AGPLv3

=FEATURES=

- Seamless roundtrip transition between NMDC `/me` and IRC `CTCP ACTION`
- IRC client's "Real Name" exposed as NMDC Description
- IRC client's `CTCP VERSION` exposed as NMDC client tag, with heuristic truncation
- NMDC server's title exposed as IRC channel topic
- Login with passworded nick (classic `PASS`, not `SASL`)
- Full nick list integration including op status
- Support IRC client changing nick via NMDC upstream reconnection
- Automatic join to single-enforced chatroom
- Multithreaded
- Single binary deployment

=USAGE=

`Usage of nmdc-ircfrontend:
  -autojoin
        Automatically join clients to the channel (default true)
  -bind string
        The address:port to bind to and listen for clients on (default ":6667")
  -hubsecurity string
        Nick used for administrative events (default "Hub-Security")
  -servername string
        Server name displayed to clients (default "nmdc-ircfrontend")
  -upstream string
        Upstream NMDC server (default "127.0.0.1:411")
  -verbose
        Display debugging information`

=COMPATIBILITY=

*This section was last updated on or around the release of 1.2.0. Current compatibility may differ.*

NMDC's smaller community has standardised around comparatively few protocol implementations by means of necessity. In comparison, there are a lot of IRC client implementations with slightly differing interpretations of the protocol.

Everything works:
- Hexchat
- Mango IRC
- AndroIRC
- Mutter
- Weechat
- mIRC 7
- HoloIRC (after version 4.1.0)

Usable, with bugs:
- Lite IRC - The username and nickname fields must be identical
- HoloIRC (4.1.0 and earlier) - Can't parse client tag, upstream bug https://github.com/tilal6991/HoloIRC/issues/140
- AndChat - Duplicate usernames appear, upstream bug https://github.com/znc/znc/issues/424
- Irssi - Ignorable warning "critical nicklist_set_host: assertion 'host != NULL' failed"

Unusable:
- Yaaic and Atomic - doesn't properly understand/parse the room join

=CHANGELOG=

2017-05-28 1.2.3
- Fix a regression with userlist display on HexChat (other IRC client compatibility unknown)

2017-05-27 1.2.2
- Update libnmdc to 0.14
- Fix a crash that could occur if the server is scanned by a non-irc client

2016-11-29 1.2.1
- Update libnmdc to 0.11
- Fix an issue with -devel version tag in 1.2.0 release binaries

2016-08-27 1.2.0
- Feature: Support WHOIS (display NMDC user's description + client software)
- Feature: `-version` command-line option
- Compatibility: Demote 'Lite IRC' to 'Usable with bugs' section
- Update libnmdc to r9 (fix protocol issues)
- Update golang to 1.7 (smaller binary size)

2016-05-10 1.1.0
- Feature: Support renaming own client during connection (`/nick`)
- Enhancement: Option to set Hub-Security nick (needed for initial CTCP, upgraded after upstream connection)
- Compatibility: Apply user-agent-specific hacks for mIRC and Atomic clients not nicely handling PRIVMSG with blank sender 
- Compatibility: Better heuristic detection for client tag extraction
- Fix an issue causing the default client tag (nmdc-ircfrontend) to briefly appear in the NMDC user list, by (briefly) delaying the upstream join unless CTCP VERSION response comes in
- Fix an issue generating malformed version numbers in NMDC client tag

2016-05-08 1.0.0
- Initial public release