Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update variables and commands based on recent discussion on documentation PR (https://github.com/edx/edx-documentation/pull/1130).

By default, the Open edX platform uses Amazon S3 (Simple Storage Service) for data storage. If you need to reconfigure an instance of Open edX to use S3, you update theĀ /edx/app/edx_ansible/server-vars.yml file.

Before proceeding, review the Guidelines for Updating the Open edX Platform.

Preparing to Configure Amazon S3 for Data Storage

...

1. Stop the LMS server.

2. Create or edit the ``/edx/app/edx_ansible/server-vars.yml`` file to define the following settings.

...

COMMON_OBJECT_STORE_LOG_SYNC: true

EDXAPP_SETTINGS: "aws"

VHOST_NAME: "aws"

EDXAPP_FILE_UPLOAD_STORAGE_BUCKET_NAME: "bucket_name"

...

EDXAPP_GRADE_STORAGE_CLASS: 'storages.backends.s3boto.S3BotoStorage'

...

ENABLE_GRADE_DOWNLOADS: true

XQUEUE_SETTINGS: "aws_settings"

XQUEUE_UPLOAD_BUCKET: "xqueue_bucket_name"

XQUEUE_UPLOAD_PATH_PREFIX: "xqueue_path_prefix"

If you were previously using Swift, your /edx/app/edx_ansible/server-vars.yml file might contain a number of Swift-related variables. (All of these variables have SWIFT in their name. See Use Swift for Data Storage for details.) They should not interfere with the AWS settings above, so it's not strictly necessary to remove them fromĀ /edx/app/edx_ansible/server-vars.yml before running the commands listed below. But to be on the safe side, it is still recommended to remove them.

3. Run the /edx/bin/update command.

sudo /edx/bin/update edx-platform <your-branch-name>

sudo /edx/bin/update xqueue <your-branch-name>

4. Restart the LMS server.

...