<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>5. Configuring Metacat — Metacat 2.19.0 documentation</title>
<link rel="stylesheet" href="_static/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" href="_static/font-awesome/css/font-awesome.min.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/metacatui.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.19.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="Metacat 2.19.0 documentation" href="index.html" />
<link rel="prev" title="4. Downloading and Installing Metacat" href="install.html" />
<link rel="next" title="6. DataONE Member Node Support" href="dataone.html" />
</head>
<body>
<div id="metacatDocs">
<div class="banner">
<a href="index.html"><img class="logo" src="_static/metacat-logo-white.png" /></a>
<a href="index.html"><h1 class="title">Metacat: Metadata and Data Management Server</h1></a>
<img class="logo-right" src="_static/nceas-logo-white.png" />
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right">
<span id="searchbox" style="display: none;">
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" class="icon-search"/>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</span>
</li>
<script type="text/javascript">$('#searchbox').show(0);</script>
<li class="right">
<a href="genindex.html" title="General Index"
accesskey="I">index</a>
</li>
<li class="right">
<a href="dataone.html" title="6. DataONE Member Node Support"
accesskey="N">next</a>
</li>
<li class="right">
<a href="install.html" title="4. Downloading and Installing Metacat"
accesskey="P">previous</a>
</li>
<li class="breadcrumb first"><a href="index.html">Metacat 2.19.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="configuring-metacat">
<h1><a class="toc-backref" href="#id15">5. Configuring Metacat</a><a class="headerlink" href="#configuring-metacat" title="Permalink to this headline">¶</a></h1>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#configuring-metacat" id="id15">Configuring Metacat</a><ul>
<li><a class="reference internal" href="#initial-configuration" id="id16">Initial Configuration</a><ul>
<li><a class="reference internal" href="#back-up-configuration" id="id17">Back-up Configuration</a></li>
<li><a class="reference internal" href="#authentication-configuration" id="id18">Authentication Configuration</a></li>
<li><a class="reference internal" href="#changing-authentication-configuration-without-authentication" id="id19">Changing Authentication Configuration without Authentication</a></li>
</ul>
</li>
<li><a class="reference internal" href="#logging-in-to-metacat" id="id20">Logging in to Metacat</a></li>
<li><a class="reference internal" href="#required-configuration" id="id21">Required Configuration</a><ul>
<li><a class="reference internal" href="#global-properties-server-ports-etc" id="id22">Global Properties (server, ports, etc)</a></li>
<li><a class="reference internal" href="#id1" id="id23">Authentication Configuration</a></li>
<li><a class="reference internal" href="#skins-configuration" id="id24">Skins Configuration</a><ul>
<li><a class="reference internal" href="#metacatui-themes" id="id25">MetacatUI Themes</a></li>
<li><a class="reference internal" href="#skins" id="id26">Skins</a></li>
</ul>
</li>
<li><a class="reference internal" href="#database-configuration" id="id27">Database Configuration</a><ul>
<li><a class="reference internal" href="#new-installation" id="id28">New Installation</a></li>
<li><a class="reference internal" href="#upgrade" id="id29">Upgrade</a></li>
</ul>
</li>
<li><a class="reference internal" href="#solr-server-configuration" id="id30">Solr Server Configuration</a><ul>
<li><a class="reference internal" href="#troubleshooting" id="id31">Troubleshooting</a></li>
</ul>
</li>
<li><a class="reference internal" href="#geoserver-configuration" id="id32">Geoserver Configuration</a></li>
<li><a class="reference internal" href="#dataone-configuration" id="id33">DataONE Configuration</a></li>
<li><a class="reference internal" href="#replication-configuration" id="id34">Replication Configuration</a></li>
<li><a class="reference internal" href="#ezid-configuration" id="id35">EZID Configuration</a></li>
</ul>
</li>
<li><a class="reference internal" href="#additional-configuration" id="id36">Additional Configuration</a><ul>
<li><a class="reference internal" href="#the-metacat-properties-file" id="id37">The <code class="docutils literal"><span class="pre">metacat.properties</span></code> file</a></li>
<li><a class="reference internal" href="#skin-name-properties" id="id38"><SKIN_NAME>.properties</a></li>
<li><a class="reference internal" href="#additional-configuration-for-tomcat-7" id="id39">Additional configuration for Tomcat 7</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<p>When Metacat (Tomcat) is started, the Metacat servlet checks to see if it is
configured. If not, Metacat will automatically send you to the configuration
pages.</p>
<p>If the installation is new, or the previous version is before 1.9.0, pay close
attention to the configuration values. If you have upgraded Metacat, and the
previous version is 1.9.0 or later, Metacat will pull existing configuration
settings from a backup location. You should still verify that the values are
correct.</p>
<p>To access your Metacat, open a Web browser and type:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">http</span><span class="p">:</span><span class="o">//<</span><span class="n">your_context_url</span><span class="o">></span>
</pre></div>
</div>
<p>Where <your_context_url> is the URL of the server hosting the Metacat followed
by the name of the WAR file (i.e., the application context) that you installed.
For instance, the context URL for the KNB Metacat is: <a class="reference external" href="http://knb.ecoinformatics.org/knb">http://knb.ecoinformatics.org/knb</a></p>
<p>You can always open the configuration screen from within Metacat by typing:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">http</span><span class="p">:</span><span class="o">//<</span><span class="n">your_context_url</span><span class="o">>/</span><span class="n">admin</span>
</pre></div>
</div>
<div class="section" id="initial-configuration">
<h2><a class="toc-backref" href="#id16">5.1. Initial Configuration</a><a class="headerlink" href="#initial-configuration" title="Permalink to this headline">¶</a></h2>
<p>Before you can log in to the Metacat and configure it, you are required to
confirm Metacat’s back-up location and authentication configuration (if not
already configured). Metacat will automatically attempt to locate an existing
back-up directory, but you may need to correct the value or specify a directory
(if the installation is new, or if Metacat was unable to determine the location
of an existing back-up directory). The authentication configuration is required
for logging in to the Metacat and for defining administrative accounts.
Instructions for <a class="reference internal" href="#changing-authentication-configuration-without-authentication">Changing Authentication Configuration without Authentication</a>
are included at the end of this section.</p>
<div class="section" id="back-up-configuration">
<h3><a class="toc-backref" href="#id17">5.1.1. Back-up Configuration</a><a class="headerlink" href="#back-up-configuration" title="Permalink to this headline">¶</a></h3>
<p>To preserve its configuration settings, Metacat backs up crucial configuration details to
a directory outside the application directories. Because a new installation/upgrade
does not know where this external directory is, Metacat uses a discovery
algorithm to locate it. If Metacat cannot identify a backup directory, you will
see the Backup Directory Configuration screen.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If the metacat.properties file has many custom settings, it should be manually
backed up before any Metacat upgrade as deploying a new Metacat war file will overwrite
the existing file.</p>
</div>
<div class="figure align-center" id="id2">
<img alt="_images/image011.png" src="_images/image011.png" />
<p class="caption"><span class="caption-text">Configuring the Backup Directory.</span></p>
</div>
</div>
<div class="section" id="authentication-configuration">
<h3><a class="toc-backref" href="#id18">5.1.2. Authentication Configuration</a><a class="headerlink" href="#authentication-configuration" title="Permalink to this headline">¶</a></h3>
<p>Whether you are installing or upgrading the Metacat servlet, you will
automatically be sent to the Authentication Configuration page. You can also
reach the Authentication Configuration page from a running Metacat by typing:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">http</span><span class="p">:</span><span class="o">//<</span><span class="n">your_context_url</span><span class="o">>/</span><span class="n">admin</span>
</pre></div>
</div>
<p>Metacat uses either an internal password file or LDAP as its authentication mechanism.
You can choose the authentication mechanism by selecting either AuthFile or AuthLdap class.
We will only allow trusted partners to access the NCEAS LDAP server to ensure the security of our user base.
If you are not in the trusted partner list, you may choose the internal password file authentication
or set up your own LDAP server. You also can define your own authentication mechanism by creating a Java
class that implements <code class="docutils literal"><span class="pre">AuthInterface</span></code>.</p>
<p>Required configuration values for the password file authentication are:</p>
<blockquote>
<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Authentication</span> <span class="n">Class</span>
<span class="n">Metacat</span> <span class="n">Administrators</span>
<span class="n">Users</span> <span class="n">Management</span> <span class="n">URL</span>
<span class="n">Password</span> <span class="n">File</span> <span class="n">Path</span><span class="o">.</span>
</pre></div>
</div>
</div></blockquote>
<p>Required configuration values for LDAP authentication are:</p>
<blockquote>
<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Authentication</span> <span class="n">Class</span>
<span class="n">Metacat</span> <span class="n">Administrators</span>
<span class="n">Users</span> <span class="n">Management</span> <span class="n">URL</span>
<span class="n">Authentication</span> <span class="n">URL</span>
<span class="n">Authentication</span> <span class="n">Secure</span> <span class="n">URL</span><span class="o">.</span>
</pre></div>
</div>
</div></blockquote>
<p>Make sure that your user account information is entered into the Metacat
Administrators field (e.g., uid=daigle,o=nceas,dc=ecoinformatics,dc=org). You
will not be allowed to continue with configuration if this is missing. Multiple
accounts can be entered, separated by the colon (:) character.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">To create an account on the password file, please see the section called <a class="reference internal" href="authinterface.html"><span class="doc">Metacat Authentication Mechanism</span></a>.
To create an LDAP account on the KNB LDAP server (specified as the default LDAP server),
go to <a class="reference external" href="https://identity.nceas.ucsb.edu">https://identity.nceas.ucsb.edu</a> and select the “create a new user account†link.</p>
</div>
<p>If you make changes to the authentication settings, you must restart Tomcat to
put them into effect.</p>
<div class="figure align-center" id="id3">
<img alt="_images/image071.png" src="_images/image071.png" />
<p class="caption"><span class="caption-text">Configuring Password File Authentication Values.</span></p>
</div>
<div class="figure align-center" id="id4">
<img alt="_images/image009.png" src="_images/image009.png" />
<p class="caption"><span class="caption-text">Configuring LDAP Authentication Values.</span></p>
</div>
</div>
<div class="section" id="changing-authentication-configuration-without-authentication">
<h3><a class="toc-backref" href="#id19">5.1.3. Changing Authentication Configuration without Authentication</a><a class="headerlink" href="#changing-authentication-configuration-without-authentication" title="Permalink to this headline">¶</a></h3>
<p>If you need to change or add authentication information and cannot authenticate
using the existing authentication settings (e.g., the existing Metacat
administrator is no longer available or you forgot the administrator password),
you must edit the Metacat configuration file by hand. This ensures that only a
person who has access to the Metacat server and the configuration files on that
server will be able to change the administrator accounts.</p>
<p>To edit the authentication configuration file:</p>
<ol class="arabic simple">
<li>Stop Tomcat and edit the Metacat properties (<code class="docutils literal"><span class="pre">metacat.properties</span></code>) file in the
Metacat context directory inside the Tomcat application directory. The
Metacat context directory is the name of the application (usually metacat):</li>
</ol>
<blockquote>
<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">tomcat_app_dir</span><span class="o">>/<</span><span class="n">context_dir</span><span class="o">>/</span><span class="n">WEB</span><span class="o">-</span><span class="n">INF</span><span class="o">/</span><span class="n">metacat</span><span class="o">.</span><span class="n">properties</span>
</pre></div>
</div>
</div></blockquote>
<ol class="arabic simple" start="2">
<li>Change the following properties appropriately:</li>
</ol>
<blockquote>
<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">auth</span><span class="o">.</span><span class="n">administrators</span> <span class="o">-</span> <span class="n">a</span> <span class="n">colon</span> <span class="n">separated</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">administrators</span>
<span class="n">auth</span><span class="o">.</span><span class="n">url</span> <span class="o">-</span> <span class="n">the</span> <span class="n">authentication</span> <span class="n">server</span> <span class="n">URL</span>
<span class="n">auth</span><span class="o">.</span><span class="n">surl</span> <span class="o">-</span> <span class="n">the</span> <span class="n">authentication</span> <span class="n">secure</span> <span class="n">server</span> <span class="n">URL</span>
<span class="n">auth</span><span class="o">.</span><span class="n">file</span><span class="o">.</span><span class="n">path</span> <span class="o">-</span> <span class="n">the</span> <span class="n">authentication</span> <span class="n">password</span> <span class="n">file</span> <span class="n">path</span>
</pre></div>
</div>
</div></blockquote>
<ol class="arabic simple" start="3">
<li>Save the <code class="docutils literal"><span class="pre">metacat.properties</span></code> file and start Tomcat.</li>
</ol>
</div>
</div>
<div class="section" id="logging-in-to-metacat">
<h2><a class="toc-backref" href="#id20">5.2. Logging in to Metacat</a><a class="headerlink" href="#logging-in-to-metacat" title="Permalink to this headline">¶</a></h2>
<p>In order to configure Metacat, you must log in with an administrative account
that has been configured in the Authentication Configuration settings. If you
did not set up the correct administrative user there, you must change the
authentication configuration by hand before you can log in.</p>
<p>In the log-in screen enter your user name and password and click
the “Login†button.</p>
<div class="figure align-center" id="id5">
<img alt="_images/image015.png" src="_images/image015.png" />
<p class="caption"><span class="caption-text">Logging into Metacat.</span></p>
</div>
</div>
<div class="section" id="required-configuration">
<h2><a class="toc-backref" href="#id21">5.3. Required Configuration</a><a class="headerlink" href="#required-configuration" title="Permalink to this headline">¶</a></h2>
<p>All required Metacat settings can be accessed from the Metacat Configuration
utility, which becomes available after the initial configurations
have been specified and an authorized administrator logs in.</p>
<div class="figure align-center" id="id6">
<img alt="_images/image017.png" src="_images/image017.png" />
<p class="caption"><span class="caption-text">Metacat configuration menu, showing each configuration section. Once all
sections are marked as green <code class="docutils literal"><span class="pre">configured</span></code>, metacat can be accessed.</span></p>
</div>
<p>The configuration settings are grouped into five sections (Metacat Global
Properties, Authentication Configuration, Skins Specific Properties, Database
Installation/Upgrade, Geoserver, DataONE, and Replication Configuration),
each of which is listed with its current status (see table).</p>
<table border="1" class="docutils">
<colgroup>
<col width="19%" />
<col width="81%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Status</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>unconfigured</td>
<td>The section has yet to be configured</td>
</tr>
<tr class="row-odd"><td>configured</td>
<td>The section has been configured.</td>
</tr>
<tr class="row-even"><td>bypassed</td>
<td>The administrator
can choose not to configure or skip the section.</td>
</tr>
</tbody>
</table>
<p>To the right of each configuration section is one of the following options:
Configure Now, Reconfigure Now, Configure Global Properties First, or
Version:X.X.X. If the option is linked (e.g., Configure Now or Reconfigure Now),
you can select the link to open the associated configuration settings and edit them.
If the option is not linked (e.g., Configure Global
Properties First), the settings cannot be specified until the global properties
are set. Once the global properties are configured, the option to configure this
section becomes available. The Version:X.X.X option is used only for the
Database Installation/Upgrade section. If the database schema version detected
by Metacat matches the application version (eg, 1.9.0), then no further database
configuration is required.</p>
<p>All settings must be in a configured or bypassed state in order to run Metacat.
For new installations or upgrades, click the “go to metacat†link that appears
after configuration is complete to go directly to Metacat. Note that Metacat
indexes at start-up time, so the initial start-up may take some time depending
on the amount of data in your database and wheter or not you have opted to regenerate the spatial cache.
If you are reconfiguring a running
version of Metacat, you must restart the Tomcat server for the changes to
take effect.</p>
<div class="figure align-center" id="id7">
<img alt="_images/image019.png" src="_images/image019.png" />
<p class="caption"><span class="caption-text">The Metacat settings as they appear after having been configured.</span></p>
</div>
<div class="section" id="global-properties-server-ports-etc">
<h3><a class="toc-backref" href="#id22">5.3.1. Global Properties (server, ports, etc)</a><a class="headerlink" href="#global-properties-server-ports-etc" title="Permalink to this headline">¶</a></h3>
<p>The Metacat configurations included under Global Properties represent the bulk
of the settings required to run Metacat. Click a blue question-mark
icon beside any setting for detailed instructions. More information about each
property is also included in the <a class="reference internal" href="metacat-properties.html"><span class="doc">Appendix: Metacat Properties</span></a>.</p>
<div class="figure align-center" id="id8">
<img alt="_images/image021.png" src="_images/image021.png" />
<p class="caption"><span class="caption-text">The Metacat Global Properties editing screen.</span></p>
</div>
<p>When you save global properties, Metacat also saves a back-up file that is
located in <code class="docutils literal"><span class="pre">/var/metacat/.metacat</span></code> (on Linux). When you update Metacat,
the system automatically locates the back-up file so you do not have to re-enter
the configuration settings.</p>
<p>The first time you install Metacat, the system attempts to automatically detect
the values for a number of settings (see table). It is important to ensure that
these values are correct.</p>
<table border="1" class="docutils">
<colgroup>
<col width="21%" />
<col width="79%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Metacat Context</td>
<td>The name of the deployed Metacat WAR file (minus the .war
extension). E.g., “metacatâ€</td>
</tr>
<tr class="row-odd"><td>Server Name</td>
<td>The DNS name of the server hosting Metacat, not including
port numbers or the protocol (“<a class="reference external" href="http://">http://</a>â€).</td>
</tr>
<tr class="row-even"><td>HTTP Port</td>
<td>The non-secure port where Metacat will be available.</td>
</tr>
<tr class="row-odd"><td>HTTP SSL Port</td>
<td>The secure port where Metacat will be available.</td>
</tr>
<tr class="row-even"><td>Deploy Location</td>
<td>The directory where the application is deployed.</td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>The Solr Home directory you choose should be writable/readable by the user solr.</p>
<p>The Environment Overwrites File should be writable/readable by the user tomcat8.</p>
<p class="last">The section of Tomcat And Solr User Management on the <a class="reference external" href="./install.html#solr-server">Solr installation page</a> will resolve this issue.</p>
</div>
</div>
<div class="section" id="id1">
<h3><a class="toc-backref" href="#id23">5.3.2. Authentication Configuration</a><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<p>Because you must specify the Authentication settings before you can access the
main configuration page, the settings will always be configured when you view
them in the admin interface. If you wish to change the authentication settings,
you must restart Metacat to put the changes into effect. For more information
about the Authentication configurations, please see Initial Configurations.</p>
</div>
<div class="section" id="skins-configuration">
<h3><a class="toc-backref" href="#id24">5.3.3. Skins Configuration</a><a class="headerlink" href="#skins-configuration" title="Permalink to this headline">¶</a></h3>
<p>Customizing the look and feel of Metacat’s web interface is done via skins or
MetacatUI themes, however as of Version 2.2.0, skins have been deprecated.
Use MetacatUI themes instead. Themes can be deployed separately from the
Metacat server allowing easier independent user interface customization.</p>
<div class="section" id="metacatui-themes">
<h4><a class="toc-backref" href="#id25">5.3.3.1. MetacatUI Themes</a><a class="headerlink" href="#metacatui-themes" title="Permalink to this headline">¶</a></h4>
<p>Themes are applied in the Skins Configuration section. If you have installed
the optional Registry, which provides a web interface for creating, editing,
and submitting content to Metacat, you can also choose which form fields
appear in that interface and which are required. Note that if you do not have
a custom theme AND you are not using the Registry, you can simply save the
<code class="docutils literal"><span class="pre">metacatui</span></code> default configuration.</p>
<p>To use the new MetacatUI theming system, select <code class="docutils literal"><span class="pre">metacatui</span></code> and click the
<code class="docutils literal"><span class="pre">Make</span> <span class="pre">metacatui</span> <span class="pre">default</span></code> radio button. Metacat will open a list of options
that apply to the Registry interface. For more information about creating
custom themes, see the section called <a class="reference internal" href="themes.html"><span class="doc">Modifying and Creating Themes</span></a>.</p>
<div class="figure align-center" id="id9">
<img alt="_images/image070.png" src="_images/image070.png" />
<p class="caption"><span class="caption-text">Configuring Metacat themes.</span></p>
</div>
</div>
<div class="section" id="skins">
<h4><a class="toc-backref" href="#id26">5.3.3.2. Skins</a><a class="headerlink" href="#skins" title="Permalink to this headline">¶</a></h4>
<p>If your Metacat has a customized skin, it will appear as a choice in the
Skins Configuration settings (see below screenshot). Select the checkbox next
to your customized skin or and click the <code class="docutils literal"><span class="pre">Make</span> <span class="pre"><skin_name></span> <span class="pre">default</span></code> radio button.
If you do not have a custom skin, select the <code class="docutils literal"><span class="pre">default</span></code> skin.</p>
<p>Once you have selected a skin, Metacat will open a list of options that apply to the Registry
interface. For more information about creating skins, see the Creating a Custom Skin
section in <a class="reference internal" href="themes.html"><span class="doc">Modifying and Creating Themes</span></a>.</p>
<div class="figure align-center" id="id10">
<img alt="_images/image023.png" src="_images/image023.png" />
<p class="caption"><span class="caption-text">Configuring Metacat skins.</span></p>
</div>
<p>Select the checkbox next to your customized skin or and click the
<code class="docutils literal"><span class="pre">Make</span> <span class="pre"><skin_name></span> <span class="pre">default</span></code> radio button. If you do not have a custom skin,
select the <code class="docutils literal"><span class="pre">default</span></code> skin. Once you have selected a skin, Metacat will open
a list of options that apply to the Registry interface.</p>
<p>Select the lists and modules that you would like to appear in the Registry
form-interface by checking the box beside each. When you save the configuration,
the customized interface will appear to site visitors.</p>
</div>
</div>
<div class="section" id="database-configuration">
<h3><a class="toc-backref" href="#id27">5.3.4. Database Configuration</a><a class="headerlink" href="#database-configuration" title="Permalink to this headline">¶</a></h3>
<p>Because the Database Configuration is dependent on values specified in the
Global Properties section, the link to these settings does not become active
until after the global settings have been saved. Once the global settings have
been saved, Metacat automatically detects the database schema version and
upgrades it if necessary (and with your permission).</p>
<ul class="simple">
<li>New Installation</li>
<li>Upgrade</li>
</ul>
<div class="section" id="new-installation">
<h4><a class="toc-backref" href="#id28">5.3.4.1. New Installation</a><a class="headerlink" href="#new-installation" title="Permalink to this headline">¶</a></h4>
<p>If Metacat determines that your database is new, the Database Install/Upgrade
utility lists the SQL scripts that will run in order to create a database
schema for the new version of Metacat.</p>
<div class="figure align-center" id="id11">
<img alt="_images/image027.png" src="_images/image027.png" />
<p class="caption"><span class="caption-text">Database installation creates tables needed for Metacat.</span></p>
</div>
<p>If the database is not new, or if you have any questions about whether it is
new or not, choose Cancel and contact support at <a class="reference external" href="mailto:knb-help%40nceas.ucsb.edu">knb-help<span>@</span>nceas<span>.</span>ucsb<span>.</span>edu</a>.</p>
<p>When you choose Continue, Metacat runs the listed scripts and creates the
database schema.</p>
</div>
<div class="section" id="upgrade">
<h4><a class="toc-backref" href="#id29">5.3.4.2. Upgrade</a><a class="headerlink" href="#upgrade" title="Permalink to this headline">¶</a></h4>
<p>If Metacat identifies a previous database schema, the Database Install/Upgrade
utility notes the existing version and lists the SQL scripts that will run in
order to update the schema for the new version of Metacat.</p>
<p>If the detected schema version is incorrect, or if you have any questions about
whether it is correct or not, click the Cancel button and contact support at
<a class="reference external" href="mailto:knb-help%40nceas.ucsb.edu.When">knb-help<span>@</span>nceas<span>.</span>ucsb<span>.</span>edu<span>.</span>When</a> you choose to continue, Metacat runs the listed
scripts and updates the database schema.</p>
<div class="figure align-center" id="id12">
<img alt="_images/image029.png" src="_images/image029.png" />
<p class="caption"><span class="caption-text">Upgrading an existing database.</span></p>
</div>
<p>Additional upgrade tasks may also run after the database upgrade is complete.
For systems hosting large amounts of data, these upgrade routines can take time to complete.
It is important to let the process complete before using Metacat otherwise your deployment may become unstable.</p>
</div>
</div>
<div class="section" id="solr-server-configuration">
<h3><a class="toc-backref" href="#id30">5.3.5. Solr Server Configuration</a><a class="headerlink" href="#solr-server-configuration" title="Permalink to this headline">¶</a></h3>
<p>Because the Solr Server Configuration is dependent on values specified in the
Global Properties section, the link to these settings does not become active
until after the global settings have been saved. Once the global settings have
been saved, Metacat automatically detects the status of the Solr Core and creates
or upgrades it if necessary (and with your permission).</p>
<div class="figure align-center">
<img alt="_images/image073.png" src="_images/image073.png" />
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Solr server should be running when you configure Metacat.</p>
</div>
<div class="section" id="troubleshooting">
<h4><a class="toc-backref" href="#id31">5.3.5.1. Troubleshooting</a><a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h4>
<p>If you click the Solr Configuration button and get the error message like
<code class="docutils literal"><span class="pre">Server</span> <span class="pre">refused</span> <span class="pre">connection</span> <span class="pre">at:</span> <span class="pre">http://localhost:8983/solr</span></code>, this means the
Solr server is not running and you need to start it.</p>
<p>If you click the Create button to create the Solr core and get an error message
like <code class="docutils literal"><span class="pre">Couldn't</span> <span class="pre">persist</span> <span class="pre">core</span> <span class="pre">properties</span> <span class="pre">to</span> <span class="pre">/var/metacat/solr-home2/</span></code>, this means
the solr user doesn’t have the write permission to the Solr Home directory. You need
to add the solr user to the tomcat group, restart Solr server and Tomcat, log in again
and continue to configure Metacat. The instructions for adding users to groups can be found in the
Tomcat And Solr User Management part of the <a class="reference external" href="./install.html#solr-server">Solr installation page</a>.</p>
</div>
</div>
<div class="section" id="geoserver-configuration">
<h3><a class="toc-backref" href="#id32">5.3.6. Geoserver Configuration</a><a class="headerlink" href="#geoserver-configuration" title="Permalink to this headline">¶</a></h3>
<div class="sidebar">
<p class="first sidebar-title">Manual Geoserver Update</p>
<p>Alternatively, you can change the Geoserver username and password manually by
directly logging in to the Geoserver. To configure the credentials manually:</p>
<ol class="last arabic simple">
<li>Go to the Geoserver admin page: <a class="reference external" href="http:/">http:/</a>/<your_context_url>/geoserver/</li>
<li>Log in using the default username and password ( admin / geoserver )</li>
<li>Navigate to the Password Change Page. Enter a new user and password and click Submit.</li>
<li>Click Apply then Save to save your new password.</li>
</ol>
</div>
<p>Metacat comes bundled with a Web Mapping Service called Geoserver, which
converts spatial data into Web-deliverable map images. Geoserver installs with
a default administrative username and password. <em>We highly recommend that you
change the default credentials so that only local administrators can make
changes to your Geoserver.</em> For more information about Geoserver,
see <a class="reference internal" href="geoserver.html"><span class="doc">Metacat’s Use of Geoserver</span></a>.</p>
<p>When you choose the Geoserver Configuration link from the main configuration
screen, Metacat will prompt you for a few important details about your Geoserver
installation. The data directory and context settings allow Geoserver and
Metacat to share the same spatial data store and render maps within Metacat skins.
The security configuration prompts for a new admin password. After you enter
the new settings, Metacat writes the information to the Geoserver deployment.</p>
<p>The default settings are typically appropriate for most Metacat deployments,
but if you wish to skip the Geoserver configuration, click the Bypass button.
Geoserver (if deployed) will remain with a default configuration and the main
Metacat configuration screen will display the “bypassed†status beside the
Geoserver settings. You will be able to run Metacat, but maps will not be
rendered.</p>
<div class="figure align-center" id="id13">
<img alt="_images/image031.png" src="_images/image031.png" />
<p class="caption"><span class="caption-text">Configuring Geoserver.</span></p>
</div>
</div>
<div class="section" id="dataone-configuration">
<h3><a class="toc-backref" href="#id33">5.3.7. DataONE Configuration</a><a class="headerlink" href="#dataone-configuration" title="Permalink to this headline">¶</a></h3>
<p>Metacat can be configured to operate as a Member Node within the DataONE
federation of data repositories. See <a class="reference internal" href="dataone.html"><span class="doc">DataONE Member Node Support</span></a> for background and details
on DataONE and details about configuring Metacat to act as a DataONE Member Node.</p>
</div>
<div class="section" id="replication-configuration">
<h3><a class="toc-backref" href="#id34">5.3.8. Replication Configuration</a><a class="headerlink" href="#replication-configuration" title="Permalink to this headline">¶</a></h3>
<p>Metacat can be configured to replicate its metadata and/or data content to another
Metacat instance for backup and redundancy purposes, as well as to share data across
sites. This feature has been used to create the Knowledge Network for Biocomplexity
(KNB), as well as other networks. See <a class="reference internal" href="replication.html"><span class="doc">Replication</span></a> for details on
the replication system and how to configure Metacat to replicate with another node.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Note that much of the functionality provided by the replication subsystem in Metacat
has now been generalized and standardized by DataONE, so consider utilizing the
DataONE services for replication as it is a more general and standardized approach
than this Metacat-specific replication system. The Metacat replication system
will be supported for a while longer, but will likely be deprecated in a future
release in favor of using the DataONE replication approach.</p>
</div>
</div>
<div class="section" id="ezid-configuration">
<h3><a class="toc-backref" href="#id35">5.3.9. EZID Configuration</a><a class="headerlink" href="#ezid-configuration" title="Permalink to this headline">¶</a></h3>
<p>Metacat can be configured to assign Digital Object Identifiers (DOIs) to metadata/data objects
through a EZID service. Click a blue question-mark icon beside any setting for detailed instructions.
More information about each property is also included in the <a class="reference internal" href="metacat-properties.html"><span class="doc">Appendix: Metacat Properties</span></a>.</p>
<div class="figure align-center" id="id14">
<img alt="_images/image072.png" src="_images/image072.png" />
<p class="caption"><span class="caption-text">Configuring EZID service.</span></p>
</div>
</div>
</div>
<div class="section" id="additional-configuration">
<h2><a class="toc-backref" href="#id36">5.4. Additional Configuration</a><a class="headerlink" href="#additional-configuration" title="Permalink to this headline">¶</a></h2>
<p>The most dynamic Metacat properties are managed and modified with the
form-based Metacat Configuration utility. These configuration properties can
also be accessed directly (along with additional static properties) via
Metacat’s property files: <code class="docutils literal"><span class="pre">metacat.properties</span></code> (which contains global
properties, e.g., authorization and database values) and
<code class="docutils literal"><span class="pre"><SKIN_NAME>.properties</span></code> (which contains skin-specific properties). Each of
these property files is discussed in more depth in this section.</p>
<div class="section" id="the-metacat-properties-file">
<h3><a class="toc-backref" href="#id37">5.4.1. The <code class="docutils literal"><span class="pre">metacat.properties</span></code> file</a><a class="headerlink" href="#the-metacat-properties-file" title="Permalink to this headline">¶</a></h3>
<p>Metacat’s <code class="docutils literal"><span class="pre">metacat.properties</span></code> file contains all of Metacat’s global
properties, both the dynamic properties, which are managed with the
Configuration utility, as well as the more static properties, which can only
be modified manually in this file. The <code class="docutils literal"><span class="pre">metacat.properties</span></code> file also contains
optional properties that are only relevant when optional Metacat features
(such as the harvester or replication) are enabled. The `
<cite>metacat.properties file`</cite> is found here:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">CONTEXT_DIR</span><span class="o">>/</span><span class="n">WEB_INF</span><span class="o">/</span><span class="n">metacat</span><span class="o">.</span><span class="n">properties</span>
</pre></div>
</div>
<p>Where <code class="docutils literal"><span class="pre"><CONTEXT_DIR></span></code> is the directory in which the Metacat application code
lives (e.g., <code class="docutils literal"><span class="pre">/var/lib/tomcat7/webapps/metacat</span></code>). The path is a combination
of the Web application directory (e.g., <code class="docutils literal"><span class="pre">/var/lib/tomcat7/webapps/</span></code>) and
the Metacat context directory (e.g., <code class="docutils literal"><span class="pre">metacat</span></code>). Both values depend upon how your
system was set up during installation.</p>
<p>For information about each property and default or example settings, please
see the <a class="reference internal" href="metacat-properties.html"><span class="doc">Appendix: Metacat Properties</span></a>. Properties that can only be edited manually
in the metacat.properties file are highlighted in the appendix.</p>
</div>
<div class="section" id="skin-name-properties">
<h3><a class="toc-backref" href="#id38">5.4.2. <SKIN_NAME>.properties</a><a class="headerlink" href="#skin-name-properties" title="Permalink to this headline">¶</a></h3>
<p>The <code class="docutils literal"><span class="pre"><SKIN_NAME>.properties</span></code> file contains skin-specific properties
(e.g., template information). For each skin, the skin-specific properties are
found here:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">CONTEXT_DIR</span><span class="o">>/</span><span class="n">style</span><span class="o">/</span><span class="n">skins</span><span class="o">/<</span><span class="n">SKIN_NAME</span><span class="o">>/<</span><span class="n">SKIN_NAME</span><span class="o">>.</span><span class="n">properties</span>
</pre></div>
</div>
<p>Where <code class="docutils literal"><span class="pre"><CONTEXT_DIR></span></code> is the directory in which the Metacat application code
lives (described above) and <code class="docutils literal"><span class="pre"><SKIN_NAME></span></code> is the name of the skin
(e.g., <code class="docutils literal"><span class="pre">default</span></code> or <code class="docutils literal"><span class="pre">nceas</span></code>).</p>
</div>
<div class="section" id="additional-configuration-for-tomcat-7">
<h3><a class="toc-backref" href="#id39">5.4.3. Additional configuration for Tomcat 7</a><a class="headerlink" href="#additional-configuration-for-tomcat-7" title="Permalink to this headline">¶</a></h3>
<p>When running Metacat on Tomcat 7, you may get the following
error logging in via the Morpho application: “Fatal error sending data to Metacat: Bad Set_Cookie header:JSESSIONID=…â€.
In order to fix the issue, modify <Catalina_HOME>/conf/context.xml
(e.g., /var/lib/tomcat7/conf/context.xml) by adding a new attribute - “useHttpOnly†- and set it to false for the “Context†element:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">Context</span> <span class="n">useHttpOnly</span><span class="o">=</span><span class="s2">"false"</span><span class="o">></span>
</pre></div>
</div>
<p>Then restart Tomcat 7.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
<div class="footerNav">
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right">
<span id="searchbox" style="display: none;">
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" class="icon-search"/>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</span>
</li>
<script type="text/javascript">$('#searchbox').show(0);</script>
<li class="right">
<a href="genindex.html" title="General Index"
>index</a>
</li>
<li class="right">
<a href="dataone.html" title="6. DataONE Member Node Support"
>next</a>
</li>
<li class="right">
<a href="install.html" title="4. Downloading and Installing Metacat"
>previous</a>
</li>
<li class="breadcrumb first"><a href="index.html">Metacat 2.19.0 documentation</a> »</li>
</ul>
</div>
</div>
<div class="small-print">
© Copyright 2012, Regents of the University of California.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.6.7.
</div>
</div>
</div>
</body>
</html>