Skip to content

overhangio/tutor-webui

Repository files navigation

WebUI plugin for Tutor

This is a plugin for Tutor that allows you to manage a Tutor-powered Open edX 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.

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 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. Community support is available from the official Open edX forum. Do you need help with this plugin? See the troubleshooting section from the Tutor documentation.

License

This work is licensed under the terms of the GNU Affero General Public License (AGPL).

This project depends on the Gotty binary, which is provided under the terms of the MIT license.