Jan Henning Thorsen > Convos-0.82 > Convos

Download:
Convos-0.82.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.82   Source  

NAME ^

Convos - Multiuser IRC proxy with web interface

VERSION ^

0.82

DESCRIPTION ^

Convos is to a multi-user IRC Proxy, that also provides a easy to use Web interface. Feature list:

Architecture principles

RUNNING CONVOS ^

Convos has sane defaults so after installing Convos you should be able to just run it:

  # Install
  $ cpanm Convos
  # Run it
  $ convos backend &
  $ convos daemon

The above works, but if you have a lot of users you probably want to use hypnotoad instead of daemon:

  $ hypnotoad $(which convos)

The command above will start a full featured, UNIX optimized, preforking non-blocking webserver. Run the same command again, and the webserver will hot reload the source code without loosing any connections.

Environment

Convos can be configured with the following environment variables:

HTTP headers

CUSTOM TEMPLATES ^

Some parts of the Convos templates can include custom content. Example:

  # Create a directory where you can store the templates
  $ mkdir -p custom-convos/vendor

  # Edit the template you want to customize
  $ $EDITOR custom-convos/vendor/login_footer.html.ep

  # Start convos with CONVOS_TEMPLATES set. Without /vendor at the end
  $ CONVOS_TEMPLATES=$PWD/custom-convos convos daemon --listen http://*:5000

Any changes to the templates require the server to restart.

The templates that can be customized are:

RESOURCES ^

SEE ALSO ^

ATTRIBUTES ^

archive

Holds a Convos::Core::Archive object.

core

Holds a Convos::Core object.

upgrader

Holds a Convos::Upgrader object.

METHODS ^

startup

This method will run once at server start

COPYRIGHT AND LICENSE ^

Copyright (C) 2012-2013, Nordaaker.

This program is free software, you can redistribute it and/or modify it under the terms of the Artistic License version 2.0.

AUTHOR ^

Jan Henning Thorsen - jhthorsen@cpan.org

Marcus Ramberg - marcus@nordaaker.com

syntax highlighting: