|
|||
This document outlines the steps required to setup a Flamenco database and interface.
In this document, we do not discuss how to assign metadata descriptors to a collection; we assume that the basic classification has already occurred. Instead this document describes in simplified form, the steps necesary for creating an instance of Flamenco. Additionally, once an instance of flamenco has been setup, additional items can be added using the Flamenco Item Addition Interface.
Flamenco Architecture
Before going over the software and code required to run an instance of Flamenco, the architecture is briefly discussed here for a better understanding of the system. It is encouraged to read this portion, though ultimately not critical. This section mostly describes the non-code components of the Flamenco Architecture. The curious reader looking to learn more about the Flamenco code, should look to the code for additional information.
Blocks in color are part of Flamenco; blocks in grey are not. Names of
Python modules are shown in a monospaced font.
Flamenco,
Shasta, FrankenMatrix, etc. |
FlamencoStyle
| |||||||||
components |
InterfaceBase
| |||||||||
metadb |
Page |
logging |
Style | |||||||
query |
lucene |
html |
store |
css | ||||||
| Lucene | MySQLdb |
Webkit | MySQLdb |
|||||||
| Java | MySQL | MySQL | ||||||||
| CONTENT | USER INTERFACE | UI PERSISTENCE | ||||||||
Data about facets and item information lie in a database. In our installation this database is MySQL, though any ODBC compliant database should work. A module is required to allow python to communicate with this database. In our setup, our module of choice is MySQLdb. This module is included along with a compatible version of python in the Flamenco distribution. On the Content side, there is also a reliance on Java and Lucene. This dependency is optional and only needed if lucene is used as the indexer for the textual search component of Flamenco. As a first installation, consider using the built-in indexing features of MySQL. To allow python to run over cgi, a package called Webkit is used. The installation files for Webkit are included in the flamenco distributable and the package is installed once for each instance. An instance is basically the combination of a "look" and the data for a collection. Typically, each instance will have an instance specific code file (specifying the "look") and its own database of relevant information. During the setup process, you will be prompted for code and instance information.
*System Administrator Support
A number of the steps required for installing Flamenco may require the assistance of your system administrator or someone with root privelages. These items are marked with a "*".
Next: Obtain the necessary software and code
Questions? Comments? Contact Kevin Li (kevinli@sims.berkeley.edu)