Skip to content

A set of docker images and containers running open-release/ginkgo.master version of Open edX

License

Notifications You must be signed in to change notification settings

vkaracic/edx-ginkgo-docker

Repository files navigation

edx-ginkgo-docker

A dockerized version of Open edX running open-release/ginkgo.master version. (Only LMS, Studio and Forum for now)

Requirements:

docker (version 17.09 or higher)
docker-compose (version 1.17.1 or higher)

Installation

Before installation

Export the CONTAINER_PREFIX environment variable to differentiate container between projects (default is edx):

export CONTAINER_PREFIX=<project_name>

If you want to build your own images rename karacic/<image_name> with <username>/<image_name>.

Now your edxapp image will be named <username>/<CONTAINER_PREFIX>-ginkgo.master. If you haven't renamed the image in the Makefile file, the edxapp image will be named karacic/<CONTAINER_PREFIX>-ginkgo.master.

Installation

Installation steps:

  1. make build.base
  2. make build.edxapp
  3. make build.elasticsearch
  4. make build.forum
  5. make clone

In your edx-platform folder search for edx.devstack. term. Change those instance with your CONTAINER_PREFIX value. Most of them are related to tests which you can skip if you don't intend to run tests.

Installation steps continued:

  1. make provision
  2. docker-compose stop
  3. make up

The provision step will create a new .env file that contains the CONTAINER_PREFIX and COMPOSE_PROJECT_NAME variables so that you don't need to export it every time you start up the containers.

Theming

You will notice that a new edx-themes directory has been created next to the cloned edx-platform directory. That directory is mapped to /edx-themes in the LMS and Studio containers. With that information continue following these instruction on how to apply a new theme.

Troubleshooting

In case the CSS is missing in either LMS or Studio, you can run make static to rebuild the static assets for both.

Bug reporting

I would very much appreciate any bug reports, so if you find a bug please open an issue for it.

About

A set of docker images and containers running open-release/ginkgo.master version of Open edX

Resources

License

Stars

Watchers

Forks

Packages

No packages published