Skip to main content

Web-based user interface plugin for Tutor

Project description

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 Abdul-Muqadim 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tutor_webui-20.0.0.tar.gz (16.8 kB view details)

Uploaded Source

File details

Details for the file tutor_webui-20.0.0.tar.gz.

File metadata

  • Download URL: tutor_webui-20.0.0.tar.gz
  • Upload date:
  • Size: 16.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.20

File hashes

Hashes for tutor_webui-20.0.0.tar.gz
Algorithm Hash digest
SHA256 fafb865657e7b510d1810bc74c4dd0bb3f8dae5af364beee462308f6aad96d2c
MD5 fdde2f0b7a3e509294f0f1a2256f1192
BLAKE2b-256 fb9f95f6f9a03b8962b56ec66efbe6c9d69998008091fc187f25ea19c4b445c4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page