From c5f2caec20378fe153d52e9cac8c1c1cb27f778c Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Wed, 5 May 2021 18:30:13 +0100 Subject: [PATCH] docs(antora): add basic structure [skip ci] * Automated using https://github.com/myii/ssf-formula/pull/999 --- docs/antora.yml | 11 + docs/modules/ROOT/attachments/.keep | 0 docs/modules/ROOT/examples/.keep | 0 docs/modules/ROOT/images/.keep | 0 docs/modules/ROOT/nav-explanations.adoc | 3 + docs/modules/ROOT/nav-guides.adoc | 3 + docs/modules/ROOT/nav-references.adoc | 3 + docs/modules/ROOT/nav-repo-docs.adoc | 8 + docs/modules/ROOT/nav-tutorials.adoc | 3 + docs/modules/ROOT/pages/.keep | 0 docs/modules/ROOT/pages/AUTHORS.adoc | 371 +++++++++++++++++++++++ docs/modules/ROOT/pages/CHANGELOG.adoc | 386 ++++++++++++++++++++++++ docs/modules/ROOT/pages/README.adoc | 366 ++++++++++++++++++++++ docs/modules/ROOT/partials/.keep | 0 14 files changed, 1154 insertions(+) create mode 100644 docs/antora.yml create mode 100644 docs/modules/ROOT/attachments/.keep create mode 100644 docs/modules/ROOT/examples/.keep create mode 100644 docs/modules/ROOT/images/.keep create mode 100644 docs/modules/ROOT/nav-explanations.adoc create mode 100644 docs/modules/ROOT/nav-guides.adoc create mode 100644 docs/modules/ROOT/nav-references.adoc create mode 100644 docs/modules/ROOT/nav-repo-docs.adoc create mode 100644 docs/modules/ROOT/nav-tutorials.adoc create mode 100644 docs/modules/ROOT/pages/.keep create mode 100644 docs/modules/ROOT/pages/AUTHORS.adoc create mode 100644 docs/modules/ROOT/pages/CHANGELOG.adoc create mode 100644 docs/modules/ROOT/pages/README.adoc create mode 100644 docs/modules/ROOT/partials/.keep diff --git a/docs/antora.yml b/docs/antora.yml new file mode 100644 index 0000000..88a266f --- /dev/null +++ b/docs/antora.yml @@ -0,0 +1,11 @@ +--- +name: 'apache-formula' +title: 'apache-formula' +version: '1.1.3' +start_page: 'README.adoc' +nav: + - 'modules/ROOT/nav-repo-docs.adoc' + - 'modules/ROOT/nav-explanations.adoc' + - 'modules/ROOT/nav-guides.adoc' + - 'modules/ROOT/nav-references.adoc' + - 'modules/ROOT/nav-tutorials.adoc' diff --git a/docs/modules/ROOT/attachments/.keep b/docs/modules/ROOT/attachments/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/modules/ROOT/examples/.keep b/docs/modules/ROOT/examples/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/modules/ROOT/images/.keep b/docs/modules/ROOT/images/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/modules/ROOT/nav-explanations.adoc b/docs/modules/ROOT/nav-explanations.adoc new file mode 100644 index 0000000..719ba6c --- /dev/null +++ b/docs/modules/ROOT/nav-explanations.adoc @@ -0,0 +1,3 @@ +.Explanations + +* xref:explanation-.adoc[...] diff --git a/docs/modules/ROOT/nav-guides.adoc b/docs/modules/ROOT/nav-guides.adoc new file mode 100644 index 0000000..b2cf454 --- /dev/null +++ b/docs/modules/ROOT/nav-guides.adoc @@ -0,0 +1,3 @@ +.Guides + +* xref:guide-.adoc[...] diff --git a/docs/modules/ROOT/nav-references.adoc b/docs/modules/ROOT/nav-references.adoc new file mode 100644 index 0000000..76bfc0e --- /dev/null +++ b/docs/modules/ROOT/nav-references.adoc @@ -0,0 +1,3 @@ +.References + +* xref:reference-.adoc[...] diff --git a/docs/modules/ROOT/nav-repo-docs.adoc b/docs/modules/ROOT/nav-repo-docs.adoc new file mode 100644 index 0000000..e22b197 --- /dev/null +++ b/docs/modules/ROOT/nav-repo-docs.adoc @@ -0,0 +1,8 @@ +.Repo documentation + +* xref:README.adoc[README] +** xref:README.adoc#_available_states[Available states] + +* xref:CHANGELOG.adoc[] + +* xref:AUTHORS.adoc[Contributors] diff --git a/docs/modules/ROOT/nav-tutorials.adoc b/docs/modules/ROOT/nav-tutorials.adoc new file mode 100644 index 0000000..720f37b --- /dev/null +++ b/docs/modules/ROOT/nav-tutorials.adoc @@ -0,0 +1,3 @@ +.Tutorials + +* xref:tutorial-.adoc[...] diff --git a/docs/modules/ROOT/pages/.keep b/docs/modules/ROOT/pages/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/modules/ROOT/pages/AUTHORS.adoc b/docs/modules/ROOT/pages/AUTHORS.adoc new file mode 100644 index 0000000..a67329a --- /dev/null +++ b/docs/modules/ROOT/pages/AUTHORS.adoc @@ -0,0 +1,371 @@ += Authors + +This list is sorted by the number of commits per contributor in +_descending_ order. + +.List of contributors +[format="psv", separator="|", options="header", cols="^.<30a,<.<40a,^.<40d", width="100"] +|=== +^.^|Avatar +<.^|Contributor +^.^|Contributions + +|image::https://avatars.githubusercontent.com/u/10231489?v=4[@myii,36,36] +|https://github.com/myii[@myii^] +|89 + +|image::https://avatars.githubusercontent.com/u/1920805?v=4[@alxwr,36,36] +|https://github.com/alxwr[@alxwr^] +|40 + +|image::https://avatars.githubusercontent.com/u/1396878?v=4[@gravyboat,36,36] +|https://github.com/gravyboat[@gravyboat^] +|36 + +|image::https://avatars.githubusercontent.com/u/1800660?v=4[@aboe76,36,36] +|https://github.com/aboe76[@aboe76^] +|32 + +|image::https://avatars.githubusercontent.com/u/91293?v=4[@whiteinge,36,36] +|https://github.com/whiteinge[@whiteinge^] +|31 + +|image::https://avatars.githubusercontent.com/u/13322818?v=4[@noelmcloughlin,36,36] +|https://github.com/noelmcloughlin[@noelmcloughlin^] +|29 + +|image::https://avatars.githubusercontent.com/u/242396?v=4[@javierbertoli,36,36] +|https://github.com/javierbertoli[@javierbertoli^] +|27 + +|image::https://avatars.githubusercontent.com/u/3374962?v=4[@nmadhok,36,36] +|https://github.com/nmadhok[@nmadhok^] +|20 + +|image::https://avatars.githubusercontent.com/u/528061?v=4[@puneetk,36,36] +|https://github.com/puneetk[@puneetk^] +|20 + +|image::https://avatars.githubusercontent.com/u/214768?v=4[@ixs,36,36] +|https://github.com/ixs[@ixs^] +|10 + +|image::https://avatars.githubusercontent.com/u/458548?v=4[@SuperTux88,36,36] +|https://github.com/SuperTux88[@SuperTux88^] +|10 + +|image::https://avatars.githubusercontent.com/u/287147?v=4[@techhat,36,36] +|https://github.com/techhat[@techhat^] +|10 + +|image::https://avatars.githubusercontent.com/u/904839?v=4[@landergate,36,36] +|https://github.com/landergate[@landergate^] +|9 + +|image::https://avatars.githubusercontent.com/u/3045456?v=4[@bradthurber,36,36] +|https://github.com/bradthurber[@bradthurber^] +|8 + +|image::https://avatars.githubusercontent.com/u/117961?v=4[@babilen5,36,36] +|https://github.com/babilen5[@babilen5^] +|8 + +|image::https://avatars.githubusercontent.com/u/445200?v=4[@arthurlogilab,36,36] +|https://github.com/arthurlogilab[@arthurlogilab^] +|7 + +|image::https://avatars.githubusercontent.com/u/3768412?v=4[@stp-ip,36,36] +|https://github.com/stp-ip[@stp-ip^] +|7 + +|image::https://avatars.githubusercontent.com/u/17673243?v=4[@porunov,36,36] +|https://github.com/porunov[@porunov^] +|7 + +|image::https://avatars.githubusercontent.com/u/3119969?v=4[@genuss,36,36] +|https://github.com/genuss[@genuss^] +|6 + +|image::https://avatars.githubusercontent.com/u/5759396?v=4[@kadogo,36,36] +|https://github.com/kadogo[@kadogo^] +|6 + +|image::https://avatars.githubusercontent.com/u/637990?v=4[@bmwiedemann,36,36] +|https://github.com/bmwiedemann[@bmwiedemann^] +|5 + +|image::https://avatars.githubusercontent.com/u/48491?v=4[@eliasp,36,36] +|https://github.com/eliasp[@eliasp^] +|5 + +|image::https://avatars.githubusercontent.com/u/65311?v=4[@multani,36,36] +|https://github.com/multani[@multani^] +|5 + +|image::https://avatars.githubusercontent.com/u/1013915?v=4[@rhertzog,36,36] +|https://github.com/rhertzog[@rhertzog^] +|4 + +|image::https://avatars.githubusercontent.com/u/20515?v=4[@scambra,36,36] +|https://github.com/scambra[@scambra^] +|4 + +|image::https://avatars.githubusercontent.com/u/2094680?v=4[@daschatten,36,36] +|https://github.com/daschatten[@daschatten^] +|4 + +|image::https://avatars.githubusercontent.com/u/1744181?v=4[@adherzog,36,36] +|https://github.com/adherzog[@adherzog^] +|3 + +|image::https://avatars.githubusercontent.com/u/2192630?v=4[@abrefort,36,36] +|https://github.com/abrefort[@abrefort^] +|3 + +|image::https://avatars.githubusercontent.com/u/1507504?v=4[@arnisoph,36,36] +|https://github.com/arnisoph[@arnisoph^] +|3 + +|image::https://avatars.githubusercontent.com/u/4195158?v=4[@dafyddj,36,36] +|https://github.com/dafyddj[@dafyddj^] +|3 + +|image::https://avatars.githubusercontent.com/u/312493?v=4[@opdude,36,36] +|https://github.com/opdude[@opdude^] +|3 + +|image::https://avatars.githubusercontent.com/u/10925856?v=4[@louis-haddrell,36,36] +|https://github.com/louis-haddrell[@louis-haddrell^] +|3 + +|image::https://avatars.githubusercontent.com/u/964610?v=4[@Wenzel,36,36] +|https://github.com/Wenzel[@Wenzel^] +|3 + +|image::https://avatars.githubusercontent.com/u/228723?v=4[@abednarik,36,36] +|https://github.com/abednarik[@abednarik^] +|3 + +|image::https://avatars.githubusercontent.com/u/12513495?v=4[@dexbleeker,36,36] +|https://github.com/dexbleeker[@dexbleeker^] +|3 + +|image::https://avatars.githubusercontent.com/u/112249?v=4[@vincentfretin,36,36] +|https://github.com/vincentfretin[@vincentfretin^] +|3 + +|image::https://avatars.githubusercontent.com/u/1079875?v=4[@bogdanr,36,36] +|https://github.com/bogdanr[@bogdanr^] +|2 + +|image::https://avatars.githubusercontent.com/u/11229682?v=4[@carlovollebregt,36,36] +|https://github.com/carlovollebregt[@carlovollebregt^] +|2 + +|image::https://avatars.githubusercontent.com/u/4313010?v=4[@thornycrackers,36,36] +|https://github.com/thornycrackers[@thornycrackers^] +|2 + +|image::https://avatars.githubusercontent.com/u/29622411?v=4[@gaetanars,36,36] +|https://github.com/gaetanars[@gaetanars^] +|2 + +|image::https://avatars.githubusercontent.com/u/7060082?v=4[@msciciel,36,36] +|https://github.com/msciciel[@msciciel^] +|2 + +|image::https://avatars.githubusercontent.com/u/485400?v=4[@actionjack,36,36] +|https://github.com/actionjack[@actionjack^] +|2 + +|image::https://avatars.githubusercontent.com/u/316108?v=4[@mosen,36,36] +|https://github.com/mosen[@mosen^] +|2 + +|image::https://avatars.githubusercontent.com/u/1244954?v=4[@RyPeck,36,36] +|https://github.com/RyPeck[@RyPeck^] +|2 + +|image::https://avatars.githubusercontent.com/u/507599?v=4[@thatch45,36,36] +|https://github.com/thatch45[@thatch45^] +|2 + +|image::https://avatars.githubusercontent.com/u/19413421?v=4[@tibberg,36,36] +|https://github.com/tibberg[@tibberg^] +|2 + +|image::https://avatars.githubusercontent.com/u/15383526?v=4[@emeygret,36,36] +|https://github.com/emeygret[@emeygret^] +|2 + +|image::https://avatars.githubusercontent.com/u/3609179?v=4[@artmoni,36,36] +|https://github.com/artmoni[@artmoni^] +|2 + +|image::https://avatars.githubusercontent.com/u/5512529?v=4[@alexfrosa,36,36] +|https://github.com/alexfrosa[@alexfrosa^] +|2 + +|image::https://avatars.githubusercontent.com/u/20859482?v=4[@jhops-ab,36,36] +|https://github.com/jhops-ab[@jhops-ab^] +|1 + +|image::https://avatars.githubusercontent.com/u/7612102?v=4[@isntall,36,36] +|https://github.com/isntall[@isntall^] +|1 + +|image::https://avatars.githubusercontent.com/u/863137?v=4[@benjy,36,36] +|https://github.com/benjy[@benjy^] +|1 + +|image::https://avatars.githubusercontent.com/u/20441?v=4[@iggy,36,36] +|https://github.com/iggy[@iggy^] +|1 + +|image::https://avatars.githubusercontent.com/u/47893434?v=4[@chorne-togetherwork,36,36] +|https://github.com/chorne-togetherwork[@chorne-togetherwork^] +|1 + +|image::https://avatars.githubusercontent.com/u/130219?v=4[@corywright,36,36] +|https://github.com/corywright[@corywright^] +|1 + +|image::https://avatars.githubusercontent.com/u/1233212?v=4[@baby-gnu,36,36] +|https://github.com/baby-gnu[@baby-gnu^] +|1 + +|image::https://avatars.githubusercontent.com/u/1640672?v=4[@ev0rtex,36,36] +|https://github.com/ev0rtex[@ev0rtex^] +|1 + +|image::https://avatars.githubusercontent.com/u/42472863?v=4[@dimitry-unified-streaming,36,36] +|https://github.com/dimitry-unified-streaming[@dimitry-unified-streaming^] + +|1 + +|image::https://avatars.githubusercontent.com/u/1194646?v=4[@fintanmm,36,36] +|https://github.com/fintanmm[@fintanmm^] +|1 + +|image::https://avatars.githubusercontent.com/u/215487?v=4[@fcrozat,36,36] +|https://github.com/fcrozat[@fcrozat^] +|1 + +|image::https://avatars.githubusercontent.com/u/38090329?v=4[@genaumann,36,36] +|https://github.com/genaumann[@genaumann^] +|1 + +|image::https://avatars.githubusercontent.com/u/41886?v=4[@jbouse,36,36] +|https://github.com/jbouse[@jbouse^] +|1 + +|image::https://avatars.githubusercontent.com/u/377632?v=4[@jerrykan,36,36] +|https://github.com/jerrykan[@jerrykan^] +|1 + +|image::https://avatars.githubusercontent.com/u/3703806?v=4[@jcristau,36,36] +|https://github.com/jcristau[@jcristau^] +|1 + +|image::https://avatars.githubusercontent.com/u/5655231?v=4[@kpostrup,36,36] +|https://github.com/kpostrup[@kpostrup^] +|1 + +|image::https://avatars.githubusercontent.com/u/783794?v=4[@morsik,36,36] +|https://github.com/morsik[@morsik^] +|1 + +|image::https://avatars.githubusercontent.com/u/22311?v=4[@madssj,36,36] +|https://github.com/madssj[@madssj^] +|1 + +|image::https://avatars.githubusercontent.com/u/201711?v=4[@mariusvw,36,36] +|https://github.com/mariusvw[@mariusvw^] +|1 + +|image::https://avatars.githubusercontent.com/u/1106959?v=4[@mpeeters,36,36] +|https://github.com/mpeeters[@mpeeters^] +|1 + +|image::https://avatars.githubusercontent.com/u/7139195?v=4[@xenophonf,36,36] +|https://github.com/xenophonf[@xenophonf^] +|1 + +|image::https://avatars.githubusercontent.com/u/393545?v=4[@mshade,36,36] +|https://github.com/mshade[@mshade^] +|1 + +|image::https://avatars.githubusercontent.com/u/1829924?v=4[@fujexo,36,36] +|https://github.com/fujexo[@fujexo^] +|1 + +|image::https://avatars.githubusercontent.com/u/219695?v=4[@rmoorman,36,36] +|https://github.com/rmoorman[@rmoorman^] +|1 + +|image::https://avatars.githubusercontent.com/u/1647923?v=4[@robruma,36,36] +|https://github.com/robruma[@robruma^] +|1 + +|image::https://avatars.githubusercontent.com/u/1554646?v=4[@doublerr,36,36] +|https://github.com/doublerr[@doublerr^] +|1 + +|image::https://avatars.githubusercontent.com/u/3667731?v=4[@netzvieh,36,36] +|https://github.com/netzvieh[@netzvieh^] +|1 + +|image::https://avatars.githubusercontent.com/u/4156131?v=4[@skylerberg,36,36] +|https://github.com/skylerberg[@skylerberg^] +|1 + +|image::https://avatars.githubusercontent.com/u/326786?v=4[@wido,36,36] +|https://github.com/wido[@wido^] +|1 + +|image::https://avatars.githubusercontent.com/u/751889?v=4[@Yoda-BZH,36,36] +|https://github.com/Yoda-BZH[@Yoda-BZH^] +|1 + +|image::https://avatars.githubusercontent.com/u/9978732?v=4[@abehling,36,36] +|https://github.com/abehling[@abehling^] +|1 + +|image::https://avatars.githubusercontent.com/u/1021809?v=4[@ardin,36,36] +|https://github.com/ardin[@ardin^] +|1 + +|image::https://avatars.githubusercontent.com/u/17029228?v=4[@mcarlton00,36,36] +|https://github.com/mcarlton00[@mcarlton00^] +|1 + +|image::https://avatars.githubusercontent.com/u/924183?v=4[@mschiff,36,36] +|https://github.com/mschiff[@mschiff^] +|1 + +|image::https://avatars.githubusercontent.com/u/2869?v=4[@nigelsim,36,36] +|https://github.com/nigelsim[@nigelsim^] +|1 + +|image::https://avatars.githubusercontent.com/u/55587680?v=4[@srse,36,36] +|https://github.com/srse[@srse^] +|1 + +|image::https://avatars.githubusercontent.com/u/46799934?v=4[@sticky-note,36,36] +|https://github.com/sticky-note[@sticky-note^] +|1 + +|image::https://avatars.githubusercontent.com/u/18380701?v=4[@tsenay,36,36] +|https://github.com/tsenay[@tsenay^] +|1 + +|image::https://avatars.githubusercontent.com/u/2089076?v=4[@ze42,36,36] +|https://github.com/ze42[@ze42^] +|1 +|=== + +''''' + +Auto-generated by a https://github.com/myii/maintainer[forked version^] +of https://github.com/gaocegege/maintainer[gaocegege/maintainer^] on +2021-04-30. diff --git a/docs/modules/ROOT/pages/CHANGELOG.adoc b/docs/modules/ROOT/pages/CHANGELOG.adoc new file mode 100644 index 0000000..f03d78d --- /dev/null +++ b/docs/modules/ROOT/pages/CHANGELOG.adoc @@ -0,0 +1,386 @@ += Changelog + +:sectnums!: + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v1.1.2...v1.1.3++[1.1.3^] (2021-04-30) + +=== Bug Fixes + +* *config/vhosts/standard:* remove erroneous trailing colon +(https://github.com/saltstack-formulas/apache-formula/commit/dedb9e2f400aa9d391ae39c22f8a4fec1e7bc220[dedb9e2^]), +closes +https://github.com/saltstack-formulas/apache-formula/issues/302[#302^] + +=== Continuous Integration + +* *kitchen+gitlab:* adjust matrix to add `3003` [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/3c21740ba52fa5c2b5cf39cddce6a42d13d17988[3c21740^]) +* *vagrant:* add FreeBSD 13.0 [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/298fdf4fb569a3d1d4a9dadedb4c3924bcb8cc9a[298fdf4^]) +* *vagrant:* use pre-salted boxes & conditional local settings [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/f354ace8e7d328580a60dbc09703ddc54a6af0a0[f354ace^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v1.1.1...v1.1.2++[1.1.2^] (2021-04-03) + +=== Bug Fixes + +* *freebsd:* fix `default` suite implementation and tests +(https://github.com/saltstack-formulas/apache-formula/commit/0a0f69ee2fc8168696f9f9c4ae786389ff894615[0a0f69e^]) +* *freebsd:* fix `modsecurity` suite implementation and tests +(https://github.com/saltstack-formulas/apache-formula/commit/bc9aa78437d14cf26605f58a3c1e17caed8f05bc[bc9aa78^]) + +=== Continuous Integration + +* enable Vagrant-based testing using GitHub Actions +(https://github.com/saltstack-formulas/apache-formula/commit/6e094e2527748cd4d72690b9289836b17f9289c7[6e094e2^]) +* *gemfile+lock:* use `ssf` customised `kitchen-docker` repo [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/53ac4638f3b902c1fd65a64d4344387e26c466c1[53ac463^]) +* *gitlab-ci:* reset after update hook for `rubocop` [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/6d40ab7634a42048a0f2b3f2e1173cf2da2a8716[6d40ab7^]) +* *kitchen+ci:* use latest pre-salted images (after CVE) [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/69e9d304fb7d637df1856e0d8ab66be7ddce86c4[69e9d30^]) +* *kitchen+gitlab-ci:* use latest pre-salted images [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/21cb59daa2f70ce6cc46f8d241fb6032c932746c[21cb59d^]) +* *pre-commit:* update hook for `rubocop` +(https://github.com/saltstack-formulas/apache-formula/commit/2c090c3a835e42bd07f0788f4b0965f1c3405662[2c090c3^]) + +=== Documentation + +* *readme:* add `Testing with Vagrant` section +(https://github.com/saltstack-formulas/apache-formula/commit/5a6b203bb18f9f28146f33af8175fc3b8c059077[5a6b203^]) + +=== Tests + +* standardise use of `share` suite & `_mapdata` state [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/e7c2d20f06f23a5ce8a5edaae513775aca0914ab[e7c2d20^]) +* *nomodsecurity:* use adjusted `modules` suite instead +(https://github.com/saltstack-formulas/apache-formula/commit/838b9172217c5e067ea0e4a6d2f155ecd1a4b053[838b917^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v1.1.0...v1.1.1++[1.1.1^] (2021-01-04) + +=== Bug Fixes + +* *memory:* pass variable not dict +(https://github.com/saltstack-formulas/apache-formula/commit/28300814fc0a83244ab64a4a87f104d67de4ac53[2830081^]) + +=== Continuous Integration + +* *commitlint:* ensure `upstream/master` uses main repo URL [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/0145922b52f21469c00c85bf46503411ffd11c56[0145922^]) +* *gitlab-ci:* add `rubocop` linter (with `allow_failure`) [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/bbf012b82eed50db3c35cb25a10d9ca36e40487b[bbf012b^]) +* *gitlab-ci:* use GitLab CI as Travis CI replacement +(https://github.com/saltstack-formulas/apache-formula/commit/26208c47c644608b00adfa8474616305e7a55e36[26208c4^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v1.0.5...v1.1.0++[1.1.0^] (2020-10-14) + +=== Bug Fixes + +* *ssl.conf:* fix pillar keys for SSLStapling in ssl.conf on debian +(https://github.com/saltstack-formulas/apache-formula/commit/65043f8a6142f7b9988cd406988b524aa9f0a1f2[65043f8^]) + +=== Code Refactoring + +* *ssl.conf:* reduce newlines in ssl.conf on debian +(https://github.com/saltstack-formulas/apache-formula/commit/b99b7b71add9fc1102d1b62eafada8358dfd5e68[b99b7b7^]) +* *vhosts:* reduce empty lines in standard.tmpl and proxy.tmpl +(https://github.com/saltstack-formulas/apache-formula/commit/4b79c1dddb1999452b618153792a8710bedbb76e[4b79c1d^]) + +=== Features + +* *ssl.conf:* add SSLSessionTickets to ssl.conf on debian +(https://github.com/saltstack-formulas/apache-formula/commit/41a7a83af0bf1bf4d4dde0f8ea522135dd721738[41a7a83^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v1.0.4...v1.0.5++[1.0.5^] (2020-10-14) + +=== Bug Fixes + +* *clean:* remove entire apache config directory +(https://github.com/saltstack-formulas/apache-formula/commit/cac5f357a47d1bdd40371aca97181b490430c158[cac5f35^]) + +=== Code Refactoring + +* *package:* remove unnecessary state +(https://github.com/saltstack-formulas/apache-formula/commit/fb81d8e69450702bcd3eaa6e5243fce02715c819[fb81d8e^]) + +=== Documentation + +* *readme:* add mod watchdog to pillar example +(https://github.com/saltstack-formulas/apache-formula/commit/e0043dd7bafcab1b87822d0c831b91e10936b291[e0043dd^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v1.0.3...v1.0.4++[1.0.4^] (2020-10-14) + +=== Bug Fixes + +* *debian:* don't execute a2enmod on every run +(https://github.com/saltstack-formulas/apache-formula/commit/5844322de46b82cad6beedd2b99c8808df8f2485[5844322^]) +* *debian:* fix default moddir on debian +(https://github.com/saltstack-formulas/apache-formula/commit/c17601ee42cc4aa0222ec60e8ec3176d902b32f1[c17601e^]) +* *logs:* don't change owners of logfiles with salt +(https://github.com/saltstack-formulas/apache-formula/commit/382e053c58c1b4e4f3ceb1af8fd75e2f56f6d153[382e053^]) +* *vhosts:* replace %O with %b in default LogFormat +(https://github.com/saltstack-formulas/apache-formula/commit/2b52e11a8a91b0837a442bac816e7383dbe6fb13[2b52e11^]) + +=== Tests + +* *pillar:* remove modules that aren't installed from being enabled +(https://github.com/saltstack-formulas/apache-formula/commit/47ec5fcc343ea889898e2418cd7c03a4a75c8f87[47ec5fc^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v1.0.2...v1.0.3++[1.0.3^] (2020-10-13) + +=== Bug Fixes + +* *config:* fix old apache.service usage +(https://github.com/saltstack-formulas/apache-formula/commit/32f05e5a66940ad86ce21831598c478b7099ed3a[32f05e5^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v1.0.1...v1.0.2++[1.0.2^] (2020-10-12) + +=== Bug Fixes + +* *package:* remove own_default_vhost and debian_full from config.init +(https://github.com/saltstack-formulas/apache-formula/commit/7691b589d7a1b0a87aaf9b13282e6ca154c5787c[7691b58^]) +* *package:* remove own_default_vhost and debian_full from config.init +(https://github.com/saltstack-formulas/apache-formula/commit/441459e56f3a8b091671839042efae2d7020380d[441459e^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v1.0.0...v1.0.1++[1.0.1^] (2020-10-10) + +=== Continuous Integration + +* *pre-commit:* finalise `rstcheck` configuration [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/1c2125c251016097e7d2c0694bf0245a3644605e[1c2125c^]) + +=== Documentation + +* *example:* document redirect 80->443 fix +https://github.com/saltstack-formulas/apache-formula/issues/226[#226^] +(https://github.com/saltstack-formulas/apache-formula/commit/e15803b4b12df2b6e625673409bc854b1d1dd751[e15803b^]) +* *readme:* fix `rstcheck` violation [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/2747e35ce1e49d46a1fd5f8613ce73517aaed095[2747e35^]), +closes +https://github.com//travis-ci.org/github/myii/apache-formula/builds/731605038/issues/L255[/travis-ci.org/github/myii/apache-formula/builds/731605038#L255^] + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v0.41.1...v1.0.0++[1.0.0^] (2020-10-05) + +=== Code Refactoring + +* *formula:* align to template-formula & improve ci features +(https://github.com/saltstack-formulas/apache-formula/commit/47818fc360fc87c94f51f2c2c7ff9317d4ecf875[47818fc^]) + +=== Continuous Integration + +* *pre-commit:* add to formula [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/5532ed7a5b1c9afb5ca4348d3984c5ff357bacad[5532ed7^]) +* *pre-commit:* enable/disable `rstcheck` as relevant [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/233111af11dd25b573928e746f19b06bcdbf19b9[233111a^]) + +=== BREAKING CHANGES + +* *formula:* 'apache.sls' converted to new style 'init.ssl' +* *formula:* "logrotate.sls" became "config/logrotate.sls" +* *formula:* "debian_full.sls" became "config/debian_full.sls" +* *formula:* "flags.sls" became "config/flags.sls" +* *formula:* "manage_security" became "config/manage_security.sls" +* *formula:* "mod*_.sls" became "config/mod_*.sls" +* *formula:* "no_default_host.sls" became "config/no_default_host.sls" +* *formula:* "own_default_host.sls" became "config/own_default_host.sls" +* *formula:* "register_site.sls" became "config/register_site.sls" +* *formula:* "server_status.sls" became "config/server_status.sls" +* *formula:* "vhosts/" became "config/vhosts/" +* *formula:* "mod_security/" became "config/mod_security/" + +NOT-BREAKING CHANGE: 'config.sls' became 'config/init.sls' NOT-BREAKING +CHANGE: 'uninstall.sls' symlinked to 'clean.sls' + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v0.41.0...v0.41.1++[0.41.1^] (2020-07-20) + +=== Bug Fixes + +* *server-status:* enable module in Debian family +(https://github.com/saltstack-formulas/apache-formula/commit/632802a5a946d2f05c40d9038d6f2ad596fafc58[632802a^]) +* *server-status:* manage module in debian +(https://github.com/saltstack-formulas/apache-formula/commit/eafa4196d9495bc975c7e1e7036969bdaba1441d[eafa419^]) + +=== Tests + +* *default+modules:* add modules' tests suite +(https://github.com/saltstack-formulas/apache-formula/commit/b25362535ae01dd140218b131a8e991d3a10cbe5[b253625^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v0.40.0...v0.41.0++[0.41.0^] (2020-07-16) + +=== Features + +* *vhosts/standard:* add support for ScriptAlias in standard vhost +(https://github.com/saltstack-formulas/apache-formula/commit/b88b437308ff5d6bc504dabf9b69153db89f5b10[b88b437^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v0.39.5...v0.40.0++[0.40.0^] (2020-07-16) + +=== Features + +* *redhat/apache-2.x.config.jinja:* allow override of default_charset +(https://github.com/saltstack-formulas/apache-formula/commit/648f589cc30684550c972d9cc4087e9e8b3fdc80[648f589^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v0.39.4...v0.39.5++[0.39.5^] (2020-06-21) + +=== Bug Fixes + +* *vhosts/cleanup:* check `sites-enabled` dir exists before listing it +(https://github.com/saltstack-formulas/apache-formula/commit/88373e38f55eab61cf1c4edc68324f3da48f7646[88373e3^]), +closes +https://github.com/saltstack-formulas/apache-formula/issues/278[#278^] + +=== Continuous Integration + +* *gemfile.lock:* add to repo with updated `Gemfile` [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/61b903e7803eb80b50130834b90ca86d26b9d6c8[61b903e^]) +* *kitchen:* use `saltimages` Docker Hub where available [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/6895fb9764e9cebcbbff05763e367401d6cad959[6895fb9^]) +* *kitchen+travis:* remove `master-py2-arch-base-latest` [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/16bb1b06e351efdf9994676de38dec7b0ecd639d[16bb1b0^]) +* *travis:* add notifications => zulip [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/2417a75fe218bd04c719f8eb2e2a7e402a20928e[2417a75^]) +* *workflows/commitlint:* add to repo [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/2ce966d031e9044e8794dc93f605ce780fd99f12[2ce966d^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v0.39.3...v0.39.4++[0.39.4^] (2020-04-02) + +=== Bug Fixes + +* *mod_ssl:* update mod_ssl package variable to prevent clashes +(https://github.com/saltstack-formulas/apache-formula/commit/5591be26fddd234ebaed0e024969c45b6536ba82[5591be2^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v0.39.2...v0.39.3++[0.39.3^] (2020-04-02) + +=== Bug Fixes + +* *debian:* generate remoteip conf before a2enconf +(https://github.com/saltstack-formulas/apache-formula/commit/1ed69f6c6fab0eb583949105e9e29e58b6ba32a3[1ed69f6^]) + +=== Continuous Integration + +* *kitchen:* avoid using bootstrap for `master` instances [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/275b5d5e69fa79f1010852d65f0fcb65cadf735d[275b5d5^]) +* *travis:* use `major.minor` for `semantic-release` version [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/08cced29134ca47824e82ee6afa794233cdb5faa[08cced2^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v0.39.1...v0.39.2++[0.39.2^] (2019-12-20) + +=== Bug Fixes + +* *redhat:* add user & group lookup to configs +(https://github.com/saltstack-formulas/apache-formula/commit/36ad2b24424936a4badeb7b4b2b26ee0d39e55f2[36ad2b2^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v0.39.0...v0.39.1++[0.39.1^] (2019-12-20) + +=== Bug Fixes + +* *mod_mpm:* cast to int to avoid Jinja type mismatch error +(https://github.com/saltstack-formulas/apache-formula/commit/21045c7a7b46d639c2d81c5793ad6e6d9d34b66b[21045c7^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v0.38.2...v0.39.0++[0.39.0^] (2019-12-20) + +=== Continuous Integration + +* *gemfile:* restrict `train` gem version until upstream fix [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/13be6f9fac5aae55c48f74c784335c61d7fbaaf2[13be6f9^]) +* *travis:* apply changes from build config validation [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/0aac479c253f95b7fdcb1505476638c2d703bc77[0aac479^]) +* *travis:* opt-in to `dpl v2` to complete build config validation +(https://github.com/saltstack-formulas/apache-formula/commit/19e90ea2d6ef91118ebf59817ef4c91ad876af54[19e90ea^]) +* *travis:* quote pathspecs used with `git ls-files` [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/6608ddf8c5a361b93e6a44658ab1e306953566bf[6608ddf^]) +* *travis:* run `shellcheck` during lint job [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/2ff6b2f17e1fd48b5f0a4156c2dbd90f07f27025[2ff6b2f^]) +* *travis:* use build config validation (beta) [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/73160b249124df6bbd36b113df71724c019a118f[73160b2^]) + +=== Features + +* *server-status:* allow remote servers to reach server-status page +(https://github.com/saltstack-formulas/apache-formula/commit/a3c0022d7988eee0ec43d939bced91dee9fec0e1[a3c0022^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v0.38.1...v0.38.2++[0.38.2^] (2019-11-07) + +=== Bug Fixes + +* *apache/modules.sls:* fix duplicated ID +(https://github.com/saltstack-formulas/apache-formula/commit/57afd71627eb554138c8d5ec9cc790d899ed80ff[57afd71^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v0.38.0...v0.38.1++[0.38.1^] (2019-11-05) + +=== Bug Fixes + +* *mod_perl2.sls:* fix a2enmod perl2 error +(https://github.com/saltstack-formulas/apache-formula/commit/fba8d217944c8b5a0abf19cdbae7d41d1ec5bf2e[fba8d21^]) +* *release.config.js:* use full commit hash in commit link [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/dc5593cfdf775e065ea5f680f2ed2b6b7c80d8ed[dc5593c^]) + +=== Continuous Integration + +* *kitchen:* use `debian-10-master-py3` instead of `develop` [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/09d82a581caa09298d3d99ded215c5e45c5b619f[09d82a5^]) +* *kitchen:* use `develop` image until `master` is ready (`amazonlinux`) + [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/d0bf6f37969a9a97a6e368278e0f9eb40431f2f1[d0bf6f3^]) +* *kitchen+travis:* upgrade matrix after `2019.2.2` release [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/fc0f869b78ef56369e1cfb6ff3d62179f703efa0[fc0f869^]) +* *travis:* update `salt-lint` config for `v0.0.10` [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/2622d48b4ccb01cd70555d46759d79d82d1db7bf[2622d48^]) + +=== Performance Improvements + +* *travis:* improve `salt-lint` invocation [skip ci] +(https://github.com/saltstack-formulas/apache-formula/commit/bf7577022040a155de8b3ab4f557dd05484d278c[bf75770^]) + +== link:++https://github.com/saltstack-formulas/apache-formula/compare/v0.37.4...v0.38.0++[0.38.0^] (2019-10-20) + +=== Bug Fixes + +* *apache-2.2.config.jinja:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/f4045ef[f4045ef^]) +* *apache-2.4.config.jinja:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/e2c1c2e[e2c1c2e^]) +* *flags.sls:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/a146c59[a146c59^]) +* *init.sls:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/8465eb4[8465eb4^]) +* *map.jinja:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/d011324[d011324^]) +* *mod_geoip.sls:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/e55ef9b[e55ef9b^]) +* *modsecurity.conf.jinja:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/2a79d05[2a79d05^]) +* *modules.sls:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/55d11f8[55d11f8^]) +* *server_status.sls:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/da9a592[da9a592^]) +* *uninstall.sls:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/ed7dc7b[ed7dc7b^]) +* *vhosts/cleanup.sls:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/b0bbd0b[b0bbd0b^]) +* *vhosts/minimal.tmpl:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/146dc67[146dc67^]) +* *vhosts/proxy.tmpl:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/e7c9fbb[e7c9fbb^]) +* *vhosts/redirect.tmpl:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/0a41b19[0a41b19^]) +* *vhosts/standard.tmpl:* fix `salt-lint` errors +(https://github.com/saltstack-formulas/apache-formula/commit/1bad58d[1bad58d^]) +* *yamllint:* fix all errors +(https://github.com/saltstack-formulas/apache-formula/commit/97f6ead[97f6ead^]) + +=== Documentation + +* *formula:* use standard structure +(https://github.com/saltstack-formulas/apache-formula/commit/701929d[701929d^]) +* *readme:* move to `docs/` directory and modify accordingly +(https://github.com/saltstack-formulas/apache-formula/commit/6933f0e[6933f0e^]) + +=== Features + +* *semantic-release:* implement for this formula +(https://github.com/saltstack-formulas/apache-formula/commit/34d1f7c[34d1f7c^]) + +=== Tests + +* *mod_security_spec:* convert from Serverspec to InSpec +(https://github.com/saltstack-formulas/apache-formula/commit/68b971b[68b971b^]) diff --git a/docs/modules/ROOT/pages/README.adoc b/docs/modules/ROOT/pages/README.adoc new file mode 100644 index 0000000..f952fb6 --- /dev/null +++ b/docs/modules/ROOT/pages/README.adoc @@ -0,0 +1,366 @@ += apache + +https://travis-ci.com/saltstack-formulas/apache-formula[image:https://travis-ci.com/saltstack-formulas/apache-formula.svg?branch=master[Travis CI Build Status]] +https://github.com/semantic-release/semantic-release[image:https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg[Semantic Release]] + +Formulas to set up and configure the Apache HTTP server on GNU/Linux, +FreeBSD, and Windows OS. + +== General notes + +See the full +https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html[SaltStack +Formulas installation and usage instructions]. + +If you are interested in writing or contributing to formulas, please pay +attention to the +https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas[Writing +Formula Section]. + +If you want to use this formula, please pay attention to the `FORMULA` +file and/or `git tag`, which contains the currently released version. +This formula is versioned according to http://semver.org/[Semantic +Versioning]. + +See +https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning[Formula +Versioning Section] for more details. + +== Contributing to this repo + +*Commit message formatting is significant!!* + +Please see +xref:main::CONTRIBUTING.adoc[How +to contribute] for more details. + +== Available states + +=== `apache` + +Installs the Apache package and starts the service. + +=== `apache.config` + +Metastate to apply all apache configuration + +=== `apache.config.file` + +Configures apache based on os_family + +=== `apache.config.flags` + +Configures apache flags on SuSE + +=== `apache.config.certificates` + +Deploy SSL certificates from pillars + +=== `apache.config.modules` + +Metastate to Enable and disable Apache modules. + +=== `apache.config.modules.mod_mpm` + +Configures the apache mpm modules on Debian `mpm_prefork`, `mpm_worker` +or `mpm_event` (Debian Only) + +=== `apache.config.modules.mod_rewrite` + +Enabled the Apache module mod_rewrite (Debian and FreeBSD only) + +=== `apache.config.modules.mod_proxy` + +Enables the Apache module mod_proxy. (Debian and FreeBSD only) + +=== `apache.config.modules.mod_proxy_http` + +Enables the Apache module mod_proxy_http and requires the Apache module +mod_proxy to be enabled. (Debian Only) + +=== `apache.config.modules.mod_proxy_fcgi` + +Enables the Apache module mod_proxy_fcgi and requires the Apache module +mod_proxy to be enabled. (Debian Only) + +=== `apache.config.modules.mod_wsgi` + +Installs the mod_wsgi package and enables the Apache module. + +=== `apache.config.modules.mod_actions` + +Enables the Apache module mod_actions. (Debian Only) + +=== `apache.config.modules.mod_headers` + +Enables the Apache module mod_headers. (Debian Only) + +=== `apache.config.modules.mod_pagespeed` + +Installs and Enables the mod_pagespeed module. (Debian and RedHat Only) + +=== `apache.config.modules.mod_perl2` + +Installs and enables the mod_perl2 module (Debian and FreeBSD only) + +=== `apache.config.modules.mod_geoip` + +Installs and enables the mod_geoIP (RedHat only) + +=== `apache.config.modules.mod_php5` + +Installs and enables the mod_php5 module + +=== `apache.config.modules.mod_cgi` + +Enables mod_cgi. (FreeBSD only) + +=== `apache.config.modules.mod_fcgid` + +Installs and enables the mod_fcgid module (Debian only) + +=== `apache.config.modules.mod_fastcgi` + +Installs and enables the mod_fastcgi module + +=== `apache.config.modules.mod_dav_svn` + +Installs and enables the mod_dav_svn module (Debian only) + +=== `apache.config.modules.mod_security` + +Installs an enables the http://modsecurity.org/[Apache mod_security2 +WAF] using data from Pillar. (Debian and RedHat Only) + +Allows you to install the basic Core Rules (CRS) and some basic +configuration for mod_security2 + +=== `apache.config.modules.mod_security.rules` + +This state can create symlinks based on basic Core Rules package. +(Debian only) Or it can distribute a mod_security rule file and place it +/etc/modsecurity/ + +=== `apache.config.modules.mod_socache_shmcb` + +Enables mod_socache_shmcb. (FreeBSD only) + +=== `apache.config.modules.mod_ssl` + +Installs and enables the mod_ssl module (Debian, RedHat and FreeBSD +only) + +=== `apache.config.modules.mod_suexec` + +Enables mod_suexec. (FreeBSD only) + +=== `apache.config.modules.mod_vhost_alias` + +Enables the Apache module vhost_alias (Debian Only) + +=== `apache.config.modules.mod_remoteip` + +Enables and configures the Apache module mod_remoteip using data from +Pillar. (Debian Only) + +=== `apache.config.modules.mod_xsendfile` + +Installs and enables mod_xsendfile module. (Debian Only) + +=== `apache.config.own_default_vhost` + +Replace default vhost with own version. By default, it's 503 code. +(Debian Only) + +=== `apache.config.no_default_vhost` + +Remove the default vhost. (Debian Only) + +=== `apache.config.vhosts.standard` + +Configures Apache name-based virtual hosts and creates virtual host +directories using data from Pillar. + +Example Pillar: + +[source,yaml] +---- +apache: + sites: + 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 +---- + +When using the provided templates, one can use a space separated list of +interfaces to bind to. For example, to bind both IPv4 and IPv6: + +[source,yaml] +---- +apache: + sites: + example.com: + interface: '1.2.3.4 [2001:abc:def:100::3]' +---- + +=== `apache.config.manage_security` + +Configures Apache's security.conf options by reassinging them using data +from Pillar. + +=== `apache.config.modules.mod_status` + +Configures Apache's server_status handler for localhost + +=== `apache.config.debian_full` + +Installs and configures Apache on Debian and Ubuntu systems. + +=== `apache.config.clean` + +Metastate to cleanup all apache configuration. + +=== `apache.clean` + +Stops the Apache service and uninstalls the package. + +These states are ordered using the `order` declaration. Different stages +are divided into the following number ranges: + +[arabic] +. apache will use 1-500 for ordering +. apache will reserve 1 -100 as unused +. apache will reserve 101-150 for pre pkg install +. apache will reserve 151-200 for pkg install +. apache will reserve 201-250 for pkg configure +. apache will reserve 251-300 for downloads, git stuff, load data +. apache will reserve 301-400 for unknown purposes +. apache will reserve 401-450 for service restart-reloads +. apache WILL reserve 451-460 for service.running +. apache will reserve 461-500 for cmd requiring operational services + +Example Pillar: + +[source,yaml] +---- +apache: + register-site: + # any name as an array index, and you can duplicate this section + {{UNIQUE}}: + name: 'my name' + path: 'salt://path/to/sites-available/conf/file' + state: 'enabled' + + sites: + # Force SSL: Redirect from 80 to 443 + example.com: + port: 80 + template_file: salt://apache/vhosts/redirect.tmpl + RedirectSource: 'permanent /' + # Trailing slash is important + RedirectTarget: 'https://example.com/' + example.com_ssl: + port: 443 + ServerName: example.com + SSLCertificateFile: /path/to/ssl.crt + SSLCertificateKeyFile: /path/to/ssl.key + SSLCertificateChainFile: /path/to/ssl.ca.crt +---- + +== Testing + +Linux testing is done with `kitchen-salt`. + +=== Requirements + +* Ruby +* Docker + +[source,bash] +---- +$ gem install bundler +$ bundle install +$ bin/kitchen test [platform] +---- + +Where `[platform]` is the platform name defined in `kitchen.yml`, e.g. +`debian-9-2019-2-py3`. + +=== `bin/kitchen converge` + +Creates the docker instance and runs the `apache` main states, ready for +testing. + +=== `bin/kitchen verify` + +Runs the `inspec` tests on the actual instance. + +=== `bin/kitchen destroy` + +Removes the docker instance. + +=== `bin/kitchen test` + +Runs all of the stages above in one go: i.e. `destroy` + `converge` + +`verify` + `destroy`. + +=== `bin/kitchen login` + +Gives you SSH access to the instance for manual testing. + +== Testing with Vagrant + +Windows/FreeBSD/OpenBSD testing is done with `kitchen-salt`. + +=== Requirements + +* Ruby +* Virtualbox +* Vagrant + +=== Setup + +[source,bash] +---- +$ gem install bundler +$ bundle install --with=vagrant +$ bin/kitchen test [platform] +---- + +Where `[platform]` is the platform name defined in +`kitchen.vagrant.yml`, e.g. `windows-81-latest-py3`. + +=== Note + +When testing using Vagrant you must set the environment variable +`KITCHEN_LOCAL_YAML` to `kitchen.vagrant.yml`. For example: + +[source,bash] +---- +$ KITCHEN_LOCAL_YAML=kitchen.vagrant.yml bin/kitchen test # Alternatively, +$ export KITCHEN_LOCAL_YAML=kitchen.vagrant.yml +$ bin/kitchen test +---- + +Then run the following commands as needed. + +=== `bin/kitchen converge` + +Creates the Vagrant instance and runs the `apache` main states, ready +for testing. + +=== `bin/kitchen verify` + +Runs the `inspec` tests on the actual instance. + +=== `bin/kitchen destroy` + +Removes the Vagrant instance. + +=== `bin/kitchen test` + +Runs all of the stages above in one go: i.e. `destroy` + `converge` + +`verify` + `destroy`. + +=== `bin/kitchen login` + +Gives you RDP/SSH access to the instance for manual testing. diff --git a/docs/modules/ROOT/partials/.keep b/docs/modules/ROOT/partials/.keep new file mode 100644 index 0000000..e69de29