How To Install Shout IRC on Uberspace

uberspace_shout-irc.md

Quick Guide: How to install Shout IRC on Uberspace

0. Description

This tutorial was tested with Shout 0.40.3. Shout is a self-hosted IRC-client. For more information refer to http://shout-irc.com/

1. Install Shout via npm (node package manager, pre-installed on Uberspace)

npm install -g shout

2. Configure Shout

• shout configure will open the configuration file (/usr/lib/node_modules/shout/config.js):

  • Set public to false
  • Set port to any number between 61000 and 65535.
    • Make sure the port is unused to avoid collisions. netstat -tulpen | grep PORTNUMBER shouldn't return anything.

• Add a login with shout add <Username> <Password>

• Request [email protected] to open the firewall for your chosen port on your server.

3. Set up the Shout daemon

You'll want to have Shout running as a daemon, which automatically boots and restarts the service if it crashes. You can stop or restart a daemon anytime.

$ cat << __EOF__ > ~/bin/shout-daemon
#!/bin/sh
exec shout start --port PORTNUMBER --private
__EOF__
$ chmod +x ~/bin/shout-daemon
$ uberspace-setup-service shout-daemon ~/bin/shout-daemon

Happy Chatting

Once Uberspace got back to you hit http://YOURSERVER.uberspace.de:PORTNUMBER