Commit af77252b authored by Maarten de Waard's avatar Maarten de Waard 🤘🏻 Committed by Tutor user on staging
Browse files

add documentation about how to set up discovery plugin, add env/plugins to .gitignore

parent cd719fe9
......@@ -26,6 +26,7 @@ env/local/docker-compose.prod.yml
env/local/docker-compose.yml
env/local/proxy/apache2/openedx.conf
env/local/proxy/nginx/openedx.conf
env/plugins
# Folder with all the data and sensitive information:
data/**
......@@ -17,9 +17,28 @@ https://docs.tutor.overhang.io/
1. Clone this repository to `~/.local/share/tutor`
- Make sure to set up submodules by cloning recursively or running `git submodule update --init`.
1. [Install tutor](https://docs.tutor.overhang.io/install.html#installing-from-pypi)
1. [Install the Figures plugin](#figures)
1. Install the Discovery plugin
```
pip3 install tutor-discovery
```
1. Set up the system by running `tutor local quickstart`.
If you already have a `config.yaml` with the desired settings,
you can add the flag `--non-interactive`.
1. Set up course-discovery integration:
```
tutor local run lms ./manage.py lms create_catalog_integrations --enabled \
--internal_api_url=http://discovery:8000/api/v1 \
--service_username=lms_catalog_service_user
```
and then:
```
tutor local run lms ./manage.py lms cache_programs
```
1. Verify that tutor works by running `tutor config printvalue PLATFORM_NAME`.
1. Depending on your requirements, enable some of the plugins in the `plugins` folder.
See the Plugins section below.
......@@ -29,6 +48,13 @@ https://docs.tutor.overhang.io/
1. [Rebuild the openedx image](#building) with our fork of the edx-platform
repo.
1. (Optional) Create an user `tutor local createuser --staff --superuser yourusername user@email.com`
1. (Optional) Re-index courses for Discovery:
```
tutor local run discovery ./manage.py refresh_course_metadata --partner_code=openedx
tutor local run discovery ./manage.py update_index --disable-change-limit
```
## Building
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment