view release on metacpan or  search on metacpan

lib/Alice/Readme.pod  view on Meta::CPAN

=pod

=head1 NAME

Alice::ReadMe - an Altogether Lovely Internet Chatting Experience

=head1 SYNPOSIS

    arthur:~ leedo$ alice
    Location: http://localhost:8080/

=head1 DESCRIPTION

Alice is an IRC client that is viewed in the web browser. Alice
runs in the background maintaining connections and collecting
messages. When a browser connects, it will display the 100 most
recent messages for each channel, and update with any new messages
as they arrive.

Alice also logs messages to an SQLite database. These logs are
searchable through the web interface.

=head1 USAGE

Installation will add a new `alice` command to start the alice
server.  When the command is run it will start the daemon and print
the URL to load in your browser.

=head2 COMMANDLINE OPTIONS

=over 4

=item -d --debug

Print out additional debug information. Useful for development or
finding out if something is wrong.

=item -p --port

This will change the port that the HTTP server listens on. The
default port is 8080.

=item -a --address

This will change the IP address that the HTTP server listens on.
The default address is 127.0.0.1. That means alice only accepts
local connections by default. If you want to connect to alice
remotely you should change it to the IP you want to listen on, or
0.0.0.0 to listen on all addresses.

=back

=head1 CONFIGURATION

Most of alice can be configured through the web interface. There
are two windows that can be used to alter the configuration,
Connections and Preferences. To bring up either of these windows
click the gear icon in the bottom right hand corner of the page.

This B<should> bring up the new window. Some browsers (specifically
Chrome) will block this popup by default. If it doesn't appear make
sure that you allow popups!

=head2 CONNECTION WINDOW

The connection window is used to add or remove servers. It should be
familiar if you have ever used an IRC client (and I assume you have.)

The only difference of note is the "Avatar" field. In reality, this field
just sets the B<realname>. Alice abuses this field to get avatars for users.
If a user has an image URL or an email address as their realname, alice
will display the image next too their messages. This feature can be disabled
in the Preferences window.

=head2 PREFERENCES WINDOW

The Preferences window can be used to set configuration options that
are not connection specific. You can toggle the use of avatars, timestamps,
and notifications. You can also edit a list of highlightable terms.

=head2 HTTP AUTHENTICATION

Some configuration options do not have a UI yet. The most notable
of these options is HTTP authentication. If you would like to use
HTTP authentication, you will have to edit your configuration file
by hand. You can find this file at ~/.alice/config.

The config is simply a perl hash. So, if you are familiar with perl it
should not be too intimidating. If you do not know perl, sorry! :)

You will need to add "user" and "pass" values to the "auth" hash.
The resulting section of configuration might look like this:

    'auth' => {
      'user' => 'lee',