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

Uploaded Source

File details

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

File metadata

  • Download URL: tutor-webui-17.0.1.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.18

File hashes

Hashes for tutor-webui-17.0.1.tar.gz
Algorithm Hash digest
SHA256 f8c6f03859742db5d7881a29169860f40d9b11549e919bbea346f943c21d7e0d
MD5 7bf4b6479e19993bbb811cac6e323270
BLAKE2b-256 db7fac7f2305730f1272464ef843875d7ec262087d37ecd39cfa3e75675d290c

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