~singpolyma/cheogram-muc-bridge

4471e1af2b300f9d72e5e7fc4d9739c4597f5c44 — Stephen Paul Weber 1 year, 4 months ago 28984fb
Small tweaks to the README improvements
1 files changed, 7 insertions(+), 3 deletions(-)

M README.md
M README.md => README.md +7 -3
@@ 34,7 34,7 @@ This assumes DNS records are already pointing to your server for `example.com` a

#### Step 1: Install cheogram-muc-bridge

You need to have `cabal` (the Haskell build system) installed, as well as `ghc` and `c2hs`. In addition, you need the `libxml2`, `gnutls`, `zlib` and `gsasl` libraries installed. On debian, you can set it all up from the following packages: `cabal-install ghc libxml2-dev libgsasl7-dev gnutls-dev c2hs zlib1g-dev`
You need to have `cabal` (the Haskell build system) installed, as well as `ghc` and `c2hs`. In addition, you need the `libxml2`, `gnutls`, `zlib` and `gsasl` libraries installed. On debian, you can set it all up from the following packages: `cabal-install libxml2-dev libgsasl7-dev gnutls-dev c2hs zlib1g-dev`

Download the sources, build with cabal (Haskell build system). The built program will be in `dist/build/gateway/gateway`:



@@ 95,7 95,7 @@ In the section that says: '{listen,' add those two lines:

#### Step 5: Configure

Configuration is explained in the [Configuration](#configuration) section of this README. You can find an example config file [here](config.dhall.example).
Configuration is explained in the [Configuration](#configuration) section of this README. You can find an [example config file](config.dhall.example).

#### Step 6: Run



@@ 142,6 142,7 @@ You can find an example configuration file in the [config.dhall.example](config.
  - jid: the JID address to reach the room
  - tag: the suffix to append to members of this room, automatically wrapped inside `[]` if the nickChars allows it on the other sides; illegal characters are replaced with `_`
  - nickChars: the explicit list of characters to allow as nicknames on this chatroom (usually `Some "a-zA-Z[]"` for IRC); `None Text` does not place any special restrictions
  - nickLength: the maximum length of a nick in this MUC, or `None Natural` for no limit.

## Known issues (TODO)



@@ 152,12 153,15 @@ cheogram-muc-bridge is alpha-quality software. Just because we haven't found a b
- when joining a [biboumi IRC gateway](https://biboumi.louiz.org/) chatroom where the nick is already taken, no error is provided ([upstream ticket](https://lab.louiz.org/louiz/biboumi/-/issues/3458))
- when the `tag` on a chan is deemed illegal by another chan's `nickChars`, no warning is currently produced
- `nickChars = None Text` does not enforce that [illegal JID characters](https://datatracker.ietf.org/doc/html/rfc7622#section-3.3.1) are prevented; in the future, such characters should be properly escaped as explained in [XEP-0106](https://xmpp.org/extensions/xep-0106.html) or entirely forbidden
- `nickChars = "a-z[]A-Z"` is too restrictive, and we should promote a better configuration; in particular, it prevents numbers in usernames, which are not uncommon; more broadly, it may be interesting when connecting through a biboumi gateway, to determine allowed characters from the IRC network's charset

## Getting Help

Part of the soprani.ca family of projects.

If you have any questions about this project, or wish to report a bug, please send email to: dev@singpolyma.net

You may come discuss the project in our chatroom: xmpp:discuss@conference.soprani.ca?join

## Contributing

If you have code or patches you wish to contribute, the maintainer's preferred mechanism is a git pull request. Push your changes to a git repository somewhere, for example: