mirror of https://codeberg.org/emersion/gamja.git synced 2024-11-25 00:38:12 -05:00

A simple IRC web client

Find a file

Simon Ser db7aa337cb Remove App.isChannel Replace all remaining usage with Client.isChannel. Client will be able to use the ISUPPORT tokens to check if a name is a channel.		2021-06-04 19:13:59 +02:00
components	Remove App.isChannel	2021-06-04 19:13:59 +02:00
lib	Introduce State.handleMessage	2021-06-04 18:27:21 +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	Remove App.isChannel	2021-06-04 19:13:59 +02:00
index.html	Set the viewport meta tag	2021-05-26 22:42:35 +02:00
keybindings.js	Make Alt+ArrowUp and Alt+ArrowDown wrap around	2021-05-31 19:21:54 +02:00
LICENSE	Initial commit	2020-04-24 19:03:43 +02:00
package-lock.json	Update dependencies	2021-05-17 09:52:42 +02:00
package.json	Update preact	2021-01-12 16:04:49 +01:00
README.md	readme: document server.ping in config section	2021-05-31 14:48:51 +02:00
state.js	Add State.addMessage	2021-06-04 19:07:14 +02:00
store.js	Introduce store helper	2021-05-26 18:43:11 +02:00
style.css	Set scrollbar style	2021-05-31 18:43:44 +02:00

README.md

gamja

A bare-bones 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, you can set the server.ping option in config.json to an interval, in seconds, between which gamja will send opportunistic pings.

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 to connect to (string).
		"url": "wss://irc.example.org",
		// Channel(s) to auto-join (string or array of strings).
		"autojoin": "#gamja",
		// 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.