...
Warning |
---|
If you are running a SSP version prior to 1.1.1 |
...
...
, you are strongly encouraged to upgrade or otherwise apply the reporting subsystem security patches described by SSP-701. Also please take a few minutes to review additional security-related announcements detailed at the top of the SSP space here in Confluence. |
Table of Contents |
---|
Step by step instructions for building and deploying the SSP 1.1.1 release.
- Software Prerequisites (JDK, Tomcat, Maven, Ant, RDBMS)
- SSP Platform build and deployment
...
- JDK 1.6 update 21 or later (JDK 1.7 is not supported as of 2013/01)
- Download Location: http://java.sun.com (openjdk works as well)
Environment Variable: JAVA_HOME
Tip title Java Environment Variable JAVA_HOME=/path/to/your/java (ie: /usr/local/java or C:\java\jdk)
(optional)
PATH= append the bin subdirectory to the path statement
- Tomcat 6.X (Tomcat 7 is not supported as of 2013/01)
Instructions for installing and configuring Tomcat for the SSP-Platform (uPortal 4.0)
Warning title Tomcat Configuration It is important to complete sections: Environment Variables, Shared Libraries, Shared Sessions, Java Heap
...
The SSP-Platform
repository in GitHub contains the tool suite for SSP. Installation begins with cloning the repository. Two methods exist for obtaining the source files.
Zip Download | Git (requires git installation) | |||||
---|---|---|---|---|---|---|
The source files can be downloaded in a zip file
| The git application can clone the repository to a local repository
|
2. SSP Configuration Files
...
- Unix/Linux/Mac example: /usr/local/ssp
Windows example: C:\ssp\ssp-local
...
2. SSP Configuration Files
- Create a directory for the local SSP configuration files
- Example:
- Unix/Linux/Mac example: /usr/local/ssp
Windows example: C:\ssp\ssp-local
Make the directory only readable by the user that is running Tomcat
Set an Environment Variable for the local configuration file location
Tip SSP_CONFIGDIR=/path/to/your/local-configuration (ie: /usr/local/ssp/ssp-local or C:\ssp\ssp-local)
- Example:
- ssp-config.properties
- The ssp-config.properties file must be modifed for database connectivity and email settings
- File Location: github
Action: create the ssp-config.properties file in the local configuration directory (ie: C:\ssp\ssp-local)
Configuration Values:
Value Description Note system_id Unique identifier of the SSP instance db_url jdbc connection syntax For Microsoft SQL Server, either specify a port (the default is 1433) or ensure that the SQL Server Browser service is running because the SQL Server JDBC driver defaults to port 1434 which is the SQL Server Server Browser service default port. Depending on the server configuration, either may work, or you may want to explicitly specify the port and instance name, if applicable. db_driver_class jdbc database connectivity syntax db_dialect Hibernate dialect Use of one of the org.jasig.ssp.util.hibernate.ExtendedSQLServer*Dialects
is strongly encouraged if running against SQLSever. The defaultssp-config.properties
has an example.)db_username Values for connecting to the SSP database db_password Values for connecting to the SSP database db_admin_username Values for connecting to the SSP database db_admin_password Values for connecting to the SSP database db_conns_max_activeValues for the name Value for the SSP database db_conns_max_active Values for the database connection pool The default value will need to be increased for test and product db_conns_max_idle Values for the database connection pool The default value will need to be increased for test and product db_conns_max_wait Values for the database connection pool db_conns_validation_query Values for the database connection pool db_liquibase_enabled Enables the liquibase script for database table management db_liquibase_changelog Location for the liquibase change log db_liquibase_set_mssql_snapshot_isolation Parameter for configuring a MSSQL database IMPORTANT The default value is 'true'. Set this value to 'false for MSSQL. The liquibase changeset 000014.xml will be ignored. The sql above configures the database correctly. smtp_username Value for email relay smtp_password Value for email relay smtp_host Value for email relay smtp_port Value for email relay ssp_admins_email_addresses Recipient of system generated messages spring.profiles.active Deployment options - dev-standalone: completely free of uPortal
- standalone: as the only portlet in a uPortal instance
- uPortal: as one of many portlets in a uPortal instance
...
- Additional step for Microsoft SQL Server to update column types
Warning | ||
---|---|---|
| ||
Follow steps 2 & 3 from the following page to update appropriate database tables for SSP-PLATFORM |
...
- Start Tomcat and point your browser to
http://localhost:8080/ssp-platform
Click Sign In, and use the credentials user: admin password: admin
6. Production Deployment Tips
Warning title Delete Demo Users You should delete or change the passwords for the uPortal users created for demonstration purposes, especially in a production deployment. This can be done through the user interface:
Manage Users
->Find an Existing User
-> [Enter user ID from list below] -> [Click result] ->Delete
orEdit
, then change password. Demo users:- advisor0
- ken
- student0
- student1
Non-private installs should also either change the
admin
user's password or add some other user to the Portal Administrators group and delete theadmin
user.
If anything in it is incorrect or unclear, please leave a comment below.
...