Metadata-Version: 2.1
Name: tutor-webui
Version: 18.0.0
Summary: Web-based user interface plugin for Tutor
Home-page: https://overhang.io/overhangio/tutor-webui
Author: Overhang.IO
Author-email: contact@overhang.io
Maintainer: Edly
Maintainer-email: hina.khadim@arbisoft.com
License: AGPLv3
Project-URL: Documentation, https://docs.tutor.edly.io/
Project-URL: Code, https://github.com/overhangio/tutor-webui
Project-URL: Issue tracker, https://github.com/overhangio/tutor-webui/issues
Project-URL: Community, https://discuss.openedx.org
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
License-File: LICENSE.txt
Requires-Dist: tutor<19.0.0,>=18.0.0
Requires-Dist: click_repl>=0.3.0
Provides-Extra: dev
Requires-Dist: tutor[dev]<19.0.0,>=18.0.0; extra == "dev"

WebUI plugin for `Tutor <https://docs.tutor.edly.io>`__
============================================================

This is a plugin for Tutor that allows you to manage a Tutor-powered `Open edX <https://open.edx.org/>`__ installation from a browser -- a web user interface! In other words, it is no longer necessary to SSH to a remote server to manage a running instance.

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

::

    tutor plugins install webui

Usage
-----

Enable the plugin::

    tutor plugins enable webui

Start the web user interface::

    tutor webui start

You can then access the interface at http://localhost:3737, or http://youserverurl:3737.

.. image:: https://overhang.io/static/catalog/screenshots/webui.png

All ``tutor`` commands can be executed from this web UI: you just don't need to prefix the commands with ``tutor``. For instance, to deploy a local Open edX instance, run::

    local launch

instead of ``tutor local launch``.

Instead of running the interactive `repl <https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop>`__ in a web browser, you can also run tutor interactively directly from your shell::

    tutor shell

Authentication
~~~~~~~~~~~~~~

**WARNING** Once you launch the web UI, it is accessible by everyone, which means that your Open edX platform is at risk. If you are planning to leave the web UI up for a long time, you should setup a user and password for authentication::

    tutor webui configure

Troubleshooting
---------------

This Tutor plugin is maintained by Hina Khadim from `Edly <https://edly.io>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.edly.io/troubleshooting.html>`__ section from the Tutor documentation.

License
-------

This software is licensed under the terms of the AGPLv3.

This project depends on the `Gotty <https://github.com/sorenisanerd/gotty/>`_ binary, which is provided under the terms of the `MIT license <https://github.com/sorenisanerd/gotty/blob/master/LICENSE>`_.
