tailsptit / docker-canvas

Docker provisioning for Canvas integration tests

Docker Canvas for Integration Testing

Docker provisioning for Canvas integration tests (via LTI, etc)

Prerequisites

• Docker Engine
• Docker Compose
• Large amount (~4GB) of memory allocated to your docker machine (Canvas uses a lot of memory)

Clone Repo and Start Server

git clone https://github.com/ubc/docker-canvas.git docker-canvas

If it is the first time:

Initialize data by first starting the database:

docker-compose up -d db

Wait a few moments for the database to start then (command might fail if database hasn't finished first time startup):

docker-compose run --rm app bundle exec rake db:create db:initial_setup

When prompted enter default account email, password, and display name. Also choose to share usage data or not.

The branding assets must also be manually generated when canvas is in production mode:

docker-compose run --rm app bundle exec rake canvas:compile_assets
docker-compose run --rm app bundle exec rake brand_configs:generate_and_upload_all

Finally startup all the services (the build will create a docker image for you):

docker-compose up -d --build

Canvas is accessible at

http://localhost:8900/

MailHog (catches all out going mail from canvas) is accessible at

http://localhost:8901/

Start Server

docker-compose up -d

Check Logs

# app
docker logs -f docker-canvas_app_1
# more detailed app logs
docker exec -it docker-canvas_app_1 tail -f log/production.log
# worker
docker logs -f docker-canvas_worker_1
# db
docker logs -f docker-canvas_db_1
# redis
docker logs -f docker-canvas_redis_1
# mail
docker logs -f docker-canvas_mail_1

Stop Server

docker-compose stop

Stop Server and Clean Up

docker-compose down
rm -rf .data

Rebuild local image

You can try rebuilding the image if you are experiencing issues importing course content, etc. Before running this command, stop the server (if it's running) using docker-compose down

docker-compose build

Update the DB

docker-compose run --rm app bundle exec rake db:migrate

Update Canvas

The official Canvas docker image might not be up-to-date with the version available on github. If you need an updated image, you will have to build it yourself. Check out Canvas from Instructure's github (make sure you're on the branch you need, e.g.: stable) and run:

docker build -t instructure/canvas-lms:stable .

Note that Instructure recommends at least 8 GB of RAM to build this image. This will build and tag the image as a newer version in your docker cache. You will need to rebuild the app and worker images to incorporate this new image:

docker-compose build app worker

You might also need to update the DB and rebuild assets. After this, you should be able to start Canvas as usual.

Communicating between projects

It may be hard to link to the Canvas container in some situations using only localhost. This can be mitigated using the IP address of your host machine to access the canvas instance or by using virtual hosts if that is not feasible.

Better instructions on getting this working will be add in the future (sorry!).

LTI services (membership, grades, etc)

For LTI you need to use your machine's IP address (Change the DOMAIN environment variable to your IP address).

Troubleshooting

Passenger timeout when trying to access Canvas.

Increase the PASSENGER_STARTUP_TIMEOUT environment variable in docker-compose.yml. First time startup can take a while and the timeout might be too short.