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

pip install tutor-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 Régis Behmo from Overhang.IO. 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 software is licensed under the terms of the AGPLv3.

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-15.0.0.tar.gz (5.0 kB view details)

Uploaded Source

File details

Details for the file tutor-webui-15.0.0.tar.gz.

File metadata

  • Download URL: tutor-webui-15.0.0.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.16

File hashes

Hashes for tutor-webui-15.0.0.tar.gz
Algorithm Hash digest
SHA256 503ead164d84215442159480df91ab857e806058c89acb69974c7e5c0d55d6bc
MD5 f76a0d5e0f96256cff5d8e0c439ed4ff
BLAKE2b-256 5d8f807e417418153556d45755bf5a0f83cb0cba3c8d27ed2209f97e4dd12c92

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