Simplify documentation to install Docker
Docker and Docker Compose are included in most Linux distributions, and we don't know whether the windows error we talked about is still relevant in 2024. In any case, the Docker documentation to install windows is a better resource for that than our documentation. We're also using the same Docker commands for every operating system.
This commit is contained in:
Javi Martín
@@ -1,63 +1,35 @@
|
||||
# Using Docker for local development
|
||||
|
||||
You can use Docker to have a local Consul Democracy installation for development if:
|
||||
|
||||
- You're having troubles having [prerequisites](prerequisites.md) installed.
|
||||
- You want to do a quick local installation just to try Consul Democracy or make a demo.
|
||||
- You prefer not to interfere with other rails installations.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
You should have installed Docker and Docker Compose in your machine:
|
||||
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 install](https://docs.docker.com/docker-for-mac/install/)
|
||||
You can follow the [official Docker installation documentation](https://docs.docker.com/docker-for-mac/install/).
|
||||
|
||||
Or if you have [homebrew](http://brew.sh) and [cask](https://caskroom.github.io/) installed you can just:
|
||||
Or, if you have [homebrew](http://brew.sh) installed, you can just:
|
||||
|
||||
```bash
|
||||
brew install docker
|
||||
brew install docker-compose
|
||||
brew cask install docker
|
||||
brew install --cask docker
|
||||
open -a docker
|
||||
```
|
||||
|
||||
You'll be asked to give Docker app permissions and type your password, then you're set.
|
||||
You'll be asked to give permissions to the Docker app and type your password; then, you're set.
|
||||
|
||||
### Linux
|
||||
|
||||
1. Install Docker:
|
||||
1. Install Docker and Docker Compose. For example, in Ubuntu 22.04:
|
||||
|
||||
```bash
|
||||
sudo apt-get update
|
||||
sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
|
||||
sudo apt-add-repository 'deb https://apt.dockerproject.org/repo ubuntu-xenial main'
|
||||
sudo apt-get update
|
||||
apt-cache policy docker-engine
|
||||
sudo apt-get install -y docker-engine
|
||||
```
|
||||
|
||||
2. Install Docker Compose
|
||||
|
||||
```bash
|
||||
sudo curl -o /usr/local/bin/docker-compose -L "https://github.com/docker/compose/releases/download/1.15.0/docker-compose-$(uname -s)-$(uname -m)"
|
||||
sudo chmod +x /usr/local/bin/docker-compose
|
||||
sudo apt-get install docker.io docker-compose-v2
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
Go to the [https://www.docker.com/get-started](Get Started with Docker) page. Under Docker Desktop, select Download for Windows with default options checked, and run. Should take about 5 minutes.
|
||||
|
||||
If you encounter the "WSL 2 installation incomplete" error:
|
||||
|
||||
1. Start PowerShell as Administrator
|
||||
1. Run `dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart`
|
||||
1. Run `dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart`
|
||||
1. Install [WSL2 Linux kernel update package for x64 machines](https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi)
|
||||
1. Run `wsl --set-default-version 2`
|
||||
1. Restart your PC
|
||||
1. The Docker Enginer will start up. Give it a few minutes. You now have the option of using the docker desktop app (GUI) and `docker` PowerShell/Bash commands
|
||||
The official Docker documentation includes a page with instructions to [install Docker Desktop on Windows](https://docs.docker.com/desktop/install/windows-install/). From there, download Docker Desktop for Windows and execute it.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -68,9 +40,7 @@ git clone https://github.com/consuldemocracy/consuldemocracy.git
|
||||
cd consuldemocracy
|
||||
```
|
||||
|
||||
### macOS & Linux
|
||||
|
||||
Then lets create our secrets and database config files based on examples:
|
||||
Then create the secrets and database config files based on the example files:
|
||||
|
||||
```bash
|
||||
cp config/secrets.yml.example config/secrets.yml
|
||||
@@ -96,13 +66,7 @@ POSTGRES_PASSWORD=password docker-compose run app rake db:create db:migrate
|
||||
POSTGRES_PASSWORD=password docker-compose run app rake db:dev_seed
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
Pending to be completed... Contributions Welcome!
|
||||
|
||||
## Running local Consul Democracy with Docker
|
||||
|
||||
### macOS & Linux
|
||||
## Running Consul Democracy in development with Docker
|
||||
|
||||
Now we can finally run the application with:
|
||||
|
||||
@@ -110,9 +74,9 @@ Now we can finally run the application with:
|
||||
POSTGRES_PASSWORD=password docker-compose up
|
||||
```
|
||||
|
||||
And you'll be able to access it at your browser visiting [http://localhost:3000](http://localhost:3000)
|
||||
And you'll be able to access it by opening your browser and visiting [http://localhost:3000](http://localhost:3000).
|
||||
|
||||
Additionally, if you want to run the rails console just run in another terminal:
|
||||
Additionally, if you'd like to run the rails console:
|
||||
|
||||
```bash
|
||||
POSTGRES_PASSWORD=password docker-compose run app rails console
|
||||
@@ -121,19 +85,15 @@ POSTGRES_PASSWORD=password docker-compose run app rails console
|
||||
To verify the containers are up execute:
|
||||
|
||||
```bash
|
||||
docker ps .
|
||||
docker ps
|
||||
```
|
||||
|
||||
You should see output similar to this:
|
||||
You should see an output similar to this:
|
||||
|
||||
|
||||
### Windows
|
||||
## Troubleshooting
|
||||
|
||||
Pending to be completed... Contributions Welcome!
|
||||
|
||||
## Having trouble?
|
||||
|
||||
Run these commands at **Consul Democracy's directory**, to erase all your previous Consul Democracy's Docker images and containers. Then restart the Docker [installation process](#installation):
|
||||
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](#installation) once again.
|
||||
|
||||
1. Remove all Consul Democracy images:
|
||||
|
||||
@@ -141,19 +101,19 @@ Run these commands at **Consul Democracy's directory**, to erase all your previo
|
||||
docker-compose down --rmi all -v --remove-orphans
|
||||
```
|
||||
|
||||
2. Remove all Consul Democracy containers
|
||||
2. Remove all Consul Democracy containers:
|
||||
|
||||
```bash
|
||||
docker-compose rm -f -s -v
|
||||
```
|
||||
|
||||
3. Verify if there is some container yet:
|
||||
3. Check whether there are still containers left:
|
||||
|
||||
```bash
|
||||
docker ps -a
|
||||
```
|
||||
|
||||
Case positive, remove each one manually:
|
||||
4. In case there are, remove each one manually:
|
||||
|
||||
```bash
|
||||
docker container rm <container_id>
|
||||
|
||||
Reference in New Issue
Block a user