Skip to content

Commit 73d12d6

Browse files
committed
Add more docker layout documentation
1 parent d116f25 commit 73d12d6

File tree

15 files changed

+156
-109
lines changed

15 files changed

+156
-109
lines changed

documentation/docs/content/DockerImages/dockerfiles/apache.rst

Lines changed: 1 addition & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -20,54 +20,6 @@ Environment variables
2020
Docker image layout
2121
-------------------
2222

23-
================================================================= ====================================================================
24-
File/Directory Description
25-
----------------------------------------------------------------- --------------------------------------------------------------------
26-
``/opt/docker/etc/httpd/conf.d`` |badge-customization| Main global configuration directory
23+
.. include:: include/layout-apache.rst
2724

28-
(automatically included files)
29-
``/opt/docker/etc/httpd/conf.d/10-php.conf`` PHP cgi configuration
3025

31-
``/opt/docker/etc/httpd/conf.d/10-error-document.conf`` Error document configuration
32-
33-
``/opt/docker/etc/httpd/conf.d/10-log.conf`` Log configuration
34-
35-
``/opt/docker/etc/httpd/conf.d/10-server.conf`` Basic server configuration
36-
37-
``/opt/docker/etc/httpd/ssl`` |badge-customization| SSL configuration directory for
38-
39-
certifications and keys
40-
41-
42-
``/opt/docker/etc/httpd/ssl/server.crt`` |badge-customization| Example SSL certification (*.vm)
43-
44-
``/opt/docker/etc/httpd/ssl/server.csr`` |badge-customization| Example SSL certification request (*.vm)
45-
46-
``/opt/docker/etc/httpd/ssl/server.key`` |badge-customization| Example SSL key (*.vm)
47-
48-
``/opt/docker/etc/httpd/vhost.common.d`` |badge-customization| Vhost configuration directory
49-
50-
(automatically included files)
51-
52-
``/opt/docker/etc/httpd/vhost.common.d/01-boilerplate.conf`` Placeholder configuration file
53-
54-
(prevent include errors for Apache 2.2)
55-
56-
``/opt/docker/etc/httpd/global.conf`` Global httpd configuration
57-
58-
``/opt/docker/etc/httpd/main.conf`` Main httpd configuration
59-
60-
``/opt/docker/etc/httpd/php.conf`` |badge-deprecated| Deprecated PHP configuration
61-
62-
``/opt/docker/etc/httpd/vhost.common.conf`` |badge-deprecated| Deprecated vhost common include
63-
64-
``/opt/docker/etc/httpd/vhost.conf`` Vhost configuration
65-
66-
``/opt/docker/etc/httpd/vhost.ssl.conf`` Vhost SSL configuration
67-
================================================================= ====================================================================
68-
69-
.. |badge-customization| image:: https://img.shields.io/badge/hint-customization-blue.svg?style=flat
70-
:target: badge-customization
71-
72-
.. |badge-deprecated| image:: https://img.shields.io/badge/hint-deprecated-lightgrey.svg?style=flat
73-
:target: badge-deprecated

documentation/docs/content/DockerImages/dockerfiles/hhvm-apache.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,6 @@ Environment variables
1919

2020
Docker image layout
2121
-------------------
22+
23+
.. include:: include/layout-apache.rst
24+
.. include:: include/layout-hhvm.rst

documentation/docs/content/DockerImages/dockerfiles/hhvm-nginx.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,5 @@ Environment variables
2020
Docker image layout
2121
-------------------
2222

23+
.. include:: include/layout-nginx.rst
24+
.. include:: include/layout-hhvm.rst

documentation/docs/content/DockerImages/dockerfiles/hhvm.rst

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,4 @@ Docker image tags
1414
Docker image layout
1515
-------------------
1616

17-
==================================================== ==================================================================
18-
File/Directory Description
19-
---------------------------------------------------- ------------------------------------------------------------------
20-
``/opt/docker/etc/php/php.ini`` WebDevOps php.ini file with basic settings
21-
``/opt/docker/etc/php/fpm/php-fpm.conf`` PHP-FPM configuration file
22-
``/opt/docker/etc/php/fpm/pool.d/application.conf`` PHP-FPM applocation pool configuration file
23-
``/opt/docker/etc/supervisor.d/php-fpm.conf`` Supervisord configuration file for PHP-FPM
24-
==================================================== ==================================================================
17+
.. include:: include/layout-hhvm.rst
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
Apache layout
2+
^^^^^^^^^^^^^
3+
4+
================================================================= ====================================================================
5+
File/Directory Description
6+
----------------------------------------------------------------- --------------------------------------------------------------------
7+
``/opt/docker/etc/httpd/conf.d`` |badge-customization| Main global configuration directory
8+
9+
(automatically included files)
10+
``/opt/docker/etc/httpd/conf.d/10-php.conf`` PHP cgi configuration
11+
12+
``/opt/docker/etc/httpd/conf.d/10-error-document.conf`` Error document configuration
13+
14+
``/opt/docker/etc/httpd/conf.d/10-log.conf`` Log configuration
15+
16+
``/opt/docker/etc/httpd/conf.d/10-server.conf`` Basic server configuration
17+
18+
``/opt/docker/etc/httpd/ssl`` |badge-customization| SSL configuration directory for
19+
20+
certifications and keys
21+
22+
23+
``/opt/docker/etc/httpd/ssl/server.crt`` |badge-customization| Example SSL certification (*.vm)
24+
25+
``/opt/docker/etc/httpd/ssl/server.csr`` |badge-customization| Example SSL certification request (*.vm)
26+
27+
``/opt/docker/etc/httpd/ssl/server.key`` |badge-customization| Example SSL key (*.vm)
28+
29+
``/opt/docker/etc/httpd/vhost.common.d`` |badge-customization| Vhost configuration directory
30+
31+
(automatically included files)
32+
33+
``/opt/docker/etc/httpd/vhost.common.d/01-boilerplate.conf`` Placeholder configuration file
34+
35+
(prevent include errors for Apache 2.2)
36+
37+
``/opt/docker/etc/httpd/global.conf`` Global httpd configuration
38+
39+
``/opt/docker/etc/httpd/main.conf`` Main httpd configuration
40+
41+
``/opt/docker/etc/httpd/php.conf`` |badge-deprecated| Deprecated PHP configuration
42+
43+
``/opt/docker/etc/httpd/vhost.common.conf`` |badge-deprecated| Deprecated vhost common include
44+
45+
``/opt/docker/etc/httpd/vhost.conf`` Vhost configuration
46+
47+
``/opt/docker/etc/httpd/vhost.ssl.conf`` Vhost SSL configuration
48+
49+
``/opt/docker/etc/supervisor.d/httpd.conf`` Supervisord configuration file for Apache HTTPD
50+
================================================================= ====================================================================
51+
52+
.. |badge-customization| image:: https://img.shields.io/badge/hint-customization-blue.svg?style=flat
53+
:target: badge-customization
54+
55+
.. |badge-deprecated| image:: https://img.shields.io/badge/hint-deprecated-lightgrey.svg?style=flat
56+
:target: badge-deprecated
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
HHVM layout
2+
^^^^^^^^^^^
3+
4+
================================================================= ====================================================================
5+
File/Directory Description
6+
----------------------------------------------------------------- --------------------------------------------------------------------
7+
``/opt/docker/etc/supervisor.d/hhvm.conf`` Supervisord configuration file for HHVM
8+
================================================================= ====================================================================
9+
10+
.. |badge-customization| image:: https://img.shields.io/badge/hint-customization-blue.svg?style=flat
11+
:target: badge-customization
12+
13+
.. |badge-deprecated| image:: https://img.shields.io/badge/hint-deprecated-lightgrey.svg?style=flat
14+
:target: badge-deprecated
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
Nginx layout
2+
^^^^^^^^^^^^
3+
4+
================================================================= ====================================================================
5+
File/Directory Description
6+
----------------------------------------------------------------- --------------------------------------------------------------------
7+
``/opt/docker/etc/nginx/conf.d`` |badge-customization| Main global configuration directory
8+
9+
(automatically included files)
10+
``/opt/docker/etc/nginx/conf.d/10-php.conf`` PHP cgi configuration
11+
12+
``/opt/docker/etc/nginx/ssl`` |badge-customization| SSL configuration directory for
13+
14+
certifications and keys
15+
``/opt/docker/etc/nginx//ssl/server.crt`` |badge-customization| Example SSL certification (*.vm)
16+
17+
``/opt/docker/etc/nginx/ssl/server.csr`` |badge-customization| Example SSL certification request (*.vm)
18+
19+
``/opt/docker/etc/nginx/ssl/server.key`` |badge-customization| Example SSL key (*.vm)
20+
21+
``/opt/docker/etc/nginx/vhost.common.d`` |badge-customization| Vhost configuration directory
22+
23+
(automatically included files)
24+
25+
``/opt/docker/etc/nginx/vhost.common.d/10-location-root.conf`` Redirect requests to DOCUMENT_INDEX
26+
27+
``/opt/docker/etc/nginx/vhost.common.d/10-php.conf`` PHP cgi configuration for vhost
28+
29+
``/opt/docker/etc/nginx/global.conf`` Global nginx configuration
30+
31+
``/opt/docker/etc/nginx/main.conf`` Main Nginx configuration
32+
33+
``/opt/docker/etc/nginx/php.conf`` |badge-deprecated| Deprecated PHP configuration
34+
35+
``/opt/docker/etc/nginx/vhost.common.conf`` |badge-deprecated| Deprecated vhost common include
36+
37+
``/opt/docker/etc/nginx/vhost.conf`` Vhost configuration
38+
39+
``/opt/docker/etc/nginx/vhost.ssl.conf`` Vhost SSL configuration
40+
41+
``/opt/docker/etc/supervisor.d/nginx.conf`` Supervisord configuration file for Nginx
42+
================================================================= ====================================================================
43+
44+
.. |badge-customization| image:: https://img.shields.io/badge/hint-customization-blue.svg?style=flat
45+
:target: badge-customization
46+
47+
.. |badge-deprecated| image:: https://img.shields.io/badge/hint-deprecated-lightgrey.svg?style=flat
48+
:target: badge-deprecated
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
PHP layout
2+
^^^^^^^^^^
3+
4+
================================================================= ====================================================================
5+
File/Directory Description
6+
----------------------------------------------------------------- --------------------------------------------------------------------
7+
``/opt/docker/etc/php/php.webdevops.ini`` PHP settings from WebDevOps image
8+
``/opt/docker/etc/php/php.ini`` |badge-customization| php.ini for custom settings
9+
``/opt/docker/etc/php/fpm/php-fpm.conf`` PHP-FPM main configuration file
10+
``/opt/docker/etc/php/fpm/pool.d/application.conf`` Application PHP-FPM pool configuration file
11+
``/opt/docker/etc/supervisor.d/php-fpm.conf`` Supervisord configuration file for PHP-FPM
12+
================================================================= ====================================================================
13+
14+
.. |badge-customization| image:: https://img.shields.io/badge/hint-customization-blue.svg?style=flat
15+
:target: badge-customization
16+
17+
.. |badge-deprecated| image:: https://img.shields.io/badge/hint-deprecated-lightgrey.svg?style=flat
18+
:target: badge-deprecated

documentation/docs/content/DockerImages/dockerfiles/nginx.rst

Lines changed: 1 addition & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -20,46 +20,4 @@ Environment variables
2020
Docker image layout
2121
-------------------
2222

23-
================================================================= ====================================================================
24-
File/Directory Description
25-
----------------------------------------------------------------- --------------------------------------------------------------------
26-
``/opt/docker/etc/nginx/conf.d`` |badge-customization| Main global configuration directory
27-
28-
(automatically included files)
29-
``/opt/docker/etc/nginx/conf.d/10-php.conf`` PHP cgi configuration
30-
31-
``/opt/docker/etc/nginx/ssl`` |badge-customization| SSL configuration directory for
32-
33-
certifications and keys
34-
``/opt/docker/etc/nginx//ssl/server.crt`` |badge-customization| Example SSL certification (*.vm)
35-
36-
``/opt/docker/etc/nginx/ssl/server.csr`` |badge-customization| Example SSL certification request (*.vm)
37-
38-
``/opt/docker/etc/nginx/ssl/server.key`` |badge-customization| Example SSL key (*.vm)
39-
40-
``/opt/docker/etc/nginx/vhost.common.d`` |badge-customization| Vhost configuration directory
41-
42-
(automatically included files)
43-
44-
``/opt/docker/etc/nginx/vhost.common.d/10-location-root.conf`` Redirect requests to DOCUMENT_INDEX
45-
46-
``/opt/docker/etc/nginx/vhost.common.d/10-php.conf`` PHP cgi configuration for vhost
47-
48-
``/opt/docker/etc/nginx/global.conf`` Global nginx configuration
49-
50-
``/opt/docker/etc/nginx/main.conf`` Main Nginx configuration
51-
52-
``/opt/docker/etc/nginx/php.conf`` |badge-deprecated| Deprecated PHP configuration
53-
54-
``/opt/docker/etc/nginx/vhost.common.conf`` |badge-deprecated| Deprecated vhost common include
55-
56-
``/opt/docker/etc/nginx/vhost.conf`` Vhost configuration
57-
58-
``/opt/docker/etc/nginx/vhost.ssl.conf`` Vhost SSL configuration
59-
================================================================= ====================================================================
60-
61-
.. |badge-customization| image:: https://img.shields.io/badge/hint-customization-blue.svg?style=flat
62-
:target: badge-customization
63-
64-
.. |badge-deprecated| image:: https://img.shields.io/badge/hint-deprecated-lightgrey.svg?style=flat
65-
:target: badge-deprecated
23+
.. include:: include/layout-nginx.rst

documentation/docs/content/DockerImages/dockerfiles/php-apache-dev.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,6 @@ Environment variables
2121

2222
Docker image layout
2323
-------------------
24+
25+
.. include:: include/layout-apache.rst
26+
.. include:: include/layout-php.rst

0 commit comments

Comments
 (0)