Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added documentation on how to adjust logging locations and levels.

...

  • 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 dialect
          • 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
        : properties file location
        • 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

...