IllumiDesk / illumidesk

IllumiDesk enhances your LMS with Jupyter Notebooks + Auto-Grading.
https://docs.illumidesk.com
Other
43 stars 13 forks source link

Explain how to run locally #624

Closed sepastian closed 2 years ago

sepastian commented 3 years ago

Is your feature request related to a problem? Please describe.

The README.md explains how to build for local testing with docker-compose and docker. It does not explain how to actually perform local testing after building. There are no docker-compose files.

Describe the solution you'd like

A docker-compose.yml file.

Describe alternatives you've considered

A docker run command(s).

Additional context

n/a

welcome[bot] commented 3 years ago

Thanks for opening your first issue here! We would like to help you as efficiently as possible so would very much appreciate if you use one of the provided Issue templates to document your feature, o but report.

jgwerner commented 3 years ago

Hi, @sepastian thanks for opening the issue. This is a good request and we are actually working on attempting to implement a viable solution for local setups again. We did have a solution working with docker-compose + ansible in the past but have since moved to Kubernetes.

You may look at this legacy setup by visiting this commit of the source. The Readme should include all the instructions for you to get up and running. However, keep in mind that this old version required an nbgrader fork that we no longer maintain. In order for this legacy code to work, simply use the standard jupyterhub/ltiauthenticator as a replacement for the included LTI 1.1 / LTI 1.3 authenticators.

Moving forward, we are "all-in" with Kubernetes and plan to provide local setup options with Kind. For the time being, we will remove the docker-compose reference to remove confusion.

github-actions[bot] commented 2 years ago

This issue has been tagged as stale due to inactivity