Skip to content

openfun/openedx-comments-docker

Repository files navigation

Open edX Comment Service Docker image

A handcrafted Docker image for the Open edX comment service (aka forum).

Installation

To add this image to your Open edX stack, pull our image from DockerHub (see fundocker/forum):

$ docker pull fundocker/forum

Getting started

First things first, if you plan to work on the project itself, you will need to clone this repository:

$ git clone git@github.com:openfun/openedx-comments-docker.git

Once the project has been cloned on your machine, you will need to build the docker image for the forum and setup a development environment that includes all required services up and running (more on this later):

$ cd openedx-comments-docker
$ make bootstrap

If everything went well, you should now be able to access the following services:

with the following credentials (for the LMS):

email: admin@foex.edu
password: openedx-rox

Developer guide

Once the project has been bootstrapped (see "Getting started" section), to start working on the project, use:

$ make dev

You can stop running services via:

$ make stop

If for any reason, you need to drop databases and start with fresh ones, use the down target:

$ make down

License

The code in this repository is licensed under the AGPL-3.0 unless otherwise noted (see LICENSE for details).