20f0ca6666 | ||
---|---|---|
client | ||
screenshots | ||
src | ||
users/example | ||
.gitignore | ||
.vimrc | ||
Gruntfile.js | ||
README.md | ||
app.json | ||
build.sh | ||
config.js | ||
index.js | ||
package.json |
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
Clicking the link above will open http://demo.shout-irc.com/
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
:
$ 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
.
Commands
These are the commands currently implemented:
- /clear
- /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.