mirror of https://codeberg.org/emersion/gamja.git synced 2024-11-14 19:05:01 -05:00

A simple IRC web client

Find a file

Simon Ser 1a8d539c9e Use linkifyjs module		2021-10-14 20:55:55 +02:00
components	Handle IRC URLs without channel name	2021-10-13 16:47:01 +02:00
lib	Use linkifyjs module	2021-10-14 20:55:55 +02:00
.editorconfig	Add .editorconfig	2020-07-22 14:51:37 +02:00
.gitignore	Add support for config file	2021-05-25 12:33:22 +02:00
commands.js	Get rid of a wild var keyword	2021-09-06 16:53:25 +02:00
index.html	Use linkifyjs module	2021-10-14 20:55:55 +02:00
keybindings.js	Update buffer store when marking all buffers as read	2021-08-25 08:47:35 +02:00
LICENSE	Initial commit	2020-04-24 19:03:43 +02:00
manifest.json	Add web app manifest	2021-06-22 10:42:16 +02:00
package-lock.json	Use linkifyjs module	2021-10-14 20:55:55 +02:00
package.json	Switch from anchorme to linkifyjs	2021-10-13 15:33:41 +02:00
README.md	readme: mention server.ping when server doesn't send PINGs	2021-10-12 20:18:29 +02:00
state.js	Fix duplicate declaration in State.handleMessage	2021-09-21 17:24:13 +02:00
store.js	Drop dangling var keyword	2021-09-21 18:26:42 +02:00
style.css	Hide buffer focus outline	2021-08-18 08:55:23 +02:00

README.md

gamja

A simple IRC web client.

Usage

Requires an IRC WebSocket server.

First install dependencies:

npm install --production

soju

Add a WebSocket listener to soju, e.g. listen wss://127.0.0.1:8080.

Configure your reverse proxy to serve gamja files and proxy /socket to soju.

webircgateway

Setup webircgateway to serve gamja files:

[fileserving]
enabled = true
webroot = /path/to/gamja

Then connect to webircgateway and append ?server=/webirc/websocket/ to the URL.

nginx

If you use nginx as a reverse HTTP proxy, make sure to bump the default read timeout to a value higher than the IRC server PING interval. Example:

location /socket {
	proxy_pass http://127.0.0.1:8080;
	proxy_read_timeout 600s;
	proxy_http_version 1.1;
	proxy_set_header Upgrade $http_upgrade;
	proxy_set_header Connection "Upgrade";
	proxy_set_header X-Forwarded-For $remote_addr;
	proxy_set_header X-Forwarded-Proto $scheme;
}

If you are unable to configure the proxy timeout accordingly, or if your IRC server doesn't send PINGs, you can set the server.ping option in config.json (see below).

Development server

Start your IRC WebSocket server, e.g. on port 8080. Then run:

npm install
npm start

This will start a development HTTP server for gamja. Connect to it and append ?server=ws://localhost:8080 to the URL.

Query parameters

gamja settings can be overridden using URL query parameters:

server: path or URL to the WebSocket server
nick: nickname
channels: comma-separated list of channels to join (# needs to be escaped)

Alternatively, the channels can be set with the URL fragment (ie, by just appending the channel name to the gamja URL).

Configuration file

gamja default settings can be set using a config.json file at the root:

{
	// IRC server settings.
	"server": {
		// WebSocket URL or path to connect to (string).
		"url": "wss://irc.example.org",
		// Channel(s) to auto-join (string or array of strings).
		"autojoin": "#gamja",
		// Controls how the password UI is presented to the user. Set to
		// "mandatory" to require a password, "optional" to accept one but not
		// require it, "disabled" to never ask for a password, or "external" to
		// use SASL EXTERNAL. Defaults to "optional".
		"auth": "optional",
		// Default nickname (string).
		"nick": "asdf",
		// Don't display the login UI, immediately connect to the server
		// (boolean).
		"autoconnect": true,
		// Interval in seconds to send PING commands (number). Set to 0 to
		// disable. Enabling PINGs can have an impact on client power usage and
		// should only be enabled if necessary.
		"ping": 60
	}
}

Contributing

Send patches on the mailing list, report bugs on the issue tracker. Discuss in #soju on Libera Chat.

License

AGPLv3, see LICENSE.