Documentation

Usage

Once you’ve installed Shout, go ahead and run:

$ shout --help

This will give you an overiew of the commands you can use.

start

Start the Shout server.

Example:

$ shout start --port 80 --private

Options:

  • -p, --port
  • -h, --host
  • --public
  • --private

config

Open the configuration file.

Example:

$ shout config

list

List all existing users.

Example:

$ shout list

add <name> [<password>]

Add a new user.

Example:

$ shout add john

remove <name>

Remove an existing user.

Example:

$ shout remove john

reset <name>

Reset user password.

Example:

$ shout reset john

edit <name>

Edit user configuration file.

Example:

$ shout edit john

Options

--home

Set the home path. This is the location where Shout will look for the config.js and the users/ folder.

Example:

$ shout --home /app add <user>  # add user to /app/users
$ shout --home /app             # start server with /app/config.js

--help

Output usage information.

Example:

$ shout --help

--version

Output the version number.

Example:

$ shout --version