Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.15 KB

docker-quickstart.md

File metadata and controls

42 lines (28 loc) · 1.15 KB
Raw

Docker Quickstart

Installation

Follow the installation instructions for docker and docker-compose. Tutor requires docker-compose v1.26+.

Running the development server

To start the app at http://localhost:3001, run:

docker-compose up --build

The --build flag ensures the image is kept up to date with your code checked out locally.

Resetting the Postgres container database

To reset the database to a state containing only the course created by bin/rake demo[mini], run:

docker-compose up --build --renew-anon-volumes

The --renew-anon-volumes flag (or -V) resets the database to an empty state, which is then repopulated by the entrypoint script.

GitHub actions

To use tutor-server in development mode in a GitHub action, add the following to your action:

- uses: actions/checkout@v2
  with:
    repository: openstax/tutor-server
    path: tutor-server
- uses: ./tutor-server/

Unfortunately, uses: openstax/tutor-server does not work, likely due to different container network settings when the remote repository syntax is used.