soCurious - A curiosity reliever - documentation

2008-01-18 - Christian Doebler



Table of contents
==================

1. Copyright
2. Legal Disclaimer
3. Snippets
4. Configuration
5. Generation of the extension package
6. Installation




1. Copyright
=============

This software is Copyright (c) 2008 Christian Doebler 
                                    <c.doebler@tinxx.de>

(Except where explicitly superseded by other copyright notices)


LICENSE:

This work is made available to you under the terms of Version 2 of
the GNU General Public License. A copy of that license should have
been provided with this software, but in any event can be snarfed
from http://www.fsf.org.

This work is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 or visit their web page on the internet at
http://www.fsf.org.


CONTRIBUTION SUBMISSION POLICY:

(The following paragraph is not intended to limit the rights granted
to you to modify and distribute this software under the terms of
the GNU General Public License and is only of importance to you if
you choose to contribute your changes and enhancements to the
community by submitting them to Christian Doebler.)

By intentionally submitting any modifications, corrections or
derivatives to this work, or any other work intended for use with
this Software, to Christian Doebler, you confirm that
you are the copyright holder for those contributions and you grant
Christian Doebler a nonexclusive, worldwide, irrevocable,
royalty-free, perpetual, license to use, copy, create derivative
works based on those contributions, and sublicense and distribute
those contributions and any derivatives thereof.




2. Legal disclaimer
====================

Christian Doebler takes no responsibility for use of this code.
It is for educational purposes only.




3. Snippets
============

This software consists partially of snippets taken from open-source
projects from all over the internet.




4.Configuration
=================

Simply edit the header of the file
soCurious_src/chrome/content/socurious/overlay.js

Variables:
hide_extension : set this ro true to hide the extension from the
                 add-ons dialogue


storage_method : define the storage method here
                 available options: file, http, smtp


Storage method 'file':
file_location  : define the file to store captured data
                 the location should be given with an absolute path

Storage method 'http':
var http_host   : define the host to send caprured data to
var http_port   : define the port, your web server is listening on
var http_script : define the script that takes the caprured data for
                  further processing

Storage method 'smtp':
var smtp_ehlo    : define the smtp EHLO domain / host
var smtp_from    : define the sender's e-mail address
var smtp_rcpt    : define the recipient's e-mail address
var smtp_subject : define the e-mail's subject
var smtp_host    : define the smtp host to send the e-mail to
var smtp_port    : define the port, your smtp host is listening on




5. Generation of the extension package
=======================================

Only generate the xpi file, when you have finished the configuration!

You have to generate the xpi-extension file, first.

The easiest way is to use the create_xpi.sh script, which will generate
socurious.xpi for you

The hard way is to zip the contents by yourself:

1. Change to the directory 'soCurious_src/chrome/'.
2. Zip the content of the folder with a usual zip utiliy like 'zip', 'winzip'
   or whatever recursively, and rename the archive to 'socurious.jar'.
3. Remove the contents, you just zipped, so only the file 'socurious.jar'
   remains.
4. Change to the directory 'soCurious_src/' and zip the content of the folder,
   again with your zip utility, recursively and rename the archive to
   'soCurious.xpi'.
5. That's it.




6. Installation
================

Launch Firefox and open the extension file soCurious.xpi via
'File' -> 'Open File...'.

Follow the installation steps.

Have fun.



# EOF