Commit | Line | Data |
903cd6ee |
1 | |
2 | Stemmaweb - a Catalyst webservice for text tradition analysis |
3 | ============================================================= |
4 | |
369ff364 |
5 | Stemmaweb is a web application, developed in Perl (using the Catalyst framework) and Javascript (using JQuery), for analysis of the copying relationships (stemmatology) between different manuscript versions of the same text. |
903cd6ee |
6 | |
7 | |
8 | Installation |
9 | ------------ |
10 | |
11 | To run Stemmaweb you need a working Perl installation (5.12 or above) |
12 | and, preferably, a working webserver. The following steps will get you |
13 | set up to run the standalone service: |
14 | |
15 | * Ensure that the following software is installed (the list given is that of the relevant Ubuntu packages): |
16 | * gcc |
17 | * make |
18 | * libxml2-dev |
19 | * zlib1g-dev |
20 | * libexpat1-dev |
21 | * graphviz |
22 | * libssl-dev |
23 | * libgmp-dev |
24 | * Install the following Perl modules: |
25 | * App::cpanminus |
26 | * Module::Install::Catalyst |
27 | * Create a database for the storage of text tradition data. This can be anything supported by Perl's DBI. |
28 | * Install the dependencies for Stemmaweb from this directory: |
29 | |
30 | cd /PATH/TO/stemmaweb && cpanm -S --installdeps . |
31 | * Make a test directory and test the installation at http://localhost:3000/ : |
32 | |
33 | script/maketestdb.pl |
34 | script/stemmaweb_server.pl |
dde0e572 |
35 | * Replace the database settings in stemmaweb.conf with the settings for your database. If you are using MySQL, for example, the contents of the <Model Directory> stanza might look like this: |
903cd6ee |
36 | |
37 | <model_args> |
dde0e572 |
38 | dsn dbi:mysql:dbname=stemmaweb;host=DB_HOSTNAME |
903cd6ee |
39 | <extra_args> |
40 | user STEMMAWEB_USER |
41 | password STEMMAWEB_PASS |
cc8e6e62 |
42 | <dbi_attrs> |
43 | mysql_enable_utf8 1 |
44 | </dbi_attrs> |
903cd6ee |
45 | </extra_args> |
46 | </model_args> |
cc8e6e62 |
47 | |
48 | * (Optionally) configure Stemmaweb to run under FastCGI, Starman, or any other Catalyst-compatible application framework. See http://www.catalystframework.org for more information. The provided stemmaweb.psgi was written to work with Starman running behind Apache on a specified non-root URL path. |