nginx-formula/docs/README.rst
2019-04-26 09:11:11 +01:00

120 lines
2.8 KiB
ReStructuredText

=====
nginx
=====
Install nginx either by source or by package.
.. note::
See the full `Salt Formulas installation and usage instructions
<http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.
Available states
================
.. contents::
:local:
``nginx``
---------
Runs the states to install nginx, configure the common files, and the users.
``nginx.common``
----------------
Ensures standard nginx files are in place, and configures enabled sites.
``nginx.luajit2``
-----------------
Installs luajit.
``nginx.openresty``
-------------------
Installs openresty.
``nginx.package``
-----------------
Installs the nginx package via package manager.
``nginx.source``
----------------
Installs nginx via the source files.
``nginx.users``
---------------
Installs apache utils, and configures nginx users specified in the pillar.
This requires `basicauth <https://github.com/saltstack/salt-contrib/blob/master/modules/basicauth.py>`_
from `salt-contrib <https://github.com/saltstack/salt-contrib/>`_ (either add it to your salt or ship
this single file in your `_modules` directory see `Dynamic Module Distribution
<https://docs.saltstack.com/en/latest/ref/file_server/dynamic-modules.html>`_
Next-generation, alternate approach
===================================
The following states provide an alternate approach to managing Nginx and Nginx
servers, as well as code organization. Please provide feedback by filing issues,
discussing in ``#salt`` in Freenode and the mailing list as normal.
.. contents::
:local:
``nginx.ng``
------------
Meta-state for inclusion of all ng states.
**Note:** nginx.ng requires the merge parameter of salt.modules.pillar.get(),
first available in the Helium release.
``nginx.ng.pkg``
--------------------
Installs nginx from package, from the distribution repositories, the official nginx repo or the ppa from Launchpad.
``nginx.ng.src``
--------------------
Builds and installs nginx from source.
``nginx.ng.certificates``
-------------------
Manages the deployment of nginx certificates.
``nginx.ng.config``
-------------------
Manages the nginx main server configuration file.
``nginx.ng.service``
--------------------
Manages the startup and running state of the nginx service.
``nginx.ng.servers_config``
--------------------------
Manages virtual host files. This state only manages the content of the files
and does not bind them to service calls.
``nginx.ng.servers``
-------------------
Manages nginx virtual hosts files and binds them to service calls.
``nginx.ng.passenger``
----------------------
Installs and configures Phusion Passenger module for nginx. You need to enable
the upstream phusion passenger repository with `install_from_phusionpassenger: true`.
Nginx will also be installed from that repository, as it needs to be modified to
allow the passenger module to work.