https://github.com/zenhack/sandstorm-znc
Sandstorm port of ZNC
https://github.com/zenhack/sandstorm-znc
Last synced: 10 months ago
JSON representation
Sandstorm port of ZNC
- Host: GitHub
- URL: https://github.com/zenhack/sandstorm-znc
- Owner: zenhack
- License: apache-2.0
- Created: 2017-03-19T17:15:25.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-06T23:54:39.000Z (almost 9 years ago)
- Last Synced: 2025-04-23T21:08:29.537Z (12 months ago)
- Language: Go
- Size: 70.3 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE
Awesome Lists containing this project
README
# sandstorm-znc
Port of ZNC to [Sandstorm][1]. This is alpha quality, but I'm dogfooding
it and it basically works.
## License
Apache-2.0; see the `LICENSE` file.
# Design Notes
IRC isn't a web based protocol, so building a Sandstorm app does IRC is
slightly more complicated that most Sandstorm apps. We still want
leverage sandstorm for authentication and authorization. We do this by
listening on a websocket instead of a raw TCP port, and have users use
[websocket-proxy][2] to connect.
# Using
To use sandstorm-znc, you must be an administrator for your sandstorm
installation. This is because IRC Idler requires raw network access,
which only an administrator can grant. Additionally, connecting to it
is a little weird; see the Design Notes section above.
Each irc network you want to connect to must run in its own grain. To
set up a new network:
* Create a new ZNC grain
* Fill out the settings for the IRC server on the grain's web interface.
For example, to connect to freenode, you would supply:
* Host: irc.freenode.net
* Port: 6667 for unencrypted, 6697 for TLS
* Check the TLS box or not, depending on whether you want to use it
(recommended).
* Click on the "Request Network Access" button, and grant network access
in the dialog that sandstorm presents
* You will be presented with a websocket URL you can use to connect. You
can get a traditional IRC client to connect to this by using
[websocket-proxy][2]:
websocket-proxy -listen :6000 -url ${websocket_url}
...and then pointing your IRC client at localhost port 6000.
You'll need to use sandstorm/sandstorm as your username and password
when connecting. You can (and should) change your nick once connected
by the usual means (/nick in most clients). You can use ZNC's
[controlpanel][3] module to tweak settings; do `/msg *controlpanel help`
for instructions.
Note that settings are not persisted, so if the grain is restarted
you'll have to reconfigure.
[1]: https://sandstorm.io
[2]: https://github.com/zenhack/websocket-proxy
[3]: http://wiki.znc.in/Controlpanel