Skip to content

Commit afe85df

Browse files
committed
Improved documentation
Fixes webdevops/TYPO3-docker-boilerplate#74
1 parent 34da1e9 commit afe85df

File tree

3 files changed

+86
-84
lines changed

3 files changed

+86
-84
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ You can use my [Vagrant Development VM](https://github.com/mblaschke/vagrant-dev
3636
- [Installation and requirements](/documentation/INSTALL.md)
3737
- [Updating docker boilerplate](/documentation/UPDATE.md)
3838
- [Customizing](/documentation/CUSTOMIZE.md)
39+
- [Services (Webserver, MySQL... Ports, Users, Passwords)](/documentation/SERVICES.md)
3940
- [Docker Quickstart](/documentation/DOCKER-QUICKSTART.md)
4041
- [Run your project](/documentation/DOCKER-STARTUP.md)
4142
- [Container detail info](/documentation/DOCKER-INFO.md)

documentation/DOCKER-INFO.md

Lines changed: 2 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ This directory will be mounted under `/docker` in `main` and `web` container.
2323
## Docker images
2424
Container | Source
2525
------------------------- | -------------------------------
26-
main/ubuntu | [Ubuntu](https://registry.hub.docker.com/_/ubuntu/) *official* (prebuild available from https://registry.hub.docker.com/u/mblaschke/php-boilerplate/)
27-
main/centos | [CentOS](https://registry.hub.docker.com/_/centos/) *official* (prebuild available from https://registry.hub.docker.com/u/mblaschke/php-boilerplate/)
26+
main/ubuntu | [Ubuntu](https://registry.hub.docker.com/_/ubuntu/) *official* (prebuilt available from https://registry.hub.docker.com/u/mblaschke/php-boilerplate/)
27+
main/centos | [CentOS](https://registry.hub.docker.com/_/centos/) *official* (prebuilt available from https://registry.hub.docker.com/u/mblaschke/php-boilerplate/)
2828
storage | [Ubuntu](https://registry.hub.docker.com/_/ubuntu/) *official*
2929
web | [Apache](https://registry.hub.docker.com/_/httpd/) *official* or [Nginx](https://registry.hub.docker.com/_/nginx/) *official*
3030
mysql | [MySQL](https://registry.hub.docker.com/_/mysql/) *official*
@@ -56,88 +56,6 @@ make solr-restore | Restore Solr cores
5656
<br> |
5757
make build | Run building (composer, gulp, bower)
5858

59-
## Docker containers
60-
61-
### Web (Nginx or Apache HTTPd)
62-
63-
Setting | Value
64-
------------- | -------------
65-
Host | web:80 and web:443 (ssl)
66-
External Port | 8000 and 8443 (ssl)
67-
68-
### MySQL
69-
70-
You can choose between [MySQL](https://www.mysql.com/) (default), [MariaDB](https://www.mariadb.org/)
71-
and [PerconaDB](http://www.percona.com/software) in `docker/mysql/Dockerfile`
72-
73-
Setting | Value
74-
------------- | -------------
75-
User | dev (if not changed in env)
76-
Password | dev (if not changed in env)
77-
Database | database (if not changed in env)
78-
Host | mysql:3306
79-
External Port | 13306
80-
81-
Access fo MySQL user "root" and "dev" will be allowed from external hosts (eg. for debugging, dumps and other stuff).
82-
83-
84-
### PostgreSQL
85-
86-
Setting | Value
87-
------------- | -------------
88-
User | dev (if not changed in env)
89-
Password | dev (if not changed in env)
90-
Host | postgres:5432
91-
External Port | 15432
92-
93-
94-
### Solr
95-
96-
Setting | Value
97-
------------- | -------------
98-
Host | solr:8983
99-
External Port | 18983
100-
Cores | docker/solr/conf/solr.xml (data dirs are created automatically)
101-
102-
### Elasticsearch (disabled by default)
103-
104-
Setting | Value
105-
------------- | -------------
106-
Host | elasticsearch:9200 and :9300
107-
External Port | 19200 and 19300
108-
109-
### Redis
110-
111-
Setting | Value
112-
------------- | -------------
113-
Host | redis
114-
Port | 6379
115-
116-
### Memcached
117-
118-
Setting | Value
119-
------------- | -------------
120-
Host | memcached
121-
Port | 11211
122-
123-
### Mailcatcher
124-
125-
Setting | Value
126-
------------- | -------------
127-
Host | mail
128-
SMTP port | 1025
129-
Web port | 1080
130-
131-
### FTP
132-
133-
Setting | Value
134-
------------- | -------------
135-
Host | ftp
136-
Ports | 20,21
137-
User | dev (if not changed in env)
138-
Password | dev (if not changed in env)
139-
Path | /data/ftp (if not changed in env)
140-
14159
## Environment settings
14260

14361
Environment | Description

documentation/SERVICES.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
[<-- Back to main section](../README.md)
2+
3+
# Services
4+
5+
### Web (Nginx or Apache HTTPd)
6+
7+
Setting | Value
8+
------------- | -------------
9+
Host | web:80 and web:443 (ssl)
10+
External Port | 8000 and 8443 (ssl)
11+
12+
### MySQL
13+
14+
You can choose between [MySQL](https://www.mysql.com/) (default), [MariaDB](https://www.mariadb.org/)
15+
and [PerconaDB](http://www.percona.com/software) in `docker/mysql/Dockerfile`
16+
17+
Setting | Value
18+
------------- | -------------
19+
User | dev (if not changed in env)
20+
Password | dev (if not changed in env)
21+
Database | database (if not changed in env)
22+
Host | mysql:3306
23+
External Port | 13306
24+
25+
Access fo MySQL user "root" and "dev" will be allowed from external hosts (eg. for debugging, dumps and other stuff).
26+
27+
28+
### PostgreSQL
29+
30+
Setting | Value
31+
------------- | -------------
32+
User | dev (if not changed in env)
33+
Password | dev (if not changed in env)
34+
Host | postgres:5432
35+
External Port | 15432
36+
37+
38+
### Solr
39+
40+
Setting | Value
41+
------------- | -------------
42+
Host | solr:8983
43+
External Port | 18983
44+
Cores | docker/solr/conf/solr.xml (data dirs are created automatically)
45+
46+
### Elasticsearch (disabled by default)
47+
48+
Setting | Value
49+
------------- | -------------
50+
Host | elasticsearch:9200 and :9300
51+
External Port | 19200 and 19300
52+
53+
### Redis
54+
55+
Setting | Value
56+
------------- | -------------
57+
Host | redis
58+
Port | 6379
59+
60+
### Memcached
61+
62+
Setting | Value
63+
------------- | -------------
64+
Host | memcached
65+
Port | 11211
66+
67+
### Mailcatcher
68+
69+
Setting | Value
70+
------------- | -------------
71+
Host | mail
72+
SMTP port | 1025
73+
Web port | 1080
74+
75+
### FTP
76+
77+
Setting | Value
78+
------------- | -------------
79+
Host | ftp
80+
Ports | 20,21
81+
User | dev (if not changed in env)
82+
Password | dev (if not changed in env)
83+
Path | /data/ftp (if not changed in env)

0 commit comments

Comments
 (0)