Before anything else, be sure to consult our Getting Started guide for a high-level of how Materia is setup, configured, and run.

Materia on Github

The repository for the Materia application is on GitHub. You can clone it locally or fork it, but whether that’s necessary depends on your use case!

I want to use Materia in a production environment at my institution:

Review the setting up docker guide for a breakdown of how to setup and configure Materia for production. You don’t need the repo!

You might actually need the repo if you’re going to be deploying a custom docker image with your own changes built in. Let’s not sweat that just yet though.

I want to setup and run Materia quickly, just to try it out:

Go ahead and clone the repo, review the README and run the run_first_for_nondev.sh script as instructed in the README’s Setup section.

Remember that you’ll need yq installed on your machine prior to running this script. Make sure it’s the right version too.

I want to setup Materia for local development:

Clone the repo, review the README, and run the run_first_for_dev.sh script instead.