diff --git a/README.md b/README.md index a3b524754e..cd8b546540 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,33 @@ Jump In: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samv ## Running the stack +### For development / testing with Docker + +#### Dory + +On OS X or Linux we recommend running [Dory](https://github.com/FreedomBen/dory). It acts as a proxy allowing you to access domains locally such as hyku.docker or tenant.hyku.docker, making multitenant development more straightforward and prevents the need to bind ports locally. You can still run in development via docker with out Dory, but to do so please uncomment the ports section in docker-compose.yml and then find the running application at localhost:3000 + +```bash +gem install dory +dory up +``` + +#### Basic steps + +```bash +docker-compose up web # web here means you can start and stop Rails w/o starting or stopping other services. `docker-compose stop` when done shuts everything else down. +``` + +Once that starts (you'll see the line `Passenger core running in multi-application mode.` to indicate a successful boot), you can view your app in a web browser with at either hyku.docker or localhost:3000 (see above) + +#### Tests in Docker + +The full spec suite can be run in docker locally. There are several ways to do this, but one way is to run the following: + +```bash +docker-compose exec web rake +``` + ### For development ```bash diff --git a/docker-compose.yml b/docker-compose.yml index b6e49d9f3e..466ccb2179 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -123,6 +123,8 @@ services: - db_migrate expose: - 80 + #ports: + # 3000:80 # uncomment this if you dont use dory or another proxy workers: extends: