From 4488f2760392b07cb981ef2f5c5a627c2d16e02e Mon Sep 17 00:00:00 2001 From: Derek Crosson Date: Tue, 14 Dec 2021 20:27:20 +0200 Subject: [PATCH 1/3] chore: update android app repository url --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 78c2a2b..0605bb4 100644 --- a/README.rst +++ b/README.rst @@ -48,7 +48,7 @@ Features * 100% `open source `__ * Runs entirely on Docker * World-famous 1-click `installation and upgrades `__ -* Comes with batteries included: `theming `__, `SCORM `__, `HTTPS `__, `web-based administration interface `__, `mobile app `__, `custom translations `__... +* Comes with batteries included: `theming `__, `SCORM `__, `HTTPS `__, `web-based administration interface `__, `mobile app `__, `custom translations `__... * Extensible architecture with `plugins `__ * Works with `Kubernetes `__ * Amazing premium plugins available in the `Tutor Wizard Edition `__, including `Cairn `__ the next-generation analytics solution for Open edX. From c240aec711d44551aaf7c312d4eded0c97bcf409 Mon Sep 17 00:00:00 2001 From: Braden MacDonald Date: Wed, 15 Dec 2021 12:12:31 -0800 Subject: [PATCH 2/3] docs: Document how to run Tutor on ARM-based systems --- docs/tutorials.rst | 1 + docs/tutorials/arm64.rst | 67 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 docs/tutorials/arm64.rst diff --git a/docs/tutorials.rst b/docs/tutorials.rst index 5f9dfea..b8a9f2d 100644 --- a/docs/tutorials.rst +++ b/docs/tutorials.rst @@ -25,5 +25,6 @@ System administration tutorials/datamigration tutorials/multiplatforms tutorials/oldreleases + tutorials/arm64 Other tutorials can be found in the official Tutor forums, `in the "Tutorials" category `__. diff --git a/docs/tutorials/arm64.rst b/docs/tutorials/arm64.rst new file mode 100644 index 0000000..babd6fe --- /dev/null +++ b/docs/tutorials/arm64.rst @@ -0,0 +1,67 @@ +.. _arm64: + +Running Tutor on ARM based Systems +================================== + +Tutor can be used on ARM64 systems, although support for that platform is currently experimental. + +There are generally two ways to run Tutor on am ARM system - using qemu to run x86_64 images using emulation or running native ARM images. Since emulation can be quite slow, this Tutorial will focus on using native images where possible. + +There are currently no official ARM64 images provided for Tutor, but Tutor makes it easy to build them yourself. + +Building the images +------------------- + +Start by :ref:`installing ` Tutor and its depdencies (e.g. Docker) onto your system. + +.. note:: For Open edX developers, if you want to use the :ref:`nightly ` version of Tutor to "run master", install Tutor using git and check out the ``nightly`` branch of Tutor at this point. See the :ref:`nightly documentation ` for details. + +Next, configure Tutor:: + + tutor config save --interactive + +Go through the configuration process, answering each question. + +Then, build the Open edX image:: + + tutor images build openedx + +If you want to use Tutor as an Open edX development environment, you should also build the development images:: + + # If you are using a regular Tutor release: + tutor images build openedx-dev + # Or if you are using Tutor nightly: + tutor dev dc build lms + +Change the database server +-------------------------- + +The version of MySQL that Open edX uses by default does not support the ARM architecture. Our current recommendation is to use MariaDB instead, which should be largely compatible. + +.. warning:: + Note that using MariaDB is experimental and incompatibilites may exist, so this should only be used for local development - not for production instances. + +Configure Tutor to use MariaDB:: + + tutor config save --set DOCKER_IMAGE_MYSQL=mariadb:10.4 + +Finish setup and start Tutor +---------------------------- + +From this point on, use Tutor as normal. + +For example, to apply migrations and start Open edX:: + + tutor local init + tutor local start + +Or for a development environment:: + + tutor local init + tutor local stop + tutor dev start + +Using with tutor-mfe +-------------------- + +You may wish to use `tutor-mfe `_ to run the Open edX microfrontends. If so, be aware that there is a known issue with ``tutor-mfe`` on ARM systems. See `this GitHub issue `_ for details and known workarounds. From dbb79c0fa08457c3b04e426a609157de21bd3dbe Mon Sep 17 00:00:00 2001 From: Braden MacDonald Date: Mon, 20 Dec 2021 12:28:04 -0800 Subject: [PATCH 3/3] docs: Address review comments --- docs/tutorials/arm64.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/tutorials/arm64.rst b/docs/tutorials/arm64.rst index babd6fe..c8500df 100644 --- a/docs/tutorials/arm64.rst +++ b/docs/tutorials/arm64.rst @@ -1,6 +1,6 @@ .. _arm64: -Running Tutor on ARM based Systems +Running Tutor on ARM-based systems ================================== Tutor can be used on ARM64 systems, although support for that platform is currently experimental. @@ -12,7 +12,7 @@ There are currently no official ARM64 images provided for Tutor, but Tutor makes Building the images ------------------- -Start by :ref:`installing ` Tutor and its depdencies (e.g. Docker) onto your system. +Start by :ref:`installing ` Tutor and its dependencies (e.g. Docker) onto your system. .. note:: For Open edX developers, if you want to use the :ref:`nightly ` version of Tutor to "run master", install Tutor using git and check out the ``nightly`` branch of Tutor at this point. See the :ref:`nightly documentation ` for details. @@ -28,9 +28,6 @@ Then, build the Open edX image:: If you want to use Tutor as an Open edX development environment, you should also build the development images:: - # If you are using a regular Tutor release: - tutor images build openedx-dev - # Or if you are using Tutor nightly: tutor dev dc build lms Change the database server