added docker documentation (openemr#3678)

* added docker documentation * fixes * fixes * fixes
bradymiller · Jun 26, 2020 · b2b0763 · b2b0763
1 parent d153ecc
commit b2b0763
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 0 deletions.
diff --git a/DOCKER_README.md b/DOCKER_README.md
@@ -0,0 +1,25 @@
+# OpenEMR Docker Documentation
+
+## Overview
+The OpenEMR community loves Docker. We eat and breath Docker. The OpenEMR dockers can be found on
+[dockerhub](https://hub.docker.com/r/openemr/openemr/). There are two main categories of dockers for
+OpenEMR, Production Dockers and Development Dockers. Production dockers are meant for production use
+with tags such as `5.0.2` and `latest`. Development dockers are meant for development and include the
+`flex` series.
+
+## Production Dockers
+Production dockers are meant for production use with tags such as `5.0.2` and `latest` and can be found
+on [dockerhub](https://hub.docker.com/r/openemr/openemr/). An example docker-compose.yml script can be
+found in the `docker` directory at [docker/docker-compose.yml](docker/docker-compose.yml). After modifying the
+script for your purposes, it can then be started with `docker-compose up`, which will then take about 5-10
+minutes to complete.
+
+## Development Dockers
+Development dockers are meant for development and include the `flex` series and can be found on
+[dockerhub](https://hub.docker.com/r/openemr/openemr/). It is strongly recommended to not use these dockers
+for production purposes unless you know what you are doing. There are 2 OpenEMR development environments,
+which are based on these development dockers. The main development environment is the Easy Development Docker
+environment, which is documented at [CONTRIBUTING.md](CONTRIBUTING.md#code-contributions-local-development)
+and [contrib/util/docker/README.md](contrib/util/docker/README.md#easy-development-docker-environment). The other
+development environment, which is much more complex, is the Insane Development Docker environment, which is
+documented at [contrib/util/docker/README.md](contrib/util/docker/README.md#insane-development-docker-environment).
diff --git a/README.md b/README.md
@@ -30,6 +30,10 @@ Send an email to brady.g.miller@gmail.com . If possible, please encrypt your ema
 
 Check out [API_README.md](API_README.md)
 
+### Docker
+
+Check out [DOCKER_README.md](DOCKER_README.md)
+
 ### For Developers
 
 If using OpenEMR directly from the code repository, then the following commands will build OpenEMR (Node.js version 10.* or 12.* is required) :

diff --git a/docker/README.md b/docker/README.md
@@ -0,0 +1,2 @@
+
+Check out [DOCKER_README.md](../DOCKER_README.md)
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
@@ -0,0 +1,36 @@
+# Use admin/pass as user/password credentials to login to openemr (from OE_USER and OE_PASS below)
+# MYSQL_HOST and MYSQL_ROOT_PASS are required for openemr
+# MYSQL_USER, MYSQL_PASS, OE_USER, MYSQL_PASS are optional for openemr and
+#   if not provided, then default to openemr, openemr, admin, and pass respectively.
+version: '3.1'
+services:
+  mysql:
+    restart: always
+    image: mariadb:10.4
+    command: ['mysqld','--character-set-server=utf8']
+    volumes:
+    - databasevolume:/var/lib/mysql
+    environment:
+      MYSQL_ROOT_PASSWORD: root
+  openemr:
+    restart: always
+    image: openemr/openemr:latest
+    ports:
+    - 80:80
+    - 443:443
+    volumes:
+    - logvolume01:/var/log
+    - sitevolume:/var/www/localhost/htdocs/openemr/sites
+    environment:
+      MYSQL_HOST: mysql
+      MYSQL_ROOT_PASS: root
+      MYSQL_USER: openemr
+      MYSQL_PASS: openemr
+      OE_USER: admin
+      OE_PASS: pass
+    depends_on:
+    - mysql
+volumes:
+  logvolume01: {}
+  sitevolume: {}
+  databasevolume: {}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@

		Check out [DOCKER_README.md](../DOCKER_README.md)