christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-12 14:17:46 +00:00
Code Issues Releases Activity
a6c9bba3bf
tutor/docs/extra.rst

77 lines
2.6 KiB
ReStructuredText
Raw Normal View History

Better documentation - More concise table of contents - New intro - Simpler make commands - Fix a couple typos here and there - Get rid of the default github issue template, and start using the template created online.
2019-05-13 14:33:26 +00:00
.. _extra:
Extra features
==============
.. _webui:
Web UI
------
Tutor comes with a web user interface (UI) that allows you to administer your Open edX platform remotely. It's especially convenient for remote administration of the platform.
Launching the web UI
~~~~~~~~~~~~~~~~~~~~
::
tutor webui start
You can then access the interface at http://localhost:3737, or http://youserverurl:3737.
.. 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
~~~~~~~~~~~~~~
**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
Fix android app build/auth We had to backtrack from the latest release of the android app, which is not compatible with the mobile api v0.5 available in Hawthorn. This should change in ironwood. Also, we included the correct oauth client ID in the app, which prevented communication with the LMS. The android app is now out of beta \o/ Close #89
2019-02-20 15:07:18 +00:00
.. _mobile:
Mobile Android application
Better documentation - More concise table of contents - New intro - Simpler make commands - Fix a couple typos here and there - Get rid of the default github issue template, and start using the template created online.
2019-05-13 14:33:26 +00:00
--------------------------
Fix android app build/auth We had to backtrack from the latest release of the android app, which is not compatible with the mobile api v0.5 available in Hawthorn. This should change in ironwood. Also, we included the correct oauth client ID in the app, which prevented communication with the LMS. The android app is now out of beta \o/ Close #89
2019-02-20 15:07:18 +00:00
Simplify environment generation Environment is no longer generated separately for each target, but only once the configuration is saved. Note that the environment is automatically updated during re-configuration, based on a "version" file stored in the environment.
2019-03-18 16:26:37 +00:00
With Tutor, you can build an Android mobile application for your platform. To build the application in debug mode, run::
Fix android app build/auth We had to backtrack from the latest release of the android app, which is not compatible with the mobile api v0.5 available in Hawthorn. This should change in ironwood. Also, we included the correct oauth client ID in the app, which prevented communication with the LMS. The android app is now out of beta \o/ Close #89
2019-02-20 15:07:18 +00:00
tutor android build debug
Restore more recent Android app tagged release A prior change used the ironwood.1 tag to build the Android app in an attempt to solve #289. Turns out that this change was unnecessary. So here we revert to a more recent release of the Android app. Instead of building from the master branch (which might create suprises) we build from a fixed release tag. The source repo and version are customisable via build arguments.
2020-02-25 16:16:09 +00:00
The ``.apk`` file will then be available in ``$(tutor config printroot)/data/android``. Transfer it to an Android phone to install the application. You should be able to sign in and view available courses.
Building a custom Android app
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Android app is built from the `official edx-app-android repository <https://github.com/edx/edx-app-android/>`__. To change this repository or the app version, you can simply build a different docker image with::
tutor images build \
--build-arg ANDROID_APP_REPOSITORY=https://github.com/mycustomfork/edx-app-android \
Fix android app custom build instructions
2020-05-18 18:30:36 +00:00
--build-arg ANDROID_APP_VERSION=master \
android
Fix android app build/auth We had to backtrack from the latest release of the android app, which is not compatible with the mobile api v0.5 available in Hawthorn. This should change in ironwood. Also, we included the correct oauth client ID in the app, which prevented communication with the LMS. The android app is now out of beta \o/ Close #89
2019-02-20 15:07:18 +00:00
Releasing an Android app
Better documentation - More concise table of contents - New intro - Simpler make commands - Fix a couple typos here and there - Get rid of the default github issue template, and start using the template created online.
2019-05-13 14:33:26 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~
Fix android app build/auth We had to backtrack from the latest release of the android app, which is not compatible with the mobile api v0.5 available in Hawthorn. This should change in ironwood. Also, we included the correct oauth client ID in the app, which prevented communication with the LMS. The android app is now out of beta \o/ Close #89
2019-02-20 15:07:18 +00:00
**Note**: this is an untested feature.
Releasing an Android app on the Play Store requires to build the app in release mode. To do so, edit the ``$TUTOR_ROOT/config.yml`` configuration file and define the following variables::
ANDROID_RELEASE_STORE_PASSWORD
ANDROID_RELEASE_KEY_PASSWORD
ANDROID_RELEASE_KEY_ALIAS
Restore more recent Android app tagged release A prior change used the ironwood.1 tag to build the Android app in an attempt to solve #289. Turns out that this change was unnecessary. So here we revert to a more recent release of the Android app. Instead of building from the master branch (which might create suprises) we build from a fixed release tag. The source repo and version are customisable via build arguments.
2020-02-25 16:16:09 +00:00
Then, place your keystore file in ``$(tutor config printroot)/env/android/app.keystore``. Finally, build the application with::
Fix android app build/auth We had to backtrack from the latest release of the android app, which is not compatible with the mobile api v0.5 available in Hawthorn. This should change in ironwood. Also, we included the correct oauth client ID in the app, which prevented communication with the LMS. The android app is now out of beta \o/ Close #89
2019-02-20 15:07:18 +00:00
tutor android build release
Customising the Android app
Better documentation - More concise table of contents - New intro - Simpler make commands - Fix a couple typos here and there - Get rid of the default github issue template, and start using the template created online.
2019-05-13 14:33:26 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Fix android app build/auth We had to backtrack from the latest release of the android app, which is not compatible with the mobile api v0.5 available in Hawthorn. This should change in ironwood. Also, we included the correct oauth client ID in the app, which prevented communication with the LMS. The android app is now out of beta \o/ Close #89
2019-02-20 15:07:18 +00:00
Customising the application, such as the logo or the background image, is currently not supported. If you are interested by this feature, please tell us about it in the Tutor `discussion forums <https://discuss.overhang.io>`_.
Copy Permalink