diff --git a/docker/README.md b/docker/README.md index ed34c46013..8c3cc0036c 100644 --- a/docker/README.md +++ b/docker/README.md @@ -5,6 +5,9 @@ * Docker provides a common virtual environment available to all developers and resolves the infamous "but it works on my machine" problem. * Use the scripts in this directory to execute tasks in Docker. Please note that these scripts are intended to be executed from this app's root directory (/openfoodnetwork). These scripts allow you to bypass the need to keep typing "docker-compose run web". +## Limitations +1. he docker environment can't directly control your host system browser, which means that browser specs (under `/spec/system/`) and email previews will not work. You may be able to find a solution with [this article](https://evilmartians.com/chronicles/system-of-a-test-setting-up-end-to-end-rails-testing). If so, please contribute! + ## Installing Docker ### Requirements * You should have at least 2 GB free on your local machine to download Docker images and create Docker containers for this app. @@ -123,7 +126,7 @@ See [#8421](https://github.com/openfoodfoundation/openfoodnetwork/issues/8421) f ## Script Summary * docker/build(.ps1): This script builds the Docker containers specified for this app, seeds the database, and logs the screen output for these operations. After you use "git clone" to download this repository, run the docker/build script to start the setup process. * docker/server(.ps1): Use this script to run this app in the Rails server. This script executes the "docker-compose up" command and logs the results. If all goes well, you will be able to view this app on your local browser at http://localhost:3000/. -* docker/test(.ps1): Use this script to run the entire test suite. +* docker/test(.ps1): Use this script to run the entire test suite. **Note limitation with system specs mentioned above**. * docker/qtest: Use this script to run the entire test suite in quiet mode. The deprecation warnings are removed to make the test results easier to read. * docker/run: Use this script to run commands within the Docker container. If you want shell access, enter "docker/run bash". To execute "ls -l" within the Docker container, enter "docker/run ls -l". * docker/seed(.ps1): Use this script to seed the database. Please note that this process is not compatible with simultaneously running the Rails server or tests.