Skip to content
This repository was archived by the owner on Aug 1, 2024. It is now read-only.

Commit 0b62f92

Browse files
author
Clinton Blackburn
committed
Updated README
ECOM-6560
1 parent c7a6097 commit 0b62f92

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
1-
# devstack
1+
# edX Devstack
22

33
Get up and running quickly with edX services.
44

5-
This project is meant to replace the traditional Vagrant VM "devstack" with a multi-container approach driven by Docker Compose. You should run any Make targets described below on your local machine, not from within a VM.
5+
If you are seeking info on the Vagrant-based devstack, please see https://openedx.atlassian.net/wiki/display/OpenOPS/Running+Devstack.
6+
This project is meant to replace the traditional Vagrant-based devstack with a multi-container approach driven by [Docker
7+
Compose](https://docs.docker.com/compose/). It is still in the alpha/beta testing phase. Support for this project is
8+
limited at the moment, so it may take a while to respond to issues.
9+
10+
You should run any Make targets described below on your local machine, _not_ from within a VM.
611

712
## Getting Started
813

@@ -23,7 +28,7 @@ configure Docker with a sufficient amount of resources. Our testing found that [
2328
development without the auth service) and tenants (for multi-tenancy).
2429

2530
The username and password for the superusers are both "edx". You can access the services directly via Django admin
26-
at the `/admin` path.
31+
at the `/admin/` path, or login via single sign-on at `/login/`.
2732

2833
```
2934
$ make devstack.provision
@@ -36,6 +41,7 @@ configure Docker with a sufficient amount of resources. Our testing found that [
3641
```
3742
3843
After the services have started, if you need shell access to one of the services, run `make devstack.open.<service>`.
44+
For example to access the Catalog/Course Discovery Service, you can run:
3945
4046
```
4147
$ make devstack.open.discovery

0 commit comments

Comments
 (0)