Installing Oppia

If you are looking for more elaborate instructions on how to get started with Oppia, go to setting things up. If you get stuck somewhere and need help please refer to our Getting Help Page.

Note that throughout our wiki, we use the following notations:

• $ represents a command prompt that is not root. For example, if we want you to type the command python into your terminal, you'll see $ python. This distinguishes commands (which are prefixed with $) from output from those commands (whose lines are not prefixed with $).
• # represents a root command prompt. For example, # apt-get install python means to run apt-get install python as root (e.g. using sudo).
• ... indicates where we've omitted content for the sake of brevity.

We also assume that readers (and all Oppia developers) are familiar with the following:

• Standard Unix path notation, including ~ as an abbreviation for the home directory.
• Creating and editing text files, including hidden files. Be careful with using graphical editors like Notepad in Windows. These can add carriage returns (\r) that confuse our Linux-based development tools. Instead, we recommend using editors designed for programming or command-line text editors.
• Basic Unix commands like ls, cat, echo, cd, etc.
• Using git.

If you need to learn or brush up on these, please do so before trying to start the installation so you don't get confused by our instructions.

Installation using Docker

To install Oppia using Docker, follow these instructions:

• Oppia Docker Setup

If you run into any problems during installation, please read these notes and the Troubleshooting page.

Take a look at our guide for getting started with some common code editors.

If you still face problems, you can open a new discussion in discussions page.

Python setup (soon to be depreciated)

This setup is soon to be discontinued, please use Docker setup below.

To install Oppia, follow these instructions:

• Linux
• Mac OS
• Windows

Warning: You should always edit Oppia code on your local machine. Do not use web-based editors like github.dev or the editor on github.com. These web-based editors won't run the automated checks that run on your local machine. Pushing without these checks just means that the tests will fail on your PR.