1.8 KiB

Raw Blame History

Shout

What is it?
Shout is a web IRC client that you host on your own server.

What features does it have?

Multiple user support
Stays connected even when you close the browser
Connect from multiple devices at once
Responsive layout — works well on your smartphone
.. and more!

Ok, you caught my attention. I want to try it!
Here's a Shout server running in public mode, which allows for anonymous connections:

Try the Shout client

Install

sudo npm install -g shout

Usage

When the install is complete, go ahead and start the server:

shout

For more information:

shout --help

Screenshot

Configuration

Open your config.json file and edit:

port
The default port to be used.
You can override this by running shout --port 80

public
Set to either true|false.
When set to false, a login will be required for connecting users.

User Management

Go ahead and run shout --help:

Usage: shout [options] [command]

Commands:

  list
    List all existing users
  
  add <name>
    Add a new user
  
  remove <name>
    Remove an existing user

Pretty simple, huh?

If you want to edit users manually, see users/example/user.json.

Commands

These are the commands currently implemented:

/close
/connect
/deop
/devoice
/disconnect
/invite
/join
/kick
/leave
/me
/mode
/msg
/nick
/notice
/op
/part
/query
/quit
/raw
/say
/send
/server
/slap
/topic
/voice
/whois

License

Available under the MIT license.

1.8 KiB Raw Blame History