E-Commerce plugin for Tutor
This is a plugin for Tutor that integrates the E-Commerce application in an Open edX platform.
This plugin requires tutor>=12.0.0, the Discovery plugin and the MFE plugin. If you have installed Tutor by downloading the pre-compiled binary, then both plugins should be automatically installed. You can confirm by running:
tutor plugins list
But if you have installed tutor from source, then you also need to install the plugin from source:
tutor plugins install ecommerce
Then, in any case you need to enable the plugins:
tutor plugins enable discovery ecommerce mfe
Services will have to be re-configured and restarted, so you are probably better off just running launch again:
tutor local launch
Note that this plugins is compatible with Kubernetes integration. When deploying to a Kubernetes cluster, run instead:
tutor k8s launch
For further instructions on how to setup E-Commerce with Open edX, check the official E-Commerce documentation.
ECOMMERCE_HOST
(default:"ecommerce.{{ LMS_HOST }}"
)ECOMMERCE_PAYMENT_PROCESSORS
(default:{cybersource: {...}, paypal: {...}}
See below for details.)ECOMMERCE_ENABLE_IDENTITY_VERIFICATION
: (default:True
)ECOMMERCE_ENABLED_PAYMENT_PROCESSORS
: (default:["cybersource", "paypal"]
)ECOMMERCE_ENABLED_CLIENT_SIDE_PAYMENT_PROCESSORS
(default:["cybersource"]
)ECOMMERCE_EXTRA_PAYMENT_PROCESSOR_CLASSES
(default:[]
)ECOMMERCE_MYSQL_PASSWORD
:"{{ 8|random_string }}"
)ECOMMERCE_SECRET_KEY
(default:"{{ 20|random_string }}"
)ECOMMERCE_OAUTH2_SECRET
(default:"{{ 8|random_string }}"
)ECOMMERCE_API_KEY
(default:"{{ 20|random_string }}"
)ECOMMERCE_DOCKER_IMAGE
(default:"{{ DOCKER_REGISTRY }}overhangio/openedx-ecommerce:{{ TUTOR_VERSION }}"
)ECOMMERCE_WORKER_DOCKER_IMAGE
(default:"{{ DOCKER_REGISTRY }}overhangio/openedx-ecommerce-worker:{{ TUTOR_VERSION }}"
)ECOMMERCE_MYSQL_DATABASE
(default:"ecommerce"
)ECOMMERCE_MYSQL_USERNAME
(default:"ecommerce"
)ECOMMERCE_CURRENCY
(default:"USD"
)ECOMMERCE_OAUTH2_KEY
(default:"ecommerce"
)ECOMMERCE_API_TIMEOUT
(default:5
)ECOMMERCE_WORKER_JWT_ISSUER
(default:"ecommerce-worker"
)ECOMMERCE_EXTRA_PIP_REQUIREMENTS
(default:[]
)
You will need to modify the ECOMMERCE_PAYMENT_PROCESSORS
parameter to configure your payment providers credentials. By default, it is equal to:
cybersource: merchant_id: SET-ME-PLEASE flex_shared_secret_key_id: SET-ME-PLEASE flex_shared_secret_key: SET-ME-PLEASE soap_api_url: https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor/CyberSourceTransaction_1.140.wsdl transaction_key: SET-ME-PLEASE flex_run_environment: cybersource.environment.sandbox paypal: cancel_checkout_path: /checkout/cancel-checkout/ client_id: SET-ME-PLEASE client_secret: SET-ME-PLEASE error_url: /checkout/error/ mode: sandbox receipt_url: /checkout/receipt/
We suggest you modify this configuration, save it to ecommerce-config.yml
and then load it with:
tutor config save --set "ECOMMERCE_PAYMENT_PROCESSORS=$(cat ecommerce-config.yml)"
To enable the Cybersource payment processor, two keys need to be generated. In your Cybersource account, go to "Payment Configuration" 🠆 "Key Management" 🠆 "Generate key". Create the following keys:
- SOAP API key: use this key to define the
transaction_key
setting. - REST Shared secret: use the key ID and value to define
flex_shared_secret_key_id
andflex_shared_secret_key
, respectively.
The merchant_id
setting corresponds to your Merchant ID.
If you are running in production, you need to change the flex_run_environment
value in the configuration file as well. You should change the flex_run_environment
value to cybersource.environment.production
The ecommerce user interface will be available at http://ecommerce.local.edly.io for a local instance, and at ECOMMERCE_HOST
(by default: http(s)://ecommerce.<yours lms host>
) in production. In order to run commands from the UI, a user with admin rights must be created. There are two ways to proceed. To create a brand new user in E-Commerce which will not exist in the LMS, run:
tutor local run ecommerce ./manage.py createsuperuser
Then login with this new user at: http://ecommerce.local.edly.io/admin/
To re-use an existing LMS user, first go to http://ecommerce.local.edly.io/login. You should be redirected to the LMS login page, then to the dashboard. Then this user must be made a staff/superuser in E-Commerce:
tutor local run ecommerce ./manage.py shell -c "from django.contrib.auth import get_user_model; get_user_model().objects.filter(email='[email protected]').update(is_staff=True, is_superuser=True)"
Make sure to replace [email protected]
by the actual user email address. You should then be able to view the Oscar dashboard at http://ecommerce.local.edly.io.
E-Commerce implementations vary a lot from one country to another. If all you need are the Paypal, Cybersource and Stripe payment processors, then it should not be necessary to customize the tutor-ecommerce docker image, which contains the vanilla E-Commerce platform. However, if you need to run a fork of E-Commerce, or install extra requirements, then you should re-build the docker image. To do so, first set the appropriate settings:
tutor config save \ --set 'ECOMMERCE_EXTRA_PIP_REQUIREMENTS=["git+https://github.com/myusername/myplugin"]'
Then, build the image, pointing to your fork if necessary:
tutor images build ecommerce \ -a ECOMMERCE_REPOSITORY=https://github.com/myusername/ecommerce \ -a ECOMMERCE_VERSION=my/tag
When running Tutor in development mode, the ecommerce service is accessible at http://ecommerce.local.edly.io:8130.
To mount a local ecommerce repository in the ecommerce container, add an auto-mounted repository with:
tutor mounts add /path/to/ecommerce
Rebuild the "ecommerce" Docker image:
tutor images build ecommerce
Launch your platform again:
tutor dev launch
To attach a debugger to the ecommerce service, run:
tutor dev start ecommerce
This Tutor plugin is maintained by Muhammad Faraz Maqsood 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.
Pull requests are welcome! Please read the "contributing" section from the Tutor documentation.
This work is licensed under the terms of the GNU Affero General Public License (AGPL).