There are three main ways to install MunkiReport: Download the release, using git, and using the Docker container. There are advantages and disadvantages to each method.

Download the Release

The most common and recommended way to install MunkiReport is to download the zip file from the releases page. This method includes all dependencies and is the most straight forward way of installing MunkiReport.

In order to update, follow the instructions on the General Upgrade Procedures page.

Using git

For those comfortable with git and who may want to develop or run the development branch (wip), this installation method may be more suitable. Because there are many dependencies in the project, when using this method php's dependency manager, Composer, must be installed and used.

To install via git, run:

git clone https://github.com/munkireport/munkireport-php.git /path/to/destination/directory

This will download the core files to the destination directory (If no destination is provided it will install to ./munkireport-php)

Once downloaded, you must run Composer from the MunkiReport directory:

composer install --no-dev --no-suggest --optimize-autoloader

To switch branches, run:

git checkout wip # or other branch_name

To switch branch to a specific tagged release:

git checkout tags/v3.2.6

Once you switch branches you will also need to run composer again to download the updated dependencies.

Useful Composer Commands

composer update --no-dev = update all dependencies to latest with no dev dependencies.
composer install --no-dev --no-suggest --optimize-autoloader = install any dependencies if they aren't already installed, again no dev, no suggested dependencies, and rebuild the cache.
composer dumpautoload --optimize --no-dev = flag to dump the composer cache and rebuild.

There are more options for Composer, but this should get you started.

Using Docker

For those comfortable with Docker, a container has been setup on DockerHub.

The Docker pull command is:

docker pull munkireport/munkireport-php

If you run Docker, you don’t need the .env config file. You can set the variables via the environment directly.