.. include:: /includes.rst.txt

.. comments - headings

   # with overline, for parts
   * with overline, for chapters
   = for sections
   - for subsections
   ^ for subsubsections
   " for paragraphs
   * for H5
   + for H6

.. _installation_checklist:

Installation Checklist
======================

This document serves as a checklist to outline the information needed for EDG installations. 
Please use this guide to pull in appropriate IT resources and gather needed information prior to installation. 
The links in this guide will be very useful for new customers. 
Please read them completely. 

1. Read the documentation for server installation at :ref:`edg_installation_and_authentication`. 
   Details on the below items will be found in this document. 

2. Provision Tomcat server with appropriate sizing for users and data, plan for growth. 
   Follow the guidelines provided upon purchase. 
   Contact TopQuadrant support if you need a new copy of this information.

3. Decide where the workspace, properties file, and vault will be located. 
   The workspace contains configuration, connector and data files. 

4. **Ensure Tomcat has access to write to the directory for the workspace.** 
   For Debian based Linux distributions, see the `notes for using Tomcat 10 <https://salsa.debian.org/java-team/tomcat10/blob/master/debian/README.Debian>`_.

5. Server must be running supported Tomcat and Java. 
   See :ref:`edg_server_platform_considerations`

6. Decide on authentication mechanisms for end users and API clients, see :ref:`authentication_methods`.
   For SSO methods, have the required IDP details ready.

7. Decide on active database storage options. 
   TDB will be contained in the workspace.
   Data Platform will enable all EDG collections to be synced between EDG nodes. 
   See :ref:`topbraid_data_platform` for specific instructions on setting up Data Platform.
   You cannot change this later without creating a new environment workspace.

8. Implement a backup strategy for the workspace and/or database. Backup often. See :ref:`edg_backup_and_restore`.

9. If implementing more than 1 server (for instance Explorer) both should have the ability to talk to each other. 

10. Obtain the .war file and license file from TopQuadrant Jira ticketing system. 
    If the ticket is closed, you can still access it in the portal. 

11. After reading the installation guide and preparing the above information, you will be ready to deploy EDG application, setup users and rights management. 
    See :ref:`RightsManagementAdminPage` for Rights Management assistance. 
    See :ref:`edg_governance_model` for using the governance collection to control user permissions as well. 

12. Follow the rest of the :ref:`ServerAdministrationPage` guide for additional configurations in EDG. 
    Please go through the :ref:`ProductConfigurationParametersAdminPage` and the :ref:`SystemConfigurationParametersAdminPage` prior to use. 
    These have important configurations such as the :ref:`MailSettingsSection`. 

13. Highly Recommended:

  * Monitoring software (such as Splunk, Zabbix, ELK)
  * Update the log4j.xml file in EDG/WEB-INF with appropriate parameters for rollover size
  * Create a playbook/runbook for deployment and installation of EDG for future use

14. Security:

  * EDG will create temporary files (including potentially sensitive files such as uploaded documents) in the temp directory that is used by the Java VM. 
    The specific location of that can be controlled using the system property java.io.tmpdir. If the temp files are deemed a security risk, the system administrator may elect to change the temp dir location and adjust permissions accordingly.
  * Hashicorp can be used for secure storage data encryption. See :ref:`hashicorp` and :ref:`related setup field reference <setup_file_hashicorp>`
  * Several configuration settings exist to limit security risk for EDG, please check the Server Administration page in EDG and the :ref:`setup field reference <setup_file_security>` to enable/disable these settings.