Refactored the README with individual sections for each state
This commit is contained in:
parent
2499a50135
commit
65e2bffaea
75
README.rst
75
README.rst
@ -1,7 +1,8 @@
|
||||
======
|
||||
apache
|
||||
======
|
||||
|
||||
Formulas to set up and configure the Apache HTTP server
|
||||
Formulas to set up and configure the Apache HTTP server.
|
||||
|
||||
.. note::
|
||||
|
||||
@ -9,13 +10,72 @@ Formulas to set up and configure the Apache HTTP server
|
||||
<http://docs.saltstack.com/topics/conventions/formulas.html>`_.
|
||||
|
||||
Available states
|
||||
----------------
|
||||
================
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
``apache``
|
||||
----------
|
||||
|
||||
Installs the Apache package and starts the service.
|
||||
|
||||
``apache.mod_wsgi``
|
||||
-------------------
|
||||
|
||||
Installs the mod_wsgi package and enables the Apache module.
|
||||
|
||||
``apache.vhost.standard``
|
||||
-------------------------
|
||||
|
||||
Configures Apache name-based virtual hosts using data from Pillar.
|
||||
|
||||
Example Pillar:
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
apache:
|
||||
sites:
|
||||
# Default values below are used unless disabled by setting to 'None'.
|
||||
example.com: # must be unique; used as an ID declaration in Salt; also passed to the template context as {{ id }}
|
||||
template_file: salt://apache/vhosts/standard.tmpl
|
||||
template_engine: jinja
|
||||
|
||||
interface: '*'
|
||||
port: '80'
|
||||
|
||||
ServerName: {{ id }} # uses the unique ID above unless specified
|
||||
ServerAlias: www.{{ id }}
|
||||
|
||||
ServerAdmin: webmaster@{{ id }}
|
||||
|
||||
LogLevel: warn
|
||||
ErrorLog: {{ logdir }}/{{ id }}-error.log # E.g.: /var/log/apache2/example.com-error.log
|
||||
CustomLog: {{ logdir }}/{{ id }}-access.log # E.g.: /var/log/apache2/example.com-access.log
|
||||
|
||||
DocumentRoot: {{ wwwdir }}/{{ id }} # E.g., /var/www/example.com
|
||||
|
||||
Directory:
|
||||
{{ wwwdir }}/{{ id }}: # E.g.: /var/www/example.com:
|
||||
Options: -Indexes FollowSymLinks
|
||||
Order: allow,deny
|
||||
Allow: from all
|
||||
AllowOverride: All
|
||||
Formula_Append: |
|
||||
Additional config as a
|
||||
multi-line string here
|
||||
|
||||
Formula_Append: |
|
||||
Additional config as a
|
||||
multi-line string here
|
||||
|
||||
example.net:
|
||||
template_file: salt://apache/vhosts/minimal.tmpl
|
||||
|
||||
|
||||
``apache.debian_full``
|
||||
----------------------
|
||||
|
||||
Installs and configures Apache on Debian and Ubuntu systems.
|
||||
|
||||
These states are ordered using the ``order`` declaration. Different stages
|
||||
@ -40,3 +100,14 @@ Available states
|
||||
|
||||
1) `php <https://github.com/saltstack-formulas/php-formula>`_
|
||||
|
||||
Example Pillar:
|
||||
|
||||
.. code:: yaml
|
||||
|
||||
apache:
|
||||
register-site:
|
||||
# any name as an array index, and you can duplicate this section
|
||||
{{UNQIUE}}:
|
||||
name: 'my name'
|
||||
path: 'salt://path/to/sites-available/conf/file'
|
||||
state: 'enabled'
|
||||
|
Loading…
Reference in New Issue
Block a user