Read Me

Communigeek README
======================


1. Brief Introduction to Communigeek
====================================
Communigeek is basically a chat program which allows the participants
to transmit messages and files over a SSL secured connection.
This works with a server that is accepting connections from the clients.
The server acts as a relay for chat messages and is used to communicate
between the clients when they want to do a filetransfer.

Filetransfers are taking place directly between the two clients via another
dedicated SSL connection.


2. The Communigeek interface
============================

2.1 Available commands
----------------------


2.2 The configuration File
--------------------------

CommuniGeek will feature a Configuration File in which you can put all the required
paths, so you don't have to enter them all over again each time you start it.

The format of .communigeek looks like this:

host=10.0.0.1
nick=myname
key=path/to/keyfile
cert=path/to/certfile

Store that the directory you run CommuniGeek from or in your $HOME and the file will supersede
the default settings in the .py files.


3. Required Files
=================

There are two file that the server must have. That is an OpenSSL Certificate
and the corresponding Key.

It is recommended that each client creates these files for themselves aswell.
They are needed in case you want to receive a file.

3.1 How to generate your own certificate and key file
-----------------------------------------------------

Simply type that in your terminal

$ openssl req -new -x509 -out cert.pem -keyout key.pem

If you don't want to enter the password each time you access the PEM files
add -nodes to the above command. This is not recommended though.


3.2 Required Modules
--------------------

    - progressbar [http://pypi.python.org/pypi/progressbar]
    - PyQt4 [http://www.riverbankcomputing.co.uk/software/pyqt/download]