History

Brian Watson 2526686089 Add selenium-edge support for docker flag=none Test-plan: - For docker - in config/selenium.yml, change browser to 'edge' - in docker-compose.selenium.yml (or equivalent), uncomment out new edge service definition. It may have to be copied from docker-compose/selenium.override.yml if using a copy Change-Id: I7d60dcec9d70d63ce5b5efb2e686cdabdb49dae8 Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/281697 Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com> Reviewed-by: Robin Kuss <rkuss@instructure.com> Reviewed-by: James Butters <jbutters@instructure.com> QA-Review: Robin Kuss <rkuss@instructure.com> Product-Review: Brian Watson <bwatson@instructure.com>		2022-01-26 20:50:15 +00:00
..
README.md	minor linux docker development tweaks	2021-01-13 18:48:08 +00:00
consul.md	Add rake task to populate Consul from dynamic_settings.yml	2017-09-19 18:08:39 +00:00
developing_with_docker.md	Add selenium-edge support for docker	2022-01-26 20:50:15 +00:00
getting_docker.md	update docker documentation	2021-01-06 18:29:18 +00:00
vault.md	Add vault client to canvas	2020-02-03 19:00:13 +00:00

README.md

Using Docker to run Canvas

Prerequisites

You need Docker. Don't have Docker yet? Go here for details on getting it setup.

Development

Just on Linux (skip this on OSX), you may want to run this to avoid a few permissions issues first by granting Canvas docker containers write access to your Canvas folder:

setfacl -Rm u:9999:rwX,g:9999:rwX .
setfacl -dRm u:9999:rwX,g:9999:rwX .
sudo addgroup --gid 9999 docker-instructure
sudo usermod -a -G docker-instructure $USER

After logging back into your system (to recognize your new group), you should be able to edit or delete any files created by Canvas docker containers. If you're using this approach to grant Canvas write access, you can also disable the default built-in usermod hack that runs Canvas containers as your host UID instead (since this has been known to cause problems). This can be done by adding this to your ~/.bash_profile:

export CANVAS_SKIP_DOCKER_USERMOD=1

For everyone now, this command should get you going:

./script/docker_dev_setup.sh

Be sure to pay attention to any Next Steps output from the script that you may need to run.

Now you can do docker-compose up and you should be good to go. If you're using Dinghy or Dory. You should be able to access Canvas by going to: http://canvas.docker/

For more information checkout Developing with Docker

Known Issues

Long URL Gateway 502

If a URL is long enough, you may see a Gateway 502 error. This problem has been patched in dinghy-http-proxy#36 however until a new release is cut the follow can be done as a work around:

In ~/.dinghy/proxy.conf add the following:

proxy_buffers 8 1024k;
proxy_buffer_size 1024k;

Restart dinghy afterwards.

NFS Not Starting

During dinghy boot (normally if you've killed and restarted dinghy since your last system reboot), you get a message that indicate NFS could not start and it gives you a path to an error file where you see something like:

=== Starting NFS at 2019-09-05T17:31:22-05:00 ===

UNFS3 unfsd 0.9.23 (C) 2009, Pascal Schmidt <unfs3-server@ewetel.net>
bind: Address already in use
Couldn't bind to udp port 19091

See this issue on dinghy: https://github.com/codekitchen/dinghy/issues/272

You can reboot your system to clear the zombie process, or you can use xhyve as your VM backend.