Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Install/Verify you have Java 1.7

    Include Page
    Install Java 1.7+
    Install Java 1.7+
  2. Install/Verify you have MySQL 5.1 or later 

    Include Page
    Install MySQL 5.1
    Install MySQL 5.1
  3. Setup Sakai DB (schema) and user

    1. Create the sakai database and sakai user (password=ironchef)
    2. Run the following from a command line prompt:

      No Format
      mysql -uroot -pmysqlpwd1
      
      • Note: You can also do the following if you prefer to be prompted for the password: mysql -uroot -p
    3. Then run these commands from the mysql prompt (one command per line):

      No Format
      create database sakai default character set utf8;
      grant all privileges on sakai.* to 'sakai'@'localhost' identified by 'ironchef';
      grant all privileges on sakai.* to 'sakai'@'127.0.0.1' identified by 'ironchef';
      flush privileges;
      quit
      
    4. [Optional] Download and install mysql query browser
      1. http://dev.mysql.com/downloads/query-browser/1.1.html
      2. You do not have to do anything with query browser now
  4. Download and setup Maven 2.2.x+ stable package

    Include Page
    Install Maven 2.2+
    Install Maven 2.2+
  5. Install/Verify you have Subversion

    Include Page
    Install Subversion
    Install Subversion
  6. Download and setup tomcat 7.0.21+ (stable only)

    Include Page
    Install Tomcat 7 / 8
    Install Tomcat 7 / 8
  7. Download and setup MySQL Connector/J stable

    Include Page
    Install Mysql Connector 5+
    Install Mysql Connector 5+
  8. Use Subversion to download sakai code (Sakai 10 and earlier) or use Git/Github to download sakai code (Sakai 11 and later)

    1. Change to the /opt directory
    2. Checkout source from trunk (absolute latest stuff) or a release branch or tag:
      1. Trunk: svn checkout https://source.sakaiproject.org/svn/sakai/trunk/ sakai-trunk
      2. 2.9.x Branch: svn checkout https://source.sakaiproject.org/svn/sakai/branches/sakai-2.9.x/

        Tip
        titleAlternative Sakai 2.9.x repository

        Should you run into errors related to missing dependencies when building source from the above repository with Maven (Step 11 below), attempt to checkout from https://source.sakaiproject.org/svn/sakai/branches/sakai-2.9.x-all instead

      3. If you want a version other than these, browse the tags and branches at https://source.sakaiproject.org/svn/sakai/
    3. Checkout will take about 5-10 minutes
    4. The directory created by subversion will be referred to as <sakai-src> directory (this could be whatever you want; above examples use 'sakai-trunk' and 'sakai-2.9.x')
  9. Setup sakai.properties file

    1. Create sakaidirectory in $CATALINA_HOME
      • $CATALINA_HOME should be /opt/tomcat if you have been following these instructions
    2. Copy the default config from default.sakai.properties to $CATALINA_HOME/sakai/sakai.properties
    3. Edit the sakai.properties file for a MySQL dev environment. Starting at the section marked # DATABASE:
      1. Set BaseDataSource username
        1. Set username@javax.sql.BaseDataSource=sakai
      2. Set BaseDataSource password
        1. Set password@javax.sql.BaseDataSource=ironchef
      3. Find the section: # HSQLDB settings and verify following lines are commented out

        No Format
        # HSQLDB settings (DEFAULT)                                                                                                                               
        #vendor@org.sakaiproject.db.api.SqlService=hsqldb
        #driverClassName@javax.sql.BaseDataSource=org.hsqldb.jdbcDriver
        #hibernate.dialect=org.hibernate.dialect.HSQLDialect
        #validationQuery@javax.sql.BaseDataSource=select 1 from INFORMATION_SCHEMA.SYSTEM_USERS
        # Two hsqldb storage options: first for in-memory (no persistence between runs), second for disk based.
        #url@javax.sql.BaseDataSource=jdbc:hsqldb:mem:sakai
        #url@javax.sql.BaseDataSource=jdbc:hsqldb:file:${sakai.home}db/sakai.db
        
      4. Find the section: # MySQL settings and uncomment the 6+ lines in it

        No Format
        # MySQL settings
        vendor@org.sakaiproject.db.api.SqlService=mysql
        driverClassName@javax.sql.BaseDataSource=com.mysql.jdbc.Driver
        hibernate.dialect=org.hibernate.dialect.MySQL5InnoDBDialect
        url@javax.sql.BaseDataSource=jdbc:mysql://127.0.0.1:3306/sakai?useUnicode=true&characterEncoding=UTF-8
        validationQuery@javax.sql.BaseDataSource=select 1 from DUAL
        defaultTransactionIsolationString@javax.sql.BaseDataSource=TRANSACTION_READ_COMMITTED
        
    4. Save the changes to the sakai.properties file

       

  10. Create maven settings.xml file

    Include Page
    Maven 2.x settings.xml file
    Maven 2.x settings.xml file
  11. Use Maven to build Sakai

    1. Open a command line shell
    2. Change directory to /opt/<sakai-src>
    3. Execute mvn clean install to build Sakai using maven
      • Note: The build will take an extra 5-10 minutes to download dependencies the first time
    4. Execute mvn sakai:deploy to deploy Sakai to your tomcat using maven
    5. Partial builds are supported by the maven2 build system
      You can now do a "mvn clean install sakai:deploy" from any subdirectory and build just that code
    6. Once you have downloded the jars you can run maven off-line with mvn -o clean install sakai:deploy
  12. Start Tomcat and check to make sure Sakai runs

    1. Start tomcat using $CATALINA_HOME/bin/startup

      Tip
      titleViewing an active launch log in Linux

      If you are in Linux you can view the activity log as its generated by using "# ./catalina.sh run" from Tomcat's bin directory instead of startup.sh. This is helpful for viewing potential errors as they happen or to know if Tomcat has locked-up during a launch. A launch will have completed when "INFO: Server startup in xxxx ms" is displayed in the terminal.

    2. Allow 1 minute+ for tomcat to start up
    3. Open http://localhost:8080/ to verify tomcat is running
    4. Open http://localhost:8080/portal to verify sakai is running
    5. Login to sakai as username:admin, password:admin
    6. Shutdown Tomcat using $CATALINA_HOME/bin/shutdown
  13. Install Eclipse 3.2+ stable

    Include Page
    Install Eclipse 3.2+
    Install Eclipse 3.2+
  14. Add subclipse to Eclipse

    Include Page
    Install Subclipse
    Install Subclipse
  15. Add Maven Eclipse Plugin to Eclipse

    Include Page
    Install Maven Eclipse Plugin
    Install Maven Eclipse Plugin
  16. Add Lombok plugin to Eclipse [OPTIONAL]

    1. Shutdown eclipse
    2. Follow the steps on the page linked above
    3. Restart eclipse
    • NOTE: this is only required for certain parts of the code that use the lombok library (a limited set)
  17. Import Sakai source code into Eclipse

    Include Page
    Import Sakai source into Eclipse
    Import Sakai source into Eclipse