{"id":15167097,"url":"https://github.com/lkubb/salt-nginx-formula","last_synced_at":"2025-04-09T03:26:33.709Z","repository":{"id":134852522,"uuid":"577096697","full_name":"lkubb/salt-nginx-formula","owner":"lkubb","description":"Manage Nginx with Salt.","archived":false,"fork":false,"pushed_at":"2024-11-13T23:25:45.000Z","size":252,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-14T21:47:48.964Z","etag":null,"topics":["nginx","salt","salt-formula","saltstack","saltstack-formula"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lkubb.png","metadata":{"files":{"readme":"docs/README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-12T00:11:02.000Z","updated_at":"2024-11-13T23:25:49.000Z","dependencies_parsed_at":"2024-01-19T18:43:29.909Z","dependency_job_id":"ab625e51-9caa-4be8-b91b-f056e709ecc9","html_url":"https://github.com/lkubb/salt-nginx-formula","commit_stats":{"total_commits":41,"total_committers":1,"mean_commits":41.0,"dds":0.0,"last_synced_commit":"d57e2ff628bbcc70d4982fa80cd9af1a3430312b"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lkubb%2Fsalt-nginx-formula","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lkubb%2Fsalt-nginx-formula/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lkubb%2Fsalt-nginx-formula/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lkubb%2Fsalt-nginx-formula/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lkubb","download_url":"https://codeload.github.com/lkubb/salt-nginx-formula/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247970486,"owners_count":21026153,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nginx","salt","salt-formula","saltstack","saltstack-formula"],"created_at":"2024-09-27T05:24:36.291Z","updated_at":"2025-04-09T03:26:33.691Z","avatar_url":"https://github.com/lkubb.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. _readme:\n\nNginx Formula\n=============\n\n|img_sr| |img_pc|\n\n.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n   :alt: Semantic Release\n   :scale: 100%\n   :target: https://github.com/semantic-release/semantic-release\n.. |img_pc| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white\n   :alt: pre-commit\n   :scale: 100%\n   :target: https://github.com/pre-commit/pre-commit\n\nManage Nginx with Salt.\n\n.. contents:: **Table of Contents**\n   :depth: 1\n\nGeneral notes\n-------------\n\nSee the full `SaltStack Formulas installation and usage instructions\n\u003chttps://docs.saltproject.io/en/latest/topics/development/conventions/formulas.html\u003e`_.\n\nIf you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section\n\u003chttps://docs.saltproject.io/en/latest/topics/development/conventions/formulas.html#writing-formulas\u003e`_.\n\nIf you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,\nwhich contains the currently released version. This formula is versioned according to `Semantic Versioning \u003chttp://semver.org/\u003e`_.\n\nSee `Formula Versioning Section \u003chttps://docs.saltproject.io/en/latest/topics/development/conventions/formulas.html#versioning\u003e`_ for more details.\n\nIf you need (non-default) configuration, please refer to:\n\n- `how to configure the formula with map.jinja \u003cmap.jinja.rst\u003e`_\n- the ``pillar.example`` file\n- the `Special notes`_ section\n\nSpecial notes\n-------------\n\n\nConfiguration\n-------------\nAn example pillar is provided, please see `pillar.example`. Note that you do not need to specify everything by pillar. Often, it's much easier and less resource-heavy to use the ``parameters/\u003cgrain\u003e/\u003cvalue\u003e.yaml`` files for non-sensitive settings. The underlying logic is explained in `map.jinja`.\n\n\nAvailable states\n----------------\n\nThe following states are found in this formula:\n\n.. contents::\n   :local:\n\n\n``nginx``\n^^^^^^^^^\n*Meta-state*.\n\nThis installs the nginx package and possibly repository,\nmanages the nginx configuration file\nplus snippets, manages webroot dirs,\ngenerates DH params if requested (discouraged),\nstarts the associated nginx service\nand manages server configurations.\n\n\n``nginx.package``\n^^^^^^^^^^^^^^^^^\nInstalls the nginx package only.\nIf installation from repo is configured, will also\nconfigure the selected repo.\n\n\n``nginx.package.repo``\n^^^^^^^^^^^^^^^^^^^^^^\nThis state will install the configured nginx repository.\nThis works for apt/dnf/yum/zypper-based distributions only by default.\n\n\n``nginx.certs``\n^^^^^^^^^^^^^^^\nGenerates certificates for servers that have ``certs`` set.\nAlso generates Diffie-Hellman key exchange parameters, if requested.\nThis is discouraged.\nHas a dependency on `nginx.config`_.\n\n\n``nginx.certs.dhparam``\n^^^^^^^^^^^^^^^^^^^^^^^\n\n\n\n``nginx.certs.managed``\n^^^^^^^^^^^^^^^^^^^^^^^\n\n\n\n``nginx.certs.snakeoil``\n^^^^^^^^^^^^^^^^^^^^^^^^\n\n\n\n``nginx.config``\n^^^^^^^^^^^^^^^^\nManages the nginx service configuration.\nHas a dependency on `nginx.package`_.\n\n\n``nginx.config.file``\n^^^^^^^^^^^^^^^^^^^^^\n\n\n\n``nginx.config.selinux``\n^^^^^^^^^^^^^^^^^^^^^^^^\n\n\n\n``nginx.snippets``\n^^^^^^^^^^^^^^^^^^\nManages Nginx snippets.\nHas a dependency on `nginx.package`_.\n\n\n``nginx.webroots``\n^^^^^^^^^^^^^^^^^^\nEnsures configured webroot directories are present.\nHas a dependency on `nginx.package`_.\n\n\n``nginx.service``\n^^^^^^^^^^^^^^^^^\nStarts the nginx service (and session key rotation service, if configured)\nand enables it at boot time.\nHas a dependency on `nginx.config`_.\n\n\n``nginx.servers``\n^^^^^^^^^^^^^^^^^\nManages server configurations and their state (enabled/disabled).\nHas a dependency on `nginx.service`_.\n\n\n``nginx.clean``\n^^^^^^^^^^^^^^^\n*Meta-state*.\n\nUndoes everything performed in the ``nginx`` meta-state\nin reverse order, i.e.\nremoves managed server configurations,\nstops the service,\nremoves webroots if ``nginx.lookup.remove_all_data_for_sure`` is True,\nremoves snippets, the configuration file and possibly\ngenerated DH params and then uninstalls the package\nand possibly repository.\n\n\n``nginx.package.clean``\n^^^^^^^^^^^^^^^^^^^^^^^\nRemoves the nginx package and nginx repositories.\nHas a dependency on `nginx.config.clean`_.\n\n\n``nginx.package.repo.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^\nThis state will remove the configured nginx repository.\nThis works for apt/dnf/yum/zypper-based distributions only by default.\n\n\n``nginx.certs.clean``\n^^^^^^^^^^^^^^^^^^^^^\nRemoves generated certificates, private keys and DH parameters.\nHas a dependency on `nginx.service.clean`_.\n\n\n``nginx.config.clean``\n^^^^^^^^^^^^^^^^^^^^^^\nRemoves the configuration of the nginx service and has a\ndependency on `nginx.service.clean`_.\n\n\n``nginx.snippets.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^\nRemoves all managed snippets.\n\n\n``nginx.webroots.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^\nRemoves configured webroot directories if\n``nginx.lookup.remove_all_data_for_sure`` is True.\nHas a dependency on `nginx.service.clean`_.\n\n\n``nginx.service.clean``\n^^^^^^^^^^^^^^^^^^^^^^^\nStops the nginx service (and session key rotation service, if configured)\nand disables it at boot time.\n\n\n``nginx.servers.clean``\n^^^^^^^^^^^^^^^^^^^^^^^\nRemoves all managed server configurations.\n\n\n\nContributing to this repo\n-------------------------\n\nCommit messages\n^^^^^^^^^^^^^^^\n\n**Commit message formatting is significant!**\n\nPlease see `How to contribute \u003chttps://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst\u003e`_ for more details.\n\npre-commit\n^^^^^^^^^^\n\n`pre-commit \u003chttps://pre-commit.com/\u003e`_ is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes.\nFirst install  the ``pre-commit`` package manager using the appropriate `method \u003chttps://pre-commit.com/#installation\u003e`_, then run ``bin/install-hooks`` and\nnow ``pre-commit`` will run automatically on each ``git commit``. ::\n\n  $ bin/install-hooks\n  pre-commit installed at .git/hooks/pre-commit\n  pre-commit installed at .git/hooks/commit-msg\n\nState documentation\n~~~~~~~~~~~~~~~~~~~\nThere is a script that semi-autodocuments available states: ``bin/slsdoc``.\n\nIf a ``.sls`` file begins with a Jinja comment, it will dump that into the docs. It can be configured differently depending on the formula. See the script source code for details currently.\n\nThis means if you feel a state should be documented, make sure to write a comment explaining it.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flkubb%2Fsalt-nginx-formula","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flkubb%2Fsalt-nginx-formula","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flkubb%2Fsalt-nginx-formula/lists"}