diff --git a/docs/en/installation/docker.md b/docs/en/installation/docker.md index 3b8199e09..4181b9b6e 100644 --- a/docs/en/installation/docker.md +++ b/docs/en/installation/docker.md @@ -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: ![docker ps](https://i.imgur.com/ASvzXrd.png) -### 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 diff --git a/docs/es/installation/docker.md b/docs/es/installation/docker.md index d8663fa9e..f458b1cd0 100644 --- a/docs/es/installation/docker.md +++ b/docs/es/installation/docker.md @@ -1,65 +1,37 @@ # Usando Docker para desarrollo en local -Puedes usar Docker para tener una instalación local de Consul Democracy si: - -- Estás teniendo problemas para instalar los [prerrequisitos](prerequisites.md) correctamente. -- Quieres tener una instalación local rápidamente para probar o hacer una demo. -- Prefieres no interferir con instalaciones de apps Rails existentes. - ## Prerrequisitos -Debes tener instalador Docker y Docker Compose en tu ordenador: +Debes tener instalados Docker y Docker Compose en tu ordenador. El proceso de instalación depende de tu sistema operativo. ### macOS -Puedes seguir la [guía oficial de docker](https://docs.docker.com/docker-for-mac/install/) +Puedes seguir la [guía oficial de Docker](https://docs.docker.com/docker-for-mac/install/). -O si tienes instalado [homebrew](http://brew.sh) y [cask](https://caskroom.github.io/) puedes ejecutar: +O, si tienes instalado [homebrew](http://brew.sh), puedes ejecutar: ```bash brew install docker brew install docker-compose -brew cask install docker +brew install --cask docker open -a docker ``` -La aplicación de Docker te pedirá darle permisos e intrudocir tu contraseña. +La aplicación de Docker te pedirá darle permisos e introducir tu contraseña. ### Linux -1. Instala Docker: +1. Instala Docker y Docker Compose. Por ejemplo, en 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. Instala 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 -En la página de [https://www.docker.com/get-started](Empezando con Docker), en la sección "Docker Desktop", selecciona "Download for Windows", y ejecútalo. Debería tardar unos 5 minutos. +La documentación oficial de Docker incluye una página con instrucciones para [instalar Docker Desktop en Windows](https://docs.docker.com/desktop/install/windows-install/). En esa página, descarga Docker Desktop para Windows y ejecútalo. -Si encuentras el error "WSL 2 installation incomplete": - -1. Ejecuta PowerShell como administrator -1. Ejecuta `dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart` -1. Ejecuta `dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart` -1. Instala el [paquete de actualización de WSL2 para 64 bits](https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi) -1. Ejecuta `wsl --set-default-version 2` -1. Reinicia el sistema -1. Se iniciará Docker Enginer. tardará unos minutos. Tras esto, tendrás la opción de usar la applicación de Docker Desktop y la orden `docker` de PowerShell/Bash - -## Instalación +

Instalación

Clona el repositorio en tu ordenador y entra en el directorio: @@ -68,9 +40,7 @@ git clone https://github.com/consuldemocracy/consuldemocracy.git cd consuldemocracy ``` -### macOS & Linux - -Creamos nuestros ficheros de secrets y database basados en los ejemplos: +A continuación, crea los ficheros de `config/secrets.yml` y `config/database.yml` basados en los ficheros de ejemplo: ```bash cp config/secrets.yml.example config/secrets.yml @@ -96,21 +66,15 @@ POSTGRES_PASSWORD=password docker-compose run app rake db:create db:migrate POSTGRES_PASSWORD=password docker-compose run app rake db:dev_seed ``` -### Windows +## Arranque de Consul Democracy en desarrollo -Pendiente de ser completado... ¡Se agradecen las Contribuciones! - -## Corriendo Consul Democracy en local con Docker - -### macOS & Linux - -Una vez instalado, puedes lanzar la aplicación con: +Una vez instalada, puedes lanzar la aplicación con: ```bash POSTGRES_PASSWORD=password docker-compose up ``` -Y podrás acceder a la aplicación desde tu navegador visitando [http://localhost:3000](http://localhost:3000) +Y podrás acceder a la aplicación desde tu navegador visitando [http://localhost:3000](http://localhost:3000). Adicionalmente, si quieres lanzar por ejemplo la consola de rails: @@ -118,42 +82,38 @@ Adicionalmente, si quieres lanzar por ejemplo la consola de rails: POSTGRES_PASSWORD=password docker-compose run app rails console ``` -Para verificar que los contenedores estan corriendo usa: +Para verificar que los contenedores están ejecutándose usa: ```bash -docker ps . +docker ps ``` Deberías obtener algo similar a: ![docker ps](https://i.imgur.com/ASvzXrd.png) -### Windows +## Resolución de problemas -Pendiente de ser completado... ¡Se agradecen las Contribuciones! +Ejecuta los siguientes comandos **en el directorio de Consul Democracy** para borrar todas las imágenes y contenedores anteriores del Docker de Consul Democracy. Luego, comienza de nuevo con el [proceso de instalación](#instalacion) de Docker. -## ¿Tienes problemas? - -Ejecute los comandos en el **directorio de Consul Democracy**, para borrar todas las imágenes y contenedores anteriores del Docker de Consul Democracy. Luego, reinicie el [proceso de instalación](#instalacion) de Docker: - -1. Quitar todas las imágenes de Consul Democracy: +1. Quita todas las imágenes de Consul Democracy: ```bash docker-compose down --rmi all -v --remove-orphans ``` -2. Quitar todos los contenedores de Consul Democracy +2. Quita todos los contenedores de Consul Democracy: ```bash docker-compose rm -f -s -v ``` -3. Verificar si todavía hay algún contenedor: +3. Verifica si todavía hay algún contenedor: ```bash docker ps -a ``` -Caso positivo, eliminar cada uno de forma manual: +4. En caso afirmativo, elimina cada uno de forma manual: ```bash docker container rm