PonyChat's fork of Shout
Go to file
Stuart P. Bentley 3cfa1f42b2 Use PORT and IP environment variables
This makes Shout Heroku / Dokku / Plusku compatible.
2014-09-09 11:20:24 +00:00
client Load Lato Google Font without protocol, to allow for HTTPS serving of Shout 2014-09-09 14:38:12 +08:00
screenshots Update screenshot 2014-08-17 08:25:45 -07:00
src Use PORT and IP environment variables 2014-09-09 11:20:24 +00:00
users/example Update example user.json 2014-09-09 02:21:18 -07:00
.gitignore Bump version 2014-08-14 09:43:36 -07:00
Gruntfile.js Use FontAwesome 2014-08-29 13:55:26 -07:00
README.md Update README.md 2014-09-08 19:13:35 +02:00
build.sh Precompile Handlebars templates 2014-08-25 16:13:47 -07:00
config.json Added listen IP parameter. Listening on localhost allow to put Nginx/Varnish in front of shout server 2014-09-09 09:48:53 +02:00
index.js Rename cli folder 2014-08-25 02:40:13 -07:00
package.json Update example user.json 2014-09-09 02:21:18 -07:00

README.md

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

Note: If lots of people are trying the demo, you might want to try another network than irc.freenode.org. Freenode only allows ~5 connections.

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 the config.json file by running:

shout config

The settings:

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

  edit <name>
    Edit 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
  • /quote
  • /raw
  • /say
  • /send
  • /server
  • /slap
  • /topic
  • /voice
  • /whois

License

Available under the MIT license.