Files

Javi Martín d88ea7f26d Use build+create in Docker installation instructions

There was a typo where we said we were creating the containers but we
were building the image.

While none of these commands are necessary because they're run
automatically when first running the `db:create` rake task, I think it's
better to show them separately, since the `build` command might be used
to rebuild the image, and running the `create` command separately makes
it easier to know what's going on.

We're also removing the "start database service" step, since it's
automatically started because the app service depends on it.

Finally, we're updating one command for macOS.

2024-09-19 15:20:38 +02:00

2.8 KiB

Raw Blame History

Using Docker for local development

Prerequisites

Docker and Docker Compose should be installed on your machine. The installation process depends on your operating system.

macOS

You can follow the official Docker installation documentation.

Or, if you have homebrew installed, you can just:

brew install docker
brew install docker-compose
brew install --cask docker
open -a docker

You'll be asked to give permissions to the Docker app and type your password; then, you're set.

Linux

Install Docker and Docker Compose. For example, in Ubuntu 22.04:

sudo apt-get install docker.io docker-compose-v2

Windows

The official Docker documentation includes a page with instructions to install Docker Desktop on Windows. From there, download Docker Desktop for Windows and execute it.

Installation

Clone the repo on your computer and enter the folder:

git clone https://github.com/consuldemocracy/consuldemocracy.git
cd consuldemocracy

Then create the secrets and database config files based on the example files:

cp config/secrets.yml.example config/secrets.yml
cp config/database-docker.yml.example config/database.yml

Then build the image with:

POSTGRES_PASSWORD=password docker-compose build

And create the containers:

POSTGRES_PASSWORD=password docker-compose create

You can now initialize your development DB and populate it with:

POSTGRES_PASSWORD=password docker-compose run app rake db:create db:migrate
POSTGRES_PASSWORD=password docker-compose run app rake db:dev_seed

Running Consul Democracy in development with Docker

Now we can finally run the application with:

POSTGRES_PASSWORD=password docker-compose up

And you'll be able to access it by opening your browser and visiting http://localhost:3000.

Additionally, if you'd like to run the rails console:

POSTGRES_PASSWORD=password docker-compose run app rails console

To verify the containers are up execute:

docker ps

You should see an output similar to this:

Troubleshooting

Run these commands inside Consul Democracy's directory, to erase all your previous Consul Democracy's Docker images and containers. Then start the Docker installation process once again.

Remove all Consul Democracy images:

docker-compose down --rmi all -v --remove-orphans

Remove all Consul Democracy containers:

docker-compose rm -f -s -v

Check whether there are still containers left:

docker ps -a

In case there are, remove each one manually:

docker container rm <container_id>

2.8 KiB Raw Blame History