| blob | 0b5667ff56414a44189699cb3fd6da54fd4a91a7 |
1 ### Insane Development Docker Environment ###
2 The Insane Development Docker Environment will load up about 37 separate dockers and allow you to
3 test almost any version of mysql/mariadb/php, however it is not nearly as easy to use as the above Easy Development
4 Docker Environment. See below for instructions of use of the Insane Development Docker Environment.
6 #### Setup
8 **Step 1.** Install [git](https://git-scm.com/downloads),
9 [docker](https://www.docker.com/get-docker) and
10 [compose](https://docs.docker.com/compose/install/) for your system. Also, make
11 sure you have a [fork](https://help.github.com/articles/fork-a-repo/) of OpenEMR.
12 - If you want to set up the base services(e.g. git, docker, docker-compose, openemr-cmd) easily, please try [openemr-env-installer](https://github.com/openemr/openemr-devops/tree/master/utilities/openemr-env-installer)
13 - If you want to troubleshoot with the below steps easier, please also [install openemr-cmd](https://github.com/openemr/openemr-devops/tree/master/utilities/openemr-cmd) for your system
14 - If you want to monitor and easily manage the docker environment, please also [install openemr-monitor](https://github.com/openemr/openemr-devops/tree/master/utilities/openemr-monitor) and [install portainer](https://github.com/openemr/openemr-devops/tree/master/utilities/portainer) for your system
15 - If you want to migrator the running docker environment, please try [openemr-env-migrator](https://github.com/openemr/openemr-devops/tree/master/utilities/openemr-env-migrator)
17 **Step 2.** Start OpenEMR.
18 ```bash
19 $ git clone git@github.com:YOUR_USERNAME/openemr.git
20 ```
21 There are 2 different schools of thought on where to run the docker from.
22 - Option 1. Run the docker from within your git repository.(this is also where you edit
23 scripts in your editor)
24 ```bash
25 $ cd openemr/docker/development-insane
26 $ docker-compose up -d
27 ```
28 - Option 2. Run the docker from a separate directory that is synchronized with your git
29 repository. For example, if used /var/www/openemr.
30 ```bash
31 $ cd /var/www/openemr/docker/development-insane
32 $ docker-compose up -d
33 ```
34 - At this time, I highly recommend option 2 since running OpenEMR will change
35 scripts, add files, add cache files, thus making it very tough to track your
36 code change. Modern GUI Editors support this; for example PHPStorm can be
37 set up to do this every time you save a script via
38 [PHP Storm Customizing Upload](https://www.jetbrains.com/help/phpstorm/customizing-upload.html).
39 - Option 2 also allows support to quickly change branches on a repository to
40 develop/test other code. This is done by first running a command or script
41 to delete and replace the synchronized directory (ie. remove the /var/www/openemr
42 directory) and then restart the development docker (see below for how to do this)
44 **Step 3.** Open up OpenEMR in the latest Chrome or Firefox! You have many
45 options to choose from:
46 - http://localhost:8070 (with Alpine 3.7 (Apache and PHP 7.1))
47 - http://localhost:8071 (with Alpine 3.9 (Apache and PHP 7.2))
48 - http://localhost:8072 (with Alpine 3.11 (Apache and PHP 7.3))
49 - http://localhost:8073 (with Alpine 3.12 (Apache and PHP 7.3))
50 - http://localhost:8074 (with Alpine 3.13 (Apache and PHP 7.4))
51 - http://localhost:8075 (with Alpine 3.13 (Apache and PHP 8.0))
52 - http://localhost:8076 (with Alpine 3.14 (Apache and PHP 7.4))
53 - http://localhost:8077 (with Alpine 3.14 (Apache and PHP 8.0))
54 - http://localhost:8078 (with Alpine 3.15 (Apache and PHP 7.4))
55 - http://localhost:8079 (with Alpine 3.15 (Apache and PHP 8.0))
56 - http://localhost:8080 (with Alpine Edge (Apache and now PHP 8.0))
57 - http://localhost:8081 (with Alpine 3.7 (Apache and PHP 7.1) with redis)
58 - http://localhost:8082 (with Alpine 3.9 (Apache and PHP 7.2) with redis)
59 - http://localhost:8083 (with Alpine 3.11 (Apache and PHP 7.3) with redis)
60 - http://localhost:8084 (with Alpine 3.12 (Apache and PHP 7.3) with redis)
61 - http://localhost:8085 (with Alpine 3.13 (Apache and PHP 7.4) with redis)
62 - http://localhost:8086 (with Alpine 3.13 (Apache and PHP 8.0) with redis)
63 - http://localhost:8087 (with Alpine 3.14 (Apache and PHP 7.4) with redis)
64 - http://localhost:8088 (with Alpine 3.14 (Apache and PHP 8.0) with redis)
65 - http://localhost:8089 (with Alpine 3.15 (Apache and PHP 7.4) with redis)
66 - http://localhost:8090 (with Alpine 3.15 (Apache and PHP 8.0) with redis)
67 - http://localhost:8091 (with Alpine Edge (Apache and now PHP 8.0) with redis)
68 - http://localhost:8100 (with Nginx and PHP-FPM 5.6)
69 - http://localhost:8101 (with Nginx and PHP-FPM 7.0)
70 - http://localhost:8102 (with Nginx and PHP-FPM 7.1)
71 - http://localhost:8103 (with Nginx and PHP-FPM 7.2)
72 - http://localhost:8104 (with Nginx and PHP-FPM 7.3)
73 - http://localhost:8105 (with Nginx and PHP-FPM 7.4)
74 - http://localhost:8106 (with Nginx and PHP-FPM 8.0)
75 - http://localhost:8107 (with Nginx and PHP-FPM 8.1)
76 - http://localhost:8108 (with Nginx and PHP-FPM 8.2)
77 - http://localhost:8150 (with Nginx and PHP-FPM 5.6 with redis)
78 - http://localhost:8151 (with Nginx and PHP-FPM 7.0 with redis)
79 - http://localhost:8152 (with Nginx and PHP-FPM 7.1 with redis)
80 - http://localhost:8153 (with Nginx and PHP-FPM 7.2 with redis)
81 - http://localhost:8154 (with Nginx and PHP-FPM 7.3 with redis)
82 - http://localhost:8155 (with Nginx and PHP-FPM 7.4 with redis)
83 - http://localhost:8156 (with Nginx and PHP-FPM 8.0 with redis)
84 - http://localhost:8157 (with Nginx and PHP-FPM 8.1 with redis)
85 - http://localhost:8158 (with Nginx and PHP-FPM 8.2 with redis)
86 - https://localhost:9070 with SSL and Alpine 3.7 (with Apache and PHP 7.1)
87 - https://localhost:9071 with SSL and Alpine 3.9 (with Apache and PHP 7.2)
88 - https://localhost:9072 with SSL and Alpine 3.11 (with Apache and PHP 7.3)
89 - https://localhost:9073 with SSL and Alpine 3.12 (with Apache and PHP 7.3)
90 - https://localhost:9074 with SSL and Alpine 3.13 (with Apache and PHP 7.4)
91 - https://localhost:9075 with SSL and Alpine 3.13 (with Apache and PHP 8.0)
92 - https://localhost:9076 with SSL and Alpine 3.14 (with Apache and PHP 7.4)
93 - https://localhost:9077 with SSL and Alpine 3.14 (with Apache and PHP 8.0)
94 - https://localhost:9078 with SSL and Alpine 3.15 (with Apache and PHP 7.4)
95 - https://localhost:9079 with SSL and Alpine 3.15 (with Apache and PHP 8.0)
96 - https://localhost:9080 with SSL and Alpine Edge (with Apache and now PHP 8.0)
97 - https://localhost:9081 with SSL and Alpine 3.7 (with Apache and PHP 7.1 with redis)
98 - https://localhost:9082 with SSL and Alpine 3.9 (with Apache and PHP 7.2 with redis)
99 - https://localhost:9083 with SSL and Alpine 3.11 (with Apache and PHP 7.3 with redis)
100 - https://localhost:9084 with SSL and Alpine 3.12 (with Apache and PHP 7.3 with redis)
101 - https://localhost:9085 with SSL and Alpine 3.13 (with Apache and PHP 7.4 with redis)
102 - https://localhost:9086 with SSL and Alpine 3.13 (with Apache and PHP 8.0 with redis)
103 - https://localhost:9087 with SSL and Alpine 3.14 (with Apache and PHP 7.4 with redis)
104 - https://localhost:9088 with SSL and Alpine 3.14 (with Apache and PHP 8.0 with redis)
105 - https://localhost:9089 with SSL and Alpine 3.15 (with Apache and PHP 7.4 with redis)
106 - https://localhost:9090 with SSL and Alpine 3.15 (with Apache and PHP 8.0 with redis)
107 - https://localhost:9091 with SSL and Alpine Edge (with Apache and now PHP 8.0 with redis)
108 - https://localhost:9100 with SSL (with Nginx and PHP-FPM 5.6)
109 - https://localhost:9101 with SSL (with Nginx and PHP-FPM 7.0)
110 - https://localhost:9102 with SSL (with Nginx and PHP-FPM 7.1)
111 - https://localhost:9103 with SSL (with Nginx and PHP-FPM 7.2)
112 - https://localhost:9104 with SSL (with Nginx and PHP-FPM 7.3)
113 - https://localhost:9105 with SSL (with Nginx and PHP-FPM 7.4)
114 - https://localhost:9106 with SSL (with Nginx and PHP-FPM 8.0)
115 - https://localhost:9107 with SSL (with Nginx and PHP-FPM 8.1)
116 - https://localhost:9108 with SSL (with Nginx and PHP-FPM 8.2)
117 - https://localhost:9150 with SSL (with Nginx and PHP-FPM 5.6 with redis)
118 - https://localhost:9151 with SSL (with Nginx and PHP-FPM 7.0 with redis)
119 - https://localhost:9152 with SSL (with Nginx and PHP-FPM 7.1 with redis)
120 - https://localhost:9153 with SSL (with Nginx and PHP-FPM 7.2 with redis)
121 - https://localhost:9154 with SSL (with Nginx and PHP-FPM 7.3 with redis)
122 - https://localhost:9155 with SSL (with Nginx and PHP-FPM 7.4 with redis)
123 - https://localhost:9156 with SSL (with Nginx and PHP-FPM 8.0 with redis)
124 - https://localhost:9157 with SSL (with Nginx and PHP-FPM 8.1 with redis)
125 - https://localhost:9158 with SSL (with Nginx and PHP-FPM 8.2 with redis)
127 **Step 4.** Setup up OpenEMR. The first time you run OpenEMR (and whenever you clear and replace your
128 synchronized openemr directory and restart the development docker). On the main
129 setup input screen:
130 - for `Server Host`, use either `mariadb` or `mariadb-ssl` or `mysql` or `mariadb-old` or `mariadb-very-old` or
131 `mariadb-very-very-old` or `mariadb-dev` or `mysql-old` (you have all
132 mariadb/mysql/mariadb-\*/mysql-\* dockers ready to go to make testing either one easy;
133 `mysql` is version 8.0; `mysql-old` is version 5.7;
134 `mariadb` is version 10.5; `mariadb-ssl` is version 10.5 with support for ssl; `mariadb-old` is version 10.4; `mariadb-very-old` is
135 version 10.3; `mariadb-very-very-old` is version 10.2; `mariadb-dev` is version 10.6)
136 - for `Root Pass`, use `root`
137 - for `User Hostname`, use `%`
139 #### Stop/Clean Out Dockers
140 There are frequently times where you will want to remove the dockers and start anew.
141 For example, when you change github branches and start testing/developing on a
142 different github branch. This is done by first running a command or script
143 to delete and replace the synchronized directory (ie. remove the /var/www/openemr
144 directory) and then restart the development docker:
145 ```bash
146 docker-compose down -v
147 docker-compose up -d
148 ```
150 #### Updating Dockers
151 To ensure you are using the most recent dockers, recommend running below set of commands intermittently:
152 ```console
153 docker pull openemr/openemr:flex
154 docker pull openemr/openemr:flex-edge
155 docker pull openemr/openemr:flex-3.15
156 docker pull openemr/openemr:flex-3.15-8
157 docker pull openemr/openemr:flex-3.14
158 docker pull openemr/openemr:flex-3.14-8
159 docker pull openemr/openemr:flex-3.13
160 docker pull openemr/openemr:flex-3.13-8
161 docker pull openemr/openemr:flex-3.12
162 docker pull openemr/openemr:flex-3.11
163 docker pull openemr/openemr:flex-3.9
164 docker pull openemr/openemr:flex-3.7
165 docker pull openemr/dev-php-fpm:8.2
166 docker pull openemr/dev-php-fpm:8.1
167 docker pull openemr/dev-php-fpm:8.0
168 docker pull openemr/dev-php-fpm:7.4
169 docker pull openemr/dev-php-fpm:7.3
170 docker pull openemr/dev-php-fpm:7.2
171 docker pull openemr/dev-php-fpm:7.1
172 docker pull openemr/dev-php-fpm:7.0
173 docker pull openemr/dev-php-fpm:5.6
174 docker pull openemr/dev-php-fpm:8.2-redis
175 docker pull openemr/dev-php-fpm:8.1-redis
176 docker pull openemr/dev-php-fpm:8.0-redis
177 docker pull openemr/dev-php-fpm:7.4-redis
178 docker pull openemr/dev-php-fpm:7.3-redis
179 docker pull openemr/dev-php-fpm:7.2-redis
180 docker pull openemr/dev-php-fpm:7.1-redis
181 docker pull openemr/dev-php-fpm:7.0-redis
182 docker pull openemr/dev-php-fpm:5.6-redis
183 docker pull openemr/dev-nginx
184 docker pull mariadb:10.6
185 docker pull mariadb:10.5
186 docker pull mariadb:10.4
187 docker pull mariadb:10.3
188 docker pull mariadb:10.2
189 docker pull mysql:8
190 docker pull mysql:5.7
191 docker pull phpmyadmin/phpmyadmin
192 docker pull couchdb
193 docker pull jodogne/orthanc-plugins
194 docker pull openemr/dev-ldap:insane
195 docker pull redis
196 docker pull ibmcom/ibm-fhir-server
198 ```
200 #### Usage
202 ##### Examine Containers
204 Run `$ docker ps` to see the OpenEMR and MySQL containers in the following format:
206 ```
207 CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
208 21919d2661bf openemr/dev-nginx "nginx -g 'daemon ..." 13 minutes ago Up 13 minutes 0.0.0.0:8100->80/tcp, 0.0.0.0:8101->81/tcp, 0.0.0.0:8102->82/tcp, 0.0.0.0:8103->83/tcp, 0.0.0.0:8104->84/tcp, 0.0.0.0:8105->85/tcp, 0.0.0.0:8106->86/tcp, 0.0.0.0:8150->90/tcp, 0.0.0.0:8151->91/tcp, 0.0.0.0:8152->92/tcp, 0.0.0.0:8153->93/tcp, 0.0.0.0:8154->94/tcp, 0.0.0.0:8155->95/tcp, 0.0.0.0:8156->96/tcp, 0.0.0.0:9100->440/tcp, 0.0.0.0:9101->441/tcp, 0.0.0.0:9102->442/tcp, 0.0.0.0:9103->443/tcp, 0.0.0.0:9104->444/tcp, 0.0.0.0:9105->445/tcp, 0.0.0.0:9106->446/tcp, 0.0.0.0:9150->450/tcp, 0.0.0.0:9151->451/tcp, 0.0.0.0:9152->452/tcp, 0.0.0.0:9153->453/tcp, 0.0.0.0:9154->454/tcp, 0.0.0.0:9155->455/tcp, 0.0.0.0:9156->456/tcp docker_nginx_1
209 f9b3844b16b4 openemr/openemr:flex-3.10 "./run_openemr.sh" 14 minutes ago Up 13 minutes 0.0.0.0:8087->80/tcp, 0.0.0.0:9087->443/tcp docker_openemr-7-3-redis-310_1
210 33561685efcf openemr/dev-php-fpm:5.6-redis "docker-php-entryp..." 14 minutes ago Up 14 minutes 9000/tcp docker_dev-php-fpm-5-6-redis_1
211 84c1b8514556 mariadb:10.4 "docker-entrypoint..." 14 minutes ago Up 13 minutes 0.0.0.0:8210->3306/tcp docker_mariadb_1
212 6d55960d12ee couchdb "tini -- /docker-e..." 14 minutes ago Up 13 minutes 0.0.0.0:5984->5984/tcp, 4369/tcp, 9100/tcp, 0.0.0.0:6984->6984/tcp docker_couchdb_1
213 217b51921613 mariadb:10.2 "docker-entrypoint..." 14 minutes ago Up 14 minutes 3306/tcp docker_mariadb-very-old_1
214 715782908b7b mysql:8 "docker-entrypoint..." 14 minutes ago Up 13 minutes 33060/tcp, 0.0.0.0:8220->3306/tcp docker_mysql_1
215 621069bc0bba redis "docker-entrypoint..." 14 minutes ago Up 14 minutes 6379/tcp docker_redis_1
216 48d1998f19a2 openemr/openemr:flex-3.10 "./run_openemr.sh" 14 minutes ago Up 13 minutes 0.0.0.0:8082->80/tcp, 0.0.0.0:9082->443/tcp docker_openemr-7-3-310_1
217 ca615ad4a021 ibmcom/ibm-fhir-server "/opt/ol/helpers/r..." 14 minutes ago Up 13 minutes 9080/tcp, 0.0.0.0:9443->9443/tcp docker_fhir_1
218 2cfba3013358 openemr/openemr:flex-3.11 "./run_openemr.sh" 14 minutes ago Up 13 minutes 0.0.0.0:8083->80/tcp, 0.0.0.0:9083->443/tcp docker_openemr-7-3-311_1
219 534aa394a3f6 openemr/openemr:flex-3.9 "./run_openemr.sh" 14 minutes ago Up 14 minutes 0.0.0.0:8081->80/tcp, 0.0.0.0:9081->443/tcp docker_openemr-7-2_1
220 5833b84a791c openemr/dev-php-fpm:8.0-redis "docker-php-entryp..." 14 minutes ago Up 14 minutes 9000/tcp docker_dev-php-fpm-8-0-redis_1
221 9922f2b50e4d openemr/dev-php-fpm:7.2-redis "docker-php-entryp..." 14 minutes ago Up 14 minutes 9000/tcp docker_dev-php-fpm-7-2-redis_1
222 d2fe53bb3177 openemr/dev-php-fpm:7.1-redis "docker-php-entryp..." 14 minutes ago Up 14 minutes 9000/tcp docker_dev-php-fpm-7-1-redis_1
223 b5918e344113 openemr/openemr:flex-edge "./run_openemr.sh" 14 minutes ago Up 14 minutes 0.0.0.0:8089->80/tcp, 0.0.0.0:9089->443/tcp docker_openemr-edge-redis_1
224 653184128fce openemr/dev-php-fpm:7.2 "docker-php-entryp..." 14 minutes ago Up 14 minutes 9000/tcp docker_dev-php-fpm-7-2_1
225 97e664c8f555 jodogne/orthanc-plugins "Orthanc /etc/orth..." 14 minutes ago Up 13 minutes 0.0.0.0:4242->4242/tcp, 0.0.0.0:8042->8042/tcp docker_orthanc_1
226 56e2e2bec925 osixia/openldap "/container/tool/run" 14 minutes ago Up 14 minutes 389/tcp, 636/tcp docker_openldap_1
227 f5009868ab52 openemr/dev-php-fpm:7.0-redis "docker-php-entryp..." 14 minutes ago Up 14 minutes 9000/tcp docker_dev-php-fpm-7-0-redis_1
228 e3fbde1539ab openemr/dev-php-fpm:8.0 "docker-php-entryp..." 14 minutes ago Up 14 minutes 9000/tcp docker_dev-php-fpm-8-0_1
229 95fbfe06c740 mariadb:10.5 "docker-entrypoint..." 14 minutes ago Up 14 minutes 3306/tcp docker_mariadb-dev_1
230 07c1fb11e3a1 openemr/dev-php-fpm:7.4 "docker-php-entryp..." 14 minutes ago Up 14 minutes 9000/tcp docker_dev-php-fpm-7-4_1
231 9382e3f1b8be mariadb:10.1 "docker-entrypoint..." 14 minutes ago Up 14 minutes 3306/tcp docker_mariadb-very-very-old_1
232 33ba9403b218 mariadb:10.3 "docker-entrypoint..." 14 minutes ago Up 14 minutes 3306/tcp docker_mariadb-old_1
233 6e0bd890cd30 openemr/openemr:flex-3.7 "./run_openemr.sh" 14 minutes ago Up 14 minutes 0.0.0.0:8080->80/tcp, 0.0.0.0:9080->443/tcp docker_openemr-7-1_1
234 a81e7e2cc6c2 openemr/dev-php-fpm:7.1 "docker-php-entryp..." 14 minutes ago Up 14 minutes 9000/tcp docker_dev-php-fpm-7-1_1
235 77b9a1c21867 openemr/dev-php-fpm:5.6 "docker-php-entryp..." 14 minutes ago Up 14 minutes 9000/tcp docker_dev-php-fpm-5-6_1
236 3f9c03757d16 mysql:5.7 "docker-entrypoint..." 14 minutes ago Up 14 minutes 3306/tcp, 33060/tcp docker_mysql-old_1
237 76e9cef725cd openemr/dev-php-fpm:7.0 "docker-php-entryp..." 14 minutes ago Up 14 minutes 9000/tcp docker_dev-php-fpm-7-0_1
238 2f6e268e7411 openemr/openemr:flex-3.9 "./run_openemr.sh" 14 minutes ago Up 13 minutes 0.0.0.0:8086->80/tcp, 0.0.0.0:9086->443/tcp docker_openemr-7-2-redis_1
239 e55ea8b540d8 openemr/openemr:flex-edge "./run_openemr.sh" 14 minutes ago Up 14 minutes 0.0.0.0:8084->80/tcp, 0.0.0.0:9084->443/tcp docker_openemr-edge_1
240 3a95311da546 openemr/openemr:flex-3.11 "./run_openemr.sh" 14 minutes ago Up 13 minutes 0.0.0.0:8088->80/tcp, 0.0.0.0:9088->443/tcp docker_openemr-7-3-redis-311_1
241 8706b8495b41 openemr/dev-php-fpm:7.4-redis "docker-php-entryp..." 14 minutes ago Up 14 minutes 9000/tcp docker_dev-php-fpm-7-4-redis_1
242 31df6d708395 phpmyadmin/phpmyadmin "/docker-entrypoin..." 14 minutes ago Up 14 minutes 0.0.0.0:8200->80/tcp docker_phpmyadmin_1
243 b044c08bf02b openemr/openemr:flex-3.7 "./run_openemr.sh" 14 minutes ago Up 14 minutes 0.0.0.0:8085->80/tcp, 0.0.0.0:9085->443/tcp docker_openemr-7-1-redis_1
244 ba8362e6ecdc openemr/dev-php-fpm:7.3 "docker-php-entryp..." 14 minutes ago Up 14 minutes 9000/tcp docker_dev-php-fpm-7-3_1
245 16eebdbfb00f openemr/dev-php-fpm:7.3-redis "docker-php-entryp..." 14 minutes ago Up 14 minutes 9000/tcp docker_dev-php-fpm-7-3-redis_1
246 24c8a1614707 mysql:5.6 "docker-entrypoint..." 14 minutes ago Up 14 minutes 3306/tcp docker_mysql-very-old_1
247 ```
248 - Note the `NAMES` column is extremely important and how you run docker commands
249 on specific containers. For example, to go into a shell script in the
250 `openemr_openemr-7-2_1` container, would use:
251 ```bash
252 docker exec -it openemr_openemr-7-2_1 bash
253 ```
255 ##### Bash Access
257 ```
258 $ docker exec -it <container_NAME> bash
259 ```
261 ##### MySQL Client Access
262 There are 2 options for gui access:
263 - GUI can be accessed via the phpMyAdmin at http://localhost:8200 for all sql dockers
264 - Or you can directly connect to port 8210 (`mariadb` server only) or 8220 (`mysql` server only) via your favorite sql tool (Mysql Workbench etc.). Note this option is limited to the `mysql` and `mariadb` servers.
265 If you are interested in using the MySQL client line as opposed to a GUI program, execute the following (password is passed in/is simple because this is for local development purposes):
267 ```
268 $ docker exec -it <container_NAME> mysql -u root --password=root openemr
269 ```
271 ##### Apache Error Log Tail
273 ```
274 $ docker exec -it <container_NAME> tail -f /var/log/apache2/error.log
275 ```
276 ...if you want the `access.log`, you can use this approach as well.
278 ##### Recommended Development Setup
280 While there is no officially recommended toolset for programming OpenEMR,
281 many in the community have found
282 [PhpStorm](https://www.jetbrains.com/phpstorm/),
283 [Sublime Text](https://www.sublimetext.com/),
284 and [Vim](http://www.vim.org/) to be useful for coding. For database work,
285 [MySQL Workbench](https://dev.mysql.com/downloads/workbench/) or PhpMyAdmin
286 offers a smooth experience.
288 Many helpful tips and development "rules of thumb" can be found by reviewing
289 [OpenEMR Development](http://open-emr.org/wiki/index.php/OpenEMR_Wiki_Home_Page#Development).
290 Remember that learning to code against a very large and complex system is not a
291 task that will be completed over night. Feel free to post on
292 [the development forums](https://community.open-emr.org/c/openemr-development)
293 if you have any questions after reviewing the wiki.
295 ##### Ports
297 See the `docker-compose.yml` file in the contrib/util/docker directory for port details.
299 All host machine ports can be changed by editing the `docker-compose.yml` file.
300 Host ports differ from the internal container ports by default to avoid conflicts
301 services potentially running on the host machine (a web server such as Nginx,
302 Tomcat, or Apache2 could be installed on the host machine that makes use of
303 port 80, for instance).
305 ##### Additional Build Tools
307 Programmers looking to use OpenEMR's and [Composer and NPM](http://www.open-emr.org/wiki/index.php//Composer_and_NPM)
308 build tools can simply `bash` into the OpenEMR container and use them as expected.
310 ##### CouchDB
311 In OpenEMR, CouchDB is an option for the patients document storage. For this reason, a CouchDB
312 docker is included in this OpenEMR docker development environment. You can visit the CouchDB
313 GUI directly via http://localhost:5984/_utils/ or https://localhost:6984/_utils/ with
314 username `admin` and password `password`. You can configure OpenEMR to use this CouchDB
315 docker for patient document storage in OpenEMR at Administration->Globals->Documents:
316 - Document Storage Method->CouchDB
317 - CouchDB HostName->couchdb
318 - CouchDB UserName->admin
319 - CouchDB Password->password
320 - CouchDB Port->6984
321 - CouchDB Database can be set to any name you want
323 ##### OpenLDAP
324 In OpenEMR, LDAP is an option for user authentication. You can configure OpenEMR to use the
325 OpenLDAP docker patient authentication in OpenEMR at Administration->Globals->Security:
326 - LDAP - Server Name or URI : ldap://openldap:389
327 - LDAP - Distinguished Name of User : cn={login},dc=example,dc=org
328 - LDAP - Login Exclusions : (place whatever your admin login is; warning, do not use "admin" for your openemr admin login)
330 (note that using 'cn' rather than 'uid' in this case for the distinguished name since the default openldap docker hasn't assigned a uid to the "admin" user)
332 Then create a user named “admin” in OpenEMR. When you log in as that user, the password is “admin”.
334 #### Ongoing Development
336 ##### Orthanc
337 Developers are currently working on integrating the Orthanc PACS server into OpenEMR. This
338 feature is currently under development. Although it is not yet integrated with OpenEMR yet,
339 you can connect to the Orthanc application gui via http://localhost:8042/ with username `orthanc`
340 and password `orthanc`. The nginx docker has also been set up to work as a reverse proxy
341 with orthanc to allow ongoing development via http://localhost:8090/orthanc/ (Note this reverse
342 proxy is still a work in progress)
344 ##### FHIR
345 A FHIR server is included to make it easier to test on a bona fide FHIR server as developers
346 work towards supporting FHIR via OpenEMR's API. The FHIR server is docker from
347 https://hub.docker.com/r/ibmcom/ibm-fhir-server and see there for instructions of use.
349 #### The Insane Docker Development Environment is a work in progress
351 This is an ongoing work in progress and feel free to join the super exciting
352 OpenEMR container projects. Feel free to post PR's to update the
353 docker-compose.yml script or this documentation. Also feel free to post
354 updates on the openemr/openemr:flex or openemr/openemr:flex-edge dockers
355 which can be found at
356 https://github.com/openemr/openemr-devops/tree/master/docker/openemr
358 #### Stuff that needs fixing
359 1. The reverse proxy for orthanc