summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorRuss Allbery <rra@stanford.edu>2013-03-27 13:55:48 -0700
committerRuss Allbery <rra@stanford.edu>2013-03-27 13:56:37 -0700
commit207b1e4c59f4577b98ef74795313c5afcdd77ff0 (patch)
treedf5b40d38925fa12d66ebd819dc270d05ffe89cf /README
parentf6c63bdb2be5ccc0c6133bf87025d37805579005 (diff)
Add new requirements for the server backend
Now that we're using DBIx::Class, we need several new modules. Take a first cut at documenting them in README. Change-Id: I98e796091258633daaad4049d14bf3c5ea1e55fa Reviewed-on: https://gerrit.stanford.edu/974 Reviewed-by: Russ Allbery <rra@stanford.edu> Tested-by: Russ Allbery <rra@stanford.edu>
Diffstat (limited to 'README')
-rw-r--r--README43
1 files changed, 21 insertions, 22 deletions
diff --git a/README b/README
index 691c37f..a264f2a 100644
--- a/README
+++ b/README
@@ -64,11 +64,17 @@ REQUIREMENTS
The wallet client will build with either MIT Kerberos or Heimdal.
The wallet server is written in Perl and requires Perl 5.6.0 or later.
- It uses the Perl DBI layer to talk to a database, and therefore the DBI
- module and a DBD module for the database it will use must be installed.
- Currently, the server has only been tested against SQLite 3 and MySQL 5
- and will probably not work fully with other database backends. Porting
- is welcome.
+ It uses DBIx::Class and DBI to talk to a database, and therefore the
+ DBIx::Class and DBI modules (and their dependencies) and a DBD module
+ for the database it will use must be installed. The SQL::Translator
+ Perl module is also required for schema deployment and database
+ upgrades. If the wallet server is used with a SQLite 3 database, the
+ Perl module DateTime::Format::SQLite should also be installed.
+
+ Currently, the server has only been tested against SQLite 3, MySQL 5,
+ and PostgreSQL, and prebuilt SQL files (for database upgrades) are only
+ provided for those servers. It will probably not work fully with other
+ database backends. Porting is welcome.
The wallet server is intended to be run under remctld and use remctld to
do authentication. It can be ported to any other front-end, but doing
@@ -103,23 +109,16 @@ REQUIREMENTS
to manage DNS), the Net::Remctl Perl module must be installed on the
server.
- To run the test suite, you must have Perl 5.8 or later and the Perl DBI
- module installed. You will also need a DBD module installed for the
- database backend you want to use (currently, either DBD::SQLite or
- DBD::mysql). The other modules are available from CPAN and may be
- available as part of your OS (many Linux distributions have them as
- packages, for example).
-
- To run the full test suite, additionally all of the above software
- requirements must be met. Tests requiring some bit of software that's
- not installed should be skipped, but not all the permutations have been
- checked. The full test suite also requires the Test::Pod Perl module
- (available from CPAN), that remctld be installed and available on the
- user's path or in /usr/local/sbin or /usr/sbin, that test cases can run
- services on and connect to port 14373 on 127.0.0.1, and that kinit and
- either kvno or kgetcred (which come with Kerberos) be installed and
- available on the user's path. The full test suite also requires a local
- keytab and some additional configuration.
+ To run the full test suite, all of the above software requirements must
+ be met. Tests requiring some bit of software that's not installed
+ should be skipped, but not all the permutations have been checked. The
+ full test suite also requires the Test::Pod Perl module (available from
+ CPAN), that remctld be installed and available on the user's path or in
+ /usr/local/sbin or /usr/sbin, that test cases can run services on and
+ connect to port 14373 on 127.0.0.1, and that kinit and either kvno or
+ kgetcred (which come with Kerberos) be installed and available on the
+ user's path. The full test suite also requires a local keytab and some
+ additional configuration.
To bootstrap from a Git checkout, or if you change the Automake files
and need to regenerate Makefile.in, you will need Automake 1.11 or