DOCKER_README.md

   1 # OpenEMR Docker Documentation
   2
   3 ## Overview
   4 The OpenEMR community loves Docker. We eat and breathe Docker. The OpenEMR dockers and detailed documentation
   5 can be found on [dockerhub](https://hub.docker.com/r/openemr/openemr/). There are two main categories of
   6 dockers for OpenEMR, Production Dockers and Development Dockers. Production dockers are meant for production
   7 use with tags such as `7.0.0` whereby the `latest` tag identifies the most recent version Production
   8 docker. Development dockers are mainly meant for development and/or testing and include the `flex`
   9 series which are highly flexible development dockers that are used to create the standard OpenEMR development
  10 environments. There is also a development docker that is built nightly from the current development codebase
  11 with tags `dev` and `next` that is less flexible than the `flex` series and is mainly used for testing.
  12
  13 ## Production Dockers
  14 Production dockers are meant for production use with tags such as `7.0.0` whereby the `latest` tag identifies
  15 the most recent version Production docker and can be found on [dockerhub](https://hub.docker.com/r/openemr/openemr/).
  16 Several example docker-compose.yml scripts are discussed below.
  17
  18 ### Production example
  19 An example docker-compose.yml script can be found at
  20 [docker/production/docker-compose.yml](docker/production/docker-compose.yml). After modifying the
  21 script for your purposes, it can then be started with `docker-compose up`, which will then take about 5-10
  22 minutes to complete.
  23
  24 ### Production example for Raspberry Pi
  25 An example docker-compose.yml script for Raspberry Pi can be found at
  26 [docker/production-arm/docker-compose.yml](docker/production-arm/docker-compose.yml). After modifying the
  27 script for your purposes, it can then be started with `docker-compose up`, which will then take about 5-10
  28 minutes to complete.
  29
  30 ## Development Dockers
  31 Development dockers are meant for development and testing and can be found on
  32 [dockerhub](https://hub.docker.com/r/openemr/openemr/).
  33
  34 ### `Flex` Series Development Dockers and Development Environments
  35 The `flex` series development dockers are highly flexible development dockers that are used to create the
  36 standard OpenEMR development environments, and can be found on
  37 [dockerhub](https://hub.docker.com/r/openemr/openemr/). It is strongly recommended to not use these dockers
  38 for production purposes unless you know what you are doing. There are 2 OpenEMR development environments,
  39 which are based on these development dockers. The main development environment is the Easy Development Docker
  40 environment, which is documented at [CONTRIBUTING.md](CONTRIBUTING.md#code-contributions-local-development);
  41 note this environment can also be run on Raspberry Pi. The other development environment, which is much more
  42 complex, is the Insane Development Docker environment, which is documented at
  43 [docker/development-insane/README.md](docker/development-insane/README.md#insane-development-docker-environment).
  44
  45 ### Nightly build Development Docker
  46 There is also a development docker that is built nightly from the current development codebase with tags `dev`
  47 and `next` that is less flexible than the `flex` series and is mainly used for testing, and can be found on
  48 [dockerhub](https://hub.docker.com/r/openemr/openemr/).