NAME

Convos - Multiuser IRC proxy with web interface

VERSION

0.84

DESCRIPTION

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

• Always online

  The backend server will keep you logged in and logs all the activity in your archive.

• Archive

  All chats will be logged and indexed, which allow you to search in earlier conversations.

• Avatars

  The chat contains profile pictures which can be retrieved from Facebook or from gravatar.com.

• Include external resources

  Links to images and video will be displayed inline. No need to click on the link to view the data.

Architecture principles

• Keep the JS simple and manageable

• Use Redis to manage state / publish subscribe

• Bootstrap-based user interface

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.

Convos can be configured using Convos::Manual::Environment and Convos::Manual::HttpHeaders.

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:

• vendor/login_footer.html.ep

  This template will be included below the form on the /login page.

• vendor/register_footer.html.ep

  This template will be included below the form on the /register page.

• vendor/wizard.html.ep

  This template will be included below the form on the /wizard page that a new visitor sees after registering.

RESOURCES

• Homepage: http://convos.by

• Project page: https://github.com/Nordaaker/convos

• Icon: https://raw.github.com/Nordaaker/convos/master/public/image/icon.svg

• Logo: https://raw.github.com/Nordaaker/convos/master/public/image/logo.svg

SEE ALSO

• Convos::Controller::Client

  Mojolicious controller for IRC chat.

• Convos::Controller::User

  Mojolicious controller for user data.

• Convos::Core

  Backend functionality.

ATTRIBUTES

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

cpanm Convos

perl -MCPAN -e shell
install Convos