.. _admin_readme:

Lucy
====

What is lucy?
-------------
Lucy is the backbone of d3VIEW that enhances the ability to track, submit,
and process jobs. Lucy is responsible for preview, publisher, submit, as
well as job execution.

Installation
------------
Lucy comes by default as a python executable self installer, that is built with
the intention of reducing IT workload.

1) Create the directory to extract to (such as /opt/d3VIEW/lucy)

2) Ensure the permissions in the directory match the permissions of the user
   that will run the preview.

3) Run the installer using python, specifying the install directory::

   $ python d3view-0.6.0-full-p27.install /opt/d3VIEW/lucy

The ``-import-from`` option copies the bin and etc folders into the current 
installation folders at the end of the installation.

Upgrading and Downgrading
-------------------------
To upgrade lucy, simply install a newly downloaded .install file in the same
directory. ::

   $ python d3view-0.7.0-full-p27.install /opt/d3VIEW/lucy

To downgrade, install the previously installed file again.::

   $ python d3view-0.6.0-full-p27.install /opt/d3VIEW/lucy

Setup
-----

Lucy Setup
^^^^^^^^^^
The configuration file that drives the application is in json format and
exists at ``<install_path>/etc/config/lucy.json``. Each
distribution comes with a new configuration file named ``lucy.json.in``.
This prevents overwriting an existing configuration when an upgrade is
made.

The upgrade will automatically update keys from ``lucy.json.in`` that are not
site specific, and will replace those keys in the ``lucy.json`` after creating
a backup ``lucy.json`` file.

For api calls to be successful, the following connection fields will have
to be updated to match your d3VIEW installation:

``URI`` - url to the site's d3VIEW server. E.g. ``http://d3VIEW-internal.com``

``PORT`` - port the d3VIEW server is running on

``APPLICATION_KEY`` - the key generated by Xfinity, Inc. for each d3VIEW
installation