From e94fee176701c0bd1f1fee57933bf1974e1c656a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9gis=20Behmo?= Date: Mon, 26 Nov 2018 12:07:58 +0100 Subject: [PATCH] Document how to run forked edx-platform --- CHANGELOG.md | 1 + Makefile | 11 ++++++++++- README.md | 12 ++++++++++++ 3 files changed, 23 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e3af253..cc97b05 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,6 @@ # Changelog +- 2018-11-26 [Improvement] Make it easier to run a forked version of edx-platform - 2018-11-25 [Feature] Use local filesystem for open assessment file upload - 2018-11-23 [Improvement] Faster container bootstrapping without "chmod", as suggested by @silviot - 2018-11-20 [Bugfix] Fix cross-platform theme assets generation diff --git a/Makefile b/Makefile index c5c974f..e2a2601 100644 --- a/Makefile +++ b/Makefile @@ -170,8 +170,17 @@ update: ## Download most recent images $(DOCKER_COMPOSE) pull build: build-openedx build-configurator build-forum build-notes build-xqueue build-android ## Build all docker images + +openedx_build_args = +ifdef EDX_PLATFORM_REPOSITORY + openedx_build_args += --build-arg="EDX_PLATFORM_REPOSITORY=$(EDX_PLATFORM_REPOSITORY)" +endif +ifdef EDX_PLATFORM_VERSION + openedx_build_args += --build-arg="EDX_PLATFORM_VERSION=$(EDX_PLATFORM_VERSION)" +endif + build-openedx: ## Build the Open edX docker image - docker build -t regis/openedx:latest -t regis/openedx:hawthorn openedx/ + docker build -t regis/openedx:latest -t regis/openedx:hawthorn $(openedx_build_args) openedx/ build-configurator: ## Build the configurator docker image docker build -t regis/openedx-configurator:latest -t regis/openedx-configurator:hawthorn configurator/ build-forum: ## Build the forum docker image diff --git a/README.md b/README.md index aea1d94..30fbb32 100644 --- a/README.md +++ b/README.md @@ -265,6 +265,18 @@ Additional requirements can be added to the `openedx/requirements/private.txt` f make build-openedx make run +### How to run Open edX from a forked version of edx-platform? + +You may want to run your own flavor of edx-platform instead of the [official version](https://github.com/edx/edx-platform/). To do so, you will have to re-build the openedx image with the proper environment variables pointing to your repository and version: + + EDX_PLATFORM_REPOSITORY=https://mygitrepo/edx-platform.git EDX_PLATFORM_VERSION=my-tag-or-branch make build-openedx + +You can then restart the services which will now be running your forked version of edx-platform: + + make restart-openedx + +Note that your release must be a fork of Hawthorn in order to work. Otherwise, you may have important compatibility issues with other services. + ### "Cannot start service nginx: driver failed programming external connectivity" The containerized Nginx needs to listen to ports 80 and 443 on the host. If there is already a webserver, such as Apache or Nginx, running on the host, the nginx container will not be able to start. There are two solutions: