Marcus Ramberg > Convos-0.8604 > Convos

Download:
Convos-0.8604.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.8604   Source  

NAME ^

Convos - Multiuser IRC proxy with web interface

VERSION ^

0.8604

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 daemon --listen http://*:8080

The steps above will install and run Convos in a single process. This is a very quick way to get started, but we incourage to run Convos as one backend and one frontend:

  # Start the backend first
  $ convos backend start

  # Then start the frontend
  $ convos daemon --listen http://*:8080

This allow you to upgrade and restart the frontend, without having to reconnect to the IRC servers.

See Convos::Manual::Running for more details.

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 ^

core

Holds a Convos::Core object .

upgrader

DEPRECATED.

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: