egaia config

Set, print, or edit variables in configuration files.

Usage

egaia config --help
egaia config --defaults
egaia config --new [ --path=FILE ]
egaia config --update [ --section=SECTION ] [ --path=FILE ]
egaia config --get [ --section=SECTION ] [ --key=KEY ]
egaia config --set=KEY:VALUE... [ --section=SECTION ] [ --path=FILE ]

Options

--help

Show this help text and exit.

--new

Dump all current values to a new config file. This will be in the user config directory, written to ~/.config/egaia/shared.cfg by default, unless a different file is specified with --path. If a file ~/.config/egaia/local.cfg exists, any values in that file will override the default settings from shared.cfg; this is to allow switching of configuration settings between different archives or localized versions of the same archive, when managed on the same system, by copying local settings into local.cfg (e.g., cp english.cfg ~/.config/egaia/local.cfg).

--update

Interactively update configuration values in a specified section of a given configuration file.

--get

Print all set variables from the files recognized by egaia.

--path FILE

Create or edit configuration FILE.

--section SECTION

Show or edit values for SECTION [default: archive]

--key KEY

Show only the value for the given key.

--set KEY:VALUE

Set VALUE as the value for the specified KEY.

--defaults

Print the default configuration values (i.e., the values that will be used when no configuration files are set). Unlike the --new option, this flag will provide a string that includes comments indicating the function of each variable.

Configuration file sections

system

This section contains the paths to executable programs, directories, etc. on the computer on which egaia is installed.

archive

This section includes the name, address, and catalogue generation settings for the archive.

terms

This section lists the metadata terms and their localized / customized labels in use in the archive. The list is extensible, but includes by default all the terms in the Dublin Core terms namespace, <http://dublincore.org/documents/dcmi-terms/>. The labels may be used as html template variables, in urls, and as keys in json. Caution: changing the label for a term that is already in use will break metadata parsing, and may require manual updating in item descriptions through a global find-and-replace.

Note that the keys are case-sensitive, but labels may be converted to title case or lowercase by the application depending on the context.

prefixes

This section includes base URIs for metadata terms in RDF output; by default this is only DCTERMS.

template_fields

This section lists the non-metadata variables used in html templates. These are included here in order to enable end-user localization or extension.

For further information on setting up and configuring the archive, see the “install” page in the egaia manual.