Home

Requirements

Linux

Note: For Ubuntu/Debian users, you can use this easy script to install everything in one go.

1. Docker Engine
2. Docker Compose

MacOS

1. Docker Desktop plus Mutagen (install extension for better performance)
2. Alternatively: Rancher Desktop plus Mutagen (use classic approach)

*If you are on a newer Mac with M1 or M2 chip check out: Apple Silicon support

Windows

Recommended: WSL2

Alternatively: Docker Desktop + Mutagen (install extension for better performance)

Installation

Note: On Windows, these next steps will need to be done within your WSL2 Ubuntu terminal/filesystem

1. Clone this repo (e.g. to ~/docker-dev)
2. Create a directory that you can clone your Totara sites into (mkdir ~/totara-sites)
3. Clone the Totara source code (For Totara employees, see our BitBucket repository) into your site folder and give it a name (e.g. cd ~/totara-sites && git clone REPO_URL totara13)
4. In the docker folder copy the .env.dist file to .env (cp .env.dist .env)
5. Within the copied .env, set LOCAL_SRC to be the full path to your local Totara site folder (e.g. LOCAL_SRC=/home/USERNAME/totara-sites)
6. Copy the config.php file from this repo into your Totara site repo folder (or alternatively create a config.php based upon config.example.php/config.php.dist in the site root)
7. Add the bin/ folder to your paths (e.g. PATH=$PATH:/path/to/docker-dev/bin)
8. Windows Only: In an elevated Windows command prompt, run icacls C:\Windows\System32\drivers\etc\hosts /grant Users:W (required for the next step)
9. Run the tools/set_hosts.sh script from this repo to add all the required host entries to your /etc/hosts file
10. Configure your terminal to use an extended font pack (full font list available here)
11. MacOS Only: Set up Mutagen to improve performance (recommended)

Usage

See the Usage page for usage documentation.