Back to project page

urqm

NAME

urqm - micro request queue manager

SYNOPSIS

urqm [OPTIONS]
urqm [-h|-l|-V]

DESCRIPTION

Micro Request Queue Manager is a request queue manager with a small footprint. It maintains a series of queues of "tickets", or support requests, which can be delegated, commented on, and have links made between them. Tickets can be managed via email and via the web interface.

urqm is the user interface / front end to the main daemon, and as such must be running on the same machine as a running instance of urqmd.

There are several different user interfaces available. The command line interface is the default, unless the environment variable REQUEST_METHOD exists, in which case the CGI (web) interface is used.

OPTIONS

-c, --command
Choose the command line interface.
-w, --web, --cgi
Choose the CGI interface. This is the default if the environment variable REQUEST_METHOD exists.
-e, --email QUEUEID
Treat standard input as an incoming email message destined for the queue with the given queue ID.
-u, --username USERNAME
When using the command line interface, authenticate with the given username.
-p, --password PASSWORD
When using the command line interface, authenticate with the given password.
-b, --batch COMMAND
Execute a single COMMAND through the command line interface, and exit. Remember that COMMAND will need to be quoted if it contains multiple words, so it does not get split up by the shell.
-D, --data-dir DIR
Use the specified data directory instead of the default (see FILES).
-h, --help
Print a usage message on standard output and exit successfully.
-l, --license
Print details of the program's license on standard output and exit successfully.
-V, --version
Print version information on standard output and exit successfully.

COMMAND LINE INTERFACE

The following commands are available within the command line interface:

auth username password
Authenticate with the given username and password. If one or both are not given, they will be prompted for.

(TODO: more to follow)

CGI INTERFACE

To use the CGI interface, set up your web server to use urqm as a CGI script, and point your browser at it.

The page design can be modified by altering /var/lib/urqm/template.html - the simplest way is to add a <link rel="stylesheet" ...> tag referring to a stylesheet on your web server, which you can then customise.

The following stylesheet classes are used throughout urqm:

(TODO: list of stylesheet classes to follow)

EMAIL INTERFACE

Incoming email (supplied using the -e option) will either create a new ticket on that queue, with a status of "new" and no owner, or it will add to the history of the ticket it refers to and mark that ticket as "open".

Also, if it refers to a ticket, the email will be forwarded on to whoever is watching the ticket (i.e. the creator and the owner).

FILES

/var/lib/urqm/
The data directory. urqm needs to have read/execute access to this directory.
/var/lib/urqm/template.html
The HTML template file. The first occurrence of {{CONTENT}} is replaced by urqm content when using the CGI interface.
/var/lib/urqm/socket
The Unix socket that urqm will use to communicate with urqmd.

AUTHOR

Andrew Wood
http://www.ivarch.com/

BUGS

If you find any bugs, please contact the primary author, either by email or by using the contact form on the web site.

SEE ALSO

urqmd(8)

LICENSE

This is free software, distributed under the ARTISTIC license.

 

 

urqmd

NAME

urqmd - micro request queue manager daemon

SYNOPSIS

urqmd [-D DIR] [-d]
urqmd [-h|-l|-V]

DESCRIPTION

Micro Request Queue Manager is a request queue manager with a small footprint. It maintains a series of queues of "tickets", or support requests, which can be delegated, commented on, and have links made between them. Tickets can be managed via email and via the web interface.

urqmd is the daemon that runs the main part of the Micro Request Queue Manager. It handles authentication, ticket management, and background maintenance (as opposed to urqm, which handles the user interface).

Please do not run urqmd as root; it is not necessary or wise. Instead, run it as some user ID that has access to the relevant files (see the FILES section below).

OPTIONS

-D, --data-dir DIR
Use the specified data directory instead of the default (see FILES).
-d, --debug
Run in the foreground, instead of running in the background as a daemon, and output information to standard error instead of using syslog(3).
-h, --help
Print a usage message on standard output and exit successfully.
-l, --license
Print details of the program's license on standard output and exit successfully.
-V, --version
Print version information on standard output and exit successfully.

FILES

/var/lib/urqm/
The data directory. urqmd needs to have both read and write access to this directory.
/var/lib/urqm/main.db
The main database. This holds details of all users, queues, and tickets.
/var/lib/urqm/socket
The Unix socket that urqm will use to communicate with urqmd.
/var/lib/urqm/files/
A directory containing any files that have been attached to tickets.

AUTHOR

Andrew Wood
http://www.ivarch.com/

BUGS

If you find any bugs, please contact the primary author, either by email or by using the contact form on the web site.

SEE ALSO

urqm(1)

LICENSE

This is free software, distributed under the ARTISTIC license.

Back to project page