Installing PL for local development
This page describes the procedure to install and run your course locally within Docker. You can develop course content locally following the instructions below, or using the in-browser tools.
Step 1: Install Docker Community Edition. It's free.
Step 2: Run PrairieLearn using the example course with:
docker run -it --rm -p 3000:3000 prairielearn/prairielearn
Step 3: Open a web browser and connect to http://localhost:3000/pl
Step 4: When you are finished with PrairieLearn, type Control-C on the commandline where your ran the server to stop it.
Step 5: To use your own course, use the
-vflag to bind the Docker
/coursedirectory with your own course directory (replace the precise path with your own) on Windows:
docker run -it --rm -p 3000:3000 -v C:\GitHub\pl-tam212:/course prairielearn/prairielearn
or on MacOS/Linux:
docker run -it --rm -p 3000:3000 -v /Users/mwest/git/pl-tam212:/course prairielearn/prairielearn
If you are using Docker for Windows then you will need to first give Docker permission to access the C: drive (or whichever drive your course directory is on). This can be done by right-clicking on the Docker "whale" icon in the taskbar, choosing "Settings", and granting shared access to the C: drive.
To use multiple courses, add additional
-v flags (e.g.,
-v /path/to/course:/course -v /path/to/course2:course2). There are nine available mount points in the Docker:
If you're in the root of your course directory already, you can substitute
%cd% (on Windows) or
$PWD (Linux and MacOS) for
If you plan on running externally graded questions in local development, please see this section for a slightly different docker launch command.
Upgrading your Docker's version of PrairieLearn
To obtain the latest version of PrairieLearn at any time, make sure PrairieLearn is not running (Ctrl-C it if needed) and then run:
docker pull prairielearn/prairielearn
After this, run PrairieLearn using the same commands as above.
Running a specific older version of PrairieLearn
The commands above will always run the very latest version of PrairieLearn, which might be an unreleased development version.
The list of available versions is viewable on the hub.docker build page.
To run a specific older version (e.g., version 1.2.3) then you can do:
docker run -it --rm -p 3000:3000 [other args] prairielearn/prairielearn:1.2.3