Skip to content

Commit

Permalink
Merge pull request #99 from edx/aleffert/mobile-initial-docs
Browse files Browse the repository at this point in the history
Initial checkin with stub for video
  • Loading branch information
aleffert committed Jan 14, 2015
2 parents e6551d0 + 092282b commit a6bd691
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 1 deletion.
4 changes: 3 additions & 1 deletion en_us/install_operations/source/change_log.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ May, 2014

* - Date
- Change
* - 01/14/2014
- Addition of the section :ref:`Setting up the Mobile Applications`
* - 06/07/2014
- Addition of the section :ref:`Installing the edX Production Stack`
* - 05/21/2014
- The initial release of this guide, with the sections :ref:`Installing the
edX Developer Stack` and :ref:`Running the edX Developer Stack`.


1 change: 1 addition & 0 deletions en_us/install_operations/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ Installing, Configuring, and Running the edX Platform
devstack/install_devstack
devstack/run_devstack
prodstack/install_prodstack
mobile
60 changes: 60 additions & 0 deletions en_us/install_operations/source/mobile.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
.. include:: links.rst

.. _Setting up the Mobile Applications:

######################################
Setting up the edX Mobile Applications
######################################

This chapter is intended for those are who are building the edX mobile applications and customizing their Open edX installation to support their use.

* `Code`_
* `Authentication`_
* `Video`_

****
Code
****

There are currently two edX mobile applications, one for iOS and one for Android. You can find the source code and additional documentation for each:

- iOS: http://github.com/edx/edx-app-ios

- Android http://github.com/edx/edx-app-android

**************
Authentication
**************

The edX mobile apps require you to adjust your ``edx-platform`` configuration settings in ``lms.env.json`` to enable mobile API support.

In particular, you need to add the following under the features section:

.. code-block:: json
"FEATURES" : {
...
"ENABLE_MOBILE_REST_API": true,
"ENABLE_OAUTH2_PROVIDER": true,
...
}
You also need to set the following configuration value at the top level of the configuration dictionary:

.. code-block:: json
"OAUTH_ENFORCE_SECURE": ""
Additionally, you need to create an OAuth key and secret specific to your installation for use by the apps. You can do this by logging into the Django administration console at ``<YOUR_EDX_INSTALLATION>/admin``. From there, choose **Clients** under the **Oauth2** section. If you don't already have any clients set up, you will need to add one. Choose **Add client** and create a client. The client id and secret that you see will need to be added to your mobile app configuration. For more information about how to do that, see the documentation for each app linked above.


*****
Video
*****

Courseware videos must be specifically prepared to ensure they're in mobile accessible formats. Video modules in mobile-available courses should have low resolution encodings that can be readily accessible by mobile devices.

To configure a video module with a low resolution encoding for mobile, enter the URL to the mobile-targeted video as the first URL in the "Video File URLs" list in the video module's Advanced Editor in edX Studio.

Alternatively, if the course is edited directly in XML, enter the URL to the mobile-targeted video as the first URL in the list of html5_sources.

0 comments on commit a6bd691

Please sign in to comment.