New Site Initialisation

Install a Totara Instance

The following is basic usage for creating a new Totara instance in ~/totara-sites. You may need to adjust for older Totara versions.

Replace <directory name> with the name of new site. It needs to be URL-safe.

If you are part of the Totara team please use the internal Git repository url, otherwise please refer to our help site for more information on how to gain access to the source code. Replace the <repositoryurl> with the correct url.

1. Windows Only: The following commands need to be run from within the WSL instance (i.e Ubuntu Terminal)

2. Clone the site. If you've already cloned the site and set up your config.php, skip to step 6

   cd ~/totara-sites
   git clone <repositoryurl> <directory name>
   

3. Copy the template config.php

   cd <directory name>
   cp ~/totara-docker-dev/config.php ./
   

4. If you wish to use a different database, edit config.php to select the database you wish to use, by commenting and uncommenting lines.

5. Create a database

   tdb create
   

6. Build front end assets

   Windows/Ubuntu Commands

   npm ci && \
   npm run tui-build && \
   cd server && \
   npm ci && \
   grunt css && \
   cd ..
   

   Mac Commands

   tnpm ci && \
   tnpm run tui-build && \
   cd server && \
   tnpm ci && \
   tgrunt css && \
   cd ..
   

7. Run the site installation script

   tphp install
   

Now visit http://<directory name>.totara83.localhost/ - e.g. http://integration.totara83.localhost - happy developing!

If this page is inaccurate for integration branch due to minimum version updates or other issues, please update it.