Skip to content
This repository has been archived by the owner on May 28, 2023. It is now read-only.

Latest commit

 

History

History
70 lines (45 loc) · 3.29 KB

DOCKER_README.md

File metadata and controls

70 lines (45 loc) · 3.29 KB
Raw

Running New Sanctuary Asylum in a Docker Container

Installing Docker:

Confirm docker is installed by typing docker info in your terminal.

Using Docker

Setup files

  • Ensure you have a .env file (see README.md for details.)
  • Add this line to .env: POSTGRES_PASSWORD=password

Building The Image

The first time you run the application in docker, you need to build the docker-compose image. This will create a static artifact that will be used to start the containers. You only need to build once, or if you change the Dockerfile, docker-compose.yml file, or make changes to the database.

Run make build. If you are on Windows, make commands may not work. Windows OS: docker-compose -f docker-compose.yml build

To Start and Run the Containers

Now that the image has been build, we need to start the containers for the web application and the database. We do this with the up command.

Run make up. Windows OS: docker-compose -f docker-compose.yml up

To Stop the Containers

To stop your running container process, press ctrl+c. To bring down the containers cleanly, run make down. Windows OS: docker-compose -f docker-compose.yml down

To confirm the containers have stopped, you can take a look with docker ps -- the output should be empty.

Docker Workflow

While you're developing, you should be able to work in your text editor and see your changes to the application while the container is up and running.

The server may need to be restarted at times, such as after adding new migrations or adding or updating gems. If you previously would have had to restart the rails server to see changes, instead you'll have to down and up the docker container.

Running Commands inside a Container

To run the rails console or rspec, you have to exec into a running container. This application has two: a web container, which contains the rails application, and a db container, which contains the postgres database.

To Run Rails Console

Run: docker exec -it sanctuary_web /bin/bash then rails c.

To Run Rspec

To interactively run tests, run: docker exec -it sanctuary_web /bin/bash then rspec .. To just see test results, run: docker exec -it sanctuary_web rspec or make test.

To Open a PSQL Console

Run: docker exec -it sanctuary_db psql -U postgres

Some shortcuts for using PSQL: cheatsheet

Docker Troubleshooting

To start from scratch completely and eliminate previously-built images, run make down_clean. Windows OS: docker-compose -f docker-compose.yml down --rmi all

If you get the error A server is already running. Check /tmp/sanctuary/tmp/pids/server.pid, in another tab run:

docker start sanctuary_web; docker exec sanctuary_web rm /sanctuary/tmp/pids/server.pid

and the container should restart with a new pid.

Running the Application Without Docker (after running it WITH Docker)

Running the application without Docker requires values in the database.yml file that are different from what Docker populated when building the image. To run without Docker, replace the contents of database.yml with the contents of database.yml.sample.