EDG Server Installation

The following section detail specific instructions for running TopBraid servers on Tomcat.

Note

These are not upgrade steps. These are for new installations.

1. Ensure you are running on Java 17

2. Copy the edg-setup.properties file from the downloaded TopBraid EDG distribution zip file into the Tomcat root directory (or a location readable by Tomcat). Modify the settings in the file per the instructions found alongside the settings.

Field	Description	example
workspacePath	The workspace houses all the data for EDG. This needs to be persistent and have read/write access for Tomcat.	/var/lib/tomcat10/Workspace
endUserAuthMethod	See Authentication Methods	form
apiAuthMethods	See Authentication Methods	basic
authRealm	For HTTP Basic Authentication, sets the name in the header	TopBraid EDG
securityRoles	Security groups that align with SSO IdP groups or Tomcat users	admin,poweruser,manager,editor,viewer
Vault Type	Choice of Local or Hashicorp Vault integration determines configuration parameters. Please fill out accordingly. See EDG Integration with Hashicorp Vault for setup instructions.
licenseFile	Path to license file. Do not enter this if you want your Administrators to be able to update the license in the UI. If entered then this file will need to be updated when new licenses are provided by TopQuadrant and the server restarted.	./edg-license.lic
sessionTimeout	Tomcat session timeout in minutes	90
databaseType	Choice of database storage option, TDB or Data Platform. Additional fields will need to be entered when choosing DP. Please see descriptions Database Type: Application data storage for more details.

3. Complete any additional configuration steps required by the authentication methods chosen for endUserAuthMethod and apiAuthMethods. Refer to Authentication Methods for details.

4. Set the system property edg.setup for Tomcat to the full path of edg-setup.properties. This can be done in various ways, for example by editing Tomcat’s conf/catalina.properties file. For example: edg.setup=/var/lib/tomcat10/edg-setup.properties

   Or you can also modify the command line used to start Tomcat such as: -Dedg-setup=/var/lib/tomcat10/edg-setup.properties

5. Place the edg.war into the webapps directory in Tomcat

6. Start Tomcat

7. In EDG, Enter license if location not specified in the setup file.

8. Navigate to Server Administration, Rights Management, make sure security roles are correctly set for ANY_ROLE, administrator, etc. Initially, all users will have permissions to all EDG resources and functions via the default assignment of AdministratorGroup to ANY_ROLE. An administrator’s initial task should be to use Rights Management Admin Page to transfer the AdministratorGroup to their organization’s defined administrative role(s) and then remove it from ANY_ROLE.

9. Now navigate to the home page of EDG. Setup is complete.

   From now on this file will act as the source of your configuration settings. An administrator should now go over the Server Administration Page to make any additional adjustments to EDG. If setup was done incorrectly or is incomplete you will get a setup page instead of the EDG home page. You can always navigate to <server>/edg/tbl/setup to see your configurations.