diff --git a/docs/install.rst b/docs/install.rst index 32a85ac..9fd780e 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -44,3 +44,12 @@ Installing from source git clone https://github.com/regisb/tutor cd tutor python setup.py develop + +Cloud deployment +---------------- + +Are you deploying Tutor to a Ubuntu cloud server? The `ubuntu.sh `_ installs Tutor and creates a service under supervision that runs the Tutor :ref:`web UI `. To run this script, just connect to your server and run:: + + curl -sSL https://raw.githubusercontent.com/regisb/tutor/master/cloud/ubuntu.sh | sudo bash -e + +After the script finishes, you should be able to access the web UI at http://server_ip_address:3737. For security reasons, you should immediately set a password for accessing the UI by running ``webui configure`` from the web UI, or ``tutor webui configure`` from the server shell. diff --git a/docs/webui.rst b/docs/webui.rst index 3dc5be1..ecafecd 100644 --- a/docs/webui.rst +++ b/docs/webui.rst @@ -16,6 +16,12 @@ You can then access the interface at http://localhost:3737, or http://youserveru .. image:: img/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 quickstart + +instead of ``tutor local quickstart``. + Authentication --------------