These are minimal instructions for customizing ERDDAP and are intended to get you up and running quickly so that you can test out ERDDAP.
Configuration files overview
datasets/– Sample datasets. This is where you put your source data files to be loaded in ERDDAP.
Starting with ERDDAP v2.13, ERDDAP administrators can override any value in setup.xml by specifying an environment
ERDDAP_valueName before running ERDDAP. For example, use
ERDDAP_baseUrl overrides the
config.sh script assists with setting those environment variables. Below are some of the configurations
you may want to set up.
For the initial setup, you MUST at least change these settings:
<baseHttpsUrl>when you set up https)
Configure administrator information
The settings below contain information about the ERDDAP administrator and is used for the SOS and WMS servers.
<admin.*> tags by setting:
ERDDAP_adminInstitution="" ERDDAP_adminInstitutionUrl="" ERDDAP_adminIndividualName="" ERDDAP_adminPosition="" ERDDAP_adminPhone="+1 ###-###-####" ERDDAP_adminAddress="" ERDDAP_adminCity="" ERDDAP_adminStateOrProvince="" ERDDAP_adminPostalCode="" ERDDAP_adminCountry="" ERDDAP_adminEmail=""
Email account information is used for sending emails to the
addresses and for sending emails related to subscriptions. So if you don’t setup the email system, your ERDDAP
won’t support subscriptions (including allowing other ERDDAP’s to subscribe to datasets on your ERDDAP).
If you don’t want your ERDDAP to send emails, change the
emailSmtpHost tag contents to be nothing.
It is a security risk to put your email password in a plain text file like this. To mitigate that problem, we strongly recommend that you:
- Set up an email account just for ERDDAP’s use, e.g., erddap@yourInstitution.org That has other benefits as well: more than one ERDDAP administrator can then be given access to that email account.
- Make the permissions of this
rw(read+write) for the user who will run Tomcat and ERDDAP (user=tomcat?) and no permissions (not read or write) for the group and other users.
emailProperties is a list of additional properties in the form
prop1|value1|prop2|value2. The default is nothing.
To configure the email address update the
<emailEverythingTo> tags by setting:
ERDDAP_emailEverythingTo="" ERDDAP_emailDailyReportsTo="" ERDDAP_emailFromAddress="" ERDDAP_emailUserName="" ERDDAP_emailPassword="" ERDDAP_emailProperties="" ERDDAP_emailSmtpHost="" ERDDAP_emailSmtpPort=""
For example, with NOAA email accounts would use the following settings:
ERDDAP_emailSmtpHost="http://smtp.gmail.com/" ERDDAP_emailSmtpPort="587" ERDDAP_emailProperties="mail.smtp.starttls.enable|true"
Update for your domain
baseUrl - is the start of the public url, to which “/erddap” is appended. For example, when running/testing on your
baseHttpsUrl - this is a variant of
baseUrl which is used when authentication is active and the user is logged in.
More details can be found at https://coastwatch.pfeg.noaa.gov/erddap/download/setup.html#security.
flagKeyKey - ERDDAP has a service that lets remote users set a flag to notify ERDDAP to try to reload a dataset. These
requests use a key which is generated based on baseUrl/erddap, a datasetID, and flagKeyKey. CHANGE THIS ONCE, to any
text (a favorite quote? random text? Whatever you want.). Normally, you won’t ever change this again. But if you think
someone is abusing the flag system, change this text again, restart ERDDAP, and send all of the users of the flag system
the relevant new flagKeys (see the list in the Daily Report).
<flagKeyKey> to match your domain by setting:
ERDDAP_baseUrl="" ERDDAP_baseHttpsUrl="" ERDDAP_flagKeyKey=""