Toggle navigation
Dataverse Project
About
About the Project
Add Data
Blog
Presentations
Publications
Community
Best Practices
Academic Credit
Harvard Dataverse Policies
Data Management
Replication Dataset Guidelines
Software
Features
Source Code
User Guide
Installation Guide
API Guide
Developer Guide
Style Guide
Admin Guide
Contact
User Guide
Admin Guide
API Guide
Installation Guide
Introduction
Preparation
Prerequisites
Installation
Configuration
Upgrading
TwoRavens
Geoconnect
Shibboleth
OAuth Login: ORCID, GitHub, Google
External Tools
Advanced Installation
Developer Guide
Style Guide
Installation Guide
ΒΆ
Contents:
Introduction
Quick Links
Intended Audience
Related Guides
Getting Help
Improving this Guide
Preparation
Choose Your Own Installation Adventure
Vagrant (for Testing Only)
Pilot Installation
Advanced Installation
Architecture and Components
Required Components
Optional Components
System Requirements
Hardware Requirements
Software Requirements
Decisions to Make
Next Steps
Prerequisites
Linux
Java
Installing Java
Glassfish
Installing Glassfish
Launching Glassfish on system boot
PostgreSQL
Installing PostgreSQL
Configuring Database Access for the Dataverse Application (and the Dataverse Installer)
Solr
Installing Solr
Solr Init Script
Securing Solr
jq
Installing jq
ImageMagick
Installing and configuring ImageMagick
R
Installing R
Installing the required R libraries
Rserve
Counter Processor
Installing Counter Processor
Installing Counter Processor Python Requirements
Next Steps
Installation
Running the Dataverse Installer
Logging In
Superuser Account
Troubleshooting
Dataset Cannot Be Published
Problems Sending Email
Mail Host Configuration & Authentication
UnknownHostException While Deploying
Fresh Reinstall
Drop database
Clear Solr
Deleting Uploaded Files
Rerun Installer
Configuration
Securing Your Installation
Changing the Superuser Password
Blocking API Endpoints
Forcing HTTPS
Privacy Considerations
Email Privacy
Additional Recommendations
Run Glassfish as a User Other Than Root
Enforce Strong Passwords for User Accounts
Network Ports
Root Dataverse Permissions
Persistent Identifiers and Publishing Datasets
Configuring Dataverse for DOIs
Configuring Dataverse for Handles
Auth Modes: Local vs. Remote vs. Both
File Storage: Local Filesystem vs. Swift vs. S3
Swift Storage
Setting up Compute
Amazon S3 Storage (or Compatible)
First: Set Up Accounts and Access Credentials
Preparation When Using Amazon’s S3 Service
Preparation When Using Custom S3-Compatible Service
Reported Working S3-Compatible Storage
Manually Set Up Credentials File
Console Commands to Set Up Access Configuration
Second: Configure Dataverse to use S3 Storage
S3 Storage Options
Branding Your Installation
Custom Homepage
Custom Navbar Logo
Custom Header
Custom Footer
Custom Stylesheet
Web Analytics Code
Tracking Button Clicks
DuraCloud/Chronopolis Integration
Going Live: Launching Your Production Deployment
Letting Search Engines Crawl Your Installation
Ensure robots.txt Is Not Blocking Search Engines
Creating a Sitemap and Submitting it to Search Engines
Putting Your Dataverse Installation on the Map at dataverse.org
Administration of Your Dataverse Installation
Setting Up Integrations
JVM Options
dataverse.fqdn
dataverse.siteUrl
dataverse.files.directory
dataverse.auth.password-reset-timeout-in-minutes
dataverse.rserve.host
dataverse.rserve.port
dataverse.rserve.user
dataverse.rserve.tempdir
dataverse.rserve.password
dataverse.dropbox.key
dataverse.path.imagemagick.convert
dataverse.dataAccess.thumbnail.image.limit
dataverse.dataAccess.thumbnail.pdf.limit
doi.baseurlstring
doi.username
doi.password
dataverse.handlenet.admcredfile
dataverse.handlenet.admprivphrase
dataverse.handlenet.index
dataverse.timerServer
dataverse.lang.directory
dataverse.files.hide-schema-dot-org-download-urls
Database Settings
:BlockedApiPolicy
:BlockedApiEndpoints
:BlockedApiKey
BuiltinUsers.KEY
:SearchApiRequiresToken
:SystemEmail
:HomePageCustomizationFile
:LogoCustomizationFile
:HeaderCustomizationFile
:DisableRootDataverseTheme
:FooterCustomizationFile
:StyleCustomizationFile
:WebAnalyticsCode
:FooterCopyright
:DoiProvider
:Protocol
:Authority
:Shoulder
:IdentifierGenerationStyle
:DataFilePIDFormat
:FilePIDsEnabled
:IndependentHandleService
:ApplicationTermsOfUse
:ApplicationPrivacyPolicyUrl
:ApiTermsOfUse
:ExcludeEmailFromExport
:NavbarAboutUrl
:GuidesBaseUrl
:GuidesVersion
:NavbarSupportUrl
:MetricsUrl
:StatusMessageHeader
:StatusMessageText
:MaxFileUploadSizeInBytes
:ZipDownloadLimit
:TabularIngestSizeLimit
:ZipUploadFilesLimit
:SolrHostColonPort
:SolrFullTextIndexing
:SolrMaxFileSizeForFullTextIndexing
:SignUpUrl
:TwoRavensUrl
:TwoRavensTabularView
:GeoconnectCreateEditMaps
:GeoconnectViewMaps
:DatasetPublishPopupCustomText
:DatasetPublishPopupCustomTextOnAllVersions
:SearchHighlightFragmentSize
:ScrubMigrationData
:MinutesUntilConfirmEmailTokenExpires
:DefaultAuthProvider
:AllowSignUp
:FileFixityChecksumAlgorithm
:PVMinLength
:PVMaxLength
:PVNumberOfConsecutiveDigitsAllowed
:PVCharacterRules
:PVNumberOfCharacteristics
:PVDictionaries
:PVGoodStrength
:PVCustomPasswordResetAlertMessage
:ShibPassiveLoginEnabled
:ComputeBaseUrl
:CloudEnvironmentName
:PublicInstall
:DataCaptureModuleUrl
:RepositoryStorageAbstractionLayerUrl
:UploadMethods
:DownloadMethods
:GuestbookResponsesPageDisplayLimit
:CustomDatasetSummaryFields
:AllowApiTokenLookupViaApi
:ProvCollectionEnabled
:MetricsCacheTimeoutMinutes
:MDCLogPath
:Languages
:InheritParentRoleAssignments
Upgrading
TwoRavens
0. Overview
1. Prerequisites
a. httpd (Apache):
b. R:
c. rApache:
d. Install the build environment for R:
2. Install Extra R Packages
3. Install the TwoRavens Application
a. download and unzip the application
b. Rename the resulting directory “dataexplore” ...
c. run the installer
d. Version conflict check (preprocess.R)
e. Enable TwoRavens Button in Dataverse
f. Perform a quick test of TwoRavens functionality
4. Appendix
I. Ports configuration discussion
II. What the r-setup.sh script does:
III. What the install.pl script does:
Geoconnect
Shibboleth
Introduction
Installation
System Requirements
Install Apache
Install Shibboleth
Enable Shibboleth Yum Repo
Install Shibboleth Via Yum
Configure Glassfish
Apply GRIZZLY-1787 Patch
Glassfish HTTP and HTTPS ports
AJP
SSLEngine Warning Workaround
Configure Apache
Enforce HTTPS
Edit Apache ssl.conf File
Configure Shibboleth
shibboleth2.xml
Specific Identity Provider(s)
Identity Federation
Shibboleth Attributes
attribute-map.xml
Shibboleth and ADFS
Disable or Reconfigure SELinux
Disable SELinux
Reconfigure SELinux to Accommodate Shibboleth
Put Type Enforcement (TE) File in misc directory
Navigate to misc directory
Run checkmodule
Run semodule_package
Run semodule
Restart Apache and Shibboleth
Configure Apache and shibd to Start at Boot
Verify DiscoFeed and Metadata URLs
Add the Shibboleth Authentication Provider to Dataverse
Exchange Metadata with Your Identity Provider
Backup sp-cert.pem and sp-key.pem Files
Debugging
Converting Accounts
Converting Local Users to Shibboleth
Converting Shibboleth Users to Local
Institution-Wide Shibboleth Groups
OAuth Login: ORCID, GitHub, Google
Introduction
Setup
Identity Provider Side
Obtain Client ID and Client Secret
Dataverse Side
ORCID Sandbox
Converting Local Users to OAuth
Converting OAuth Users to Local
External Tools
Inventory of External Tools
Downloading and Adjusting an External Tool Manifest File
Making an External Tool Available in Dataverse
Listing all External Tools in Dataverse
Removing an External Tool Available in Dataverse
Writing Your Own External Tool
Advanced Installation
Multiple Glassfish Servers
Detecting Which Glassfish Server a User Is On