Service List#

These are the edX services that Devstack can provision, pull, run, attach to, etc. Each service is accessible at localhost on a specific port. The table below provides links to the homepage, API root, or API docs of each service, as well as links to the repository where each service’s code lives.

Most developers will be best served by working with specific combinations of these services, for example make dev.pull.cms or make dev.up.ecommerce. These will pull in dependencies as needed—starting ecommerce will also start lms, and lms will pull in forums, discovery, and others. If you need multiple, they can be listed like make dev.up.cms+ecommerce. After the service table below there is a list of some common combinations.

Instead of a service name or list, you can also run commands like make dev.provision / make dev.pull.large-and-slow / make dev.up.large-and-slow. This is a larger list than most people will need for most of their work, and includes all of the services marked “Default” in the below table. (Some of these targets use large-and-slow in their name as a warning; others may be changed to use this over time.) However, you can change this list by modifying the DEFAULT_SERVICES option as described in Advanced Configuration Options.

Service

URL

Type

Role

lms

http://localhost:18000/

Python/Django

Default

cms

http://localhost:18010/

Python/Django

Default

forum

http://localhost:44567/api/v1/

Ruby/Sinatra

Default

discovery

http://localhost:18381/api-docs/

Python/Django

Default

ecommerce

http://localhost:18130/dashboard/

Python/Django

Default

credentials

http://localhost:18150/api/v2/

Python/Django

Default

edx_notes_api

http://localhost:18120/api/v1/

Python/Django

Default

frontend-app-learning

http://localhost:2000/

MFE (React.js)

Default

frontend-app-payment

http://localhost:1998/

MFE (React.js)

Default

frontend-app-publisher

http://localhost:18400/

MFE (React.js)

Default

frontend-app-gradebook

http://localhost:1994/

MFE (React.js)

Default

frontend-app-authn

http://localhost:1999/

MFE (React.js)

Default

registrar

http://localhost:18734/api-docs/

Python/Django

Extra

frontend-app-program-console

http://localhost:1976/

MFE (React.js)

Extra

frontend-app-library-authoring

http://localhost:3001/

MFE (React.js)

Extra

frontend-app-course-authoring

http://localhost:2001/

MFE (React.js)

Extra

frontend-app-account

http://localhost:1997/

MFE (React.js)

Extra

frontend-app-profile

http://localhost:1995/

MFE (React.js)

Extra

xqueue

http://localhost:18040/api/v1/

Python/Django

Extra

coursegraph

http://localhost:7474/browser

Tooling (Java)

Extra

insights

http://localhost:18110

Python/Django

Extra

analyticsapi

http://localhost:19001

Python/Django

Extra

frontend-app-ora-grading

http://localhost:1993

MFE (React.js)

Extra

Some common service combinations include:

  • lms: LMS, along with dependencies forum, discovery, Authn and some databases

  • ecommerce: Ecommerce, but also LMS as a dependency (for auth)

  • cms+credentials: Services can be combined to affect both at once