mirror of
https://github.com/thelounge/thelounge
synced 2024-12-04 17:59:15 +00:00
169 lines
3.1 KiB
Markdown
169 lines
3.1 KiB
Markdown
# Shout [](https://www.npmjs.org/package/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](http://shout-irc.com:9000/)
|
|
|
|
## Install
|
|
|
|
```
|
|
sudo npm install -g shout
|
|
```
|
|
|
|
### Experimental Heroku Deployment
|
|
|
|
[](https://heroku.com/deploy)
|
|
|
|
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:
|
|
|
|
- [x] /close
|
|
- [x] /connect
|
|
- [x] /deop
|
|
- [x] /devoice
|
|
- [x] /disconnect
|
|
- [x] /invite
|
|
- [x] /join
|
|
- [x] /kick
|
|
- [x] /leave
|
|
- [x] /me
|
|
- [x] /mode
|
|
- [x] /msg
|
|
- [x] /nick
|
|
- [x] /notice
|
|
- [x] /op
|
|
- [x] /part
|
|
- [x] /query
|
|
- [x] /quit
|
|
- [x] /quote
|
|
- [x] /raw
|
|
- [x] /say
|
|
- [x] /send
|
|
- [x] /server
|
|
- [x] /slap
|
|
- [x] /topic
|
|
- [x] /voice
|
|
- [x] /whois
|
|
|
|
## License
|
|
|
|
Available under [the MIT license](http://mths.be/mit).
|