Install with Vagrant

This installation method uses Vagrant to provision a VirtualBox virtual machine (VM). The authoring tool is automatically installed and configured on Vagrant's ubuntu/trusty64. Once installed, simple commands are used to start and stop the VM. When the VM is running, the authoring tool is accessible through a web browser.

If you would prefer to manually install the authoring tool and its prerequisites, please reference the Developer's Install.

Creating the Vagrant Installation

If you're unfamiliar with using a terminal or command prompt window, have a look at our Just Enough Command Line for Installing page first.

1. Install Vagrant.

   • After installing, ensure that Vagrant appears in the PATH. For Windows, in command prompt window type PATH. For Mac, in terminal type echo $PATH. If Vagrant is not present in the PATH, restart your computer and check again. Reinstall Vagrant if still not present.

2. Install VirtualBox the platform packages (the extension pack is not needed).

   • Concerned about the warning about Oracle VM VirtualBox 5.0.12 Networking feature? Read https://forums.virtualbox.org/viewtopic.php?f=3&t=15769
   • Uncheck "Start Oracle VM VirtualBox after installation". Vagrant will start VirtualBox at the appropriate time.

3. Get the latest release of the Authoring Tool code by one of the following methods

   • Download and decompress/unzip an archive file from the GitHub repository, OR
   • Use git to clone the repository:
     1. cd to the desired folder.
     2. Run git clone https://github.com/adaptlearning/adapt_authoring.git
        Note: To upgrade the Adapt Authoring Tool to a newer version, you must use the git clone option.

4. Launch a terminal window (or command prompt) and cd into the adapt_authoring directory you have just downloaded. (Windows users: it is essential that you launch command prompt as an Administrator.)

5. Run the command vagrant up. (Windows users: during this process you may receive prompts from your firewall software, to which you must allow access, as installation will fail if the VM cannot access the internet to download the required dependencies.) Installation times will vary according to the quality of your internet connection and system hardware. Please allow up to 30 minutes for setup to complete. Errors reported during set-up are not always an indication of a failed installation.

6. Installation has successfully completed when you see the following:

   Adapt Authoring Tool is running on: http://localhost:5000
   username: admin
   password: password

The virtual machine is now running in the background. It cannot be seen.
7. Open a browser and navigate to http://localhost:5000
8. Login with the following credentials:

 E-mail address: admin
 Password: password

At this point you do not need to keep your terminal/command prompt window open.
8. When you want to shut down, open a terminal/command prompt window, if necessary, and cd into the adapt_authoring directory and run the command vagrant halt.

Running the Authoring Tool in a Vagrant Installation

To start:

1. Open a terminal/command prompt window.
2. cd into the adapt_authoring directory.
3. Run the command vagrant up.
4. Open a browser in your Vagrant/VirtualBox environment and navigate to http://localhost:5000
5. Login to the authoring tool. Once logged in, you may close the terminal/command prompt window.

To end:

1. Log out of the authoring tool.
2. Open a terminal/command prompt window.
3. cd into the adapt_authoring directory.
4. Run the command vagrant halt.

Troubleshooting Installation

• Some module dependencies will report an error and then resolve them. Please do not conclude too quickly that the installation has failed.
• If after running the vagrant up command the installation freezes or terminates with an error, run vagrant halt to ensure the VM is no longer running. If the command line prompt is inaccessible, press Ctrl+c to regain the prompt, then run vagrant halt.
• To clear out a failed installation, use one of the following commands as appropriate to your situation: vagrant destroy or vagrant box remove NAME.
• On a clean install of Windows 10 you may get this error: The box 'ubuntu/trusty64' could not be found or could not be accessed in the remote catalog. To resolve this you may need to install Microsoft Visual C++ Redistributable.