chipmunkmc/gamja-old
1
0
Fork 0
mirror of https://git.sr.ht/~emersion/gamja synced 2024-11-14 19:25:26 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

readme: add more detailed usage instructions

Browse source
This commit is contained in:
Simon Ser 2020-07-01 14:46:49 +02:00
parent c309d3cff6
commit 72c51b6923
No known key found for this signature in database
GPG key ID: 0FDE7BE0E88F5E48
1 changed files with 33 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -6,11 +6,44 @@ A bare-bones IRC web client.
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:
```ini
[fileserving]
enabled = true
webroot = /path/to/gamja
```
Then connect to webircgateway and append `?server=/webirc/websocket/` to the
URL.
### 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.
## License
AGPLv3, see LICENSE.
Copyright (C) 2020 The gamja Contributors
[soju]: https://soju.im
[webircgateway]: https://github.com/kiwiirc/webircgateway