confdroid/confdroid_apache
3
0
Fork 0
Code Issues Projects Wiki Activity

EN-0001 - markdownlint

Browse Source
This commit is contained in:
Arne Teuke
2021-08-05 16:11:02 +02:00
parent 4e3682f6a8
commit f69cf3b41d
1 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -5,15 +5,17 @@
[[_TOC_]] [[_TOC_]]
## Synopsis ## Synopsis
`Apache httpd` is a very powerful and widely used web server. `Apache httpd` is a very powerful and widely used web server.
`cd_apache` automates the installation and configuration of httpd. This module is a base module simply providing the httpd service itself to be used by other role- or profile modules, adding more detailed configurations specific to the particular use case. `cd_apache` automates the installation and configuration of httpd. This module is a base module simply providing the httpd service itself to be used by other role- or profile modules, adding more detailed configurations specific to the particular use case.
## WARNING ## WARNING
`**__!!! Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previuos configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production!!! __**` `**__!!! Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previuos configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production!!! __**`
## Features ## Features
Installation Installation
* install required binaries and dependencies * install required binaries and dependencies
@@ -29,6 +31,7 @@ Maintenance
* manage the service * manage the service
### vHosts ### vHosts
As stated in the synopsis, this module was written particularly for usage as base module. `Apache httpd` has a great number of usae cases where it actually is not used directly as full blown webser, but instead as 'sub-service'. Examples here would be As stated in the synopsis, this module was written particularly for usage as base module. `Apache httpd` has a great number of usae cases where it actually is not used directly as full blown webser, but instead as 'sub-service'. Examples here would be
* frontend proxy for other applications to avoid having to put the port number into the URL * frontend proxy for other applications to avoid having to put the port number into the URL
@@ -39,6 +42,7 @@ As stated in the synopsis, this module was written particularly for usage as bas
With those use cases, you would provide the vHosts at the Puppet module for the application, not the base module. Also, if you plan to use this module to run a plain fully fledged web server, you would use a role- or profile class/module on top of `cd_apache` to set up your vHost exactly as needed. Examples for regular basic vHost configuration files are included in the examples directory as parameterized .erb files. You would create a define for vhosts, i.e. using the example parameters, and simply add `cd_apache` as requirement (i.e. require cd_apache) so it gets installed automatically. With those use cases, you would provide the vHosts at the Puppet module for the application, not the base module. Also, if you plan to use this module to run a plain fully fledged web server, you would use a role- or profile class/module on top of `cd_apache` to set up your vHost exactly as needed. Examples for regular basic vHost configuration files are included in the examples directory as parameterized .erb files. You would create a define for vhosts, i.e. using the example parameters, and simply add `cd_apache` as requirement (i.e. require cd_apache) so it gets installed automatically.
### Dependencies ### Dependencies
All dependencies must be included in the catalogue. All dependencies must be included in the catalogue.
* [cd_resources](https://gitlab.confdroid.com/12WW1160/cd_resources) * [cd_resources](https://gitlab.confdroid.com/12WW1160/cd_resources)
@@ -75,6 +79,7 @@ All files and directories are configured with correct selinux context. If selinu
* Puppet 5 * Puppet 5
## Tests ## Tests
* Puppet Lint * Puppet Lint
* excluded tests: * excluded tests:
* `--no-class_inherits_from_params_class-check`:relavant only to non-supported outdated puppet versions * `--no-class_inherits_from_params_class-check`:relavant only to non-supported outdated puppet versions