ApacheSystemService
Apache System Service Module
Overview
ApacheSystemService:
Apache System Service Module
Models the Apache httpd server as installed by the OS and with service management done through /etc/init.d/httpd
Design
- Super Type
- SystemService
| Role | Concrete. (Objects can be created.) |
| Instance Names | Unique |
| Notification | false |
| Template Directory | |
| Data View | Children, proximity: 1 |
| Logger Name | ApacheSystemService |
Constraints
Allowed Child Dependencies
- ApacheCgiBin1
- ApacheDocumentRoot1
- ApacheErrorDir1
- ApacheGroup1
- ApacheIconsDir1
- ApacheListen
- ApacheProxyAjpLocation1
- ApacheProxyAjpWebapp1
- ApacheServerAdmin1
- ApacheServerName1
- ApacheServerRoot1
- ApacheUser1
- Package
- Service
- SystemServiceScript1
- SystemServiceUseSudo1
- TomcatAjpPort1
- TomcatServer 1
1: These types have a Singleton constraint. Only one instance may be added as a resource.
Allowed Parent Dependencies
- Node
- Site
Attributes
Settings are defined in the Apache module's type definition. Defaults are taken from Red Hat Enterprise Linux. Defaults may be different than those of the Apache type. N.B. There is no default for serverName. You must specify the ApacheServerName setting.
Defaults for Imported Attributes
| Name | Default | Description |
|---|---|---|
| cgiBin | /var/www/cgi-bin | Directory for cgi-bin scripts |
| documentRoot | /var/www/html | Home of server documents |
| errorDir | /var/www/error | Directory for error pages |
| group | apache | Runtime group of Apache daemon |
| iconsDir | /var/www/icons | Directory for icons used in generated directory listings |
| listen | 80 | Listen specification (port, or address:port, etc.) |
| proxyAjpLocation | /examples/ | The location under http://servername/ for which traffic will be forwarded via mod_proxy_ajp |
| proxyAjpWebapp | examples/ | The Tomcat web application to which traffic will be proxied by mod_proxy_ajp |
| serverAdmin | webmaster@localhost.localdomain | Administrator e-mail address |
| serverRoot | /etc/httpd | Home of apache configuration |
| systemServiceScript | httpd | Name of /etc/init.d script (httpd in RHEL; apache in some other distributions) |
| systemServiceUseSudo | true | Boolean whether to use sudo (from SystemService) |
| user | apache | Runtime user of Apache daemon |
Commands
Note
Commandline options displayed in square brackets "[]" are optional. If an option expects arguments, then angle brackets are shown after the option "<>". Any default value is shown within the brackets.
Docs-Generate
Generate the Apache configuration file
Uses templates to generate the httpd.conf file; also generates proxy_ajp.conf if a TomcatServer is a dependency.
- Usage
- Docs-Generate [-ajpPort <>] [-proxyAjpLocation <>] [-proxyAjpWebapp <>] [-serverRoot <>]
Options
| Option | Description |
|---|---|
| ajpPort | Tomcat Ajp13 Port |
| proxyAjpLocation | mod_proxy_ajp Location to proxy to Tomcat |
| proxyAjpWebapp | mod_proxy_ajp Destination Tomcat Webapp |
| serverRoot | Apache Server Root |