Skip to content

Commit be2e96d

Browse files
committed
Update documentation
1 parent ff61a45 commit be2e96d

9 files changed

+608
-252
lines changed

CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44
## Unreleased
55

66

7+
## Release 0.146
8+
9+
This release adds lots of documentation about recently added features.
10+
11+
### Added
12+
- Documentation
13+
14+
715
## Release 0.145
816

917
This is a massive restructuring release, which adds another layer on top of Ansible to easily manage/edit/add PHP tools and to configure their respective order of building and installing.

README.md

+135-66
Large diffs are not rendered by default.

doc/available-tools.md

+126-5
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,131 @@ Tools |
1717
:information_source: For details on how to generate modules see **[Abuser Documentation: Build your own image](../doc/abuser/README.md)**<br/>
1818

1919

20-
### PHP Tools (`slim`)
20+
### PHP Tools ([`prod`](flavours.md#prod))
2121

22-
The following PHP cli tools are available on the `slim` flavour:
22+
The following PHP cli tools are available on the [`prod`](flavours.md#prod) flavour:
23+
24+
> :information_source: Click on any tool name to find out what they are
25+
26+
<table>
27+
<tr>
28+
<th>Tool</th>
29+
<th>PHP 5.2</th>
30+
<th>PHP 5.3</th>
31+
<th>PHP 5.4</th>
32+
<th>PHP 5.5</th>
33+
<th>PHP 5.6</th>
34+
<th>PHP 7.0</th>
35+
<th>PHP 7.1</th>
36+
<th>PHP 7.2</th>
37+
<th>PHP 7.3</th>
38+
<th>PHP 7.4</th>
39+
<th>PHP 8.0</th>
40+
<th>PHP 8.1</th>
41+
<th>PHP 8.2</th>
42+
</tr>
43+
<tr>
44+
<td><a target="_blank" href="https://linux.die.net/man/8/cron">Cron</a></td>
45+
<td class="tool_prod_cron_5.2">✓</td>
46+
<td class="tool_prod_cron_5.3">✓</td>
47+
<td class="tool_prod_cron_5.4">✓</td>
48+
<td class="tool_prod_cron_5.5">✓</td>
49+
<td class="tool_prod_cron_5.6">✓</td>
50+
<td class="tool_prod_cron_7.0">✓</td>
51+
<td class="tool_prod_cron_7.1">✓</td>
52+
<td class="tool_prod_cron_7.2">✓</td>
53+
<td class="tool_prod_cron_7.3">✓</td>
54+
<td class="tool_prod_cron_7.4">✓</td>
55+
<td class="tool_prod_cron_8.0">✓</td>
56+
<td class="tool_prod_cron_8.1">✓</td>
57+
<td class="tool_prod_cron_8.2">✓</td>
58+
</tr>
59+
<tr>
60+
<td><a target="_blank" href="http://www.postfix.org/">Postfix</a></td>
61+
<td class="tool_prod_postfix_5.2">✓</td>
62+
<td class="tool_prod_postfix_5.3">✓</td>
63+
<td class="tool_prod_postfix_5.4">✓</td>
64+
<td class="tool_prod_postfix_5.5">✓</td>
65+
<td class="tool_prod_postfix_5.6">✓</td>
66+
<td class="tool_prod_postfix_7.0">✓</td>
67+
<td class="tool_prod_postfix_7.1">✓</td>
68+
<td class="tool_prod_postfix_7.2">✓</td>
69+
<td class="tool_prod_postfix_7.3">✓</td>
70+
<td class="tool_prod_postfix_7.4">✓</td>
71+
<td class="tool_prod_postfix_8.0">✓</td>
72+
<td class="tool_prod_postfix_8.1">✓</td>
73+
<td class="tool_prod_postfix_8.2">✓</td>
74+
</tr>
75+
<tr>
76+
<td><a target="_blank" href="http://www.postfix.org/pcre_table.5.html">Postfix PCRE</a></td>
77+
<td class="tool_prod_postfix_pcre_5.2">✓</td>
78+
<td class="tool_prod_postfix_pcre_5.3">✓</td>
79+
<td class="tool_prod_postfix_pcre_5.4">✓</td>
80+
<td class="tool_prod_postfix_pcre_5.5">✓</td>
81+
<td class="tool_prod_postfix_pcre_5.6">✓</td>
82+
<td class="tool_prod_postfix_pcre_7.0">✓</td>
83+
<td class="tool_prod_postfix_pcre_7.1">✓</td>
84+
<td class="tool_prod_postfix_pcre_7.2">✓</td>
85+
<td class="tool_prod_postfix_pcre_7.3">✓</td>
86+
<td class="tool_prod_postfix_pcre_7.4">✓</td>
87+
<td class="tool_prod_postfix_pcre_8.0">✓</td>
88+
<td class="tool_prod_postfix_pcre_8.1">✓</td>
89+
<td class="tool_prod_postfix_pcre_8.2">✓</td>
90+
</tr>
91+
<tr>
92+
<td><a target="_blank" href="https://www.rsyslog.com/">Rsyslog</a></td>
93+
<td class="tool_prod_rsyslog_5.2">✓</td>
94+
<td class="tool_prod_rsyslog_5.3">✓</td>
95+
<td class="tool_prod_rsyslog_5.4">✓</td>
96+
<td class="tool_prod_rsyslog_5.5">✓</td>
97+
<td class="tool_prod_rsyslog_5.6">✓</td>
98+
<td class="tool_prod_rsyslog_7.0">✓</td>
99+
<td class="tool_prod_rsyslog_7.1">✓</td>
100+
<td class="tool_prod_rsyslog_7.2">✓</td>
101+
<td class="tool_prod_rsyslog_7.3">✓</td>
102+
<td class="tool_prod_rsyslog_7.4">✓</td>
103+
<td class="tool_prod_rsyslog_8.0">✓</td>
104+
<td class="tool_prod_rsyslog_8.1">✓</td>
105+
<td class="tool_prod_rsyslog_8.2">✓</td>
106+
</tr>
107+
<tr>
108+
<td><a target="_blank" href="http://www.dest-unreach.org/socat/">Socat</a></td>
109+
<td class="tool_prod_socat_5.2">✓</td>
110+
<td class="tool_prod_socat_5.3">✓</td>
111+
<td class="tool_prod_socat_5.4">✓</td>
112+
<td class="tool_prod_socat_5.5">✓</td>
113+
<td class="tool_prod_socat_5.6">✓</td>
114+
<td class="tool_prod_socat_7.0">✓</td>
115+
<td class="tool_prod_socat_7.1">✓</td>
116+
<td class="tool_prod_socat_7.2">✓</td>
117+
<td class="tool_prod_socat_7.3">✓</td>
118+
<td class="tool_prod_socat_7.4">✓</td>
119+
<td class="tool_prod_socat_8.0">✓</td>
120+
<td class="tool_prod_socat_8.1">✓</td>
121+
<td class="tool_prod_socat_8.2">✓</td>
122+
</tr>
123+
<tr>
124+
<td><a target="_blank" href="http://supervisord.org/">Supervisor</a></td>
125+
<td class="tool_prod_supervisor_5.2">✓</td>
126+
<td class="tool_prod_supervisor_5.3">✓</td>
127+
<td class="tool_prod_supervisor_5.4">✓</td>
128+
<td class="tool_prod_supervisor_5.5">✓</td>
129+
<td class="tool_prod_supervisor_5.6">✓</td>
130+
<td class="tool_prod_supervisor_7.0">✓</td>
131+
<td class="tool_prod_supervisor_7.1">✓</td>
132+
<td class="tool_prod_supervisor_7.2">✓</td>
133+
<td class="tool_prod_supervisor_7.3">✓</td>
134+
<td class="tool_prod_supervisor_7.4">✓</td>
135+
<td class="tool_prod_supervisor_8.0">✓</td>
136+
<td class="tool_prod_supervisor_8.1">✓</td>
137+
<td class="tool_prod_supervisor_8.2">✓</td>
138+
</tr>
139+
</table>
140+
141+
142+
### PHP Tools ([`slim`](flavours.md#slim))
143+
144+
Additionally to all of the `prod` tools shown above, the following PHP cli tools are available on the [`slim`](flavours.md#slim) flavour:
23145

24146
> :information_source: Click on any tool name to find out what they are
25147
@@ -237,10 +359,9 @@ The following PHP cli tools are available on the `slim` flavour:
237359
> :exclamation: **\[1\]** Not available on `arm64` Docker image.
238360
239361

362+
### PHP Tools ([`work`](flavours.md#work))
240363

241-
### PHP Tools (`work`)
242-
243-
Additionally to all of the `slim` tools shown above, the following PHP cli tools are available on the `work` flavour:
364+
Additionally to all of the `slim` tools shown above, the following PHP cli tools are available on the [`work`](flavours.md#work) flavour:
244365

245366
> :information_source: Click on any tool name to find out what they are
246367

doc/base-images.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Base Images
1717

1818
### Base Images
1919

20-
Have a look at the following Devilbox base images for which no official versions exist yet, but are required to serve as a foundation for this repository:
20+
Have a look at the following Devilbox base images for which no official versions exist yet (as of the time of writing), but are required to serve as a foundation for this repository:
2121

2222
* [PHP-FPM 5.2](https://github.com/devilbox/docker-php-fpm-5.2)
2323
* [PHP-FPM 5.3](https://github.com/devilbox/docker-php-fpm-5.3)

0 commit comments

Comments
 (0)