Manual Installation

AppData

SRM stores a variety of files, including configuration files, temporary files created during analyses, log files, and copies of files uploaded by the user. The root location for these files is the SRM AppData directory. You will need to create a directory to serve as the AppData directory (which will be referred to in these instructions as SRM_APPDATA). Make sure that the user running Tomcat has read-and-write privileges to SRM_APPDATA.

Move both codedx.props and logback.xml into SRM_APPDATA.

The user that Tomcat will be running as will need to have full access to the appdata folder. Since sensitive data may be stored here as well, it is recommended that access to this folder be restricted via disk permissions as well as access restrictions to the machine SRM will be running on.

Database

Create a new, empty database for SRM to use and create a user for SRM with SELECT, INSERT, UPDATE, DELETE, CREATE, CREATE TEMPORARY TABLES, ALTER, REFERENCES, INDEX, DROP, TRIGGER permissions on the database.

For example,

CREATE USER 'srm'@'%' IDENTIFIED BY 'enter-a-password-here';
CREATE DATABASE srm;
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, CREATE TEMPORARY TABLES, ALTER, REFERENCES, INDEX, DROP, TRIGGER ON codedx.* to 'srm'@'%';
FLUSH PRIVILEGES;

Edit the codedx.props file to reflect your new database and the credentials required to connect to it. For example,

swa.db.url = jdbc:mysql://localhost/srm
swa.db.user = srm_username
swa.db.password = srm_user_password

Tomcat

Drop the srm.war file into Tomcat's webapps directory. (You can also deploy it via Tomcat's manager interface if you prefer).

You also need to add a property to let the SRM app know the value of SRM_APPDATA. You will need to set a value for the Java property codedx.appdata. You will also need to add -Dcodedx.appdata=SRM_APPDATA to the list of CATALINA_OPTS values. (Where that's done is system-dependent: see the Tomcat Documentation for details.) Alternatively, you can define a SRM_APPDATA environment variable with this value, if you'd prefer that to configuring CATALINA_OPTS.

Additionally, you will need to ensure that the JVM will use UTF-8 as its file encoding. Doing so prevents issues with Japanese user input like comments and manual results. Add -Dfile.encoding=UTF-8 to the list of CATALINA_OPTS values.

Now when you start Tomcat, SRM will be able to access the codedx.props file.

Configuration

To make Tomcat stop reporting about cache issues, edit conf/context.xml and add <Resources cachingAllowed="true" cacheMaxSize="128000" /> inside the <Context>.

It is also recommended to edit conf/server.xml and raise the value of Connector connectionUploadTimeout, if applicable. This is set to 3600000 by default when using the SRM installer. We also recommend setting disableUploadTimeout to false. In the same file, connectionTimeout on the Connector is by default 20000 for an installation of SRM.

Further configuration may be performed per your deployment and requirements (such as configuring AJP and placing an instance of Apache HTTPD in front of Tomcat or changing the logging configuration).

Starting SRM

For version 2023.12.5 or later, if SRM is being deployed behind a proxy that is using HTTPS, it is recommended to set the prop auth.cookie.secure to true. This will allow the secure flag on the session cookie to be set and passed along through HTTPS via the proxy.

Once everything is configured, start the database and Tomcat (make sure the database is running before you start Tomcat). Open a web browser and point it at SRM (e.g., http://localhost/srm/). You will be presented with an installation screen allowing you to set the super admin username and password and initialize SRM.

You may need to add a codedx.internal-url setting to your codedx.props file. This should contain a URL that SRM can access itself at, for example http://localhost/srm/ or https://localhost/srm. This will depend on how exactly SRM is deployed.