thelounge/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 Demo

Temporarily down. Moving the server.

Install

sudo npm install -g shout

Experimental Heroku Deployment

Please note, that this will result in a public Shout instance. In order to make it private and to register users, you need to follow these steps:

git clone git@heroku.com:<your-app>.git
cd your-app
npm install
vim config.js
  # set public to false
  # set home to __dirname
git add config.js
git commit -m "Make shout private and use repo dir as shout home"
node src/command-line/index.js add <username>
git add -f users/<username>
git commit -m "Add user <username>"
git push heroku master

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:

$ shout --help

  Usage: shout [options] [command]

  Commands:

    start
       Start the server

    config
       Edit config: '/usr/lib/node_modules/shout/config.json'

    list
       List all existing users

    add <name>
       Add a new user

    remove <name>
       Remove an existing user

    reset <name>
       Reset user password

    edit <name>
       Edit user: '/home/erming/.shout/users/<name>/user.json'


  Options:

    -h, --help         output usage information
    -h, --host <ip>    host
    -p, --port <port>  port

Pretty simple, huh?

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

Custom paths

You can define Shout's file storage path via the following options:

• Add an entry called home to the config.json file.
• Set the environment variable SHOUT_HOME before calling the shout executable.
• Use the default of $HOME/.shout.

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.