tutor

mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-10 07:11:00 +00:00

History

Régis Behmo de5b82fd63 Migrate github repo to overhangio organization		2019-06-23 23:11:07 +02:00
..
tests	🔌 Introduce a plugin system for tutor	2019-06-07 22:49:45 +02:00
tutorminio	Working Kubernetes quickstart	2019-06-17 22:38:55 +02:00
README.rst	Migrate github repo to overhangio organization	2019-06-23 23:11:07 +02:00
setup.py	Migrate github repo to overhangio organization	2019-06-23 23:11:07 +02:00

README.rst

Object storage for Open edX with `MinIO <https://www.minio.io/>`_
=================================================================

This is a plugin for `Tutor <https://docs.tutor.overhang.io>`_ that provides S3-like object storage for Open edX platforms. It's S3, but without the dependency on AWS. This is achieved thanks to `MinIO <https://www.minio.io/>`_, an open source project that provides object storage with an API compatible with S3.

In particular, this plugin is essential for `Kubernetes deployment <https://docs.tutor.overhang.io/k8s.html>`_.

Installation
------------

The plugin is currently bundled with the `binary releases of Tutor <https://github.com/overhangio/tutor/releases>`_. If you have installed Tutor from source, you will have to install this plugin from source, too::
  
    git clone https://github.com/overhangio/tutor/
    pip install -e tutor/plugins/minio

Then, to enable this plugin, run::
  
    tutor plugins enable minio

Configuration
-------------

- ``MINIO_BUCKET_NAME`` (default: ``"openedx"``)
- ``MINIO_FILE_UPLOAD_BUCKET_NAME`` (default: ``"openedxuploads"``)
- ``MINIO_COURSE_IMPORT_EXPORT_BUCKET`` (default: ``"openedxcourseimportexport"``)
- ``MINIO_HOST`` (default: ``"minio.{{ LMS_HOST }}"``)
- ``MINIO_DOCKER_REGISTRY`` (default: ``"{{ DOCKER_REGISTRY }}"``)
- ``MINIO_DOCKER_IMAGE_CLIENT`` (default: ``"minio/mc:RELEASE.2019-05-23T01-33-27Z"``)
- ``MINIO_DOCKER_IMAGE_SERVER`` (default: ``"minio/minio:RELEASE.2019-05-23T00-29-34Z"``)

These values can be modified with ``tutor config save --set PARAM_NAME=VALUE`` commands.

DNS records
-----------

It is assumed that the ``MINIO_HOST`` DNS record points to your server. When running MinIO on your laptop, you should point your services to ``minio.localhost``::

    tutor config save --set MINIO_HOST=minio.localhost

Web UI
------

The MinIO web UI can be accessed at http://<MINIO_HOST>. The credentials for accessing the UI can be obtained with::

  tutor config printvalue OPENEDX_AWS_ACCESS_KEY
  tutor config printvalue OPENEDX_AWS_SECRET_ACCESS_KEY