Skip to content

Latest commit

 

History

History
137 lines (119 loc) · 8.39 KB

README.md

File metadata and controls

137 lines (119 loc) · 8.39 KB

Docker Scripts

What's the point?

  • Setting up the Open Food Network app on your local machine is quick and easy with the aid of Docker.
  • Docker provides a common virtual environment available to all developers and resolves the infamous "but it works on my machine" problem.
  • Use the scripts in this directory to execute tasks in Docker. Please note that these scripts are intended to be executed from this app's root directory (/openfoodnetwork). These scripts allow you to bypass the need to keep typing "docker-compose run web".

Limitations

  1. The docker environment can't directly control your host system browser, which means that browser specs (under /spec/system/) and email previews will not work. You may be able to find a solution with this article. If so, please contribute!

Installing Docker

Requirements

  • You should have at least 2 GB free on your local machine to download Docker images and create Docker containers for this app.

Installation

Linux

  • Visit https://docs.docker.com/engine/install/#server and select your Linux distribution to install Docker Engine. Note: There is no need to install Docker Desktop on Linux.
  • Follow the installation instructions provided. Installing from Docker repositories is recommended.
  • Install Docker Compose V1. Docker Engine comes with Docker Compose V2 which is not yet supported by our Docker scripts.
$ sudo apt install docker-compose

Windows

  • Docker installation instructions are at https://docs.docker.com/get-docker/.
  • You may have to deselect the option to use Docker Compose V2 in Docker settings to make our scripts work.

Getting Started

Linux

  • Open a terminal with a shell.
  • Clone the repository. If you're planning on contributing code to the project (which we LOVE), begin by forking this repo with the Fork button in the top-right corner of this screen.
  • Use git clone to copy your fork onto your local machine.
$ git clone https://github.com/YOUR_GITHUB_USERNAME_HERE/openfoodnetwork
  • Otherwise, if you just want to get things running, clone from the OFN main repo:
$ git clone [email protected]:openfoodfoundation/openfoodnetwork.git
  • Go at the root of the app:
$ cd openfoodnetwork
  • Download the Docker images, build the Docker containers, seed the database with sample data, AND log the screen output from these tasks:
$ docker/build
  • Run the Rails server and its required Docker containers:
$ docker/server
  • The default admin user is '[email protected]' with the password 'ofn123'.
  • View the app in the browser at http://localhost:3000.
  • You will then get the trace of the containers in the terminal. You can stop the containers using Ctrl-C in the terminal.
  • You can find some useful tips and commands here.

Windows

  • Prerequisite : don't forget to activate the execution of powershell scripts following the instruction on this page chosing "Using RemoteSigned Execution Policy"
  • Open a terminal with a shell command.
  • Clone the repository. If you're planning on contributing code to the project (which we LOVE), begin by forking this repo with the Fork button in the top-right corner of this screen.
  • Use git clone to copy your fork onto your local machine.
$ git clone https://github.com/YOUR_GITHUB_USERNAME_HERE/openfoodnetwork
  • Otherwise, if you just want to get things running, clone from the OFN main repo:
$ git clone [email protected]:openfoodfoundation/openfoodnetwork.git
  • Go at the root of the app:
$ cd openfoodnetwork
  • Download the Docker images, build the Docker containers, seed the database with sample data, AND log the screen output from these tasks:
$ docker/build.ps1
  • Run the Rails server and its required Docker containers:
$ docker/server.ps1

You may need to wait several minutes before getting the server up and running properly.

  • The default admin user is '[email protected]' with the password 'ofn123'.
  • View the app in the browser at http://localhost:3000.
  • You will then get the trace of the containers in the terminal. You can stop the containers using Ctrl-C in the terminal.
  • You can find some useful tips and commands here.

Troubleshooting

  • If you get a PowerShell error saying that "execution of scripts is disabled on this system.", you may need to activate the powershell script execution on your Windows machine.
  • If you are using Windows and having issues related to the ruby-build not finding a definition for the ruby version, you may need to follow these commands here to fix your local git config related to line breaks.
  • If you’re getting the following error:
dockerpycreds.errors.InitializationError: docker-credential-desktop not installed or not available in PATH
[8929] Failed to execute script docker-compose

Just change the entry in ~/.docker/config.json like this (credStore instead of credsStore), and you’re good to go:

{
  "stackOrchestrator" : "swarm",
  "experimental" : "disabled",
  "credStore" : "desktop"
}

Troubleshooting for M1 Apple Silicon users

  1. Current Dockerfile is not architecture-agnostic, so you get an error like
#0 3.023 E: Failed to fetch http://security.ubuntu.com/ubuntu/dists/bionic-security/main/binary-arm64/Packages  404  Not Found [IP: 185.125.190.36 80]
#0 3.023 E: Some index files failed to download. They have been ignored, or old ones used instead.
------
failed to solve: executor failed running [/bin/sh -c apt-get update && apt-get install -y   curl   git   build-essential   software-properties-common   wget   zlib1g-dev   libreadline-dev   libyaml-dev   libffi-dev   libxml2-dev   libxslt1-dev   wait-for-it   imagemagick   unzip   libjemalloc-dev   libssl-dev   ca-certificates   gnupg]: exit code: 100

To solve this, we need to hack Dockerfile a bit.

Steps to follow:

  • Comment out line 7 RUN echo "deb http://security.ubuntu.com/ubuntu bionic-security main" >> /etc/apt/sources.list
  • Comment out line 33 (ENV LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so) and remove RUBY_CONFIGURE_OPTS=--with-jemalloc from the start of line 48

You may also need to comment out stuff related to Chromedriver and Chrome. Chrome setup may work with [arch=amd64] removed.

See #8421 for more info

Script Summary

  • docker/build(.ps1): This script builds the Docker containers specified for this app, seeds the database, and logs the screen output for these operations. After you use "git clone" to download this repository, run the docker/build script to start the setup process.
  • docker/server(.ps1): Use this script to run this app in the Rails server. This script executes the "docker-compose up" command and logs the results. If all goes well, you will be able to view this app on your local browser at http://localhost:3000/.
  • docker/test(.ps1): Use this script to run the entire test suite. Note limitation with system specs mentioned above.
  • docker/qtest: Use this script to run the entire test suite in quiet mode. The deprecation warnings are removed to make the test results easier to read.
  • docker/run: Use this script to run commands within the Docker container. If you want shell access, enter "docker/run bash". To execute "ls -l" within the Docker container, enter "docker/run ls -l".
  • docker/seed(.ps1): Use this script to seed the database. Please note that this process is not compatible with simultaneously running the Rails server or tests.
  • docker/nuke: Use this script to delete all Docker images and containers. This fully resets your Docker setup and is useful for making sure that the setup procedure specified for this app is complete.
  • docker/cop(.ps1): This script runs RuboCop.