mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-12-12 22:27:47 +00:00
Merge remote-tracking branch 'origin/master' into nightly
This commit is contained in:
commit
2a794c37b8
@ -48,7 +48,7 @@ Features
|
||||
* 100% `open source <https://github.com/overhangio/tutor>`__
|
||||
* Runs entirely on Docker
|
||||
* World-famous 1-click `installation and upgrades <https://docs.tutor.overhang.io/install.html>`__
|
||||
* Comes with batteries included: `theming <https://github.com/overhangio/indigo>`__, `SCORM <https://github.com/overhangio/openedx-scorm-xblock>`__, `HTTPS <https://docs.tutor.overhang.io/configuration.html#ssl-tls-certificates-for-https-access>`__, `web-based administration interface <https://github.com/overhangio/tutor-webui>`__, `mobile app <https://github.com/tutor/tutor-android>`__, `custom translations <https://docs.tutor.overhang.io/configuration.html#adding-custom-translations>`__...
|
||||
* Comes with batteries included: `theming <https://github.com/overhangio/indigo>`__, `SCORM <https://github.com/overhangio/openedx-scorm-xblock>`__, `HTTPS <https://docs.tutor.overhang.io/configuration.html#ssl-tls-certificates-for-https-access>`__, `web-based administration interface <https://github.com/overhangio/tutor-webui>`__, `mobile app <https://github.com/overhangio/tutor-android>`__, `custom translations <https://docs.tutor.overhang.io/configuration.html#adding-custom-translations>`__...
|
||||
* Extensible architecture with `plugins <https://docs.tutor.overhang.io/plugins.html>`__
|
||||
* Works with `Kubernetes <https://docs.tutor.overhang.io/k8s.html>`__
|
||||
* Amazing premium plugins available in the `Tutor Wizard Edition <https://overhang.io/tutor/wizardedition>`__, including `Cairn <https://overhang.io/tutor/plugin/cairn>`__ the next-generation analytics solution for Open edX.
|
||||
|
@ -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 <https://discuss.overhang.io/c/tutor/tutorials/13>`__.
|
||||
|
64
docs/tutorials/arm64.rst
Normal file
64
docs/tutorials/arm64.rst
Normal file
@ -0,0 +1,64 @@
|
||||
.. _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 <install>` Tutor and its dependencies (e.g. Docker) onto your system.
|
||||
|
||||
.. note:: For Open edX developers, if you want to use the :ref:`nightly <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 <nightly>` 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::
|
||||
|
||||
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 <https://github.com/overhangio/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 <https://github.com/overhangio/tutor-mfe/issues/31>`_ for details and known workarounds.
|
Loading…
Reference in New Issue
Block a user