Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Step by step instructions for building and deploying the SSP package.

 

  1. Software Prerequisites (JDK, Tomcat, PostgreSQL, Maven)
  2. SSP Open Source Project build and deployment

...

Software Prerequisites

The following software prerequisites must be installed to build and run SSP:

...

  • Maven 3.0.3 or later (until a general release is available, expected July 2012)

 

...

Configure and Deploy SSP

The following configurations are required for the developer environment.

1. Create Directories

 

Note
titlePrerequisite Installations

All software prerequisites should be installed into the local environment.  Make note of the locations to set the environment variables.

...

  • On Windows:
    • Create a directory at C:\ssp

    • Make it only readable by the user that is running tomcat

  • In the next step, be sure to use Windows paths formatted in Java

    • There is a context.xml file that is put into the conf directory of tomcat once the application starts.  Or you can paste it there ahead of time.

    • It is available from this project in src/main/webapp/META-INF/context.xml

    • The destination path is $CATALINA_HOME/conf/context.xml

2. Modify SSP Configuration Files

  • Update the configuration files on Unix/Mac/Windows:

    • Copy the SSP source files in src/main/config/external to /usr/local/etc/ssp or C:\ssp (depending on the environment)

    • Review each file carefully to set the appropriate settings.

      • ssp-config.properties: database connectivity, users and database
        • Unique identifier of the SSP instance
          • system_id
        • Values for connecting to the SSP database
          • 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: Spring Hibernate dialectHibernate dialect (Use of one of the org.jasig.ssp.util.hibernate.ExtendedSQLServer*Dialects is strongly encouraged if running against SQLSever. The default ssp-config.properties has an example.)
          • db_username
          • db_password
          • db_admin_username
          • db_admin_password
        • Values for SSP generated emails
          • smtp_username
          • smtp_password
          • smtp_host
          • smtp_port
          • ssp_admins_email_addresses: recipient of system generated messages
        • Deployment options
          • spring.profiles.active
            • 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
      • Logging
        • To adjust where logs are sent, edit the logback.xml file.
        • Adjust the log levels for each log appender as necessary.
        • If you enable the smtpAppender (disabled by default), don't forget to update the properties file location path, in addition to uncommenting the appropriate sections in logback.xml:
          Example: <property file="/usr/local/etc/ssp/ssp-config.properties" />
        • Further details regarding managing the logback.xml are included in XML comments within the file.
  • Add the following environment variables to your system, and point them to the appropriate external configuration path:

    • On Unix/Mac:

      • SSP_CONFIGDIR=/usr/local/etc/ssp

    • On Windows:

      • SSP_CONFIGDIR=C:\ssp

    Tip
    titleAdditional Information

    Optional environment and configuration parameters are defined in the Developer Environment Setup Instructions

3. Deploy SSP

  • Currently the deployment file is not available anywhere, so it must be generated with maven.
  • Instructions for building the SSP package

...

If anything in it is incorrect or unclear, please leave a comment below.Unlicensed userAndrew Wills (Deactivated)