ylqjgm
/
canvas-lms
mirror of https://github.com/instructure/canvas-lms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docker docs -- common problems 

problems encountered by me

Test plan:
- none necessary unless you want to view it in gitiles browse

refs HACKWEEK-EBATTAGLIA

Change-Id: Ie10638fa03cc9c85a1d4b66ef7b677e85da307f6
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/213678
Tested-by: Jenkins
Reviewed-by: Xander Moffatt <xmoffatt@instructure.com>
QA-Review: Xander Moffatt <xmoffatt@instructure.com>
Product-Review: Xander Moffatt <xmoffatt@instructure.com>
This commit is contained in:
Evan Battaglia 2019-10-17 16:31:46 -06:00
parent 6349c6e2cc
commit d6c7c396a1
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/docker/developing_with_docker.md
View File

@ -17,7 +17,7 @@ The easiest way to get a working development environment is to run:
This will guide you through the process of installing docker, dinghy/dory, This will guide you through the process of installing docker, dinghy/dory,
building the docker images, and setting up Canvas. building the docker images, and setting up Canvas.
If you would rather do things manually, read on! If you would rather do things manually, read on! And be sure to check the [Troubleshooting](#Troubleshooting) section below.
## Recommendations ## Recommendations
@ -66,7 +66,7 @@ Now you're ready to build all of the containers. This will take a while as a lot
```bash ```bash
docker-compose run --rm web bundle install docker-compose run --rm web bundle install
docker-compose run --rm web bundle exec rake db:create db:initial_setup canvas:compile_assets_dev docker-compose run --rm web bundle exec rake db:create db:initial_setup canvas:compile_assets
``` ```
Now you should be able to start up and access canvas like you would any other container. Now you should be able to start up and access canvas like you would any other container.
@ -225,12 +225,18 @@ Now you can just run commands like `dcrx rake db:migrate` or `dcr bundle install
## Troubleshooting ## Troubleshooting
### Building docker container
If you get an error about some gems requiring a newer ruby, you may have to change `2.4-xenial` to `2.5` in the `FROM` line in Dockerfile.
### Permissions
If you are having trouble running the `web` container, make sure that permissions on the directory are permissive. You can try the owner change (less disruptive): If you are having trouble running the `web` container, make sure that permissions on the directory are permissive. You can try the owner change (less disruptive):
``` ```
chown -R 1000:1000 canvas-lms chown -R 1000:1000 canvas-lms
``` ```
Instead of `1000`, you may need to use `9999` -- the `docker` user inside the container may have uid `9999`.
Or the permissions change (which will make Docker work, but causes the git working directory to become filthy): Or the permissions change (which will make Docker work, but causes the git working directory to become filthy):
``` ```
@ -260,6 +266,7 @@ Or it can be disabled permanently by editing `/etc/selinux/config` thusly:
SELINUX=disabled SELINUX=disabled
``` ```
### Performance
If you are having performance or other issues with your web container If you are having performance or other issues with your web container
starting up, you may try adding `DISABLE_SPRING: 1` to your starting up, you may try adding `DISABLE_SPRING: 1` to your
`docker-compose.override.yml` file, like so: `docker-compose.override.yml` file, like so:
@ -270,6 +277,13 @@ web: &WEB
DISABLE_SPRING: 1 DISABLE_SPRING: 1
``` ```
Sometimes, very poor performance (or not loading at all) can be due to webpack
problems. Running
`docker-compose run --rm web bundle exec rake canvas:compile_assets` again, or
`docker-compose run --rm web bundle exec rake js:webpack_development` again, may help.
### DNS
If you are getting DNS resolution errors, and you use Docker for Mac or Linux, If you are getting DNS resolution errors, and you use Docker for Mac or Linux,
make sure [dory](https://github.com/FreedomBen/dory) is running: make sure [dory](https://github.com/FreedomBen/dory) is running:
@ -282,3 +296,5 @@ If dory is not running, you can start it with:
``` ```
dory up dory up
``` ```
Alternatively, you can use Dinghy or Traefik to handle DNS resolution.