A very basic configuration is very short. By default, the HTTP server runs on port 8080 on localhost. All that needs to be specified are the IRC server host, bot nickname, and channel(s) to join.

.. code:: toml

[irc.server]
host = "irc.server.example"

[irc.bot]
nickname = "Weitersager"

[[irc.channels]]
name = "#lobby"

A lot more can be configured, though:

.. code:: toml

log_level = "debug"         # optional; default: `"debug"`

[http]
host = "127.0.0.1"          # optional; default: `"127.0.0.1"`
port = 8080                 # optional; default: `8080`
api_tokens = [ "123xyz" ]   # optional; default: `[]`

[irc.server]
host = "irc.server.example"
port = 6667                 # optional; default: `6667`
ssl = false                 # optional; default: `false`
password = "secret"         # optional; default: no password
rate_limit = 0.5            # optional; limit of messages
                            # per second; default: no limit

[irc.bot]
nickname = "Weitersager"
realname = "Weitersager"    # optional; default: `"Weitersager"`

[irc]
commands = [                # optional; default: `[]`
  "MODE Weitersager +i",
]

[[irc.channels]]
name = "#party"

[[irc.channels]]
name = "#secretlab"
password = "555-secret"

.. _TOML: https://toml.io/

IRC Dummy Mode

If no value for irc.server.host is set, Weitersager will not attempt to connect to an IRC server and start in IRC dummy mode. It will still accept messages, but it will write them to STDOUT. This can be useful for testing.

HTTP API

To send messages to IRC, send an HTTP POST request to URL path / at the address and port the application is listening on.

The body has to be in JSON_ format and contain two keys, channel and text, with string values:

.. code:: json

{ "channel": "#party", "text": "Oh yeah!" }

.. _JSON: https://www.json.org/

Example HTTPie_ call to send a message to Weitersager on localhost, port 8080:

.. code:: sh

$ http --json post :8080 channel='#party' text='Oh yeah!'

.. _HTTPie: https://httpie.org/

Authorization


To protect the HTTP API a bit, requests can be required to include an
authorization header with a valid token to be accepted.

The authorization check becomes active if at least one API token is
configured. A command line tool is provided to generate secure tokens:

.. code:: sh

    $ weitersager-token
    e72CbijlYLqjaRIv0uMNBpgZKl397FEp-Y8PNEXn5vM

Multiple API tokens can be configured so that each legitimate client
can be given its own token which can than be revoked (by removing it
from the configuration, and restarting) individually.

Header format:

.. code:: http

    Authorization: Bearer <a token of your choosing>

Example authorization header:

.. code:: http

    Authorization: Bearer e72CbijlYLqjaRIv0uMNBpgZKl397FEp-Y8PNEXn5vM

Example HTTPie_ call with authorization header:

.. code:: sh

    $ http --json post :8080 Authorization:'Bearer e72CbijlYLqjaRIv0uMNBpgZKl397FEp-Y8PNEXn5vM' channel='#party' text='Oh yeah!'

Note that Weitersager itself only uses unencrypted HTTP, so the API
tokens are passed in the clear. That might suffice if you run it on the
same host as the HTTP clients. Otherwise you might want to look into
hiding Weitersager behind a web server or proxy that can add TLS
encryption.


Channel Tokens

Weitersager supports an alternative HTTP endpoint using a secret token as part of the URL instead of an authorization header. This makes it a bit easier to use for clients.

Each secret token is mapped to a channel, so each URL already implicitly (though intransparently, for the caller) defines the channel the submitted text should be sent to.

This pattern is also used by popular messaging services like Slack_ and Discord_ for incoming webhooks.

To expose a channel via this endpoint, just add one or more tokens to it:

.. code:: toml

[[irc.channels]]
name = "#secretlab"
tokens = [
  "A2x23NmcdQgWJ8-5PivbvPX4KmdL9oa7Sy8Jj_9ldoY",
  "JMApghB7wkHCtw0TcQ1Bu7zY-wG03os61bBDXfAZ4Yc",
]

To generate a token, use the weitersager-token command. Feel free to use a separate token for each client/app that calls the endpoint to be able to revoke tokens separately (by simply removing them from the configuration) if need be.

As a result, these endpoints become available:

/ct/A2x23NmcdQgWJ8-5PivbvPX4KmdL9oa7Sy8Jj_9ldoY
/ct/JMApghB7wkHCtw0TcQ1Bu7zY-wG03os61bBDXfAZ4Yc

Call them like this (note that neither the Authorization header nor the channel key in the payload are specified):

.. code:: sh

$ http --json post :8080/ct/A2x23NmcdQgWJ8-5PivbvPX4KmdL9oa7Sy8Jj_9ldoY text='Oh yeah!'

.. _Slack: https://slack.com/ .. _Discord: https://discord.com/

Run in a Docker Container

Build a container image, tagged weitersager:

.. code:: sh

$ docker build -t weitersager .

Start the container, using configuration file config_example_docker.toml (which should expose Weitersager inside the container on host 0.0.0.0 and port 8080), exposing Weitersager on the Docker host on host 127.0.0.1 and port 9000:

.. code:: sh

$ docker run -d \
  --mount type=bind,source="$(pwd)"/config_example_docker.toml,destination=/app/config.toml,readonly \
  -p 127.0.0.1:9000:8080 \
  weitersager

The local configuration file is made available to the container through a bind mount_.

.. _bind mount: https://docs.docker.com/storage/bind-mounts/

Using Docker Compose

A configuration file for Docker Compose, compose.yaml, is also available. Adjust as necessary, then run Weitersager in a container using:

.. code:: sh

$ docker-compose up --detach

Implementation Details

A Note on Threads

This tool uses threads. Besides the main thread, there are two additional threads: one for the message receiver and one for the IRC bot. Both are configured to be daemon threads.

The dummy bot, on the other hand, does not run in a thread.

A Python application exits if no more non-daemon threads are running.

The user has to manually interrupt the application to exit.

For details, see the documentation on the threading module that is part of Python's standard library.

Author

Weitersager was created, and is developed and maintained, by Jochen "Y0Gi" Kupperschmidt.

License

Weitersager is licensed under the MIT License <https://choosealicense.com/licenses/mit/>_.

The license text is provided in the LICENSE <LICENSE>_ file.

Keywords

irc

webhook

FAQs

What is Weitersager?

Is Weitersager well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Weitersager

=========== Weitersager

Website

Code Status

Requirements

Installation

Usage

Configuration

IRC Dummy Mode

HTTP API

Run in a Docker Container

Using Docker Compose

Implementation Details

A Note on Threads

Author

License

Keywords

Related posts

Protestware in JavaScript UI Toolkits on npm Target Russian Language Sites

The Growing Risk of Malicious Browser Extensions