Differences

This shows you the differences between two versions of the page.

--- metamod:install [2008-06-24 13:15:14]
egils
+++ metamod:install [2022-05-31 09:29:32]
@@ Line 1: / Line 1: @@
-====== How to configure and install ======
-===== Dependencies =====
-This software depends on the following external software which is not part
-of the METAMOD 2.x distribution:
-  * Linux operating system. METAMOD 2.x might work on other UNIX-like operating systems, but this is not tested.
-  * PostgreSQL database system. Tested on version 8.1
-  * Apache 2.x web server with PHP 5.x installed
-  * Perl v5.8 with the following Perl modules: File::Copy, File::Path, XML::Simple, Data::Dumper, DBI, POSIX, warnings, Geo::Proj4, Fcntl, Mail::Mailer, PDL, PDL::Char, PDL::NetCDF, integer
-  * NetCDF software: ncdump and ncgen
-===== Directory structure =====
-The top METAMOD 2.x directory
-is divided into one subdirectory for each module (base, search, upload and
-quest). In addition, one subdirectory (app) contains an example application.
-The module directories shares a common structure. During installation of an
-application, a new directory is created (the target directory), and all module
-directories are merged into this target directory. In each module directory
-there is a htdocs subdirectory. The htdocs directories for all the selected
-modules are in the same way merged into one htdocs subdirectory in the target
-directory.  To avoid name collisions, the actual HTML and PHP files etc. are
-contained within subdirectories of the htdocs directory. For example, all such
-files are contained in the directory htdocs/sch for the METAMODSEARCH module,
-and htdocs/upl for the METAMODUPLOAD module. On the target directory, there
-will be a htdocs directory containing both the sch and the upl subdirectories.
-Some htdocs subdirectories may be shared among several modules. For example,
-the METAMODBASE module and the METAMODQUEST module both have files in the adm
-subdirectory. Special care must be taken for these files to avoid name
-collisions.
-Each module directory must also contain a file 'filelist.txt' which
-lists all files comprising the module.
-The app directory contains one subdirectory for each application. In each
-of these application directories there must be a configuration file called
-'master_config.txt', and a 'filelist.txt' file containing a list of files
-that are specific for the application (image files, style sheets etc.).
-Application directories may also be found outside the METAMOD 2.x source tree.
-===== Configuration =====
-The source files within the METAMOD 2.x directories contain a variety of file
-types (PHP, Perl, XML, HTML/XHTML, CSS and shell-script files, some of
-them with embedded SQL). The source files are not intended to be used
-directly, but must be modified and copied to a target directory tree before
-the application can run. The reason for this is to apply a unified
-configuration method for all the different file types.
-An application directory must contain a file, **''master_config.txt''**, which is the master configuration file for the application:
-This file contains lines as follows:
-  VARNAME = VALUE
-'VARNAME' must be all uppercase letters [A-Z], underscore or digits. Any number
-of white space characters may separate 'VARNAME' and '=', and also '=' and
-'VALUE'. 'VALUE' starts with the first non-whitespace character and ends with
-the last non-whitespace character on the line. Additional lines may be
-appended to 'VALUE' immideately after the initial 'VARNAME = ...' line. Such
-lines must start with a space character. No whitespace are removed from such
-appended lines.
-VALUEs may be empty, which sometimes indicate that some aspect of the software
-is turned off. An empty value is indicated by having no characters (or only
-whitespace characters) after the '=' character.
-In addition, comment lines, starting with '#', may be found. Blank lines are
-ignored.
-In the source files, all text strings like:
-  [==VARNAME==]
-will be substituted with the corresponding value when the files are modified and
-moved to the target directory. Such text strings may also be found within 'VALUE'
-strings, and they will be substituted as appropriate.
-One variable is mandatory in master_config.txt: TARGET_DIRECTORY. This is the
-directory name of the target directory, the top level of the target directory
-tree.
-The following variables are used to select the modules that will comprise the
-application. They also identify the absolute path of the source directory for
-each module:
-  METAMODBASE_DIRECTORY
-  METAMODSEARCH_DIRECTORY
-  METAMODUPLOAD_DIRECTORY
-  METAMODQUEST_DIRECTORY
-If any of these variables are missing, the corresponding modules will not be part
-of the application.
-Each application delivering data to a database (an application with the
-METAMODUPLOAD and/or the METAMODQUEST module) must have a short acronym
-that uniquely identify the application for the database. This acronym is
-included in the master_config.txt file as the value of variable APPLICATION_ID.
-===== Installation =====
-To install an application, the following installation script (located in the top
-METAMOD2 directory) should be run with one argument:
-<code>
-update_target.pl application_directory
-</code>
-The argument is the absolute or relative path of the directory containing the
-''master_config.txt'' file for the application.
-For each module selected by the configuration file, there is a ''filelist.txt'' list
-of files in the corresponding module directory. The installation script will copy
-all the files in these lists to the target directory tree (given by
-''TARGET_DIRECTORY'' in the configuration file). In the same way, files in the
-application specific ''filelist.txt'' file (located in the application directory)
-will be copied to the target directory tree. If any file name collision occur
-between the module file lists and the application file list, the file in the
-application file list is used. Thus, it is possible to substitute any file
-in any module with an application specific file, although this mechanism is
-primarily meant for image files, style sheets etc. Name collisions between files
-from different modules are supposed not to occur.
-While copying the files, the script will perform all substitutions prescribed
-in the configuration file. The script will only copy files that are
-modified later than the corresponding target files (or the target file does not
-exist). Directories will be created as needed.
-If any of these files should not be substituted according to the configuration
-file (e.g. a binary file), the file name must be prepended with ''='' in
-''filelist.txt''.
-The file pathes in each ''filelist.txt'' file must all be relative to the
-corresponding top module directory (or the application directory). The copied
-files will keep these relative pathes on the the target directory.
-===== Multiple target files =====
-It is possible to use the configuration file to produce several target files
-from a single source file. This is done using the special directives:
-<code>
-!substitute_to_file_with_new_name sourcefilepath => targetfilepath
-!end_substitute_to_file_with_new_name
-</code>
-The ''sourcefilepath'' must be a relative file path found in one of the
-''filelist.txt'' files, and ''targetfilepath'' must also be a relative file path,
-but it is not required to exist in any ''filelist.txt'' file. The source file
-(given by ''sourcefilepath'') will be modified and copied to the target file
-(given by ''targetfilepath'') using the ordinary substitution directives in
-the configuration file. In addition to these substitutions, any substitution
-directive between the ''!substitute_to_file_with_new_name'' directive and the
-corresponding ''!end_substitute_to_file_with_new_name'' directive will be
-performed. Note that these substitution directives will not affect any of the
-other files produced by the installation script.
-By using these special directives several times for the same source file,
-and varying the target file name between each use, several target files are
-produced from the same source file, and they will have different content
-depending on the in-between substitution directives found for each target
-file.