diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/.geppetto-rc.json b/modules/services/unix/http/apache_stretch_compatible/apache/.geppetto-rc.json new file mode 100644 index 000000000..7df232989 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/.geppetto-rc.json @@ -0,0 +1,9 @@ +{ + "excludes": [ + "**/contrib/**", + "**/examples/**", + "**/tests/**", + "**/spec/**", + "**/pkg/**" + ] +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/auto_release.yml b/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/auto_release.yml new file mode 100644 index 000000000..e02848360 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/auto_release.yml @@ -0,0 +1,84 @@ +name: "Auto release" + +on: + workflow_dispatch: + +env: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 + HONEYCOMB_DATASET: litmus tests + CHANGELOG_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + +jobs: + auto_release: + name: "Automatic release prep" + runs-on: ubuntu-20.04 + + steps: + - name: "Honeycomb: Start recording" + uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 + with: + apikey: ${{ env.HONEYCOMB_WRITEKEY }} + dataset: ${{ env.HONEYCOMB_DATASET }} + job-status: ${{ job.status }} + + - name: "Honeycomb: start first step" + run: | + echo STEP_ID="auto-release" >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: "Checkout Source" + if: ${{ github.repository_owner == 'puppetlabs' }} + uses: actions/checkout@v2 + with: + fetch-depth: 0 + persist-credentials: false + + - name: "PDK Release prep" + uses: docker://puppet/iac_release:ci + with: + args: 'release prep --force' + env: + CHANGELOG_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - name: "Get Version" + if: ${{ github.repository_owner == 'puppetlabs' }} + id: gv + run: | + echo "::set-output name=ver::$(jq --raw-output .version metadata.json)" + + - name: "Commit changes" + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + git config --local user.email "${{ github.repository_owner }}@users.noreply.github.com" + git config --local user.name "GitHub Action" + git add . + git commit -m "Release prep v${{ steps.gv.outputs.ver }}" + + - name: Create Pull Request + id: cpr + uses: puppetlabs/peter-evans-create-pull-request@v3 + if: ${{ github.repository_owner == 'puppetlabs' }} + with: + token: ${{ secrets.GITHUB_TOKEN }} + commit-message: "Release prep v${{ steps.gv.outputs.ver }}" + branch: "release-prep" + delete-branch: true + title: "Release prep v${{ steps.gv.outputs.ver }}" + body: | + Automated release-prep through [pdk-templates](https://github.com/puppetlabs/pdk-templates/blob/main/moduleroot/.github/workflows/auto_release.yml.erb) from commit ${{ github.sha }}. + Please verify before merging: + - [ ] last [nightly](https://github.com/${{ github.repository }}/actions/workflows/nightly.yml) run is green + - [ ] [Changelog](https://github.com/${{ github.repository }}/blob/release-prep/CHANGELOG.md) is readable and has no unlabeled pull requests + - [ ] Ensure the [changelog](https://github.com/${{ github.repository }}/blob/release-prep/CHANGELOG.md) version and [metadata](https://github.com/${{ github.repository }}/blob/release-prep/metadata.json) version match + labels: "maintenance" + + - name: PR outputs + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}" + echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}" + + - name: "Honeycomb: Record finish step" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Finished auto release workflow' diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/nightly.yml b/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/nightly.yml new file mode 100644 index 000000000..865578cfd --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/nightly.yml @@ -0,0 +1,204 @@ +name: "nightly" + +on: + schedule: + - cron: '0 0 * * *' + +env: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 + HONEYCOMB_DATASET: litmus tests + +jobs: + setup_matrix: + name: "Setup Test Matrix" + runs-on: ubuntu-20.04 + outputs: + matrix: ${{ steps.get-matrix.outputs.matrix }} + + steps: + - name: "Honeycomb: Start recording" + uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 + with: + apikey: ${{ env.HONEYCOMB_WRITEKEY }} + dataset: ${{ env.HONEYCOMB_DATASET }} + job-status: ${{ job.status }} + + - name: "Honeycomb: Start first step" + run: | + echo STEP_ID=setup-environment >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Checkout Source + uses: actions/checkout@v2 + if: ${{ github.repository_owner == 'puppetlabs' }} + + - name: Activate Ruby 2.7 + uses: ruby/setup-ruby@v1 + if: ${{ github.repository_owner == 'puppetlabs' }} + with: + ruby-version: "2.7" + bundler-cache: true + + - name: Print bundle environment + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + echo ::group::bundler environment + buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env + echo ::endgroup:: + + - name: "Honeycomb: Record Setup Environment time" + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' + echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Setup Acceptance Test Matrix + id: get-matrix + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then + buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2 + else + echo "::set-output name=matrix::{}" + fi + + - name: "Honeycomb: Record Setup Test Matrix time" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' + + Acceptance: + name: "${{matrix.platforms.label}}, ${{matrix.collection}}" + needs: + - setup_matrix + + runs-on: ubuntu-20.04 + strategy: + fail-fast: false + matrix: ${{fromJson(needs.setup_matrix.outputs.matrix)}} + + env: + BUILDEVENT_FILE: '../buildevents.txt' + + steps: + - run: | + echo 'platform=${{ matrix.platforms.image }}' >> $BUILDEVENT_FILE + echo 'collection=${{ matrix.collection }}' >> $BUILDEVENT_FILE + echo 'label=${{ matrix.platforms.label }}' >> $BUILDEVENT_FILE + + + - name: "Honeycomb: Start recording" + uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 + with: + apikey: ${{ env.HONEYCOMB_WRITEKEY }} + dataset: ${{ env.HONEYCOMB_DATASET }} + job-status: ${{ job.status }} + matrix-key: ${{ matrix.platforms.label }}-${{ matrix.collection }} + + - name: "Honeycomb: start first step" + run: | + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-1 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Checkout Source + uses: actions/checkout@v2 + + - name: Activate Ruby 2.7 + uses: ruby/setup-ruby@v1 + with: + ruby-version: "2.7" + bundler-cache: true + + - name: Print bundle environment + run: | + echo ::group::bundler environment + buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env + echo ::endgroup:: + + - name: "Honeycomb: Record Setup Environment time" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-2 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Provision test environment + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:provision ${{ matrix.platforms.image }}' -- bundle exec rake 'litmus:provision[${{matrix.platforms.provider}},${{ matrix.platforms.image }}]' + echo ::group::=== REQUEST === + cat request.json || true + echo + echo ::endgroup:: + echo ::group::=== INVENTORY === + if [ -f 'spec/fixtures/litmus_inventory.yaml' ]; + then + FILE='spec/fixtures/litmus_inventory.yaml' + elif [ -f 'inventory.yaml' ]; + then + FILE='inventory.yaml' + fi + sed -e 's/password: .*/password: "[redacted]"/' < $FILE || true + echo ::endgroup:: + + - name: Install agent + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_agent ${{ matrix.collection }}' -- bundle exec rake 'litmus:install_agent[${{ matrix.collection }}]' + + - name: Install module + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_module' -- bundle exec rake 'litmus:install_module' + + - name: "Honeycomb: Record deployment times" + if: ${{ always() }} + run: | + echo ::group::honeycomb step + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Deploy test system' + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-3 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + echo ::endgroup:: + + - name: Run acceptance tests + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:acceptance:parallel' -- bundle exec rake 'litmus:acceptance:parallel' + + - name: "Honeycomb: Record acceptance testing times" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Run acceptance tests' + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-4 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Remove test environment + if: ${{ always() }} + continue-on-error: true + run: | + if [[ -f inventory.yaml || -f spec/fixtures/litmus_inventory.yaml ]]; then + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:tear_down' -- bundle exec rake 'litmus:tear_down' + echo ::group::=== REQUEST === + cat request.json || true + echo + echo ::endgroup:: + fi + + - name: "Honeycomb: Record removal times" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Remove test environment' + + slack-workflow-status: + if: always() + name: Post Workflow Status To Slack + needs: + - Acceptance + runs-on: ubuntu-20.04 + steps: + - name: Slack Workflow Notification + uses: puppetlabs/Gamesight-slack-workflow-status@pdk-templates-v1 + with: + # Required Input + repo_token: ${{ secrets.GITHUB_TOKEN }} + slack_webhook_url: ${{ secrets.SLACK_WEBHOOK }} + # Optional Input + channel: '#team-ia-bots' + name: 'GABot' diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/pr_test.yml b/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/pr_test.yml new file mode 100644 index 000000000..69e414b55 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/pr_test.yml @@ -0,0 +1,184 @@ +name: "PR Testing" + +on: [pull_request] + +env: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 + HONEYCOMB_DATASET: litmus tests + +jobs: + setup_matrix: + name: "Setup Test Matrix" + runs-on: ubuntu-20.04 + outputs: + matrix: ${{ steps.get-matrix.outputs.matrix }} + + steps: + - name: "Honeycomb: Start recording" + uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 + with: + apikey: ${{ env.HONEYCOMB_WRITEKEY }} + dataset: ${{ env.HONEYCOMB_DATASET }} + job-status: ${{ job.status }} + + - name: "Honeycomb: Start first step" + run: | + echo STEP_ID=setup-environment >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Checkout Source + uses: actions/checkout@v2 + if: ${{ github.repository_owner == 'puppetlabs' }} + + - name: Activate Ruby 2.7 + uses: ruby/setup-ruby@v1 + if: ${{ github.repository_owner == 'puppetlabs' }} + with: + ruby-version: "2.7" + bundler-cache: true + + - name: Print bundle environment + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + echo ::group::bundler environment + buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env + echo ::endgroup:: + + - name: "Honeycomb: Record Setup Environment time" + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' + echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Setup Acceptance Test Matrix + id: get-matrix + run: | + if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then + buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2 + else + echo "::set-output name=matrix::{}" + fi + + - name: "Honeycomb: Record Setup Test Matrix time" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' + + Acceptance: + name: "${{matrix.platforms.label}}, ${{matrix.collection}}" + needs: + - setup_matrix + if: ${{ needs.setup_matrix.outputs.matrix != '{}' }} + + runs-on: ubuntu-20.04 + strategy: + fail-fast: false + matrix: ${{fromJson(needs.setup_matrix.outputs.matrix)}} + + env: + BUILDEVENT_FILE: '../buildevents.txt' + + steps: + - run: | + echo 'platform=${{ matrix.platforms.image }}' >> $BUILDEVENT_FILE + echo 'collection=${{ matrix.collection }}' >> $BUILDEVENT_FILE + echo 'label=${{ matrix.platforms.label }}' >> $BUILDEVENT_FILE + + - name: "Honeycomb: Start recording" + uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 + with: + apikey: ${{ env.HONEYCOMB_WRITEKEY }} + dataset: ${{ env.HONEYCOMB_DATASET }} + job-status: ${{ job.status }} + matrix-key: ${{ matrix.platforms.label }}-${{ matrix.collection }} + + - name: "Honeycomb: start first step" + run: | + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-1 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Checkout Source + uses: actions/checkout@v2 + + - name: Activate Ruby 2.7 + uses: ruby/setup-ruby@v1 + with: + ruby-version: "2.7" + bundler-cache: true + + - name: Print bundle environment + run: | + echo ::group::bundler environment + buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env + echo ::endgroup:: + + - name: "Honeycomb: Record Setup Environment time" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-2 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Provision test environment + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:provision ${{ matrix.platforms.image }}' -- bundle exec rake 'litmus:provision[${{matrix.platforms.provider}},${{ matrix.platforms.image }}]' + echo ::group::=== REQUEST === + cat request.json || true + echo + echo ::endgroup:: + echo ::group::=== INVENTORY === + if [ -f 'spec/fixtures/litmus_inventory.yaml' ]; + then + FILE='spec/fixtures/litmus_inventory.yaml' + elif [ -f 'inventory.yaml' ]; + then + FILE='inventory.yaml' + fi + sed -e 's/password: .*/password: "[redacted]"/' < $FILE || true + echo ::endgroup:: + + - name: Install agent + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_agent ${{ matrix.collection }}' -- bundle exec rake 'litmus:install_agent[${{ matrix.collection }}]' + + - name: Install module + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:install_module' -- bundle exec rake 'litmus:install_module' + + - name: "Honeycomb: Record deployment times" + if: ${{ always() }} + run: | + echo ::group::honeycomb step + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Deploy test system' + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-3 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + echo ::endgroup:: + + - name: Run acceptance tests + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:acceptance:parallel' -- bundle exec rake 'litmus:acceptance:parallel' + + - name: "Honeycomb: Record acceptance testing times" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Run acceptance tests' + echo STEP_ID=${{ matrix.platforms.image }}-${{ matrix.collection }}-4 >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Remove test environment + if: ${{ always() }} + continue-on-error: true + run: | + if [[ -f inventory.yaml || -f spec/fixtures/litmus_inventory.yaml ]]; then + buildevents cmd $TRACE_ID $STEP_ID 'rake litmus:tear_down' -- bundle exec rake 'litmus:tear_down' + echo ::group::=== REQUEST === + cat request.json || true + echo + echo ::endgroup:: + fi + + - name: "Honeycomb: Record removal times" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Remove test environment' diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/release.yml b/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/release.yml new file mode 100644 index 000000000..1509f6e91 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/release.yml @@ -0,0 +1,47 @@ +name: "Publish module" + +on: + workflow_dispatch: + +jobs: + create-github-release: + name: Deploy GitHub Release + runs-on: ubuntu-20.04 + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + ref: ${{ github.ref }} + clean: true + fetch-depth: 0 + - name: Get Version + id: gv + run: | + echo "::set-output name=ver::$(jq --raw-output .version metadata.json)" + - name: Create Release + uses: actions/create-release@v1 + id: create_release + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tag_name: "v${{ steps.gv.outputs.ver }}" + draft: false + prerelease: false + + deploy-forge: + name: Deploy to Forge + runs-on: ubuntu-20.04 + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + ref: ${{ github.ref }} + clean: true + - name: "PDK Build" + uses: docker://puppet/pdk:nightly + with: + args: 'build' + - name: "Push to Forge" + uses: docker://puppet/pdk:nightly + with: + args: 'release publish --forge-token ${{ secrets.FORGE_API_KEY }} --force' diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/spec.yml b/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/spec.yml new file mode 100644 index 000000000..209dd3f4a --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/.github/workflows/spec.yml @@ -0,0 +1,124 @@ +name: "Spec Tests" + +on: + schedule: + - cron: '0 0 * * *' + workflow_dispatch: + pull_request: + +env: + HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 + HONEYCOMB_DATASET: litmus tests + +jobs: + setup_matrix: + name: "Setup Test Matrix" + runs-on: ubuntu-20.04 + outputs: + spec_matrix: ${{ steps.get-matrix.outputs.spec_matrix }} + + steps: + - name: "Honeycomb: Start recording" + uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 + with: + apikey: ${{ env.HONEYCOMB_WRITEKEY }} + dataset: ${{ env.HONEYCOMB_DATASET }} + job-status: ${{ job.status }} + + - name: "Honeycomb: Start first step" + run: | + echo STEP_ID=setup-environment >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Checkout Source + uses: actions/checkout@v2 + if: ${{ github.repository_owner == 'puppetlabs' }} + + - name: Activate Ruby 2.7 + uses: ruby/setup-ruby@v1 + if: ${{ github.repository_owner == 'puppetlabs' }} + with: + ruby-version: "2.7" + bundler-cache: true + + - name: Print bundle environment + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + echo ::group::bundler environment + buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env + echo ::endgroup:: + + - name: "Honeycomb: Record Setup Environment time" + if: ${{ github.repository_owner == 'puppetlabs' }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Environment' + echo STEP_ID=Setup-Acceptance-Test-Matrix >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: Setup Acceptance Test Matrix + id: get-matrix + run: | + if [ '${{ github.repository_owner }}' == 'puppetlabs' ]; then + buildevents cmd $TRACE_ID $STEP_ID matrix_from_metadata -- bundle exec matrix_from_metadata_v2 + else + echo "::set-output name=spec_matrix::{}" + fi + + - name: "Honeycomb: Record Setup Test Matrix time" + if: ${{ always() }} + run: | + buildevents step $TRACE_ID $STEP_ID $STEP_START 'Setup Test Matrix' + + Spec: + name: "Spec Tests (Puppet: ${{matrix.puppet_version}}, Ruby Ver: ${{matrix.ruby_version}})" + needs: + - setup_matrix + if: ${{ needs.setup_matrix.outputs.spec_matrix != '{}' }} + + runs-on: ubuntu-20.04 + strategy: + fail-fast: false + matrix: ${{fromJson(needs.setup_matrix.outputs.spec_matrix)}} + + env: + BUILDEVENT_FILE: '../buildevents.txt' + PUPPET_GEM_VERSION: ${{ matrix.puppet_version }} + + steps: + - run: | + echo "SANITIZED_PUPPET_VERSION=$(echo '${{ matrix.puppet_version }}' | sed 's/~> //g')" >> $GITHUB_ENV + + - run: | + echo 'puppet_version=${{ env.SANITIZED_PUPPET_VERSION }}' >> $BUILDEVENT_FILE + + - name: "Honeycomb: Start first step" + run: | + echo "STEP_ID=${{ env.SANITIZED_PUPPET_VERSION }}-spec" >> $GITHUB_ENV + echo STEP_START=$(date +%s) >> $GITHUB_ENV + + - name: "Honeycomb: Start recording" + uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 + with: + apikey: ${{ env.HONEYCOMB_WRITEKEY }} + dataset: ${{ env.HONEYCOMB_DATASET }} + job-status: ${{ job.status }} + matrix-key: ${{ env.SANITIZED_PUPPET_VERSION }} + + - name: Checkout Source + uses: actions/checkout@v2 + + - name: "Activate Ruby ${{ matrix.ruby_version }}" + uses: ruby/setup-ruby@v1 + with: + ruby-version: ${{matrix.ruby_version}} + bundler-cache: true + + - name: Print bundle environment + run: | + echo ::group::bundler environment + buildevents cmd $TRACE_ID $STEP_ID 'bundle env' -- bundle env + echo ::endgroup:: + + - name: Run parallel_spec tests + run: | + buildevents cmd $TRACE_ID $STEP_ID 'rake parallel_spec Puppet ${{ matrix.puppet_version }}, Ruby ${{ matrix.ruby_version }}' -- bundle exec rake parallel_spec diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/.github_changelog_generator b/modules/services/unix/http/apache_stretch_compatible/apache/.github_changelog_generator new file mode 100644 index 000000000..e69de29bb diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/.gitpod.Dockerfile b/modules/services/unix/http/apache_stretch_compatible/apache/.gitpod.Dockerfile new file mode 100644 index 000000000..0814c5e61 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/.gitpod.Dockerfile @@ -0,0 +1,18 @@ +FROM gitpod/workspace-full +RUN sudo wget https://apt.puppet.com/puppet-tools-release-bionic.deb && \ + wget https://apt.puppetlabs.com/puppet6-release-bionic.deb && \ + sudo dpkg -i puppet6-release-bionic.deb && \ + sudo dpkg -i puppet-tools-release-bionic.deb && \ + sudo apt-get update && \ + sudo apt-get install -y pdk zsh puppet-agent && \ + sudo apt-get clean && \ + sudo rm -rf /var/lib/apt/lists/* +RUN sudo usermod -s $(which zsh) gitpod && \ + sh -c "$(curl -fsSL https://raw.github.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" && \ + echo "plugins=(git gitignore github gem pip bundler python ruby docker docker-compose)" >> /home/gitpod/.zshrc && \ + echo 'PATH="$PATH:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/opt/puppetlabs/bin:/opt/puppetlabs/puppet/bin"' >> /home/gitpod/.zshrc && \ + sudo /opt/puppetlabs/puppet/bin/gem install puppet-debugger hub -N && \ + mkdir -p /home/gitpod/.config/puppet && \ + /opt/puppetlabs/puppet/bin/ruby -r yaml -e "puts ({'disabled' => true}).to_yaml" > /home/gitpod/.config/puppet/analytics.yml +RUN rm -f puppet6-release-bionic.deb puppet-tools-release-bionic.deb +ENTRYPOINT /usr/bin/zsh diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/.gitpod.yml b/modules/services/unix/http/apache_stretch_compatible/apache/.gitpod.yml new file mode 100644 index 000000000..9d89d9faa --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/.gitpod.yml @@ -0,0 +1,9 @@ +image: + file: .gitpod.Dockerfile + +tasks: + - init: pdk bundle install + +vscode: + extensions: + - puppet.puppet-vscode@1.2.0:f5iEPbmOj6FoFTOV6q8LTg== diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/.nodeset.yml b/modules/services/unix/http/apache_stretch_compatible/apache/.nodeset.yml new file mode 100644 index 000000000..767f9cd2f --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/.nodeset.yml @@ -0,0 +1,31 @@ +--- +default_set: 'centos-64-x64' +sets: + 'centos-59-x64': + nodes: + "main.foo.vm": + prefab: 'centos-59-x64' + 'centos-64-x64': + nodes: + "main.foo.vm": + prefab: 'centos-64-x64' + 'fedora-18-x64': + nodes: + "main.foo.vm": + prefab: 'fedora-18-x64' + 'debian-607-x64': + nodes: + "main.foo.vm": + prefab: 'debian-607-x64' + 'debian-70rc1-x64': + nodes: + "main.foo.vm": + prefab: 'debian-70rc1-x64' + 'ubuntu-server-10044-x64': + nodes: + "main.foo.vm": + prefab: 'ubuntu-server-10044-x64' + 'ubuntu-server-12042-x64': + nodes: + "main.foo.vm": + prefab: 'ubuntu-server-12042-x64' diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/.rubocop_todo.yml b/modules/services/unix/http/apache_stretch_compatible/apache/.rubocop_todo.yml new file mode 100644 index 000000000..9e99e2004 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/.rubocop_todo.yml @@ -0,0 +1,18 @@ +Style/GlobalVars: + Enabled: false +RSpec/InstanceVariable: + Enabled: false +RSpec/RepeatedExample: + Enabled: false +RSpec/ExpectInHook: + Enabled: false +RSpec/NamedSubject: + Enabled: false +RSpec/VoidExpect: + Enabled: false +RSpec/AnyInstance: + Enabled: false +RSpec/FilePath: + Enabled: false +RSpec/EmptyExampleGroup: + Enabled: false diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/CHANGELOG.md b/modules/services/unix/http/apache_stretch_compatible/apache/CHANGELOG.md index 7c8fa2b83..7ee7a7855 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/CHANGELOG.md +++ b/modules/services/unix/http/apache_stretch_compatible/apache/CHANGELOG.md @@ -1,7 +1,572 @@ # Change log -All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) -and this project adheres to [Semantic Versioning](http://semver.org). +All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). + +## [v7.0.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v7.0.0) (2021-10-11) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v6.5.1...v7.0.0) + +### Changed + +- Drop Debian \< 8 and Ubuntu \< 14.04 code [\#2189](https://github.com/puppetlabs/puppetlabs-apache/pull/2189) ([ekohl](https://github.com/ekohl)) +- Drop support and compatibility for Debian \< 9 and Ubuntu \< 16.04 [\#2123](https://github.com/puppetlabs/puppetlabs-apache/pull/2123) ([ekohl](https://github.com/ekohl)) + +### Added + +- pdksync - \(IAC-1751\) - Add Support for Rocky 8 [\#2196](https://github.com/puppetlabs/puppetlabs-apache/pull/2196) ([david22swan](https://github.com/david22swan)) +- Allow `docroot` with `mod_vhost_alias` `virtual_docroot` [\#2195](https://github.com/puppetlabs/puppetlabs-apache/pull/2195) ([yakatz](https://github.com/yakatz)) + +### Fixed + +- Restore Ubuntu 14.04 support in suphp [\#2193](https://github.com/puppetlabs/puppetlabs-apache/pull/2193) ([ekohl](https://github.com/ekohl)) +- add double quote on scope parameter [\#2191](https://github.com/puppetlabs/puppetlabs-apache/pull/2191) ([aba-rechsteiner](https://github.com/aba-rechsteiner)) +- Debian 11: fix typo in `versioncmp()` / set default php to 7.4 [\#2186](https://github.com/puppetlabs/puppetlabs-apache/pull/2186) ([bastelfreak](https://github.com/bastelfreak)) + +## [v6.5.1](https://github.com/puppetlabs/puppetlabs-apache/tree/v6.5.1) (2021-08-25) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v6.5.0...v6.5.1) + +### Fixed + +- \(maint\) Allow stdlib 8.0.0 [\#2184](https://github.com/puppetlabs/puppetlabs-apache/pull/2184) ([smortex](https://github.com/smortex)) + +## [v6.5.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v6.5.0) (2021-08-24) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v6.4.0...v6.5.0) + +### Added + +- pdksync - \(IAC-1709\) - Add Support for Debian 11 [\#2180](https://github.com/puppetlabs/puppetlabs-apache/pull/2180) ([david22swan](https://github.com/david22swan)) + +## [v6.4.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v6.4.0) (2021-08-02) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v6.3.1...v6.4.0) + +### Added + +- \(MODULES-11075\) Improve future version handling for RHEL [\#2174](https://github.com/puppetlabs/puppetlabs-apache/pull/2174) ([mwhahaha](https://github.com/mwhahaha)) +- Allow custom userdir directives [\#2164](https://github.com/puppetlabs/puppetlabs-apache/pull/2164) ([hunner](https://github.com/hunner)) +- Add feature to reload apache service when content of ssl files has changed [\#2157](https://github.com/puppetlabs/puppetlabs-apache/pull/2157) ([timdeluxe](https://github.com/timdeluxe)) + +## [v6.3.1](https://github.com/puppetlabs/puppetlabs-apache/tree/v6.3.1) (2021-07-22) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v6.3.0...v6.3.1) + +### Fixed + +- \(MODULES-10899\) Load php module with the right libphp file [\#2166](https://github.com/puppetlabs/puppetlabs-apache/pull/2166) ([sheenaajay](https://github.com/sheenaajay)) +- \(maint\) Fix puppet-strings docs on apache::vhost [\#2165](https://github.com/puppetlabs/puppetlabs-apache/pull/2165) ([ekohl](https://github.com/ekohl)) + +## [v6.3.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v6.3.0) (2021-06-22) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/kps_ssl_reload_and_cache_disk_combined_tag...v6.3.0) + +### Added + +- The default disk\_cache.conf.erb caches everything. [\#2142](https://github.com/puppetlabs/puppetlabs-apache/pull/2142) ([Pawa2NR](https://github.com/Pawa2NR)) + +### Fixed + +- Update the default version of Apache for Amazon Linux 2 [\#2158](https://github.com/puppetlabs/puppetlabs-apache/pull/2158) ([turnopil](https://github.com/turnopil)) +- Only warn about servername logging if relevant [\#2154](https://github.com/puppetlabs/puppetlabs-apache/pull/2154) ([ekohl](https://github.com/ekohl)) + +## [kps_ssl_reload_and_cache_disk_combined_tag](https://github.com/puppetlabs/puppetlabs-apache/tree/kps_ssl_reload_and_cache_disk_combined_tag) (2021-06-14) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v6.2.0...kps_ssl_reload_and_cache_disk_combined_tag) + +## [v6.2.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v6.2.0) (2021-05-24) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v6.1.0...v6.2.0) + +### Added + +- \(MODULES-11068\) Allow apache::vhost ssl\_honorcipherorder to take boolean parameter [\#2152](https://github.com/puppetlabs/puppetlabs-apache/pull/2152) ([davidc](https://github.com/davidc)) + +## [v6.1.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v6.1.0) (2021-05-17) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v6.0.1...v6.1.0) + +### Added + +- support for uri for severname with use\_servername\_for\_filenames [\#2150](https://github.com/puppetlabs/puppetlabs-apache/pull/2150) ([Zarne](https://github.com/Zarne)) +- \(MODULES-11061\) mod\_security custom rule functionality [\#2145](https://github.com/puppetlabs/puppetlabs-apache/pull/2145) ([k2patel](https://github.com/k2patel)) + +## [v6.0.1](https://github.com/puppetlabs/puppetlabs-apache/tree/v6.0.1) (2021-05-10) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v6.0.0...v6.0.1) + +### Fixed + +- Fix HEADER\* and README\* wildcards in IndexIgnore [\#2138](https://github.com/puppetlabs/puppetlabs-apache/pull/2138) ([keto](https://github.com/keto)) +- Fix dav\_svn for Debian 10 [\#2135](https://github.com/puppetlabs/puppetlabs-apache/pull/2135) ([martijndegouw](https://github.com/martijndegouw)) + +## [v6.0.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v6.0.0) (2021-03-02) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v5.10.0...v6.0.0) + +### Changed + +- pdksync - \(MAINT\) Remove SLES 11 support [\#2132](https://github.com/puppetlabs/puppetlabs-apache/pull/2132) ([sanfrancrisko](https://github.com/sanfrancrisko)) +- pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 [\#2125](https://github.com/puppetlabs/puppetlabs-apache/pull/2125) ([carabasdaniel](https://github.com/carabasdaniel)) + +## [v5.10.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v5.10.0) (2021-02-17) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v5.9.0...v5.10.0) + +### Added + +- \(IAC-1186\) Add $use\_port\_for\_filenames parameter [\#2122](https://github.com/puppetlabs/puppetlabs-apache/pull/2122) ([smortex](https://github.com/smortex)) + +### Fixed + +- \(MODULES-10899\) Handle PHP8 MOD package naming convention changes [\#2121](https://github.com/puppetlabs/puppetlabs-apache/pull/2121) ([sanfrancrisko](https://github.com/sanfrancrisko)) + +## [v5.9.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v5.9.0) (2021-01-25) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v5.8.0...v5.9.0) + +### Added + +- Add ssl\_user\_name vhost parameter [\#2093](https://github.com/puppetlabs/puppetlabs-apache/pull/2093) ([bodgit](https://github.com/bodgit)) +- Add support for mod\_md [\#2090](https://github.com/puppetlabs/puppetlabs-apache/pull/2090) ([smortex](https://github.com/smortex)) + +### Fixed + +- \(FIX\) Correct PHP packages on Ubuntu 16.04 [\#2111](https://github.com/puppetlabs/puppetlabs-apache/pull/2111) ([ekohl](https://github.com/ekohl)) + +## [v5.8.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v5.8.0) (2020-12-07) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v5.7.0...v5.8.0) + +### Added + +- \(MODULES-10887\) Set `use_servername_for_filenames` for defaults [\#2103](https://github.com/puppetlabs/puppetlabs-apache/pull/2103) ([towo](https://github.com/towo)) +- pdksync - \(feat\) Add support for Puppet 7 [\#2101](https://github.com/puppetlabs/puppetlabs-apache/pull/2101) ([daianamezdrea](https://github.com/daianamezdrea)) +- \(feat\) Add support for apreq2 MOD on Debian 9, 10 [\#2085](https://github.com/puppetlabs/puppetlabs-apache/pull/2085) ([TigerKriika](https://github.com/TigerKriika)) + +### Fixed + +- \(fix\) Convert unnecessary multi line warnings to single lines [\#2104](https://github.com/puppetlabs/puppetlabs-apache/pull/2104) ([rj667](https://github.com/rj667)) +- Fix bool2httpd function call for older ruby versions [\#2102](https://github.com/puppetlabs/puppetlabs-apache/pull/2102) ([carabasdaniel](https://github.com/carabasdaniel)) +- Use Ruby 2.7 compatible string matching [\#2060](https://github.com/puppetlabs/puppetlabs-apache/pull/2060) ([ekohl](https://github.com/ekohl)) + +## [v5.7.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v5.7.0) (2020-11-24) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v5.6.0...v5.7.0) + +### Added + +- Add cas\_cookie\_path in vhosts [\#2089](https://github.com/puppetlabs/puppetlabs-apache/pull/2089) ([yakatz](https://github.com/yakatz)) +- \(IAC-1186\) Add new $use\_servername\_for\_filenames parameter [\#2086](https://github.com/puppetlabs/puppetlabs-apache/pull/2086) ([sanfrancrisko](https://github.com/sanfrancrisko)) +- Allow relative paths in oidc\_redirect\_uri [\#2082](https://github.com/puppetlabs/puppetlabs-apache/pull/2082) ([sanfrancrisko](https://github.com/sanfrancrisko)) +- Improve SSLVerify options [\#2081](https://github.com/puppetlabs/puppetlabs-apache/pull/2081) ([bovy89](https://github.com/bovy89)) +- Change icon path [\#2079](https://github.com/puppetlabs/puppetlabs-apache/pull/2079) ([yakatz](https://github.com/yakatz)) +- Support mod\_auth\_gssapi parameters [\#2078](https://github.com/puppetlabs/puppetlabs-apache/pull/2078) ([traylenator](https://github.com/traylenator)) +- Add ssl\_proxy\_machine\_cert\_chain param to vhost class [\#2072](https://github.com/puppetlabs/puppetlabs-apache/pull/2072) ([AbelNavarro](https://github.com/AbelNavarro)) + +### Fixed + +- Use Ruby 2.7 compatible string matching [\#2074](https://github.com/puppetlabs/puppetlabs-apache/pull/2074) ([sanfrancrisko](https://github.com/sanfrancrisko)) + +## [v5.6.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v5.6.0) (2020-10-01) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v5.5.0...v5.6.0) + +### Added + +- Configure default shared lib path for mod\_wsgi on RHEL8 [\#2063](https://github.com/puppetlabs/puppetlabs-apache/pull/2063) ([nbarrientos](https://github.com/nbarrientos)) +- Various enhancements to apache::mod::passenger [\#2058](https://github.com/puppetlabs/puppetlabs-apache/pull/2058) ([smortex](https://github.com/smortex)) + +### Fixed + +- make apache::mod::fcgid redhat 8 compatible [\#2071](https://github.com/puppetlabs/puppetlabs-apache/pull/2071) ([creativefre](https://github.com/creativefre)) +- pdksync - \(feat\) - Removal of inappropriate terminology [\#2062](https://github.com/puppetlabs/puppetlabs-apache/pull/2062) ([pmcmaw](https://github.com/pmcmaw)) +- Use python3-mod\_wsgi instead of mod\_wsgi on CentOS8 [\#2052](https://github.com/puppetlabs/puppetlabs-apache/pull/2052) ([kajinamit](https://github.com/kajinamit)) + +## [v5.5.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v5.5.0) (2020-07-03) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v5.4.0...v5.5.0) + +### Added + +- Allow IPv6 CIDRs for proxy\_protocol\_exceptions in mod remoteip [\#2033](https://github.com/puppetlabs/puppetlabs-apache/pull/2033) ([thechristschn](https://github.com/thechristschn)) +- \(IAC-746\) - Add ubuntu 20.04 support [\#2032](https://github.com/puppetlabs/puppetlabs-apache/pull/2032) ([david22swan](https://github.com/david22swan)) +- Replace legacy `bool2httpd()` function with shim [\#2025](https://github.com/puppetlabs/puppetlabs-apache/pull/2025) ([alexjfisher](https://github.com/alexjfisher)) +- Tidy up `pw_hash` function [\#2024](https://github.com/puppetlabs/puppetlabs-apache/pull/2024) ([alexjfisher](https://github.com/alexjfisher)) +- Replace validate\_apache\_loglevel\(\) with data type [\#2023](https://github.com/puppetlabs/puppetlabs-apache/pull/2023) ([alexjfisher](https://github.com/alexjfisher)) +- Add ProxyIOBufferSize option [\#2014](https://github.com/puppetlabs/puppetlabs-apache/pull/2014) ([jplindquist](https://github.com/jplindquist)) +- Add support for SetInputFilter directive [\#2007](https://github.com/puppetlabs/puppetlabs-apache/pull/2007) ([HoucemEddine](https://github.com/HoucemEddine)) +- \[MODULES-10530\] Add request limiting directives on virtual host level [\#1996](https://github.com/puppetlabs/puppetlabs-apache/pull/1996) ([aursu](https://github.com/aursu)) +- \[MODULES-10528\] Add ErrorLogFormat directive on virtual host level [\#1995](https://github.com/puppetlabs/puppetlabs-apache/pull/1995) ([aursu](https://github.com/aursu)) +- Add template variables and parameters for ModSecurity Audit Logs [\#1988](https://github.com/puppetlabs/puppetlabs-apache/pull/1988) ([jplindquist](https://github.com/jplindquist)) +- \(MODULES-10432\) Add mod\_auth\_openidc support [\#1987](https://github.com/puppetlabs/puppetlabs-apache/pull/1987) ([asieraguado](https://github.com/asieraguado)) + +### Fixed + +- \(MODULES-10712\) Fix mod\_ldap on RH/CentOS 5 and 6 [\#2041](https://github.com/puppetlabs/puppetlabs-apache/pull/2041) ([h-haaks](https://github.com/h-haaks)) +- Update mod\_dir, alias\_icons\_path, error\_documents\_path for CentOS 8 [\#2038](https://github.com/puppetlabs/puppetlabs-apache/pull/2038) ([initrd](https://github.com/initrd)) +- Ensure switching of thread module works on Debian 10 / Ubuntu 20.04 [\#2034](https://github.com/puppetlabs/puppetlabs-apache/pull/2034) ([tuxmea](https://github.com/tuxmea)) +- MODULES-10586 Centos 8: wrong package used to install mod\_authnz\_ldap [\#2021](https://github.com/puppetlabs/puppetlabs-apache/pull/2021) ([farebers](https://github.com/farebers)) +- Re-add package for fcgid on debian/ubuntu machines [\#2006](https://github.com/puppetlabs/puppetlabs-apache/pull/2006) ([vStone](https://github.com/vStone)) +- Use ldap\_trusted\_mode in conditional [\#1999](https://github.com/puppetlabs/puppetlabs-apache/pull/1999) ([dacron](https://github.com/dacron)) +- Typo in oidcsettings.pp [\#1997](https://github.com/puppetlabs/puppetlabs-apache/pull/1997) ([asieraguado](https://github.com/asieraguado)) +- Fix proxy\_html Module to work on Debian 10 [\#1994](https://github.com/puppetlabs/puppetlabs-apache/pull/1994) ([buchstabensalat](https://github.com/buchstabensalat)) +- \(MODULES-10360\) Fix icon paths for RedHat systems [\#1991](https://github.com/puppetlabs/puppetlabs-apache/pull/1991) ([2and3makes23](https://github.com/2and3makes23)) +- SSLProxyEngine on has to be set before any Proxydirective using it [\#1989](https://github.com/puppetlabs/puppetlabs-apache/pull/1989) ([zivis](https://github.com/zivis)) + +## [v5.4.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v5.4.0) (2020-01-22) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v5.3.0...v5.4.0) + +### Added + +- Add an apache::vhost::fragment define [\#1980](https://github.com/puppetlabs/puppetlabs-apache/pull/1980) ([ekohl](https://github.com/ekohl)) + +### Fixed + +- \(MODULES-10391\) ssl\_protocol includes SSLv2 and SSLv3 on all platforms [\#1990](https://github.com/puppetlabs/puppetlabs-apache/pull/1990) ([legooolas](https://github.com/legooolas)) + +## [v5.3.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v5.3.0) (2019-12-11) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v5.2.0...v5.3.0) + +### Added + +- \(FM-8672\) - Addition of Support for CentOS 8 [\#1977](https://github.com/puppetlabs/puppetlabs-apache/pull/1977) ([david22swan](https://github.com/david22swan)) +- \(MODULES-9948\) Allow switching of thread modules [\#1961](https://github.com/puppetlabs/puppetlabs-apache/pull/1961) ([tuxmea](https://github.com/tuxmea)) + +### Fixed + +- Fix newline being added before proxy params [\#1984](https://github.com/puppetlabs/puppetlabs-apache/pull/1984) ([oxc](https://github.com/oxc)) +- When using mod jk, we expect the libapache2-mod-jk package to be installed [\#1979](https://github.com/puppetlabs/puppetlabs-apache/pull/1979) ([tuxmea](https://github.com/tuxmea)) +- move unless into manage\_security\_corerules [\#1976](https://github.com/puppetlabs/puppetlabs-apache/pull/1976) ([SimonHoenscheid](https://github.com/SimonHoenscheid)) +- Change mod\_proxy's ProxyTimeout to follow Apache's global timeout [\#1975](https://github.com/puppetlabs/puppetlabs-apache/pull/1975) ([gcoxmoz](https://github.com/gcoxmoz)) +- \(FM-8721\) fix php version and ssl error on redhat8 [\#1973](https://github.com/puppetlabs/puppetlabs-apache/pull/1973) ([sheenaajay](https://github.com/sheenaajay)) + +## [v5.2.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v5.2.0) (2019-11-01) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v5.1.0...v5.2.0) + +### Added + +- Add parameter version for mod security [\#1953](https://github.com/puppetlabs/puppetlabs-apache/pull/1953) ([tuxmea](https://github.com/tuxmea)) +- add possibility to define variables inside VirtualHost definition [\#1947](https://github.com/puppetlabs/puppetlabs-apache/pull/1947) ([trefzer](https://github.com/trefzer)) + +### Fixed + +- \(FM-8662\) Correction in manifests/mod/ssl.pp for SLES 11 [\#1963](https://github.com/puppetlabs/puppetlabs-apache/pull/1963) ([sanfrancrisko](https://github.com/sanfrancrisko)) +- always quote ExpiresDefault in vhost::directories [\#1958](https://github.com/puppetlabs/puppetlabs-apache/pull/1958) ([evgeni](https://github.com/evgeni)) +- MODULES-9904 Fix lbmethod module load order [\#1956](https://github.com/puppetlabs/puppetlabs-apache/pull/1956) ([optiz0r](https://github.com/optiz0r)) +- Add owner, group, file\_mode and show\_diff to apache::custom\_config [\#1942](https://github.com/puppetlabs/puppetlabs-apache/pull/1942) ([treydock](https://github.com/treydock)) +- Add shibboleth support for Debian 10 [\#1939](https://github.com/puppetlabs/puppetlabs-apache/pull/1939) ([fabbks](https://github.com/fabbks)) + +## [v5.1.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v5.1.0) (2019-09-13) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/v5.0.0...v5.1.0) + +### Added + +- \(FM-8393\) add support on Debian 10 [\#1945](https://github.com/puppetlabs/puppetlabs-apache/pull/1945) ([ThoughtCrhyme](https://github.com/ThoughtCrhyme)) +- FM-8140 Add Redhat 8 support [\#1941](https://github.com/puppetlabs/puppetlabs-apache/pull/1941) ([sheenaajay](https://github.com/sheenaajay)) +- \(FM-8214\) converted to use litmus [\#1938](https://github.com/puppetlabs/puppetlabs-apache/pull/1938) ([tphoney](https://github.com/tphoney)) +- \(MODULES-9668 \) Please make ProxyRequests setting in vhost.pp configurable [\#1935](https://github.com/puppetlabs/puppetlabs-apache/pull/1935) ([aukesj](https://github.com/aukesj)) +- Added unmanaged\_path and custom\_fragment options to userdir [\#1931](https://github.com/puppetlabs/puppetlabs-apache/pull/1931) ([GeorgeCox](https://github.com/GeorgeCox)) +- Add LDAP parameters to httpd.conf [\#1930](https://github.com/puppetlabs/puppetlabs-apache/pull/1930) ([daveseff](https://github.com/daveseff)) +- Add LDAPReferrals configuration parameter [\#1928](https://github.com/puppetlabs/puppetlabs-apache/pull/1928) ([HT43-bqxFqB](https://github.com/HT43-bqxFqB)) + +### Fixed + +- \(MODULES-9104\) Add file\_mode to config files. [\#1922](https://github.com/puppetlabs/puppetlabs-apache/pull/1922) ([stevegarn](https://github.com/stevegarn)) +- \(bugfix\) Add default package name for mod\_ldap [\#1913](https://github.com/puppetlabs/puppetlabs-apache/pull/1913) ([turnopil](https://github.com/turnopil)) +- Remove event mpm when using prefork, worker or itk [\#1905](https://github.com/puppetlabs/puppetlabs-apache/pull/1905) ([tuxmea](https://github.com/tuxmea)) + +## [v5.0.0](https://github.com/puppetlabs/puppetlabs-apache/tree/v5.0.0) (2019-05-20) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/4.1.0...v5.0.0) + +### Changed + +- pdksync - \(MODULES-8444\) - Raise lower Puppet bound [\#1908](https://github.com/puppetlabs/puppetlabs-apache/pull/1908) ([david22swan](https://github.com/david22swan)) + +### Added + +- \(FM-7923\) Implement Puppet Strings [\#1916](https://github.com/puppetlabs/puppetlabs-apache/pull/1916) ([eimlav](https://github.com/eimlav)) +- Define SCL package name for mod\_ldap [\#1893](https://github.com/puppetlabs/puppetlabs-apache/pull/1893) ([treydock](https://github.com/treydock)) + +### Fixed + +- \(MODULES-9014\) Improve SSLSessionTickets handling [\#1923](https://github.com/puppetlabs/puppetlabs-apache/pull/1923) ([FredericLespez](https://github.com/FredericLespez)) +- \(MODULES-8931\) Fix stahnma/epel failures [\#1914](https://github.com/puppetlabs/puppetlabs-apache/pull/1914) ([eimlav](https://github.com/eimlav)) +- Fix wsgi\_daemon\_process to support hash data type [\#1884](https://github.com/puppetlabs/puppetlabs-apache/pull/1884) ([mdechiaro](https://github.com/mdechiaro)) + +## [4.1.0](https://github.com/puppetlabs/puppetlabs-apache/tree/4.1.0) (2019-04-05) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/4.0.0...4.1.0) + +### Added + +- \(MODULES-7196\) Allow setting CASRootProxiedAs per virtualhost \(replaces \#1857\) [\#1900](https://github.com/puppetlabs/puppetlabs-apache/pull/1900) ([Lavinia-Dan](https://github.com/Lavinia-Dan)) +- \(feat\) - Amazon Linux 2 compatibility added [\#1898](https://github.com/puppetlabs/puppetlabs-apache/pull/1898) ([david22swan](https://github.com/david22swan)) +- \(MODULES-8731\) Allow CIDRs for proxy\_ips/internal\_proxy in remoteip [\#1891](https://github.com/puppetlabs/puppetlabs-apache/pull/1891) ([JAORMX](https://github.com/JAORMX)) +- Manage all mod\_remoteip parameters supported by Apache [\#1882](https://github.com/puppetlabs/puppetlabs-apache/pull/1882) ([johanfleury](https://github.com/johanfleury)) +- MODULES-8541 : Allow HostnameLookups to be modified [\#1881](https://github.com/puppetlabs/puppetlabs-apache/pull/1881) ([k2patel](https://github.com/k2patel)) +- Add support for mod\_http2 [\#1867](https://github.com/puppetlabs/puppetlabs-apache/pull/1867) ([smortex](https://github.com/smortex)) +- Added code to paramertize the libphp prefix [\#1852](https://github.com/puppetlabs/puppetlabs-apache/pull/1852) ([grahamuk2018](https://github.com/grahamuk2018)) +- Added WSGI Options WSGIApplicationGroup and WSGIPythonOptimize [\#1847](https://github.com/puppetlabs/puppetlabs-apache/pull/1847) ([emetriqLikedeeler](https://github.com/emetriqLikedeeler)) + +### Fixed + +- \(bugfix\) set kernel for facter version test [\#1895](https://github.com/puppetlabs/puppetlabs-apache/pull/1895) ([tphoney](https://github.com/tphoney)) +- \(MODULES-5990\) - Managing conf\_enabled [\#1875](https://github.com/puppetlabs/puppetlabs-apache/pull/1875) ([david22swan](https://github.com/david22swan)) + +## [4.0.0](https://github.com/puppetlabs/puppetlabs-apache/tree/4.0.0) (2019-01-10) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/3.5.0...4.0.0) + +### Changed + +- default server\_tokens to prod - more secure default [\#1746](https://github.com/puppetlabs/puppetlabs-apache/pull/1746) ([juju4](https://github.com/juju4)) + +### Added + +- \(Modules 8141/Modules 8379\) - Addition of support for SLES 15 [\#1862](https://github.com/puppetlabs/puppetlabs-apache/pull/1862) ([david22swan](https://github.com/david22swan)) +- SCL support for httpd and php7.1 [\#1822](https://github.com/puppetlabs/puppetlabs-apache/pull/1822) ([mmoll](https://github.com/mmoll)) + +### Fixed + +- \(MODULES-5990\) - conf-enabled defaulted to undef [\#1869](https://github.com/puppetlabs/puppetlabs-apache/pull/1869) ([david22swan](https://github.com/david22swan)) +- pdksync - \(FM-7655\) Fix rubygems-update for ruby \< 2.3 [\#1866](https://github.com/puppetlabs/puppetlabs-apache/pull/1866) ([tphoney](https://github.com/tphoney)) + +## [3.5.0](https://github.com/puppetlabs/puppetlabs-apache/tree/3.5.0) (2018-12-17) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/3.4.0...3.5.0) + +### Added + +- \(MODULES-5990\) Addition of 'IncludeOptional conf-enabled/\*.conf' to apache2.conf' on Debian Family OS [\#1851](https://github.com/puppetlabs/puppetlabs-apache/pull/1851) ([david22swan](https://github.com/david22swan)) +- \(MODULES-8107\) - Support added for Ubuntu 18.04. [\#1850](https://github.com/puppetlabs/puppetlabs-apache/pull/1850) ([david22swan](https://github.com/david22swan)) +- \(MODULES-8108\) - Support added for Debian 9 [\#1849](https://github.com/puppetlabs/puppetlabs-apache/pull/1849) ([david22swan](https://github.com/david22swan)) +- Add option to add comments to the header of a vhost file [\#1841](https://github.com/puppetlabs/puppetlabs-apache/pull/1841) ([jovandeginste](https://github.com/jovandeginste)) + +### Fixed + +- \(FM-7605\) - Disabling conf\_enabled on Ubuntu 18.04 by default as it conflicts with Shibboleth causing errors with apache2. [\#1856](https://github.com/puppetlabs/puppetlabs-apache/pull/1856) ([david22swan](https://github.com/david22swan)) +- \(MODULES-8429\) Update GPG key for phusion passenger [\#1848](https://github.com/puppetlabs/puppetlabs-apache/pull/1848) ([abottchen](https://github.com/abottchen)) +- Fix default vhost priority in readme [\#1843](https://github.com/puppetlabs/puppetlabs-apache/pull/1843) ([HT43-bqxFqB](https://github.com/HT43-bqxFqB)) +- fix apache::mod::jk example typo and add link for more info [\#1812](https://github.com/puppetlabs/puppetlabs-apache/pull/1812) ([xorpaul](https://github.com/xorpaul)) +- MODULES-7379: Fixing syntax by adding newline [\#1803](https://github.com/puppetlabs/puppetlabs-apache/pull/1803) ([wimvr](https://github.com/wimvr)) +- ensure mpm\_event is disabled under debian 9 if mpm itk is used [\#1766](https://github.com/puppetlabs/puppetlabs-apache/pull/1766) ([zivis](https://github.com/zivis)) + +## [3.4.0](https://github.com/puppetlabs/puppetlabs-apache/tree/3.4.0) (2018-09-27) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/3.3.0...3.4.0) + +### Added + +- pdksync - \(FM-7392\) - Puppet 6 Testing Changes [\#1838](https://github.com/puppetlabs/puppetlabs-apache/pull/1838) ([pmcmaw](https://github.com/pmcmaw)) +- pdksync - \(MODULES-6805\) metadata.json shows support for puppet 6 [\#1836](https://github.com/puppetlabs/puppetlabs-apache/pull/1836) ([tphoney](https://github.com/tphoney)) + +### Fixed + +- Fix "audit\_log\_relevant\_status" typo in README.md [\#1830](https://github.com/puppetlabs/puppetlabs-apache/pull/1830) ([smokris](https://github.com/smokris)) + +## [3.3.0](https://github.com/puppetlabs/puppetlabs-apache/tree/3.3.0) (2018-09-11) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-apache/compare/3.2.0...3.3.0) + +### Added + +- pdksync - \(MODULES-7705\) - Bumping stdlib dependency from \< 5.0.0 to \< 6.0.0 [\#1821](https://github.com/puppetlabs/puppetlabs-apache/pull/1821) ([pmcmaw](https://github.com/pmcmaw)) +- Add support for ProxyTimeout [\#1805](https://github.com/puppetlabs/puppetlabs-apache/pull/1805) ([agoodno](https://github.com/agoodno)) +- \(MODULES-7343\) - Allow overrides by adding mod\_libs in apache class [\#1800](https://github.com/puppetlabs/puppetlabs-apache/pull/1800) ([karelyatin](https://github.com/karelyatin)) +- Rework passenger VHost and Directories [\#1778](https://github.com/puppetlabs/puppetlabs-apache/pull/1778) ([smortex](https://github.com/smortex)) + +### Fixed + +- MODULES-7575 reverse sort the aliases [\#1808](https://github.com/puppetlabs/puppetlabs-apache/pull/1808) ([k2patel](https://github.com/k2patel)) +- fixes for OpenSUSE ans SLES [\#1783](https://github.com/puppetlabs/puppetlabs-apache/pull/1783) ([tuxmea](https://github.com/tuxmea)) + +## 3.2.0 +### Summary +This is a clean release to prepare for several planned backwards incompatible changes. + +#### Changed +- Parameter `passenger_pre_start` has been moved outside of ``. +- Apache version fact has been enabled on FreeBSD. +- Parameter `ssl_proxyengine` has had it's default changed to false. + +#### Added +- Parameter `passenger_group` can now be set in `apache::vhost`. +- Multiple `passenger_pre_start` URIs can now be set at once. +- Manifest `mod::auth_gssapi` has been added to allow the deployment of authorisation with kerberos, through GSSAPI. + +#### Removed +- Scientific 5 and Debian 7 are no longer supported on Apache. + +## Supported Release [3.1.0] +### Summary +This release includes the module being converted using version 1.4.1 of the PDK. It also includes a couple of additional parameters added. + +#### Added +- Module has been pdk converted with version 1.4.1 ([MODULES-6331](https://tickets.puppet.com/browse/MODULES-6331)) +- Parameter `ssl_cert` to provide a SSLCertificateFile option for use with SSL, optional of type String. +- Parameter `ssl_key` to provide a SSLCertificateKey option for use with SSL, optional of type String. + +#### Fixed +- Documentation updates. +- Updates to the Japanese translation based on documentation update. + +## Supported Release [3.0.0] +### Summary +This major release changes the default value of `keepalive` to `On`. It also includes many other features and bugfixes. + +#### Changed +- Default `apache::keepalive` from `Off` to `On`. + +#### Added +- Class `apache::mod::data` +- Function `apache::apache_pw_hash` function (puppet 4 port of `apache_pw_hash()`) +- Function `apache::bool2httpd` function (puppet 4 port of `bool2httpd()`) +- Function `apache::validate_apache_log_level` function (puppet 4 port of `validate_apache_log_level()`) +- Parameter `apache::balancer::options` for additional directives. +- Parameter `apache::limitreqfields` setting the LimitRequestFields directive to 100. +- Parameter `apache::use_canonical_name` to control how httpd uses self-referential URLs. +- Parameter `apache::mod::disk_cache::cache_ignore_headers` to ignore cache headers. +- Parameter `apache::mod::itk::enablecapabilities` to manage ITK capabilities. +- Parameter `apache::mod::ldap::ldap_trusted_mode` to manage trusted mode. +- Parameters for `apache::mod::passenger`: + - `passenger_allow_encoded_slashes` + - `passenger_app_group_name` + - `passenger_app_root` + - `passenger_app_type` + - `passenger_base_uri` + - `passenger_buffer_response` + - `passenger_buffer_upload` + - `passenger_concurrency_model` + - `passenger_debug_log_file` + - `passenger_debugger` + - `passenger_default_group` + - `passenger_default_user` + - `passenger_disable_security_update_check` + - `passenger_enabled` + - `passenger_error_override` + - `passenger_file_descriptor_log_file` + - `passenger_fly_with` + - `passenger_force_max_concurrent_requests_per_process` + - `passenger_friendly_error_pages` + - `passenger_group` + - `passenger_installed_version` + - `passenger_instance_registry_dir` + - `passenger_load_shell_envvars` + - `passenger_lve_min_uid` + - `passenger_max_instances` + - `passenger_max_preloader_idle_time` + - `passenger_max_request_time` + - `passenger_memory_limit` + - `passenger_meteor_app_settings` + - `passenger_nodejs` + - `passenger_pre_start` + - `passenger_python` + - `passenger_resist_deployment_errors` + - `passenger_resolve_symlinks_in_document_root` + - `passenger_response_buffer_high_watermark` + - `passenger_restart_dir` + - `passenger_rolling_restarts` + - `passenger_security_update_check_proxy` + - `passenger_show_version_in_header` + - `passenger_socket_backlog` + - `passenger_start_timeout` + - `passenger_startup_file` + - `passenger_sticky_sessions` + - `passenger_sticky_sessions_cookie_name` + - `passenger_thread_count` + - `passenger_user` + - `passenger_user_switching` + - `rack_auto_detect` + - `rack_base_uri` + - `rack_env` + - `rails_allow_mod_rewrite` + - `rails_app_spawner_idle_time` + - `rails_auto_detect` + - `rails_base_uri` + - `rails_default_user` + - `rails_env` + - `rails_framework_spawner_idle_time` + - `rails_ruby` + - `rails_spawn_method` + - `rails_user_switching` + - `wsgi_auto_detect` +- Parameter `apache::mod::prefork::listenbacklog` to set the listen backlog to 511. +- Parameter `apache::mod::python::loadfile_name` to workaround python.load filename conflicts. +- Parameter `apache::mod::ssl::ssl_cert` to manage the client auth cert. +- Parameter `apache::mod::ssl::ssl_key` to manage the client auth key. +- Parameter `apache::mod::status::requires` as an alternative to `apache::mod::status::allow_from` +- Parameter `apache::vhost::ssl_proxy_cipher_suite` to manage that directive. +- Parameter `apache::vhost::shib_compat_valid_user` to manage that directive. +- Parameter `apache::vhost::use_canonical_name` to manage that directive. +- Parameter value `mellon_session_length` for `apache::vhost::directories` + +### Fixed +- `apache_version` is confined to just Linux to avoid erroring on AIX. +- Parameter `apache::mod::jk::workers_file_content` docs typo of "mantain" instead of maintain. +- Deduplicate `apache::mod::ldap` managing `File['ldap.conf']` to avoid resource conflicts. +- ITK package name on Debian 9 +- Dav_svn package for SLES +- Log client IP instead of loadbalancer IP when behind a loadbalancer. +- `apache::mod::remoteip` now notifies the `Class['apache::service']` class instead of `Service['httpd']` to avoid restarting the service when `apache::service_manage` is false. +- `apache::vhost::cas_scrub_request_headers` actually manages the directive. + +## Supported Release [2.3.1] +### Summary +This release fixes CVE-2018-6508 which is a potential arbitrary code execution via tasks. + +### Fixed +- Fix init task for arbitrary remote code + +## Supported Release [2.3.0] +### Summary +This is a feature release. It includes a task that will reload the apache service. + +#### Added +- Add a task that allows the reloading of the Apache service. + +## Supported Release [2.2.0] +### Summary +This is a maintainence and feature release. It will include updates to translations in Japanese, some maintainence and adding `PassengerSpawnMethod` to vhost. + +#### Added +- `PassengerSpawnMethod` added to `vhost`. + +#### Changed +- Improve version match fact for `apache_version` +- Update to prefork.conf params for Apache 2.4 +- Updates to `CONTRIBUTING.md` +- Do not install mod_fastcgi on el7 +- Include mod_wsgi when using wsgi options + +## Supported Release [2.1.0] +### Summary +This is a feature release including a security patch (CVE-2017-2299) + +#### Added +- `apache::mod::jk` class for managing the mod_jk connector +- `apache_pw_hash` function +- the ProxyPass directive in location contexts +- more Puppet 4 type validation +- `apache::mod::macro` class for managing mod_macro + +#### Changed +- $ssl_certs_dir default to `undef` for all platorms +- $ssl_verify_client must now be set to use any of the following: `$ssl_certs_dir`, `$ssl_ca`, `$ssl_crl_path`, `$ssl_crl`, `$ssl_verify_depth`, `$ssl_crl_check` + +#### Fixed +- issue where mod_alias was not being loaded when RedirectMatch* directives were being used ([MODULES-3942](https://tickets.puppet.com/browse/MODULES-3942)) +- issue with `$directories` parameter in `apache::vhost` +- issue in UserDir template where the UserDir path did not match the Directory path +- **Issue where the $ssl_certs_dir default set Apache to implicitly trust all client certificates that were issued by any CA in that directory** + +#### Removed +- support for EOL platforms: Ubuntu 10.04, 12.04 and Debian 6 (Squeeze) ## Supported Release [2.0.0] ### Summary @@ -47,6 +612,17 @@ Major release **removing Puppet 3 support** and other backwards-incompatible cha - issue where ProxyPreserveHost could not be set without other Proxy* directives - the module attempting to install proxy_html on Ubuntu Xenial and Debian Stretch +## Supported Release [1.11.1] +#### Summary +This is a security patch release (CVE-2017-2299). These changes are also in version 2.1.0 and higher. + +#### Changed +- $ssl_certs_dir default to `undef` for all platorms +- $ssl_verify_client must now be set to use any of the following: `$ssl_certs_dir`, `$ssl_ca`, `$ssl_crl_path`, `$ssl_crl`, `$ssl_verify_depth`, `$ssl_crl_check` + +#### Fixed +- **Issue where the $ssl_certs_dir default set Apache to implicitly trust all client certificates that were issued by any CA in that directory** ([MODULES-5471](https://tickets.puppet.com/browse/MODULES-5471)) + ## Supported Release [1.11.0] ### Summary This release adds SLES12 Support and many more features and bugfixes. @@ -510,6 +1086,7 @@ This release features many improvements and bugfixes, including several new defi - passenger_ruby - passenger_start_timeout - proxy_preserve_host + - proxy_requests - redirectmatch_dest - ssl_crl_check - wsgi_chunked_request @@ -864,7 +1441,15 @@ worker/prefork * f672e46 a2mod fix * 8a56ee9 add pthon support to apache +[3.2.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/3.1.0...3.2.0 +[3.1.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/3.0.0...3.1.0 +[3.0.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/2.3.1...3.0.0 +[2.3.1]:https://github.com/puppetlabs/puppetlabs-apache/compare/2.3.0...2.3.1 +[2.3.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/2.2.0...2.3.0 +[2.2.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/2.1.0...2.2.0 +[2.1.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/2.0.0...2.1.0 [2.0.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.11.0...2.0.0 +[1.11.1]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.11.0...1.11.1 [1.11.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.10.0...1.11.0 [1.10.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.9.0...1.10.0 [1.9.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.8.1...1.9.0 @@ -892,3 +1477,6 @@ worker/prefork [0.5.0-rc1]:https://github.com/puppetlabs/puppetlabs-apache/compare/0.4.0...0.5.0-rc1 [0.4.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/0.3.0...0.4.0 [0.0.4]:https://github.com/puppetlabs/puppetlabs-apache/commits/0.0.4 + + +\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/CODEOWNERS b/modules/services/unix/http/apache_stretch_compatible/apache/CODEOWNERS new file mode 100644 index 000000000..a5d109e99 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/CODEOWNERS @@ -0,0 +1,2 @@ +# Setting ownership to the modules team +* @puppetlabs/modules diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/CONTRIBUTING.md b/modules/services/unix/http/apache_stretch_compatible/apache/CONTRIBUTING.md index 990edba7e..e7a3a7c3f 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/CONTRIBUTING.md +++ b/modules/services/unix/http/apache_stretch_compatible/apache/CONTRIBUTING.md @@ -1,217 +1,3 @@ -Checklist (and a short version for the impatient) -================================================= +# Contributing to Puppet modules - * Commits: - - - Make commits of logical units. - - - Check for unnecessary whitespace with "git diff --check" before - committing. - - - Commit using Unix line endings (check the settings around "crlf" in - git-config(1)). - - - Do not check in commented out code or unneeded files. - - - The first line of the commit message should be a short - description (50 characters is the soft limit, excluding ticket - number(s)), and should skip the full stop. - - - Associate the issue in the message. The first line should include - the issue number in the form "(#XXXX) Rest of message". - - - The body should provide a meaningful commit message, which: - - - uses the imperative, present tense: "change", not "changed" or - "changes". - - - includes motivation for the change, and contrasts its - implementation with the previous behavior. - - - Make sure that you have tests for the bug you are fixing, or - feature you are adding. - - - Make sure the test suites passes after your commit: - `bundle exec rspec spec/acceptance` More information on [testing](#Testing) below - - - When introducing a new feature, make sure it is properly - documented in the README.md - - * Submission: - - * Pre-requisites: - - - Make sure you have a [GitHub account](https://github.com/join) - - - [Create a ticket](https://tickets.puppet.com/secure/CreateIssue!default.jspa), or [watch the ticket](https://tickets.puppet.com/browse/) you are patching for. - - * Preferred method: - - - Fork the repository on GitHub. - - - Push your changes to a topic branch in your fork of the - repository. (the format ticket/1234-short_description_of_change is - usually preferred for this project). - - - Submit a pull request to the repository in the puppetlabs - organization. - -The long version -================ - - 1. Make separate commits for logically separate changes. - - Please break your commits down into logically consistent units - which include new or changed tests relevant to the rest of the - change. The goal of doing this is to make the diff easier to - read for whoever is reviewing your code. In general, the easier - your diff is to read, the more likely someone will be happy to - review it and get it into the code base. - - If you are going to refactor a piece of code, please do so as a - separate commit from your feature or bug fix changes. - - We also really appreciate changes that include tests to make - sure the bug is not re-introduced, and that the feature is not - accidentally broken. - - Describe the technical detail of the change(s). If your - description starts to get too long, that is a good sign that you - probably need to split up your commit into more finely grained - pieces. - - Commits which plainly describe the things which help - reviewers check the patch and future developers understand the - code are much more likely to be merged in with a minimum of - bike-shedding or requested changes. Ideally, the commit message - would include information, and be in a form suitable for - inclusion in the release notes for the version of Puppet that - includes them. - - Please also check that you are not introducing any trailing - whitespace or other "whitespace errors". You can do this by - running "git diff --check" on your changes before you commit. - - 2. Sending your patches - - To submit your changes via a GitHub pull request, we _highly_ - recommend that you have them on a topic branch, instead of - directly on "master". - It makes things much easier to keep track of, especially if - you decide to work on another thing before your first change - is merged in. - - GitHub has some pretty good - [general documentation](http://help.github.com/) on using - their site. They also have documentation on - [creating pull requests](http://help.github.com/send-pull-requests/). - - In general, after pushing your topic branch up to your - repository on GitHub, you can switch to the branch in the - GitHub UI and click "Pull Request" towards the top of the page - in order to open a pull request. - - - 3. Update the related GitHub issue. - - If there is a GitHub issue associated with the change you - submitted, then you should update the ticket to include the - location of your branch, along with any other commentary you - may wish to make. - -Testing -======= - -Getting Started ---------------- - -Our puppet modules provide [`Gemfile`](./Gemfile)s which can tell a ruby -package manager such as [bundler](http://bundler.io/) what Ruby packages, -or Gems, are required to build, develop, and test this software. - -Please make sure you have [bundler installed](http://bundler.io/#getting-started) -on your system, then use it to install all dependencies needed for this project, -by running - -```shell -% bundle install -Fetching gem metadata from https://rubygems.org/........ -Fetching gem metadata from https://rubygems.org/.. -Using rake (10.1.0) -Using builder (3.2.2) --- 8><-- many more --><8 -- -Using rspec-system-puppet (2.2.0) -Using serverspec (0.6.3) -Using rspec-system-serverspec (1.0.0) -Using bundler (1.3.5) -Your bundle is complete! -Use `bundle show [gemname]` to see where a bundled gem is installed. -``` - -NOTE some systems may require you to run this command with sudo. - -If you already have those gems installed, make sure they are up-to-date: - -```shell -% bundle update -``` - -With all dependencies in place and up-to-date we can now run the tests: - -```shell -% bundle exec rake spec -``` - -This will execute all the [rspec tests](http://rspec-puppet.com/) tests -under [spec/defines](./spec/defines), [spec/classes](./spec/classes), -and so on. rspec tests may have the same kind of dependencies as the -module they are testing. While the module defines in its [Modulefile](./Modulefile), -rspec tests define them in [.fixtures.yml](./fixtures.yml). - -Some puppet modules also come with [beaker](https://github.com/puppetlabs/beaker) -tests. These tests spin up a virtual machine under -[VirtualBox](https://www.virtualbox.org/)) with, controlling it with -[Vagrant](http://www.vagrantup.com/) to actually simulate scripted test -scenarios. In order to run these, you will need both of those tools -installed on your system. - -You can run them by issuing the following command - -```shell -% bundle exec rake spec_clean -% bundle exec rspec spec/acceptance -``` - -This will now download a pre-fabricated image configured in the [default node-set](./spec/acceptance/nodesets/default.yml), -install puppet, copy this module and install its dependencies per [spec/spec_helper_acceptance.rb](./spec/spec_helper_acceptance.rb) -and then run all the tests under [spec/acceptance](./spec/acceptance). - -Writing Tests -------------- - -XXX getting started writing tests. - -If you have commit access to the repository -=========================================== - -Even if you have commit access to the repository, you will still need to -go through the process above, and have someone else review and merge -in your changes. The rule is that all changes must be reviewed by a -developer on the project (that did not write the code) to ensure that -all changes go through a code review process. - -Having someone other than the author of the topic branch recorded as -performing the merge is the record that they performed the code -review. - - -Additional Resources -==================== - -* [Getting additional help](http://puppet.com/community/get-help) - -* [Writing tests](https://docs.puppet.com/guides/module_guides/bgtm.html#step-three-module-testing) - -* [General GitHub documentation](http://help.github.com/) - -* [GitHub pull request documentation](http://help.github.com/send-pull-requests/) +Check out our [Contributing to Supported Modules Blog Post](https://puppetlabs.github.io/iac/docs/contributing_to_a_module.html) to find all the information that you will need. diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/Gemfile b/modules/services/unix/http/apache_stretch_compatible/apache/Gemfile deleted file mode 100644 index 46cb2eace..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/Gemfile +++ /dev/null @@ -1,75 +0,0 @@ -#This file is generated by ModuleSync, do not edit. - -source ENV['GEM_SOURCE'] || "https://rubygems.org" - -# Determines what type of gem is requested based on place_or_version. -def gem_type(place_or_version) - if place_or_version =~ /^git:/ - :git - elsif place_or_version =~ /^file:/ - :file - else - :gem - end -end - -# Find a location or specific version for a gem. place_or_version can be a -# version, which is most often used. It can also be git, which is specified as -# `git://somewhere.git#branch`. You can also use a file source location, which -# is specified as `file://some/location/on/disk`. -def location_for(place_or_version, fake_version = nil) - if place_or_version =~ /^(git[:@][^#]*)#(.*)/ - [fake_version, { :git => $1, :branch => $2, :require => false }].compact - elsif place_or_version =~ /^file:\/\/(.*)/ - ['>= 0', { :path => File.expand_path($1), :require => false }] - else - [place_or_version, { :require => false }] - end -end - -# Used for gem conditionals -supports_windows = false -ruby_version_segments = Gem::Version.new(RUBY_VERSION.dup).segments -minor_version = "#{ruby_version_segments[0]}.#{ruby_version_segments[1]}" - -group :development do - gem "puppet-module-posix-default-r#{minor_version}", :require => false, :platforms => "ruby" - gem "puppet-module-win-default-r#{minor_version}", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"] - gem "puppet-module-posix-dev-r#{minor_version}", :require => false, :platforms => "ruby" - gem "puppet-module-win-dev-r#{minor_version}", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"] - gem "json_pure", '<= 2.0.1', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.0.0') - gem "fast_gettext", '1.1.0', :require => false if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('2.1.0') - gem "fast_gettext", :require => false if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.1.0') -end - -group :system_tests do - gem "puppet-module-posix-system-r#{minor_version}", :require => false, :platforms => "ruby" - gem "puppet-module-win-system-r#{minor_version}", :require => false, :platforms => ["mswin", "mingw", "x64_mingw"] - gem "beaker", *location_for(ENV['BEAKER_VERSION'] || '>= 3') - gem "beaker-pe", :require => false - gem "beaker-rspec", *location_for(ENV['BEAKER_RSPEC_VERSION']) - gem "beaker-hostgenerator", *location_for(ENV['BEAKER_HOSTGENERATOR_VERSION']) - gem "beaker-abs", *location_for(ENV['BEAKER_ABS_VERSION'] || '~> 0.1') -end - -gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION']) - -# Only explicitly specify Facter/Hiera if a version has been specified. -# Otherwise it can lead to strange bundler behavior. If you are seeing weird -# gem resolution behavior, try setting `DEBUG_RESOLVER` environment variable -# to `1` and then run bundle install. -gem 'facter', *location_for(ENV['FACTER_GEM_VERSION']) if ENV['FACTER_GEM_VERSION'] -gem 'hiera', *location_for(ENV['HIERA_GEM_VERSION']) if ENV['HIERA_GEM_VERSION'] - - -# Evaluate Gemfile.local if it exists -if File.exists? "#{__FILE__}.local" - eval(File.read("#{__FILE__}.local"), binding) -end - -# Evaluate ~/.gemfile if it exists -if File.exists?(File.join(Dir.home, '.gemfile')) - eval(File.read(File.join(Dir.home, '.gemfile')), binding) -end - -# vim:ft=ruby diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/HISTORY.md b/modules/services/unix/http/apache_stretch_compatible/apache/HISTORY.md new file mode 100644 index 000000000..3d6897f09 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/HISTORY.md @@ -0,0 +1,1091 @@ +## 3.2.0 +### Summary +This is a clean release to prepare for several planned backwards incompatible changes. + +#### Changed +- Parameter `passenger_pre_start` has been moved outside of ``. +- Apache version fact has been enabled on FreeBSD. +- Parameter `ssl_proxyengine` has had it's default changed to false. + +#### Added +- Parameter `passenger_group` can now be set in `apache::vhost`. +- Multiple `passenger_pre_start` URIs can now be set at once. +- Manifest `mod::auth_gssapi` has been added to allow the deployment of authorisation with kerberos, through GSSAPI. + +#### Removed +- Scientific 5 and Debian 7 are no longer supported on Apache. + +## Supported Release [3.1.0] +### Summary +This release includes the module being converted using version 1.4.1 of the PDK. It also includes a couple of additional parameters added. + +#### Added +- Module has been pdk converted with version 1.4.1 ([MODULES-6331](https://tickets.puppet.com/browse/MODULES-6331)) +- Parameter `ssl_cert` to provide a SSLCertificateFile option for use with SSL, optional of type String. +- Parameter `ssl_key` to provide a SSLCertificateKey option for use with SSL, optional of type String. + +#### Fixed +- Documentation updates. +- Updates to the Japanese translation based on documentation update. + +## Supported Release [3.0.0] +### Summary +This major release changes the default value of `keepalive` to `On`. It also includes many other features and bugfixes. + +#### Changed +- Default `apache::keepalive` from `Off` to `On`. + +#### Added +- Class `apache::mod::data` +- Function `apache::apache_pw_hash` function (puppet 4 port of `apache_pw_hash()`) +- Function `apache::bool2httpd` function (puppet 4 port of `bool2httpd()`) +- Function `apache::validate_apache_log_level` function (puppet 4 port of `validate_apache_log_level()`) +- Parameter `apache::balancer::options` for additional directives. +- Parameter `apache::limitreqfields` setting the LimitRequestFields directive to 100. +- Parameter `apache::use_canonical_name` to control how httpd uses self-referential URLs. +- Parameter `apache::mod::disk_cache::cache_ignore_headers` to ignore cache headers. +- Parameter `apache::mod::itk::enablecapabilities` to manage ITK capabilities. +- Parameter `apache::mod::ldap::ldap_trusted_mode` to manage trusted mode. +- Parameters for `apache::mod::passenger`: + - `passenger_allow_encoded_slashes` + - `passenger_app_group_name` + - `passenger_app_root` + - `passenger_app_type` + - `passenger_base_uri` + - `passenger_buffer_response` + - `passenger_buffer_upload` + - `passenger_concurrency_model` + - `passenger_debug_log_file` + - `passenger_debugger` + - `passenger_default_group` + - `passenger_default_user` + - `passenger_disable_security_update_check` + - `passenger_enabled` + - `passenger_error_override` + - `passenger_file_descriptor_log_file` + - `passenger_fly_with` + - `passenger_force_max_concurrent_requests_per_process` + - `passenger_friendly_error_pages` + - `passenger_group` + - `passenger_installed_version` + - `passenger_instance_registry_dir` + - `passenger_load_shell_envvars` + - `passenger_lve_min_uid` + - `passenger_max_instances` + - `passenger_max_preloader_idle_time` + - `passenger_max_request_time` + - `passenger_memory_limit` + - `passenger_meteor_app_settings` + - `passenger_nodejs` + - `passenger_pre_start` + - `passenger_python` + - `passenger_resist_deployment_errors` + - `passenger_resolve_symlinks_in_document_root` + - `passenger_response_buffer_high_watermark` + - `passenger_restart_dir` + - `passenger_rolling_restarts` + - `passenger_security_update_check_proxy` + - `passenger_show_version_in_header` + - `passenger_socket_backlog` + - `passenger_start_timeout` + - `passenger_startup_file` + - `passenger_sticky_sessions` + - `passenger_sticky_sessions_cookie_name` + - `passenger_thread_count` + - `passenger_user` + - `passenger_user_switching` + - `rack_auto_detect` + - `rack_base_uri` + - `rack_env` + - `rails_allow_mod_rewrite` + - `rails_app_spawner_idle_time` + - `rails_auto_detect` + - `rails_base_uri` + - `rails_default_user` + - `rails_env` + - `rails_framework_spawner_idle_time` + - `rails_ruby` + - `rails_spawn_method` + - `rails_user_switching` + - `wsgi_auto_detect` +- Parameter `apache::mod::prefork::listenbacklog` to set the listen backlog to 511. +- Parameter `apache::mod::python::loadfile_name` to workaround python.load filename conflicts. +- Parameter `apache::mod::ssl::ssl_cert` to manage the client auth cert. +- Parameter `apache::mod::ssl::ssl_key` to manage the client auth key. +- Parameter `apache::mod::status::requires` as an alternative to `apache::mod::status::allow_from` +- Parameter `apache::vhost::ssl_proxy_cipher_suite` to manage that directive. +- Parameter `apache::vhost::shib_compat_valid_user` to manage that directive. +- Parameter `apache::vhost::use_canonical_name` to manage that directive. +- Parameter value `mellon_session_length` for `apache::vhost::directories` + +### Fixed +- `apache_version` is confined to just Linux to avoid erroring on AIX. +- Parameter `apache::mod::jk::workers_file_content` docs typo of "mantain" instead of maintain. +- Deduplicate `apache::mod::ldap` managing `File['ldap.conf']` to avoid resource conflicts. +- ITK package name on Debian 9 +- Dav_svn package for SLES +- Log client IP instead of loadbalancer IP when behind a loadbalancer. +- `apache::mod::remoteip` now notifies the `Class['apache::service']` class instead of `Service['httpd']` to avoid restarting the service when `apache::service_manage` is false. +- `apache::vhost::cas_scrub_request_headers` actually manages the directive. + +## Supported Release [2.3.1] +### Summary +This release fixes CVE-2018-6508 which is a potential arbitrary code execution via tasks. + +### Fixed +- Fix init task for arbitrary remote code + +## Supported Release [2.3.0] +### Summary +This is a feature release. It includes a task that will reload the apache service. + +#### Added +- Add a task that allows the reloading of the Apache service. + +## Supported Release [2.2.0] +### Summary +This is a maintainence and feature release. It will include updates to translations in Japanese, some maintainence and adding `PassengerSpawnMethod` to vhost. + +#### Added +- `PassengerSpawnMethod` added to `vhost`. + +#### Changed +- Improve version match fact for `apache_version` +- Update to prefork.conf params for Apache 2.4 +- Updates to `CONTRIBUTING.md` +- Do not install mod_fastcgi on el7 +- Include mod_wsgi when using wsgi options + +## Supported Release [2.1.0] +### Summary +This is a feature release including a security patch (CVE-2017-2299) + +#### Added +- `apache::mod::jk` class for managing the mod_jk connector +- `apache_pw_hash` function +- the ProxyPass directive in location contexts +- more Puppet 4 type validation +- `apache::mod::macro` class for managing mod_macro + +#### Changed +- $ssl_certs_dir default to `undef` for all platorms +- $ssl_verify_client must now be set to use any of the following: `$ssl_certs_dir`, `$ssl_ca`, `$ssl_crl_path`, `$ssl_crl`, `$ssl_verify_depth`, `$ssl_crl_check` + +#### Fixed +- issue where mod_alias was not being loaded when RedirectMatch* directives were being used ([MODULES-3942](https://tickets.puppet.com/browse/MODULES-3942)) +- issue with `$directories` parameter in `apache::vhost` +- issue in UserDir template where the UserDir path did not match the Directory path +- **Issue where the $ssl_certs_dir default set Apache to implicitly trust all client certificates that were issued by any CA in that directory** + +#### Removed +- support for EOL platforms: Ubuntu 10.04, 12.04 and Debian 6 (Squeeze) + +## Supported Release [2.0.0] +### Summary +Major release **removing Puppet 3 support** and other backwards-incompatible changes. + +#### Added +- support for FileETag directive configurable with the `file_e_tag` parameter +- ability to configure multiple ports per vhost +- RequestHeader directive to vhost template ([MODULES-4156](https://tickets.puppet.com/browse/MODULES-4156)) +- customizability for AllowOverride directive in userdir.conf ([MODULES-4516](https://tickets.puppet.com/browse/MODULES-4516)) +- AdvertiseFrequency directive for cluster.conf ([MODULES-4500](https://tickets.puppet.com/browse/MODULES-4500)) +- `ssl_proxy_protocol` and `ssl_sessioncache` parameters for mod::ssl ([MODULES-4737](https://tickets.puppet.com/browse/MODULES-4737)) +- SSLCACertificateFile directive in ssl.conf configurable with `ssl_ca` parameter +- mod::authnz_pam +- mod::intercept_form_submit +- mod::lookup_identity +- Suse compatibility for mod::proxy_html +- support for AddCharset directive configurable with `add_charset` parameter +- support for SSLProxyVerifyDepth and SSLProxyCACertificateFile directives configurable with `ssl_proxy_verify_depth` and `ssl_proxy_ca_cert` respectively +- `manage_security_crs` parameter for mod::security +- support for LimitExcept directive configurable with `limit_except` parameter +- support for WSGIRestrictEmbedded directive configurable with `wsgi_restrict_embedded` parameter +- support for custom UserDir path ([MODULES-4933](https://tickets.puppet.com/browse/MODULES-4933)) +- support for PassengerMaxRequests directive configurable with `passenger_max_requests` +- option to override module package names with `mod_packages` parameter ([MODULES-3838](https://tickets.puppet.com/browse/MODULES-3838)) + +#### Removed +- enclose_ipv6 as it was added to puppetlabs-stdlib +- deprecated `$verifyServerCert` parameter from the `apache::mod::authnz_ldap` class ([MODULES-4445](https://tickets.puppet.com/browse/MODULES-4445)) + +#### Changed +- `keepalive` default to 'On' from 'Off' +- Puppet version compatibility to ">= 4.7.0 < 6.0.0" +- puppetlabs-stdlib dependency to ">= 4.12.0 < 5.0.0" +- `ssl_cipher` to explicitly disable 3DES because of Sweet32 + +#### Fixed +- various issues in the vhost template +- use of deprecated `include_src` parameter in vhost_spec +- management of ssl.conf on RedHat systems +- various SLES/Suse params +- mod::cgi ordering for FreeBSD +- issue where ProxyPreserveHost could not be set without other Proxy* directives +- the module attempting to install proxy_html on Ubuntu Xenial and Debian Stretch + +## Supported Release [1.11.1] +#### Summary +This is a security patch release (CVE-2017-2299). These changes are also in version 2.1.0 and higher. + +#### Changed +- $ssl_certs_dir default to `undef` for all platorms +- $ssl_verify_client must now be set to use any of the following: `$ssl_certs_dir`, `$ssl_ca`, `$ssl_crl_path`, `$ssl_crl`, `$ssl_verify_depth`, `$ssl_crl_check` + +#### Fixed +- **Issue where the $ssl_certs_dir default set Apache to implicitly trust all client certificates that were issued by any CA in that directory** ([MODULES-5471](https://tickets.puppet.com/browse/MODULES-5471)) + +## Supported Release [1.11.0] +### Summary +This release adds SLES12 Support and many more features and bugfixes. + +#### Features +- (MODULES-4049) Adds SLES 12 Support +- Adds additional directories options for LDAP Auth + - `auth_ldap_url` + - `auth_ldap_bind_dn` + - `auth_ldap_bind_password` + - `auth_ldap_group_attribute` + - `auth_ldap_group_attribute_is_dn` +- Allows `mod_event` parameters to be unset +- Allows management of default root directory access rights +- Adds class `apache::vhosts` to create apache::vhost resources +- Adds class `apache::mod::proxy_wstunnel` +- Adds class `apache::mod::dumpio` +- Adds class `apache::mod::socache_shmcb` +- Adds class `apache::mod::authn_dbd` +- Adds support for apache 2.4 on Amazon Linux +- Support the newer `mod_auth_cas` config options +- Adds `wsgi_script_aliases_match` parameter to `apache::vhost` +- Allow to override all SecDefaultAction attributes +- Add audit_log_relevant_status parameter to apache::mod::security +- Allow absolute path to $apache::mod::security::activated_rules +- Allow setting SecAuditLog +- Adds `passenger_max_instances_per_app` to `mod::passenger` +- Allow the proxy_via setting to be configured +- Allow no_proxy_uris to be used within proxy_pass +- Add rpaf.conf template parameter to `mod::rpaf` +- Allow user to specify alternative package and library names for shibboleth module +- Allows configuration of shibboleth lib path +- Adds parameter `passenger_data_buffer_dir` to `mod::passenger` +- Adds SSL stapling +- Allows use of `balance_manager` with `mod_proxy_balancer` +- Raises lower bound of `stdlib` dependency to version 4.2 +- Adds support for Passenger repo on Amazon Linux +- Add ability to set SSLStaplingReturnResponderErrors on server level +- (MODULES-4213) Allow global rewrite rules inheritance in vhosts +- Moves `mod_env` to its own class and load it when required + +#### Bugfixes +- Deny access to .ht and .hg, which are created by mercurial hg. +- Instead of failing, include apache::mod::prefork in manifests/mod/itk.pp instead. +- Only set SSLCompression when it is set to true. +- Remove duplicate shib2 hash element +- (MODULES-3388) Include mpm_module classes instead of class declaration +- Updates `apache::balancer` to respect `apache::confd_dir` +- Wrap mod_security directives in an IfModule +- Fixes to various mods for Ubuntu Xenial +- Fix /etc/modsecurity perms to match package +- Fix PassengerRoot under Debian stretch +- (MODULES-3476) Updates regex in apache_version custom fact to work with EL5 +- Dont sql_injection_attacks.data +- Add force option to confd file resource to purge directory without warnings +- Patch httpoxy through mod_security +- Fixes config ordering of IncludeOptional +- Fixes bug where port numbers were unquoted +- Fixes bug where empty servername for vhost were written to template +- Auto-load `slotmem_shm` and `lbmethod_byrequests` with `proxy_balancer` on 2.4 +- Simplify MPM setup on FreeBSD +- Adds requirement for httpd package +- Do not set ssl_certs_dir on FreeBSD +- Fixes bug that produces a duplicate `Listen 443` after a package update on EL7 +- Fixes bug where custom facts break structured facts +- Avoid relative classname inclusion +- Fixes a failure in `vhost` if the first element of `$rewrites` is not a hash +- (MODULES-3744) Process $crs_package before $modsec_dir +- (MODULES-1491) Adds `::apache` include to mods that need it + +## Supported Release [1.10.0] +#### Summary +This release fixes backwards compatibility bugs introduced in 1.9.0. Also includes a new mod class and a new vhost feature. + +#### Features +- Allow setting KeepAlive related options per vhost + - `apache::vhost::keepalive` + - `apache::vhost::keepalive_timeout` + - `apache::vhost::max_keepalive_requests` +- Adds new class `apache::mod::cluster` + +#### Bugfixes +- MODULES-2890: Allow php_version != 5 +- MODULES-2890: mod::php: Explicit test on jessie +- MODULES-2890: Fix PHP on Debian stretch and Ubuntu Xenial +- MODULES-2890: Fix mod_php SetHandler and cleanup +- Fixed trailing slash in lib_path on Suse +- Revert "MODULES-2956: Enable options within location block on proxy_match". Bug introduced in release 1.9.0. +- Revert "changed rpaf Configuration Directives: RPAF -> RPAF_". Bug introduced in release 1.9.0. +- Set actual path to apachectl on FreeBSD. Fixes snippets verification. + +## Supported Release [1.9.0] [DELETED] +#### Features +- Added `apache_version` fact +- Added `apache::balancer::target` attribute +- Added `apache::fastcgi::server::pass_header` attribute +- Added ability for `apache::fastcgi::server::host` using sockets +- Added `apache::root_directory_options` attribute +- Added for `apache::mod::ldap`: + - `ldap_shared_cache_size` + - `ldap_cache_entries` + - `ldap_cache_ttl` + - `ldap_opcache_entries` + - `ldap_opcache_ttl` +- Added `apache::mod::pagespeed::package_ensure` attribute +- Added `apache::mod::passenger` attributes: + - `passenger_log_level` + - `manage_repo` +- Added upstream repo for `apache::mod::passenger` +- Added `apache::mod::proxy_fcgi` class +- Added `apache::mod::security` attributes: + - `audit_log_parts` + - `secpcrematchlimit` + - `secpcrematchlimitrecursion` + - `secdefaultaction` + - `anomaly_score_blocking` + - `inbound_anomaly_threshold` + - `outbound_anomaly_threshold` +- Added `apache::mod::ssl` attributes: + - `ssl_mutex` + - `apache_version` +- Added ubuntu 16.04 support +- Added `apache::mod::authnz_ldap::package_name` attribute +- Added `apache::mod::ldap::package_name` attribute +- Added `apache::mod::proxy::package_name` attribute +- Added `apache::vhost` attributes: + - `ssl_proxy_check_peen_expire` + - `ssl_proxy_protocol` + - `logroot_owner` + - `logroot_group` + - `setenvifnocase` + - `passenger_user` + - `passenger_high_performance` + - `jk_mounts` + - `fastcgi_idle_timeout` + - `modsec_disable_msgs` + - `modsec_disable_tags` +- Added ability for 2.4-style `RequireAll|RequireNone|RequireAny` directory permissions +- Added ability for includes in vhost directory +- Added directory values: + - `AuthMerging` + - `MellonSPMetadataFile` +- Adds Configurability of Collaborative Detection Severity Levels for OWASP Core Rule Set to `apache::mod::security` class + - `critical_anomaly_score` + - `error_anomaly_score` + - `warning_anomaly_score` + - `notice_anomaly_score` +- Adds ability to configure `info_path` in `apache::mod::info` class +- Adds ability to configure `verify_config` in `apache::vhost::custom` + +#### Bugfixes +- Fixed apache mod setup for event/worker failing syntax +- Fixed concat deprecation warnings +- Fixed pagespeed mod +- Fixed service restart on mod update +- Fixed mod dir purging to happen after package installs +- Fixed various `apache::mod::*` file modes +- Fixed `apache::mod::authnz_ldap` parameter `verifyServerCert` to be `verify_server_cert` +- Fixed loadfile name in `apache::mod::fcgid` +- Fixed `apache::mod::remoteip` to fail on apache < 2.4 (because it is not available) +- Fixed `apache::mod::ssl::ssl_honorcipherorder` interpolation +- Lint fixes +- Strict variable fixes +- Fixed `apache::vhost` attribute `redirectmatch_status` to be optional +- Fixed SSLv3 on by default in mod\_nss +- Fixed mod\_rpaf directive names in template +- Fixed mod\_worker needing MaxClients with ThreadLimit +- Fixed quoting on vhost php\_value +- Fixed xml2enc for proxy\_html on debian +- Fixed a problem where the apache service restarts too fast + +## Supported Release [1.8.1] +### Summary +This release includes bug fixes and a documentation update. + +#### Bugfixes +- Fixes a bug that occurs when using the module in combination with puppetlabs-concat 2.x. +- Fixes a bug where passenger.conf was vulnerable to purging. +- Removes the pin of the concat module dependency. + +## Supported Release [1.8.0] +### Summary +This release includes a lot of bug fixes and feature updates, including support for Debian 8, as well as many test improvements. + +#### Features +- Debian 8 Support. +- Added the 'file_mode' property to allow a custom permission setting for config files. +- Enable 'PassengerMaxRequestQueueSize' to be set for mod_passenger. +- MODULES-2956: Enable options within location block on proxy_match. +- Support itk on redhat. +- Support the mod_ssl SSLProxyVerify directive. +- Support ProxPassReverseCookieDomain directive (mod_proxy). +- Support proxy provider for vhost directories. +- Added new 'apache::vhost::custom' resource. + +#### Bugfixes +- Fixed ProxyPassReverse configuration. +- Fixed error in Amazon operatingsystem detection. +- Fixed mod_security catalog ordering issues for RedHat 7. +- Fixed paths and packages for the shib2 apache module on Debian pre Jessie. +- Fixed EL7 directory path for apache modules. +- Fixed validation error when empty array is passed for the rewrites parameter. +- Idempotency fixes with regards to '::apache::mod_enable_dir'. +- ITK fixes. +- (MODULES-2865) fix $mpm_module logic for 'false'. +- Set SSLProxy directives even if ssl is false, due to issue with RewriteRules and ProxyPass directives. +- Enable setting LimitRequestFieldSize globally, and remove it from vhost. + +#### Improvements +- apache::mod::php now uses FilesMatch to configure the php handler. This is following the recommended upstream configuration guidelines (http://php.net/manual/en/install.unix.apache2.php#example-20) and distribution's default config (e.g.: http://bazaar.launchpad.net/~ubuntu-branches/ubuntu/vivid/php5/vivid/view/head:/debian/php5.conf). It avoids inadvertently exposing the PHP handler to executing uploads with names like 'file.php.jpg', but might impact setups with unusual requirements. +- Improved compatibility for Gentoo. +- Vhosts can now be supplied with a wildcard listen value. +- Numerous test improvements. +- Removed workarounds for https://bz.apache.org/bugzilla/show_bug.cgi?id=38864 as the issues have been fixed in Apache. +- Documentation updates. +- Ensureed order of ProxyPass and ProxyPassMatch parameters. +- Ensure that ProxyPreserveHost is set to off mode explicitly if not set in manifest. +- Put headers and request headers before proxy with regards to template generation. +- Added X-Forwarded-For into log_formats defaults. +- (MODULES-2703) Allow mod pagespeed to take an array of lines as additional_configuration. + +## Supported Release [1.7.1] +###Summary + +Small release for support of newer PE versions. This increments the version of PE in the metadata.json file. + +## Supported Release [1.7.0] +### Summary +This release includes many new features and bugfixes. There are test, documentation and misc improvements. + +#### Features +- allow groups with - like vhost-users +- ability to enable/disable the secruleengine through a parameter +- add mod_auth_kerb parameters to vhost +- client auth for reverse proxy +- support for mod_auth_mellon +- change SSLProtocol in apache::vhost to be space separated +- RewriteLock support + +#### Bugfixes +- fix apache::mod::cgid so it can be used with the event MPM +- load unixd before fcgid on all operating systems +- fixes conditional in vhost aliases +- corrects mod_cgid worker/event defaults +- ProxyPassMatch parameters were ending up on a newline +- catch that mod_authz_default has been removed in Apache 2.4 +- mod::ssl fails on SLES +- fix typo of MPM_PREFORK for FreeBSD package install +- install all modules before adding custom configs +- fix acceptance testing for SSLProtocol behaviour for real +- fix ordering issue with conf_file and ports_file + +#### Known Issues +- mod_passenger is having issues installing on Redhat/Centos 6, This is due to package dependency issues. + +#### Improvements +- added docs for forcetype directive +- removes ruby 1.8.7 from the travisci test matrix +- readme reorganisation, minor fixups +- support the mod_proxy ProxyPassReverseCookiePath directive +- the purge_vhost_configs parameter is actually called purge_vhost_dir +- add ListenBacklog for mod worker +- deflate application/json by default +- install mod_authn_alias as default mod in debian for apache < 2.4 +- optionally set LimitRequestFieldSize on an apache::vhost +- add SecUploadDir parameter to support file uploads with mod_security +- optionally set parameters for mod_ext_filter module +- allow SetOutputFilter to be set on a directory +- RC4 is deprecated +- allow empty docroot +- add option to configure the include pattern for the vhost_enable dir +- allow multiple IP addresses per vhost +- default document root update for Ubuntu 14.04 and Debian 8 + +## Supported Release [1.6.0] +### Summary +This release includes a couple of new features, along with test and documentation updates, and support for the latest AIO puppet builds. + +#### Features +- Add `scan_proxy_header_field` parameter to `apache::mod::geoip` +- Add `ssl_openssl_conf_cmd` parameter to `apache::vhost` and `apache::mod::ssl` +- Add `filters` parameter to `apache::vhost` + +#### Bugfixes +- Test updates +- Do not use systemd on Amazon Linux +- Add missing docs for `timeout` parameter (MODULES-2148) + +## Supported Release [1.5.0] +### Summary +This release primarily adds Suse compatibility. It also adds a handful of other +parameters for greater configuration control. + +#### Features +- Add `apache::lib_path` parameter +- Add `apache::service_restart` parameter +- Add `apache::vhost::geoip_enable` parameter +- Add `apache::mod::geoip` class +- Add `apache::mod::remoteip` class +- Add parameters to `apache::mod::expires` class +- Add `index_style_sheet` handling to `apache::vhost::directories` +- Add some compatibility for SLES 11 +- Add `apache::mod::ssl::ssl_sessioncachetimeout` parameter +- Add `apache::mod::ssl::ssl_cryptodevice` parameter +- Add `apache::mod::ssl::ssl_honorcipherorder` parameter +- Add `apache::mod::userdir::options` parameter + +#### Bugfixes +- Document `apache::user` parameter +- Document `apache::group` parameter +- Fix apache::dev on FreeBSD +- Fix proxy\_connect on apache >= 2.2 +- Validate log levels better +- Fix `apache::apache_name` for package and vhost +- Fix Debian Jessie mod\_prefork package name +- Fix alias module being declared even when vhost is absent +- Fix proxy\_pass\_match handling in vhost's proxy template +- Fix userdir access permissions +- Fix issue where the module was trying to use systemd on Amazon Linux. + +## Supported Release [1.4.1] + +This release corrects a metadata issue that has been present since release 1.2.0. The refactoring of `apache::vhost` to use `puppetlabs-concat` requires a version of concat newer than the version required in PE. If you are using PE 3.3.0 or earlier you will need to use version 1.1.1 or earlier of the `puppetlabs-apache` module. + +## Supported Release [1.4.0] +###Summary + +This release fixes the issue where the docroot was still managed even if the default vhosts were disabled and has many other features and bugfixes including improved support for 'deny' and 'require' as arrays in the 'directories' parameter under `apache::vhost` + +#### Features +- New parameters to `apache` + - `default_charset` + - `default_type` +- New parameters to `apache::vhost` + - `proxy_error_override` + - `passenger_app_env` (MODULES-1776) + - `proxy_dest_match` + - `proxy_dest_reverse_match` + - `proxy_pass_match` + - `no_proxy_uris_match` +- New parameters to `apache::mod::passenger` + - `passenger_app_env` + - `passenger_min_instances` +- New parameter to `apache::mod::alias` + - `icons_options` +- New classes added under `apache::mod::*` + - `authn_file` + - `authz_default` + - `authz_user` +- Added support for 'deny' as an array in 'directories' under `apache::vhost` +- Added support for RewriteMap +- Improved support for FreeBSD. (Note: If using apache < 2.4.12, see the discussion [here](https://github.com/puppetlabs/puppetlabs-apache/pull/1030)) +- Added check for deprecated options in directories and fail when they are unsupported +- Added gentoo compatibility +- Added proper array support for `require` in the `directories` parameter in `apache::vhost` +- Added support for `setenv` inside proxy locations + +### Bugfixes +- Fix issue in `apache::vhost` that was preventing the scriptalias fragment from being included (MODULES-1784) +- Install required `mod_ldap` package for EL7 (MODULES-1779) +- Change default value of `maxrequestworkers` in `apache::mod::event` to be a multiple of the default `ThreadsPerChild` of 25. +- Use the correct `mod_prefork` package name for trusty and jessie +- Don't manage docroot when default vhosts are disabled +- Ensure resources notify `Class['Apache::Service']` instead of `Service['httpd']` (MODULES-1829) +- Change the loadfile name for `mod_passenger` so `mod_proxy` will load by default before `mod_passenger` +- Remove old Debian work-around that removed `passenger_extra.conf` + +## Supported Release [1.3.0] +### Summary + +This release has many new features and bugfixes, including the ability to optionally not trigger service restarts on config changes. + +#### Features +- New parameters - `apache` + - `service_manage` + - `use_optional_includes` +- New parameters - `apache::service` + - `service_manage` +- New parameters - `apache::vhost` + - `access_logs` + - `php_flags` + - `php_values` + - `modsec_disable_vhost` + - `modsec_disable_ids` + - `modsec_disable_ips` + - `modsec_body_limit` +- Improved FreeBSD support +- Add ability to omit priority prefix if `$priority` is set to false +- Add `apache::security::rule_link` define +- Improvements to `apache::mod::*` + - Add `apache::mod::auth_cas` class + - Add `threadlimit`, `listenbacklog`, `maxrequestworkers`, `maxconnectionsperchild` parameters to `apache::mod::event` + - Add `apache::mod::filter` class + - Add `root_group` to `apache::mod::php` + - Add `apache::mod::proxy_connect` class + - Add `apache::mod::security` class + - Add `ssl_pass_phrase_dialog` and `ssl_random_seed_bytes` parameters to `apache::mod::ssl` (MODULES-1719) + - Add `status_path` parameter to `apache::mod::status` + - Add `apache_version` parameter to `apache::mod::version` + - Add `package_name` and `mod_path` parameters to `apache::mod::wsgi` (MODULES-1458) +- Improved SCL support + - Add support for specifying the docroot +- Updated `_directories.erb` to add support for SetEnv +- Support multiple access log directives (MODULES-1382) +- Add passenger support for Debian Jessie +- Add support for not having puppet restart the apache service (MODULES-1559) + +#### Bugfixes +- For apache 2.4 `mod_itk` requires `mod_prefork` (MODULES-825) +- Allow SSLCACertificatePath to be unset in `apache::vhost` (MODULES-1457) +- Load fcgid after unixd on RHEL7 +- Allow disabling default vhost for Apache 2.4 +- Test fixes +- `mod_version` is now built-in (MODULES-1446) +- Sort LogFormats for idempotency +- `allow_encoded_slashes` was omitted from `apache::vhost` +- Fix documentation bug (MODULES-1403, MODULES-1510) +- Sort `wsgi_script_aliases` for idempotency (MODULES-1384) +- lint fixes +- Fix automatic version detection for Debian Jessie +- Fix error docs and icons path for RHEL7-based systems (MODULES-1554) +- Sort php_* hashes for idempotency (MODULES-1680) +- Ensure `mod::setenvif` is included if needed (MODULES-1696) +- Fix indentation in `vhost/_directories.erb` template (MODULES-1688) +- Create symlinks on all distros if `vhost_enable_dir` is specified + +## Supported Release [1.2.0] +### Summary + +This release features many improvements and bugfixes, including several new defines, a reworking of apache::vhost for more extensibility, and many new parameters for more customization. This release also includes improved support for strict variables and the future parser. + +#### Features +- Convert apache::vhost to use concat for easier extensions +- Test improvements +- Synchronize files with modulesync +- Strict variable and future parser support +- Added apache::custom_config defined type to allow validation of configs before they are created +- Added bool2httpd function to convert true/false to apache 'On' and 'Off'. Intended for internal use in the module. +- Improved SCL support + - allow overriding of the mod_ssl package name +- Add support for reverse_urls/ProxyPassReverse in apache::vhost +- Add satisfy directive in apache::vhost::directories +- Add apache::fastcgi::server defined type +- New parameters - apache + - allow_encoded_slashes + - apache_name + - conf_dir + - default_ssl_crl_check + - docroot + - logroot_mode + - purge_vhost_dir +- New parameters - apache::vhost + - add_default_charset + - allow_encoded_slashes + - logroot_ensure + - logroot_mode + - manage_docroot + - passenger_app_root + - passenger_min_instances + - passenger_pre_start + - passenger_ruby + - passenger_start_timeout + - proxy_preserve_host + - proxy_requests + - redirectmatch_dest + - ssl_crl_check + - wsgi_chunked_request + - wsgi_pass_authorization +- Add support for ScriptAlias and ScriptAliasMatch in the apache::vhost::aliases parameter +- Add support for rewrites in the apache::vhost::directories parameter +- If the service_ensure parameter in apache::service is set to anything other than true, false, running, or stopped, ensure will not be passed to the service resource, allowing for the service to not be managed by puppet +- Turn of SSLv3 by default +- Improvements to apache::mod* + - Add restrict_access parameter to apache::mod::info + - Add force_language_priority and language_priority parameters to apache::mod::negotiation + - Add threadlimit parameter to apache::mod::worker + - Add content, template, and source parameters to apache::mod::php + - Add mod_authz_svn support via the authz_svn_enabled parameter in apache::mod::dav_svn + - Add loadfile_name parameter to apache::mod + - Add apache::mod::deflate class + - Add options parameter to apache::mod::fcgid + - Add timeouts parameter to apache::mod::reqtimeout + - Add apache::mod::shib + - Add apache_version parameter to apache::mod::ldap + - Add magic_file parameter to apache::mod::mime_magic + - Add apache_version parameter to apache::mod::pagespeed + - Add passenger_default_ruby parameter to apache::mod::passenger + - Add content, template, and source parameters to apache::mod::php + - Add apache_version parameter to apache::mod::proxy + - Add loadfiles parameter to apache::mod::proxy_html + - Add ssl_protocol and package_name parameters to apache::mod::ssl + - Add apache_version parameter to apache::mod::status + - Add apache_version parameter to apache::mod::userdir + - Add apache::mod::version class + +#### Bugfixes +- Set osfamily defaults for wsgi_socket_prefix +- Support multiple balancermembers with the same url +- Validate apache::vhost::custom_fragment +- Add support for itk with mod_php +- Allow apache::vhost::ssl_certs_dir to not be set +- Improved passenger support for Debian +- Improved 2.4 support without mod_access_compat +- Support for more than one 'Allow from'-directive in _directories.erb +- Don't load systemd on Amazon linux based on CentOS6 with apache 2.4 +- Fix missing newline in ModPagespeed filter and memcached servers directive +- Use interpolated strings instead of numbers where required by future parser +- Make auth_require take precedence over default with apache 2.4 +- Lint fixes +- Set default for php_admin_flags and php_admin_values to be empty hash instead of empty array +- Correct typo in mod::pagespeed +- spec_helper fixes +- Install mod packages before dealing with the configuration +- Use absolute scope to check class definition in apache::mod::php +- Fix dependency loop in apache::vhost +- Properly scope variables in the inline template in apache::balancer +- Documentation clarification, typos, and formatting +- Set apache::mod::ssl::ssl_mutex to default for debian on apache >= 2.4 +- Strict variables fixes +- Add authn_core mode to Ubuntu trusty defaults +- Keep default loadfile for authz_svn on Debian +- Remove '.conf' from the site-include regexp for better Ubuntu/Debian support +- Load unixd before fcgid for EL7 +- Fix RedirectMatch rules +- Fix misleading error message in apache::version + +#### Known Bugs +* By default, the version of Apache that ships with Ubuntu 10.04 does not work with `wsgi_import_script`. +* SLES is unsupported. + +## Supported Release [1.1.1] +### Summary + +This release merely updates metadata.json so the module can be uninstalled and +upgraded via the puppet module command. + +## Supported Release [1.1.0] + +### Summary + +This release primarily focuses on extending the httpd 2.4 support, tested +through adding RHEL7 and Ubuntu 14.04 support. It also includes Passenger +4 support, as well as several new modules and important bugfixes. + +#### Features + +- Add support for RHEL7 and Ubuntu 14.04 +- More complete apache24 support +- Passenger 4 support +- Add support for max_keepalive_requests and log_formats parameters +- Add mod_pagespeed support +- Add mod_speling support +- Added several parameters for mod_passenger +- Added ssl_cipher parameter to apache::mod::ssl +- Improved examples in documentation +- Added docroot_mode, action, and suexec_user_group parameters to apache::vhost +- Add support for custom extensions for mod_php +- Improve proxy_html support for Debian + +#### Bugfixes + +- Remove NameVirtualHost directive for apache >= 2.4 +- Order proxy_set option so it doesn't change between runs +- Fix inverted SSL compression +- Fix missing ensure on concat::fragment resources +- Fix bad dependencies in apache::mod and apache::mod::mime + +#### Known Bugs +* By default, the version of Apache that ships with Ubuntu 10.04 does not work with `wsgi_import_script`. +* SLES is unsupported. + +## Supported Release [1.0.1] +### Summary + +This is a supported release. This release removes a testing symlink that can +cause trouble on systems where /var is on a seperate filesystem from the +modulepath. + +#### Features +#### Bugfixes +#### Known Bugs +* By default, the version of Apache that ships with Ubuntu 10.04 does not work with `wsgi_import_script`. +* SLES is unsupported. + +## Supported Release [1.0.0] +### Summary + +This is a supported release. This release introduces Apache 2.4 support for +Debian and RHEL based osfamilies. + +#### Features + +- Add apache24 support +- Add rewrite_base functionality to rewrites +- Updated README documentation +- Add WSGIApplicationGroup and WSGIImportScript directives + +#### Bugfixes + +- Replace mutating hashes with merge() for Puppet 3.5 +- Fix WSGI import_script and mod_ssl issues on Lucid + +#### Known Bugs +* By default, the version of Apache that ships with Ubuntu 10.04 does not work with `wsgi_import_script`. +* SLES is unsupported. + +--- + +## Supported Release [0.11.0] +### Summary: + +This release adds preliminary support for Windows compatibility and multiple rewrite support. + +#### Backwards-incompatible Changes: + +- The rewrite_rule parameter is deprecated in favor of the new rewrite parameter + and will be removed in a future release. + +#### Features: + +- add Match directive +- quote paths for windows compatibility +- add auth_group_file option to README.md +- allow AuthGroupFile directive for vhosts +- Support Header directives in vhost context +- Don't purge mods-available dir when separate enable dir is used +- Fix the servername used in log file name +- Added support for mod_include +- Remove index parameters. +- Support environment variable control for CustomLog +- added redirectmatch support +- Setting up the ability to do multiple rewrites and conditions. +- Convert spec tests to beaker. +- Support php_admin_(flag|value)s + +#### Bugfixes: + +- directories are either a Hash or an Array of Hashes +- Configure Passenger in separate .conf file on RH so PassengerRoot isn't lost +- (docs) Update list of `apache::mod::[name]` classes +- (docs) Fix apache::namevirtualhost example call style +- Fix $ports_file reference in apache::listen. +- Fix $ports_file reference in Namevirtualhost. + + +## Supported Release [0.10.0] +### Summary: + +This release adds FreeBSD osfamily support and various other improvements to some mods. + +#### Features: + +- Add suPHP_UserGroup directive to directory context +- Add support for ScriptAliasMatch directives +- Set SSLOptions StdEnvVars in server context +- No implicit entry for ScriptAlias path +- Add support for overriding ErrorDocument +- Add support for AliasMatch directives +- Disable default "allow from all" in vhost-directories +- Add WSGIPythonPath as an optional parameter to mod_wsgi. +- Add mod_rpaf support +- Add directives: IndexOptions, IndexOrderDefault +- Add ability to include additional external configurations in vhost +- need to use the provider variable not the provider key value from the directory hash for matches +- Support for FreeBSD and few other features +- Add new params to apache::mod::mime class +- Allow apache::mod to specify module id and path +- added $server_root parameter +- Add Allow and ExtendedStatus support to mod_status +- Expand vhost/_directories.pp directive support +- Add initial support for nss module (no directives in vhost template yet) +- added peruser and event mpms +- added $service_name parameter +- add parameter for TraceEnable +- Make LogLevel configurable for server and vhost +- Add documentation about $ip +- Add ability to pass ip (instead of wildcard) in default vhost files + +#### Bugfixes: + +- Don't listen on port or set NameVirtualHost for non-existent vhost +- only apply Directory defaults when provider is a directory +- Working mod_authnz_ldap support on Debian/Ubuntu + +## Supported Release [0.9.0] +### Summary: +This release adds more parameters to the base apache class and apache defined +resource to make the module more flexible. It also adds or enhances SuPHP, +WSGI, and Passenger mod support, and support for the ITK mpm module. + +#### Backwards-incompatible Changes: +- Remove many default mods that are not normally needed. +- Remove `rewrite_base` `apache::vhost` parameter; did not work anyway. +- Specify dependencies on stdlib >=2.4.0 (this was already the case, but +making explicit) +- Deprecate `a2mod` in favor of the `apache::mod::*` classes and `apache::mod` +defined resource. + +#### Features: +- `apache` class + - Add `httpd_dir` parameter to change the location of the configuration + files. + - Add `logroot` parameter to change the logroot + - Add `ports_file` parameter to changes the `ports.conf` file location + - Add `keepalive` parameter to enable persistent connections + - Add `keepalive_timeout` parameter to change the timeout + - Update `default_mods` to be able to take an array of mods to enable. +- `apache::vhost` + - Add `wsgi_daemon_process`, `wsgi_daemon_process_options`, + `wsgi_process_group`, and `wsgi_script_aliases` parameters for per-vhost + WSGI configuration. + - Add `access_log_syslog` parameter to enable syslogging. + - Add `error_log_syslog` parameter to enable syslogging of errors. + - Add `directories` hash parameter. Please see README for documentation. + - Add `sslproxyengine` parameter to enable SSLProxyEngine + - Add `suphp_addhandler`, `suphp_engine`, and `suphp_configpath` for + configuring SuPHP. + - Add `custom_fragment` parameter to allow for arbitrary apache + configuration injection. (Feature pull requests are prefered over using + this, but it is available in a pinch.) +- Add `apache::mod::suphp` class for configuring SuPHP. +- Add `apache::mod::itk` class for configuring ITK mpm module. +- Update `apache::mod::wsgi` class for global WSGI configuration with +`wsgi_socket_prefix` and `wsgi_python_home` parameters. +- Add README.passenger.md to document the `apache::mod::passenger` usage. +Added `passenger_high_performance`, `passenger_pool_idle_time`, +`passenger_max_requests`, `passenger_stat_throttle_rate`, `rack_autodetect`, +and `rails_autodetect` parameters. +- Separate the httpd service resource into a new `apache::service` class for +dependency chaining of `Class['apache'] -> ~> +Class['apache::service']` +- Added `apache::mod::proxy_balancer` class for `apache::balancer` + +#### Bugfixes: +- Change dependency to puppetlabs-concat +- Fix ruby 1.9 bug for `a2mod` +- Change servername to be `$::hostname` if there is no `$::fqdn` +- Make `/etc/ssl/certs` the default ssl certs directory for RedHat non-5. +- Make `php` the default php package for RedHat non-5. +- Made `aliases` able to take a single alias hash instead of requiring an +array. + +## Supported Release [0.8.1] +#### Bugfixes: +- Update `apache::mpm_module` detection for worker/prefork +- Update `apache::mod::cgi` and `apache::mod::cgid` detection for +worker/prefork + +## Supported Release [0.8.0] +#### Features: +- Add `servername` parameter to `apache` class +- Add `proxy_set` parameter to `apache::balancer` define + +#### Bugfixes: +- Fix ordering for multiple `apache::balancer` clusters +- Fix symlinking for sites-available on Debian-based OSs +- Fix dependency ordering for recursive confdir management +- Fix `apache::mod::*` to notify the service on config change +- Documentation updates + +## Supported Release [0.7.0] +#### Changes: +- Essentially rewrite the module -- too many to list +- `apache::vhost` has many abilities -- see README.md for details +- `apache::mod::*` classes provide httpd mod-loading capabilities +- `apache` base class is much more configurable + +#### Bugfixes: +- Many. And many more to come + +## Supported Release [0.6.0] +- update travis tests (add more supported versions) +- add access log_parameter +- make purging of vhost dir configurable + +## Supported Release [0.4.0] +#### Changes: +- `include apache` is now required when using `apache::mod::*` + +#### Bugfixes: +- Fix syntax for validate_re +- Fix formatting in vhost template +- Fix spec tests such that they pass + +## Supported Release [0.0.4] +* e62e362 Fix broken tests for ssl, vhost, vhost::* +* 42c6363 Changes to match style guide and pass puppet-lint without error +* 42bc8ba changed name => path for file resources in order to name namevar by it's name +* 72e13de One end too much +* 0739641 style guide fixes: 'true' <> true, $operatingsystem needs to be $::operatingsystem, etc. +* 273f94d fix tests +* a35ede5 (#13860) Make a2enmod/a2dismo commands optional +* 98d774e (#13860) Autorequire Package['httpd'] +* 05fcec5 (#13073) Add missing puppet spec tests +* 541afda (#6899) Remove virtual a2mod definition +* 976cb69 (#13072) Move mod python and wsgi package names to params +* 323915a (#13060) Add .gitignore to repo +* fdf40af (#13060) Remove pkg directory from source tree +* fd90015 Add LICENSE file and update the ModuleFile +* d3d0d23 Re-enable local php class +* d7516c7 Make management of firewalls configurable for vhosts +* 60f83ba Explicitly lookup scope of apache_name in templates. +* f4d287f (#12581) Add explicit ordering for vdir directory +* 88a2ac6 (#11706) puppetlabs-apache depends on puppetlabs-firewall +* a776a8b (#11071) Fix to work with latest firewall module +* 2b79e8b (#11070) Add support for Scientific Linux +* 405b3e9 Fix for a2mod +* 57b9048 Commit apache::vhost::redirect Manifest +* 8862d01 Commit apache::vhost::proxy Manifest +* d5c1fd0 Commit apache::mod::wsgi Manifest +* a825ac7 Commit apache::mod::python Manifest +* b77062f Commit Templates +* 9a51b4a Vhost File Declarations +* 6cf7312 Defaults for Parameters +* 6a5b11a Ensure installed +* f672e46 a2mod fix +* 8a56ee9 add pthon support to apache + +[3.2.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/3.1.0...3.2.0 +[3.1.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/3.0.0...3.1.0 +[3.0.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/2.3.1...3.0.0 +[2.3.1]:https://github.com/puppetlabs/puppetlabs-apache/compare/2.3.0...2.3.1 +[2.3.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/2.2.0...2.3.0 +[2.2.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/2.1.0...2.2.0 +[2.1.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/2.0.0...2.1.0 +[2.0.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.11.0...2.0.0 +[1.11.1]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.11.0...1.11.1 +[1.11.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.10.0...1.11.0 +[1.10.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.9.0...1.10.0 +[1.9.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.8.1...1.9.0 +[1.8.1]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.8.0...1.8.1 +[1.8.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.7.1...1.8.0 +[1.7.1]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.7.0...1.7.1 +[1.7.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.6.0...1.7.0 +[1.6.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.5.0...1.6.0 +[1.5.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.4.1...1.5.0 +[1.4.1]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.4.0...1.4.1 +[1.4.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.3.0...1.4.0 +[1.3.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.2.0...1.3.0 +[1.2.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.1.1...1.2.0 +[1.1.1]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.1.0...1.1.1 +[1.1.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.0.1...1.1.0 +[1.0.1]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.0.0...1.0.1 +[1.0.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/0.11.0...1.0.0 +[0.11.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.10.0...0.11.0 +[0.10.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.9.0...0.10.0 +[0.9.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/1.8.1...0.9.0 +[0.8.1]:https://github.com/puppetlabs/puppetlabs-apache/compare/0.8.0...0.8.1 +[0.8.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/0.7.0...0.8.0 +[0.7.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/0.6.0...0.7.0 +[0.6.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/0.5.0-rc1...0.6.0 +[0.5.0-rc1]:https://github.com/puppetlabs/puppetlabs-apache/compare/0.4.0...0.5.0-rc1 +[0.4.0]:https://github.com/puppetlabs/puppetlabs-apache/compare/0.3.0...0.4.0 +[0.0.4]:https://github.com/puppetlabs/puppetlabs-apache/commits/0.0.4 diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/MAINTAINERS.md b/modules/services/unix/http/apache_stretch_compatible/apache/MAINTAINERS.md deleted file mode 100644 index 18a33881e..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/MAINTAINERS.md +++ /dev/null @@ -1,6 +0,0 @@ -## Maintenance - -Maintainers: - - Puppet Forge Modules Team `forge-modules |at| puppet |dot| com` - -Tickets: https://tickets.puppet.com/browse/MODULES. Make sure to set component to `apache`. diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/NOTICE b/modules/services/unix/http/apache_stretch_compatible/apache/NOTICE index 77c13089a..0bd06041e 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/NOTICE +++ b/modules/services/unix/http/apache_stretch_compatible/apache/NOTICE @@ -1,6 +1,6 @@ Puppet Module - puppetlabs-apache -Copyright 2017 Puppet, Inc. +Copyright 2018 Puppet, Inc. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/README.md b/modules/services/unix/http/apache_stretch_compatible/apache/README.md index 90f4a7094..481cda31b 100755 --- a/modules/services/unix/http/apache_stretch_compatible/apache/README.md +++ b/modules/services/unix/http/apache_stretch_compatible/apache/README.md @@ -19,17 +19,11 @@ [apache affects]: #what-the-apache-module-affects [Reference]: #reference -[Public classes]: #public-classes -[Private classes]: #private-classes -[Public defined types]: #public-defined-types -[Private defined types]: #private-defined-types -[Templates]: #templates [Limitations]: #limitations [Development]: #development [Contributing]: #contributing -[Testing]: #testing [`AddDefaultCharset`]: https://httpd.apache.org/docs/current/mod/core.html#adddefaultcharset [`add_listen`]: #add_listen @@ -50,12 +44,15 @@ [`apache::mod::authn_dbd`]: #class-apachemodauthn_dbd [`apache::mod::authnz_ldap`]: #class-apachemodauthnz_ldap [`apache::mod::cluster`]: #class-apachemodcluster +[`apache::mod::data]: #class-apachemoddata [`apache::mod::disk_cache`]: #class-apachemoddisk_cache [`apache::mod::dumpio`]: #class-apachemoddumpio [`apache::mod::event`]: #class-apachemodevent [`apache::mod::ext_filter`]: #class-apachemodext_filter [`apache::mod::geoip`]: #class-apachemodgeoip +[`apache::mod::http2`]: #class-apachemodhttp2 [`apache::mod::itk`]: #class-apachemoditk +[`apache::mod::jk`]: #class-apachemodjk [`apache::mod::ldap`]: #class-apachemodldap [`apache::mod::passenger`]: #class-apachemodpassenger [`apache::mod::peruser`]: #class-apachemodperuser @@ -64,10 +61,12 @@ [`apache::mod::proxy_balancer`]: #class-apachemodproxybalancer [`apache::mod::proxy_fcgi`]: #class-apachemodproxy_fcgi [`apache::mod::proxy_html`]: #class-apachemodproxy_html +[`apache::mod::python`]: #class-apachemodpython [`apache::mod::security`]: #class-apachemodsecurity [`apache::mod::shib`]: #class-apachemodshib [`apache::mod::ssl`]: #class-apachemodssl [`apache::mod::status`]: #class-apachemodstatus +[`apache::mod::userdir`]: #class-apachemoduserdir [`apache::mod::worker`]: #class-apachemodworker [`apache::mod::wsgi`]: #class-apachemodwsgi [`apache::params`]: #class-apacheparams @@ -88,6 +87,7 @@ [common gateway interface]: https://httpd.apache.org/docs/current/howto/cgi.html [`confd_dir`]: #confd_dir [`content`]: #content +[CONTRIBUTING.md]: CONTRIBUTING.md [custom error documents]: https://httpd.apache.org/docs/current/custom-error.html [`custom_fragment`]: #custom_fragment @@ -129,6 +129,7 @@ [Hash]: https://docs.puppet.com/puppet/latest/reference/lang_data_hash.html [`HttpProtocolOptions`]: http://httpd.apache.org/docs/current/mod/core.html#httpprotocoloptions +[IAC Team]: https://puppetlabs.github.io/iac/ [`IncludeOptional`]: https://httpd.apache.org/docs/current/mod/core.html#includeoptional [`Include`]: https://httpd.apache.org/docs/current/mod/core.html#include [interval syntax]: https://httpd.apache.org/docs/current/mod/mod_expires.html#AltSyn @@ -141,6 +142,7 @@ [`keepalive` parameter]: #keepalive [`keepalive_timeout`]: #keepalive_timeout [`limitreqfieldsize`]: https://httpd.apache.org/docs/current/mod/core.html#limitrequestfieldsize +[`limitreqfields`]: http://httpd.apache.org/docs/current/mod/core.html#limitrequestfields [`lib`]: #lib [`lib_path`]: #lib_path @@ -164,6 +166,7 @@ [`mod_alias`]: https://httpd.apache.org/docs/current/mod/mod_alias.html [`mod_auth_cas`]: https://github.com/Jasig/mod_auth_cas [`mod_auth_kerb`]: http://modauthkerb.sourceforge.net/configure.html +[`mod_auth_gssapi`]: https://github.com/modauthgssapi/mod_auth_gssapi [`mod_authnz_external`]: https://github.com/phokz/mod-auth-external [`mod_auth_dbd`]: http://httpd.apache.org/docs/current/mod/mod_authn_dbd.html [`mod_auth_mellon`]: https://github.com/UNINETT/mod_auth_mellon @@ -175,6 +178,7 @@ [`mod_ext_filter`]: https://httpd.apache.org/docs/current/mod/mod_ext_filter.html [`mod_fcgid`]: https://httpd.apache.org/mod_fcgid/mod/mod_fcgid.html [`mod_geoip`]: http://dev.maxmind.com/geoip/legacy/mod_geoip2/ +[`mod_http2`]: https://httpd.apache.org/docs/current/mod/mod_http2.html [`mod_info`]: https://httpd.apache.org/docs/current/mod/mod_info.html [`mod_ldap`]: https://httpd.apache.org/docs/2.2/mod/mod_ldap.html [`mod_mpm_event`]: https://httpd.apache.org/docs/current/mod/event.html @@ -185,6 +189,7 @@ [`mod_proxy`]: https://httpd.apache.org/docs/current/mod/mod_proxy.html [`mod_proxy_balancer`]: https://httpd.apache.org/docs/current/mod/mod_proxy_balancer.html [`mod_reqtimeout`]: https://httpd.apache.org/docs/current/mod/mod_reqtimeout.html +[`mod_python`]: http://modpython.org/ [`mod_rewrite`]: https://httpd.apache.org/docs/current/mod/mod_rewrite.html [`mod_security`]: https://www.modsecurity.org/ [`mod_ssl`]: https://httpd.apache.org/docs/current/mod/mod_ssl.html @@ -214,7 +219,7 @@ [Puppet Forge]: https://forge.puppet.com [Puppet]: https://puppet.com [Puppet module]: https://docs.puppet.com/puppet/latest/reference/modules_fundamentals.html -[Puppet module's code]: https://github.com/puppetlabs/puppetlabs-apache/blob/master/manifests/default_mods.pp +[Puppet module's code]: https://github.com/puppetlabs/puppetlabs-apache/blob/main/manifests/default_mods.pp [`purge_configs`]: #purge_configs [`purge_vhost_dir`]: #purge_vhost_dir [Python]: https://www.python.org/ @@ -259,6 +264,8 @@ [template]: http://docs.puppet.com/puppet/latest/reference/lang_template.html [`TraceEnable`]: https://httpd.apache.org/docs/current/mod/core.html#traceenable +[`UseCanonicalName`]: https://httpd.apache.org/docs/current/mod/core.html#usecanonicalname + [`verify_config`]: #verify_config [`vhost`]: #defined-type-apachevhost [`vhost_dir`]: #vhost_dir @@ -268,6 +275,8 @@ [`WSGIRestrictEmbedded`]: http://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIRestrictEmbedded.html [`WSGIPythonPath`]: http://modwsgi.readthedocs.org/en/develop/configuration-directives/WSGIPythonPath.html [`WSGIPythonHome`]: http://modwsgi.readthedocs.org/en/develop/configuration-directives/WSGIPythonHome.html +[`WSGIApplicationGroup`]: https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIApplicationGroup.html +[`WSGIPythonOptimize`]: https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIPythonOptimize.html #### Table of Contents @@ -280,22 +289,19 @@ - [Configuring FastCGI servers to handle PHP files][Configuring FastCGI servers] - [Load balancing with exported and non-exported resources][Load balancing examples] 4. [Reference - An under-the-hood peek at what the module is doing and how][Reference] - - [Public classes][] - - [Private classes][] - - [Public defined types][] - - [Private defined types][] - - [Templates][] 5. [Limitations - OS compatibility, etc.][Limitations] 6. [Development - Guide for contributing to the module][Development] - [Contributing to the apache module][Contributing] - - [Running tests - A quick guide][Running tests] - + + ## Module description [Apache HTTP Server][] (also called Apache HTTPD, or simply Apache) is a widely used web server. This [Puppet module][] simplifies the task of creating configurations to manage Apache servers in your infrastructure. It can configure and manage a range of virtual host setups and provides a streamlined way to install and configure [Apache modules][]. + ## Setup + ### What the apache module affects: - Configuration files and directories (created and written to) @@ -312,6 +318,7 @@ On Gentoo, this module depends on the [`gentoo/puppet-portage`][] Puppet module. > >To temporarily disable full Puppet management, set the [`purge_configs`][] parameter in the [`apache`][] class declaration to false. We recommend this only as a temporary means of saving and relocating customized configurations. + ### Beginning with Apache To have Puppet install Apache with the default parameters, declare the [`apache`][] class: @@ -340,8 +347,10 @@ class { 'apache': > **Note**: When `default_vhost` is set to `false`, you have to add at least one `apache::vhost` resource or Apache will not start. To establish a default virtual host, either set the `default_vhost` in the `apache` class or use the [`apache::vhost`][] defined type. You can also configure additional specific virtual hosts with the [`apache::vhost`][] defined type. + ## Usage + ### Configuring virtual hosts The default [`apache`][] class sets up a virtual host on port 80, listening on all interfaces and serving the [`docroot`][] parameter's default directory of `/var/www`. @@ -358,7 +367,7 @@ apache::vhost { 'vhost.example.com': See the [`apache::vhost`][] defined type's reference for a list of all virtual host parameters. -> **Note**: Apache processes virtual hosts in alphabetical order, and server administrators can prioritize Apache's virtual host processing by prefixing a virtual host's configuration file name with a number. The [`apache::vhost`][] defined type applies a default [`priority`][] of 15, which Puppet interprets by prefixing the virtual host's file name with `15-`. This all means that if multiple sites have the same priority, or if you disable priority numbers by setting the `priority` parameter's value to false, Apache still processes virtual hosts in alphabetical order. +> **Note**: Apache processes virtual hosts in alphabetical order, and server administrators can prioritize Apache's virtual host processing by prefixing a virtual host's configuration file name with a number. The [`apache::vhost`][] defined type applies a default [`priority`][] of 25, which Puppet interprets by prefixing the virtual host's file name with `25-`. This means that if multiple sites have the same priority, or if you disable priority numbers by setting the `priority` parameter's value to false, Apache still processes virtual hosts in alphabetical order. To configure user and group ownership for `docroot`, use the [`docroot_owner`][] and [`docroot_group`][] parameters: @@ -615,7 +624,7 @@ apache::vhost { 'second.example.com': } ``` -You can also configure a mix of IP- and [name-based virtual hosts][] in any combination of [SSL][SSL encryption] and unencrypted configurations. +You can also configure a mix of IP- and [name-based virtual hosts][] in any combination of [SSL][SSL encryption] and unencrypted configurations. In this example, we add two IP-based virtual hosts on an IP address (in this example, 10.0.0.10). One uses SSL and the other is unencrypted: @@ -709,8 +718,31 @@ apache::mod { 'mod_authnz_external': } There are several optional parameters you can specify when defining Apache modules this way. See the [defined type's reference][`apache::mod`] for details. + ### Configuring FastCGI servers to handle PHP files +#### FastCGI on Ubuntu 18.04 + +On Ubuntu 18.04, `mod_fastcgi` is no longer supported. So considering: + +* an Apache Vhost with docroot set to `/var/www/html` +* a FastCGI server listening on `127.0.0.1:9000` + +you can then use the [`custom_fragment`][] parameter to configure the virtual host to have the FastCGI server handle the specified file type: + +``` puppet +apache::vhost { 'www': + ... + docroot => '/var/www/html/', + custom_fragment => 'ProxyPassMatch ^/(.*\.php)$ fcgi://127.0.0.1:9000/var/www/html/$1', + ... +} +``` + +Please note you have to adjust the second ProxyPassMatch parameter to you docroot value (here `/var/www/html/`). + +#### Other OSes + Add the [`apache::fastcgi::server`][] defined type to allow [FastCGI][] servers to handle requests for specific files. For example, the following defines a FastCGI server at 127.0.0.1 (localhost) on port 9000 to handle PHP requests: ``` puppet @@ -734,6 +766,7 @@ apache::vhost { 'www': } ``` + ### Load balancing examples Apache supports load balancing across groups of servers through the [`mod_proxy`][] Apache module. Puppet supports configuring Apache load balancing groups (also known as balancer clusters) through the [`apache::balancer`][] and [`apache::balancermember`][] defined types. @@ -781,4304 +814,23 @@ apache::balancer { 'puppet01': Load balancing scheduler algorithms (`lbmethod`) are listed [in mod_proxy_balancer documentation](https://httpd.apache.org/docs/current/mod/mod_proxy_balancer.html). + ## Reference -- [**Public classes**](#public-classes) - - [Class: apache](#class-apache) - - [Class: apache::dev](#class-apachedev) - - [Class: apache::vhosts](#class-apachevhosts) - - [Classes: apache::mod::\*](#classes-apachemodname) -- [**Private classes**](#private-classes) - - [Class: apache::confd::no_accf](#class-apacheconfdno_accf) - - [Class: apache::default_confd_files](#class-apachedefault_confd_files) - - [Class: apache::default_mods](#class-apachedefault_mods) - - [Class: apache::package](#class-apachepackage) - - [Class: apache::params](#class-apacheparams) - - [Class: apache::service](#class-apacheservice) - - [Class: apache::version](#class-apacheversion) -- [**Public defined types**](#public-defined-types) - - [Defined type: apache::balancer](#defined-type-apachebalancer) - - [Defined type: apache::balancermember](#defined-type-apachebalancermember) - - [Defined type: apache::custom_config](#defined-type-apachecustom_config) - - [Defined type: apache::fastcgi::server](#defined-type-fastcgi-server) - - [Defined type: apache::listen](#defined-type-apachelisten) - - [Defined type: apache::mod](#defined-type-apachemod) - - [Defined type: apache::namevirtualhost](#defined-type-apachenamevirtualhost) - - [Defined type: apache::vhost](#defined-type-apachevhost) - - [Defined type: apache::vhost::custom](#defined-type-apachevhostcustom) -- [**Private defined types**](#private-defined-types) - - [Defined type: apache::default_mods::load](#defined-type-default_mods-load) - - [Defined type: apache::peruser::multiplexer](#defined-type-apacheperusermultiplexer) - - [Defined type: apache::peruser::processor](#defined-type-apacheperuserprocessor) - - [Defined type: apache::security::file_link](#defined-type-apachesecurityfile_link) -- [**Templates**](#templates) - -### Public Classes - -#### Class: `apache` - -Guides the basic setup and installation of Apache on your system. - -When this class is declared with the default options, Puppet: - -- Installs the appropriate Apache software package and [required Apache modules](#default_mods) for your operating system. -- Places the required configuration files in a directory, with the [default location](#conf_dir) determined by your operating system. -- Configures the server with a default virtual host and standard port ('80') and address ('\*') bindings. -- Creates a document root directory determined by your operating system, typically `/var/www`. -- Starts the Apache service. - -You can simply declare the default `apache` class: - -``` puppet -class { 'apache': } -``` - -##### `allow_encoded_slashes` - -Sets the server default for the [`AllowEncodedSlashes`][] declaration, which modifies the responses to URLs containing '\' and '/' characters. If not specified, this parameter omits the declaration from the server's configuration and uses Apache's default setting of 'off'. - -Values: 'on', 'off', 'nodecode'. - -Default: `undef`. - -##### `apache_version` - -Configures module template behavior, package names, and default Apache modules by defining the version of Apache to use. We do not recommend manually configuring this parameter without reason. - -Default: Depends on operating system and release version detected by the [`apache::version`][] class. - -##### `conf_dir` - -Sets the directory where the Apache server's main configuration file is located. - -Default: Depends on operating system. - -- **Debian**: `/etc/apache2` -- **FreeBSD**: `/usr/local/etc/apache22` -- **Gentoo**: `/etc/apache2` -- **Red Hat**: `/etc/httpd/conf` - -##### `conf_template` - -Defines the [template][] used for the main Apache configuration file. Modifying this parameter is potentially risky, as the apache module is designed to use a minimal configuration file customized by `conf.d` entries. - -Default: `apache/httpd.conf.erb`. - -##### `confd_dir` - -Sets the location of the Apache server's custom configuration directory. - -Default: Depends on operating system. - -- **Debian**: `/etc/apache2/conf.d` -- **FreeBSD**: `/usr/local/etc/apache22` -- **Gentoo**: `/etc/apache2/conf.d` -- **Red Hat**: `/etc/httpd/conf.d` - -##### `default_charset` - -Used as the [`AddDefaultCharset`][] directive in the main configuration file. - -Default: `undef`. - -##### `default_confd_files` - -Determines whether Puppet generates a default set of includable Apache configuration files in the directory defined by the [`confd_dir`][] parameter. These configuration files correspond to what is typically installed with the Apache package on the server's operating system. - -Boolean. Default: `true`. - -##### `default_mods` - -Determines whether to configure and enable a set of default [Apache modules][] depending on your operating system. - -If `false`, Puppet includes only the Apache modules required to make the HTTP daemon work on your operating system, and you can declare any other modules separately using the [`apache::mod::`][] class or [`apache::mod`][] defined type. - -If `true`, Puppet installs additional modules, depending on the operating system and the values of [`apache_version`][] and [`mpm_module`][] parameters. Because these lists of modules can change frequently, consult the [Puppet module's code][] for up-to-date lists. - -If this parameter contains an array, Puppet instead enables all passed Apache modules. - -Values: Boolean or an array of Apache module names. - -Default: `true`. - -##### `default_ssl_ca` - -Sets the default certificate authority for the Apache server. - -Although the default value results in a functioning Apache server, you **must** update this parameter with your certificate authority information before deploying this server in a production environment. - -Boolean. Default: `undef`. - -##### `default_ssl_cert` - -Sets the [SSL encryption][] certificate location. - -Although the default value results in a functioning Apache server, you **must** update this parameter with your certificate location before deploying this server in a production environment. - -Default: Depends on operating system. - -- **Debian**: `/etc/ssl/certs/ssl-cert-snakeoil.pem` -- **FreeBSD**: `/usr/local/etc/apache22/server.crt` -- **Gentoo**: `/etc/ssl/apache2/server.crt` -- **Red Hat**: `/etc/pki/tls/certs/localhost.crt` - -##### `default_ssl_chain` - -Sets the default [SSL chain][] location. - -Although this default value results in a functioning Apache server, you **must** update this parameter with your SSL chain before deploying this server in a production environment. - -Default: `undef`. - -##### `default_ssl_crl` - -Sets the path of the default [certificate revocation list][] (CRL) file to use. - -Although this default value results in a functioning Apache server, you **must** update this parameter with the CRL file path before deploying this server in a production environment. You can use this parameter with or in place of the [`default_ssl_crl_path`][]. - -Default: `undef`. - -##### `default_ssl_crl_path` - -Sets the server's [certificate revocation list path][], which contains your CRLs. - -Although this default value results in a functioning Apache server, you **must** update this parameter with the CRL file path before deploying this server in a production environment. - -Default: `undef`. - -##### `default_ssl_crl_check` - -Sets the default certificate revocation check level via the [`SSLCARevocationCheck`][] directive. This parameter applies only to Apache 2.4 or higher and is ignored on older versions. - -Although this default value results in a functioning Apache server, you **must** specify this parameter when using certificate revocation lists in a production environment. - -Default: `undef`. - -##### `default_ssl_key` - -Sets the [SSL certificate key file][] location. - -Although the default values result in a functioning Apache server, you **must** update this parameter with your SSL key's location before deploying this server in a production environment. - -Default: Depends on operating system. - -- **Debian**: `/etc/ssl/private/ssl-cert-snakeoil.key` -- **FreeBSD**: `/usr/local/etc/apache22/server.key` -- **Gentoo**: `/etc/ssl/apache2/server.key` -- **Red Hat**: `/etc/pki/tls/private/localhost.key` - - -##### `default_ssl_vhost` - -Configures a default [SSL][SSL encryption] virtual host. - -If `true`, Puppet automatically configures the following virtual host using the [`apache::vhost`][] defined type: - -```puppet -apache::vhost { 'default-ssl': - port => 443, - ssl => true, - docroot => $docroot, - scriptalias => $scriptalias, - serveradmin => $serveradmin, - access_log_file => "ssl_${access_log_file}", - } -``` - -> **Note**: SSL virtual hosts only respond to HTTPS queries. - - -Boolean. Default: `false`. - -##### `default_type` - -_Apache 2.2 only_. Sets the [MIME `content-type`][] sent if the server cannot otherwise determine an appropriate `content-type`. This directive is deprecated in Apache 2.4 and newer, and is only for backwards compatibility in configuration files. - -Default: `undef`. - -##### `default_vhost` - -Configures a default virtual host when the class is declared. - -To configure [customized virtual hosts][Configuring virtual hosts], set this parameter's value to `false`. - -> **Note**: Apache will not start without at least one virtual host. If you set this to `false` you must configure a virtual host elsewhere. - -Boolean. Default: `true`. - -##### `dev_packages` - -Configures a specific dev package to use. - -Values: A string or array of strings. - -Example for using httpd 2.4 from the IUS yum repo: - -``` puppet -include ::apache::dev -class { 'apache': - apache_name => 'httpd24u', - dev_packages => 'httpd24u-devel', -} -``` - -Default: Depends on operating system. - -- **Red Hat:** 'httpd-devel' -- **Debian 8/Ubuntu 13.10 or newer:** ['libaprutil1-dev', 'libapr1-dev', 'apache2-dev'] -- **Older Debian/Ubuntu versions:** ['libaprutil1-dev', 'libapr1-dev', 'apache2-prefork-dev'] -- **FreeBSD, Gentoo:** `undef` -- **Suse:** ['libapr-util1-devel', 'libapr1-devel'] - -##### `docroot` - -Sets the default [`DocumentRoot`][] location. - -Default: Depends on operating system. - -- **Debian**: `/var/www/html` -- **FreeBSD**: `/usr/local/www/apache22/data` -- **Gentoo**: `/var/www/localhost/htdocs` -- **Red Hat**: `/var/www/html` - -##### `error_documents` - -Determines whether to enable [custom error documents][] on the Apache server. - -Boolean. Default: `false`. - -##### `group` - -Sets the group ID that owns any Apache processes spawned to answer requests. - -By default, Puppet attempts to manage this group as a resource under the `apache` class, determining the group based on the operating system as detected by the [`apache::params`][] class. To to prevent the group resource from being created and use a group created by another Puppet module, set the [`manage_group`][] parameter's value to `false`. - -> **Note**: Modifying this parameter only changes the group ID that Apache uses to spawn child processes to access resources. It does not change the user that owns the parent server process. - -##### `httpd_dir` - -Sets the Apache server's base configuration directory. This is useful for specially repackaged Apache server builds but might have unintended consequences when combined with the default distribution packages. - -Default: Depends on operating system. - -- **Debian**: `/etc/apache2` -- **FreeBSD**: `/usr/local/etc/apache22` -- **Gentoo**: `/etc/apache2` -- **Red Hat**: `/etc/httpd` - -##### http_protocol_options` - -Specifies the strictness of HTTP protocol checks. Valid options: any sequence of the following alternative values: `Strict` or `Unsafe`, `RegisteredMethods` or `LenientMethods`, and `Allow0.9` or `Require1.0`. Default '`Strict LenientMethods Allow0.9`'. - -##### `keepalive` - -Determines whether to enable persistent HTTP connections with the [`KeepAlive`][] directive. If you set this to 'On', use the [`keepalive_timeout`][] and [`max_keepalive_requests`][] parameters to set relevant options. - -Values: 'Off', 'On'. - -Default: 'Off'. - -##### `keepalive_timeout` - -Sets the [`KeepAliveTimeout`] directive, which determines the amount of time the Apache server waits for subsequent requests on a persistent HTTP connection. This parameter is only relevant if the [`keepalive` parameter][] is enabled. - -Default: '15'. - -##### `max_keepalive_requests` - -Limits the number of requests allowed per connection when the [`keepalive` parameter][] is enabled. - -Default: '100'. - -##### `lib_path` - -Specifies the location where [Apache module][Apache modules] files are stored. Default: Depends on operating system. - -- **Debian** and **Gentoo**: `/usr/lib/apache2/modules` -- **FreeBSD**: `/usr/local/libexec/apache24` -- **Red Hat**: `modules` - -> **Note**: Do not configure this parameter manually without special reason. - -##### `log_level` - -Changes the error log's verbosity. Values: 'alert', 'crit', 'debug', 'emerg', 'error', 'info', 'notice', 'warn'. - -Default: 'warn'. - -##### `log_formats` - -Define additional [`LogFormat`][] directives. Values: A [hash][], such as: - -``` puppet -$log_formats = { vhost_common => '%v %h %l %u %t \"%r\" %>s %b' } -``` - -There are a number of predefined `LogFormats` in the `httpd.conf` that Puppet creates: - -``` httpd -LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined -LogFormat "%h %l %u %t \"%r\" %>s %b" common -LogFormat "%{Referer}i -> %U" referer -LogFormat "%{User-agent}i" agent -LogFormat "%{X-Forwarded-For}i %l %u %t \"%r\" %s %b \"%{Referer}i\" \"%{User-agent}i\"" forwarded -``` - -If your `log_formats` parameter contains one of those, it will be overwritten with **your** definition. - -##### `logroot` - -Changes the directory of Apache log files for the virtual host. - -Default: Depends on operating system. - -- **Debian**: `/var/log/apache2` -- **FreeBSD**: `/var/log/apache22` -- **Gentoo**: `/var/log/apache2` -- **Red Hat**: `/var/log/httpd` - -##### `logroot_mode` - -Overrides the default [`logroot`][] directory's mode. - -> **Note**: Do _not_ grant write access to the directory where the logs are stored without being aware of the consequences. See the [Apache documentation][Log security] for details. - -Default: `undef`. - -##### `manage_group` - -When `false`, stops Puppet from creating the group resource. - -If you have a group created from another Puppet module that you want to use to run Apache, set this to `false`. Without this parameter, attempting to use a previously established group results in a duplicate resource error. - -Boolean. Default: `true`. - -##### `supplementary_groups` - -A list of groups to which the user belongs. These groups are in addition to the primary group. Default: No additional groups. - -Notice: This option only has an effect when `manage_user` is set to true. - -##### `manage_user` - -When `false`, stops Puppet from creating the user resource. - -This is for instances when you have a user, created from another Puppet module, you want to use to run Apache. Without this parameter, attempting to use a previously established user would result in a duplicate resource error. - -Boolean. Default: `true`. - -##### `mod_dir` - -Sets where Puppet places configuration files for your [Apache modules][]. - -Default: Depends on operating system. - -- **Debian**: `/etc/apache2/mods-available` -- **FreeBSD**: `/usr/local/etc/apache22/Modules` -- **Gentoo**: `/etc/apache2/modules.d` -- **Red Hat**: `/etc/httpd/conf.d` - -##### `mod_packages` - -Allows the user to override default module package names. - -```puppet -include apache::params -class { 'apache': - mod_packages => merge($::apache::params::mod_packages, { - 'auth_kerb' => 'httpd24-mod_auth_kerb', - }) -} -``` - -Hash. Default: `$apache::params::mod_packages` - -##### `mpm_module` - -Determines which [multi-processing module][] (MPM) is loaded and configured for the HTTPD process. Values: 'event', 'itk', 'peruser', 'prefork', 'worker', or `false`. - -You must set this to `false` to explicitly declare the following classes with custom parameters: - -- [`apache::mod::event`][] -- [`apache::mod::itk`][] -- [`apache::mod::peruser`][] -- [`apache::mod::prefork`][] -- [`apache::mod::worker`][] - -Default: Depends on operating system. - -- **Debian**: 'worker' -- **FreeBSD, Gentoo, and Red Hat**: 'prefork' - -##### `package_ensure` - -Controls the `package` resource's [`ensure`][] attribute. Values: 'absent', 'installed' (or equivalent 'present'), or a version string. - -Default: 'installed'. - -##### `pidfile` - -Allows settting a custom location for the pid file. Useful if using a custom-built Apache rpm. - -Default: Depends on operating system. - -- **Debian:** '\${APACHE_PID_FILE}' -- **FreeBSD:** '/var/run/httpd.pid' -- **Red Hat:** 'run/httpd.pid' - -##### `ports_file` - -Sets the path to the file containing Apache ports configuration. - -Default: '{$conf_dir}/ports.conf'. - -##### `purge_configs` - -Removes all other Apache configs and virtual hosts. - -Setting this to `false` is a stopgap measure to allow the apache module to coexist with existing or unmanaged configurations. We recommend moving your configuration to resources within this module. For virtual host configurations, see [`purge_vhost_dir`][]. - -Boolean. Default: `true`. - -##### `purge_vhost_dir` - -If the [`vhost_dir`][] parameter's value differs from the [`confd_dir`][] parameter's, this parameter determines whether Puppet removes any configurations inside `vhost_dir` that are _not_ managed by Puppet. - -Setting `purge_vhost_dir` to `false` is a stopgap measure to allow the apache module to coexist with existing or otherwise unmanaged configurations within `vhost_dir`. - -Boolean. Default: same as [`purge_configs`][]. - -##### `rewrite_lock` - -Allows setting a custom location for a rewrite lock - considered best practice if using a RewriteMap of type prg in the [`rewrites`][] parameter of your virtual host. This parameter only applies to Apache version 2.2 or lower and is ignored on newer versions. - -Default: `undef`. - -##### `sendfile` - -Forces Apache to use the Linux kernel's `sendfile` support to serve static files, via the [`EnableSendfile`][] directive. Values: 'On', 'Off'. - -Default: 'On'. - -##### `serveradmin` - -Sets the Apache server administrator's contact information via Apache's [`ServerAdmin`][] directive. - -Default: 'root@localhost'. - -##### `servername` - -Sets the Apache server name via Apache's [`ServerName`][] directive. - -Setting to `false` will not set ServerName at all. - -Default: the 'fqdn' fact reported by [Facter][]. - -##### `server_root` - -Sets the Apache server's root directory via Apache's [`ServerRoot`][] directive. - -Default: Depends on operating system. - -- **Debian**: `/etc/apache2` -- **FreeBSD**: `/usr/local` -- **Gentoo**: `/var/www` -- **Red Hat**: `/etc/httpd` - -##### `server_signature` - -Configures a trailing footer line to display at the bottom of server-generated documents, such as error documents and output of certain [Apache modules][], via Apache's [`ServerSignature`][] directive. Values: 'Off', 'On'. - -Default: 'On'. - -##### `server_tokens` - -Controls how much information Apache sends to the browser about itself and the operating system, via Apache's [`ServerTokens`][] directive. - -Default: 'OS'. - -##### `service_enable` - -Determines whether Puppet enables the Apache HTTPD service when the system is booted. - -Boolean. Default: `true`. - -##### `service_ensure` - -Determines whether Puppet should make sure the service is running. Values: `true` (or 'running'), `false` (or 'stopped'). - -The `false` or 'stopped' values set the 'httpd' service resource's `ensure` parameter to `false`, which is useful when you want to let the service be managed by another application, such as Pacemaker. - -Default: 'running'. - -##### `service_name` - -Sets the name of the Apache service. - -Default: Depends on operating system. - -- **Debian and Gentoo**: 'apache2' -- **FreeBSD**: 'apache22' -- **Red Hat**: 'httpd' - -##### `service_manage` - -Determines whether Puppet manages the HTTPD service's state. - -Boolean. Default: `true`. - -##### `service_restart` - -Determines whether Puppet should use a specific command to restart the HTTPD service. - -Values: a command to restart the Apache service. The default setting uses the [default Puppet behavior][Service attribute restart]. - -Default: `undef`. - -##### `ssl_ca` - -Specifies the SSL certificate authority. [SSLCACertificateFile](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslcacertificatefile). Default: undef. It is possible to override this on a vhost level. - - - - - - - - - - - - - - -##### `timeout` - -Sets Apache's [`TimeOut`][] directive, which defines the number of seconds Apache waits for certain events before failing a request. - -Default: 120. - -##### `trace_enable` - -Controls how Apache handles `TRACE` requests (per [RFC 2616][]) via the [`TraceEnable`][] directive. - -Values: 'Off', 'On'. - -Default: 'On'. - -##### `use_systemd` - -Controls whether the systemd module should be installed on Centos 7 servers, this is especially useful if using custom-built RPMs. - -Boolean. Default: `true`. - -##### `file_mode` - -Sets the desired permissions mode for config files. - -Values: A string, with permissions mode in symbolic or numeric notation. - -Default: '0644'. - -##### `root_directory_options` - -Array of the desired options for the / directory in httpd.conf. Defaults to 'FollowSymLinks'. - -##### `root_directory_secured` - -Sets the default access policy for the / directory in httpd.conf. A value of `false` allows access to all resources that are missing a more specific access policy. A value of `true` denies access to all resources by default. If `true`, more specific rules must be used to allow access to these resources (for example, in a directory block using the [`directories`](#parameter-directories-for-apachevhost) parameter). - -Boolean. Default: `false`. - -##### `vhost_dir` - -Changes your virtual host configuration files' location. - -Default: Depends on operating system: - -- **Debian**: `/etc/apache2/sites-available` -- **FreeBSD**: `/usr/local/etc/apache22/Vhosts` -- **Gentoo**: `/etc/apache2/vhosts.d` -- **Red Hat**: `/etc/httpd/conf.d` - -##### `vhost_include_pattern` - -Defines the pattern for files included from the `vhost_dir`. - -If set to a value like `[^.#]\*.conf[^~]` to make sure that files accidentally created in this directory (such as files created by version control systems or editor backups) are *not* included in your server configuration. - -Default: '*', also for BC with previous versions of this module. TODO: what does "also for BC" mean? - -Some operating systems use a value of `*.conf`. By default, this module creates configuration files ending in `.conf`. - -##### `user` - -Changes the user that Apache uses to answer requests. Apache's parent process continues to run as root, but child processes access resources as the user defined by this parameter. To prevent Puppet from managing the user, set the [`manage_user`][] parameter to `false`. - -Default: Depends on the user set by [`apache::params`][] class, based on your operating system: - -- **Debian**: 'www-data' -- **FreeBSD**: 'www' -- **Gentoo** and **Red Hat**: 'apache' - -To prevent Puppet from managing the user, set the [`manage_user`][] parameter to false. - -##### `apache_name` - -The name of the Apache package to install. If you are using a non-standard Apache package, such as those from Red Hat's software collections, you might need to override the default setting. - -Default: Depends on the user set by [`apache::params`][] class, based on your operating system: - -- **Debian**: 'apache2' -- **FreeBSD**: 'apache24' -- **Gentoo**: 'www-servers/apache' -- **Red Hat**: 'httpd' - -##### `error_log` - -The name of the error log file for the main server instance. If the string starts with `/`, `|`, or `syslog`: the full path is set. Otherwise, the filename is prefixed with `$logroot`. - -Default: Depends on operating system: - -- **Debian**: 'error.log' -- **FreeBSD**: 'httpd-error.log' -- **Gentoo**: 'error.log' -- **Red Hat**: 'error_log' -- **Suse**: 'error.log' - -##### `scriptalias` - -Directory to use for global script alias - -Default: Depends on operating system: - -- **Debian**: '/usr/lib/cgi-bin' -- **FreeBSD**: '/usr/local/www/apache24/cgi-bin' -- **Gentoo**: 'var/www/localhost/cgi-bin' -- **Red Hat**: '/var/www/cgi-bin' -- **Suse**: '/usr/lib/cgi-bin' - -##### `access_log_file` - -The name of the access log file for the main server instance. - -Default: Depends on operating system: - -- **Debian**: 'error.log' -- **FreeBSD**: 'httpd-access.log' -- **Gentoo**: 'access.log' -- **Red Hat**: 'access_log' -- **Suse**: 'access.log' - -#### Class: `apache::dev` - -Installs Apache development libraries. Default: Depends on the operating system:[`dev_packages`][] parameter of the [`apache::params`][] class, based on your operating system: - -- **Debian** : 'libaprutil1-dev', 'libapr1-dev'; 'apache2-dev' on Ubuntu 13.10 and Debian 8; 'apache2-prefork-dev' on other versions. -- **FreeBSD**: `undef`; on FreeBSD, you must declare the `apache::package` or `apache` classes before declaring `apache::dev`. -- **Gentoo**: `undef`. -- **Red Hat**: 'httpd-devel'. - -#### Class: `apache::vhosts` - -Creates [`apache::vhost`][] defined types. - -**Parameters**: - -* `vhosts`: Specifies the [`apache::vhost`][] defined type's parameters. - - Values: A [hash][], where the key represents the name and the value represents a [hash][] of [`apache::vhost`][] defined type's parameters. - - Default: '{}' - - > **Note**: See the [`apache::vhost`][] defined type's reference for a list of all virtual host parameters or [Configuring virtual hosts]. - - For example, to create a [name-based virtual host][name-based virtual hosts] 'custom_vhost_1, declare this class with the `vhosts` parameter set to '{ "custom_vhost_1" => { "docroot" => "/var/www/custom_vhost_1", "port" => "81" }': - -``` puppet -class { 'apache::vhosts': - vhosts => { - 'custom_vhost_1' => { - 'docroot' => '/var/www/custom_vhost_1', - 'port' => '81', - }, - }, -} -``` - -#### Classes: `apache::mod::` - -Enables specific [Apache modules][]. Enable and configure an Apache module by declaring its class. - -For example, to install and enable [`mod_alias`][] with no icons, declare the [`apache::mod::alias`][] class with the `icons_options` parameter set to 'None': - -``` puppet -class { 'apache::mod::alias': - icons_options => 'None', -} -``` - -The following Apache modules have supported classes, many of which allow for parameterized configuration. You can install other Apache modules with the [`apache::mod`][] defined type. - -* `actions` -* `alias` (see [`apache::mod::alias`][]) -* `auth_basic` -* `auth_cas`\* (see [`apache::mod::auth_cas`][]) -* `auth_mellon`\* (see [`apache::mod::auth_mellon`][]) -* `auth_kerb` -* `authn_core` -* `authn_dbd`\* (see [`apache::mod::authn_dbd`][]) -* `authn_file` -* `authnz_ldap`\* (see [`apache::mod::authnz_ldap`][]) -* `authnz_pam` -* `authz_default` -* `authz_user` -* `autoindex` -* `cache` -* `cgi` -* `cgid` -* `cluster` (see [`apache::mod::cluster`][]) -* `dav` -* `dav_fs` -* `dav_svn`\* -* `dbd` -* `deflate\` -* `dev` -* `dir`\* -* `disk_cache` (see [`apache::mod::disk_cache`][]) -* `dumpio` (see [`apache::mod::dumpio`][]) -* `env` -* `event` (see [`apache::mod::event`][]) -* `expires` -* `ext_filter` (see [`apache::mod::ext_filter`][]) -* `fastcgi` -* `fcgid` -* `filter` -* `geoip` (see [`apache::mod::geoip`][]) -* `headers` -* `include` -* `info`\* -* `intercept_form_submit` -* `itk` -* `ldap` (see [`apache::mod::ldap`][]) -* `lookup_identity` -* `mime` -* `mime_magic`\* -* `negotiation` -* `nss`\* (see [`apache::mod::nss`][]) -* `pagespeed` (see [`apache::mod::pagespeed`][]) -* `passenger`\* (see [`apache::mod::passenger`][]) -* `perl` -* `peruser` -* `php` (requires [`mpm_module`][] set to `prefork`) -* `prefork`\* -* `proxy`\* (see [`apache::mod::proxy`][]) -* `proxy_ajp` -* `proxy_balancer`\* (see [`apache::mod::proxy_balancer`][]) -* `proxy_balancer` -* `proxy_html` (see [`apache::mod::proxy_html`][]) -* `proxy_http` -* `python` -* `reqtimeout` -* `remoteip`\* -* `rewrite` -* `rpaf`\* -* `setenvif` -* `security` -* `shib`\* (see [`apache::mod::shib`]) -* `speling` -* `ssl`\* (see [`apache::mod::ssl`][]) -* `status`\* (see [`apache::mod::status`][]) -* `suphp` -* `userdir`\* -* `version` -* `vhost_alias` -* `worker`\* -* `wsgi` (see [`apache::mod::wsgi`][]) -* `xsendfile` - -Modules noted with a * indicate that the module has settings and a template that includes parameters to configure the module. Most Apache module class parameters have default values and don't require configuration. For modules with templates, Puppet installs template files with the module; these template files are required for the module to work. - -##### Class: `apache::mod::alias` - -Installs and manages [`mod_alias`][]. - -**Parameters**: - -* `icons_options`: Disables directory listings for the icons directory, via Apache [`Options`] directive. - - Default: 'Indexes MultiViews'. - -* `icons_path`: Sets the local path for an `/icons/` Alias. - - Default: Depends on operating system. - - * **Debian**: `/usr/share/apache2/icons` - * **FreeBSD**: `/usr/local/www/apache24/icons` - * **Gentoo**: `/var/www/icons` - * *Red Hat**: `/var/www/icons`, except on Apache 2.4, where it's `/usr/share/httpd/icons` - -#### Class: `apache::mod::disk_cache` - -Installs and configures [`mod_disk_cache`][] on Apache 2.2, or [`mod_cache_disk`][] on Apache 2.4. - -Default: Depends on the Apache version and operating system: - -- **Debian**: `/var/cache/apache2/mod_cache_disk` -- **FreeBSD**: `/var/cache/mod_cache_disk` -- **Red Hat, Apache 2.4**: `/var/cache/httpd/proxy` -- **Red Hat, Apache 2.2**: `/var/cache/mod_proxy` - -To specify the cache root, pass a path as a string to the `cache_root` parameter. - -``` puppet -class {'::apache::mod::disk_cache': - cache_root => '/path/to/cache', -} -``` - -##### Class: `apache::mod::diskio` - -Installs and configures [`mod_diskio`][]. - -```puppet -class{'apache': - default_mods => `false`, - log_level => 'dumpio:trace7', -} -class{'apache::mod::diskio': - disk_io_input => 'On', - disk_io_output => 'Off', -} -``` - -**Parameters**: - -* `dump_io_input`: Dump all input data to the error log. - - Values: 'On', 'Off'. - - Default: 'Off'. - -* `dump_io_output`: Dump all output data to the error log. - - Values: 'On', 'Off'. - - Defaults to 'Off'. - -##### Class: `apache::mod::event` - -Installs and manages [`mod_mpm_event`][]. You cannot include `apache::mod::event` with [`apache::mod::itk`][], [`apache::mod::peruser`][], [`apache::mod::prefork`][], or [`apache::mod::worker`][] on the same server. - -**Parameters**: - -* `listenbacklog`: Sets the maximum length of the pending connections queue via the module's [`ListenBackLog`][] directive. Setting this to `false` removes the parameter. - - Default: '511'. - -* `maxrequestworkers` (_Apache 2.3.12 or older_: `maxclients`): Sets the maximum number of connections Apache can simultaneously process, via the module's [`MaxRequestWorkers`][] directive. Setting these to `false` removes the parameters. - - Default: '150'. - -* `maxconnectionsperchild` (_Apache 2.3.8 or older_: `maxrequestsperchild`): Limits the number of connections a child server handles during its life, via the module's [`MaxConnectionsPerChild`][] directive. Setting these to `false` removes the parameters. - - Default: '0'. - -* `maxsparethreads` and `minsparethreads`: Sets the maximum and minimum number of idle threads, via the [`MaxSpareThreads`][] and [`MinSpareThreads`][] directives. Setting these to `false` removes the parameters. - - Default: '75' and '25', respectively. - -* `serverlimit`: Limits the configurable number of processes via the [`ServerLimit`][] directive. Setting this to `false` removes the parameter. - - Default: '25'. - -* `startservers`: Sets the number of child server processes created at startup, via the module's [`StartServers`][] directive. Setting this to `false` removes the parameter. - - Default: '2'. - -* `threadlimit`: Limits the number of event threads via the module's [`ThreadLimit`][] directive. Setting this to `false` removes the parameter. - - Default: '64'. - -* `threadsperchild`: Sets the number of threads created by each child process, via the [`ThreadsPerChild`][] directive. Default: '25'. Setting this to `false` removes the parameter. - -##### Class: `apache::mod::auth_cas` - -Installs and manages [`mod_auth_cas`][]. Parameters share names with the Apache module's directives. - -The `cas_login_url` and `cas_validate_url` parameters are required; several other parameters have `undef` default values. - -> **Note**: The auth_cas module isn't available on RH/CentOS without providing dependency packages provided by EPEL. See [https://github.com/Jasig/mod_auth_cas]() - -**Parameters**: - -- `cas_attribute_prefix`: Adds a header with the value of this header being the attribute values when SAML validation is enabled. - - Default: CAS_. - -- `cas_attribute_delimiter`: The delimiter between attribute values in the header created by `cas_attribute_prefix`. - - Default: , - -- `cas_authoritative`: Determines whether an optional authorization directive is authoritative and binding. - - Default: `undef`. - -- `cas_certificate_path`: Sets the path to the X509 certificate of the Certificate Authority for the server in `cas_login_url` and `cas_validate_url`. - - Default: `undef`. - -- `cas_cache_clean_interval`: Sets the minimum number of seconds that must pass between cache cleanings. - - Default: `undef`. - -- `cas_cookie_domain`: Sets the value of the `Domain=` parameter in the `Set-Cookie` HTTP header. - - Default: `undef`. - -- `cas_cookie_entropy`: Sets the number of bytes to use when creating session identifiers. - - Default: `undef`. - -- `cas_cookie_http_only`: Sets the optional `HttpOnly` flag when `mod_auth_cas` issues cookies. - - Default: `undef`. - -- `cas_cookie_path`: Where cas cookie session data is stored. Should be writable by web server user. - - Default: OS dependent. - -- `cas_cookie_path_mode`: The mode of `cas_cookie_path`. - - Default: '0750'. - -- `cas_debug`: Determines whether to enable the module's debugging mode. - - Default: 'Off'. - -- `cas_idle_timeout`: Sets the idle timeout limit, in seconds. - - Default: `undef`. - -- `cas_login_url`: **Required**. Sets the URL to which the module redirects users when they attempt to access a CAS-protected resource and don't have an active session. - -- `cas_proxy_validate_url`: The URL to use when performing a proxy validation. - - Default: `undef`. - -- `cas_root_proxied_as`: Sets the URL end users see when access to this Apache server is proxied. - - Default: `undef`. - -- `cas_scrub_request_headers`: Remove inbound request headers that may have special meaning within mod_auth_cas. - -- `cas_sso_enabled`: Enables experimental support for single sign out (may mangle POST data). - - Default: 'Off'. - -- `cas_timeout`: Limits the number of seconds a `mod_auth_cas` session can remain active. - - Default: `undef`. - -- `cas_validate_depth`: Limits the depth for chained certificate validation. - - Default: `undef`. - -- `cas_validate_saml`: Parse response from CAS server for SAML. - - Default: 'Off'. - -- `cas_validate_server`: Whether to validate the cert of the CAS server (deprecated in 1.1 - RedHat 7). - - Default: `undef`. - -- `cas_validate_url`: **Required**. Sets the URL to use when validating a client-presented ticket in an HTTP query string. - -- `cas_version`: The CAS protocol version to adhere to. Values: '1', '2'. - - Default: '2'. - -- `suppress_warning`: Suppress warning about being on RedHat (`mod_auth_cas` package is now available in epel-testing repo). - - Default: `false`. - -##### Class: `apache::mod::auth_mellon` - -Installs and manages [`mod_auth_mellon`][]. Parameters share names with the Apache module's directives. - -``` puppet -class{ 'apache::mod::auth_mellon': - mellon_cache_size => 101, -} -``` - -**Parameters**: - -* `mellon_cache_entry_size`: Maximum size for a single session. - - Default: `undef`. - -* `mellon_cache_size`: Size in megabytes of the mellon cache. - - Default: 100. - -* `mellon_lock_file`: Location of lock file. - - Default: '`/run/mod_auth_mellon/lock`'. - -* `mellon_post_directory`: Full path where post requests are saved. - - Default: '`/var/cache/apache2/mod_auth_mellon/`' - -* `mellon_post_ttl`: Time to keep post requests. - - Default: `undef`. - -* `mellon_post_size`: Maximum size of post requests. - - Default: `undef`. - -* `mellon_post_count`: Maximum number of post requests. - - Default: `undef`. - -##### Class: `apache::mod::authn_dbd` - -Installs `mod_authn_dbd` and uses `authn_dbd.conf.erb` template to generate its configuration. Optionally, creates AuthnProviderAlias. - -``` puppet -class { 'apache::mod::authn_dbd': - $authn_dbd_params => - 'host=db01 port=3306 user=apache password=xxxxxx dbname=apacheauth', - $authn_dbd_query => 'SELECT password FROM authn WHERE user = %s', - $authn_dbd_alias => 'db_auth', -} -``` - -**Parameters**: - -* `authn_dbd_alias`: Name for the 'AuthnProviderAlias'. - -* `authn_dbd_dbdriver`: Specifies the database driver to use. - - Default: 'mysql'. - -* `authn_dbd_exptime`: corresponds to DBDExptime. - - Default: 300. - -* `authn_dbd_keep`: Corresponds to DBDKeep. - - Default: 8. - -* `authn_dbd_max`: Corresponds to DBDMax. - - Default: 20. - -* `authn_dbd_min`: Corresponds to DBDMin. - - Default: 4. - -* `authn_dbd_params`: **Required**. Corresponds to DBDParams for the connection string. - -* `authn_dbd_query`: Whether to query the user and password for authentication. - -##### Class: `apache::mod::authnz_ldap` - -Installs `mod_authnz_ldap` and uses the `authnz_ldap.conf.erb` template to generate its configuration. - -**Parameters**: - -* `package_name`: The name of the package. - - Default: `undef`. - -* `verify_server_cert`: Whether to verify the server certificate. - - Default: `undef`. - -##### Class: `apache::mod::cluster` - -**Note**: There is no official package available for `mod_cluster`, so you must make it available outside of the apache module. Binaries can be found at http://mod-cluster.jboss.org/ - -``` puppet -class { '::apache::mod::cluster': - ip => '172.17.0.1', - allowed_network => '172.17.0.', - balancer_name => 'mycluster', - version => '1.3.1' -} -``` - -**Parameters**: - -* `port`: mod_cluster listen port. - - Default: '6666'. - -* `server_advertise`: Whether the server should advertise. - - Default: `true`. - -* `advertise_frequency`: Sets the interval between advertise messages in seconds[.miliseconds]. - - Default: 10. - -* `manager_allowed_network`: Whether to allow the network to access the mod_cluster_manager. - - Default: '127.0.0.1'. - -* `keep_alive_timeout`: Specifies how long Apache should wait for a request, in seconds. - - Default: 60. - -* `max_keep_alive_requests`: Maximum number of requests kept alive. - - Default: 0. - -* `enable_mcpm_receive`: Whether MCPM should be enabled. - - Default: `true`. - -* `ip`: Specifies the IP address to listen to. - -* `allowed_network`: Balanced members network. - -* `version`: Specifies the `mod_cluster` version. Version 1.3.0 or greater is required for httpd 2.4. - -##### Class: `apache::mod::deflate` - -Installs and configures [`mod_deflate`][]. - -**Parameters**: - -* `types`: An [array][] of [MIME types][MIME `content*type`] to be deflated. - - Default: [ 'text/html text/plain text/xml', 'text/css', 'application/x*javascript application/javascript application/ecmascript', 'application/rss+xml', 'application/json' ]. - -* `notes`: A [Hash][] where the key represents the type and the value represents the note name. - - Default: { 'Input' => 'instream', 'Output' => 'outstream', 'Ratio' => 'ratio' }. - -##### Class: `apache::mod::expires` - -Installs [`mod_expires`][] and uses the `expires.conf.erb` template to generate its configuration. - -**Parameters**: - -* `expires_active`: Enables generation of `Expires` headers for a document realm. - - Boolean. Default: `true`. - -* `expires_default`: Specifies the default algorithm for calculating expiration time using [`ExpiresByType`][] syntax or [interval syntax][]. - - Default: `undef`. - -* `expires_by_type`: Describes a set of [MIME `content*type`][] and their expiration times. - - Values: An [array][] of [Hashes][Hash], with each Hash's key a valid MIME `content*type` (i.e. 'text/json') and its value following valid [interval syntax][]. - - Default: `undef`. - -##### Class: `apache::mod::ext_filter` - -Installs and configures [`mod_ext_filter`][]. - -``` puppet -class { 'apache::mod::ext_filter': - ext_filter_define => { - 'slowdown' => 'mode=output cmd=/bin/cat preservescontentlength', - 'puppetdb-strip' => 'mode=output outtype=application/json cmd="pdb-resource-filter"', - }, -} -``` - -**Parameters**: - -* `ext_filter_define`: A hash of filter names and their parameters. - - Default: `undef`. - -##### Class: `apache::mod::fcgid` - -Installs and configures [`mod_fcgid`][]. - -The class does not individually parameterize all available options. Instead, configure `mod_fcgid` using the `options` [hash][]. For example: - -``` puppet -class { 'apache::mod::fcgid': - options => { - 'FcgidIPCDir' => '/var/run/fcgidsock', - 'SharememPath' => '/var/run/fcgid_shm', - 'AddHandler' => 'fcgid-script .fcgi', - }, -} -``` - -For a full list of options, see the [official `mod_fcgid` documentation][`mod_fcgid`]. - -If you include `apache::mod::fcgid`, you can set the [`FcgidWrapper`][] per directory, per virtual host. The module must be loaded first; Puppet will not automatically enable it if you set the `fcgiwrapper` parameter in `apache::vhost`. - -``` puppet -include apache::mod::fcgid - -apache::vhost { 'example.org': - docroot => '/var/www/html', - directories => { - path => '/var/www/html', - fcgiwrapper => { - command => '/usr/local/bin/fcgiwrapper', - } - }, -} -``` - -##### Class: `apache::mod::geoip` - -Installs and manages [`mod_geoip`][]. - -**Parameters**: - -* `db_file`: Sets the path to your GeoIP database file. - - Values: a path, or an [array][] paths for multiple GeoIP database files. - - Default: `/usr/share/GeoIP/GeoIP.dat`. - -* `enable`: Determines whether to globally enable [`mod_geoip`][]. - - Boolean. Default: `false`. - -* `flag`: Sets the GeoIP flag. - - Values: 'CheckCache', 'IndexCache', 'MemoryCache', 'Standard'. - - Default: 'Standard'. - -* `output`: Defines which output variables to use. - - Values: 'All', 'Env', 'Request', 'Notes'. - - Default: 'All'. - -* `enable_utf8`: Changes the output from ISO*8859*1 (Latin*1) to UTF*8. - - Boolean. Default: `undef`. - -* `scan_proxy_headers`: Enables the [GeoIPScanProxyHeaders][] option. - - Boolean. Default: `undef`. - -* `scan_proxy_header_field`: Specifies the header [`mod_geoip`][] uses to determine the client's IP address. - - Default: `undef`. - -* `use_last_xforwarededfor_ip` (sic): Determines whether to use the first or last IP address for the client's IP in a comma-separated list of IP addresses is found. - - Boolean. Default: `undef`. - -##### Class: `apache::mod::info` - -Installs and manages [`mod_info`][], which provides a comprehensive overview of the server configuration. - -**Parameters**: - -* `allow_from`: Whitelist of IPv4 or IPv6 addresses or ranges that can access `/server*info`. - - Values: One or more octets of an IPv4 address, an IPv6 address or range, or an array of either. - - Default: ['127.0.0.1','::1']. - -* `apache_version`: Apache's version number as a string, such as '2.2' or '2.4'. - - Default: The value of [`$::apache::apache_version`][`apache_version`]. - - -* `restrict_access`: Determines whether to enable access restrictions. If `false`, the `allow_from` whitelist is ignored and any IP address can access `/server*info`. - - Boolean. Default: `true`. - -##### Class: `apache::mod::passenger` - -Installs and manages [`mod_passenger`][]. For Red Hat-based systems, ensure that you meet the minimum requirements described in the [passenger docs](https://www.phusionpassenger.com/library/install/apache/install/oss/el6/#step-1:-upgrade-your-kernel,-or-disable-selinux). - -**Parameters**: - -* `passenger_high_performance`: Sets the [`PassengerHighPerformance`](https://www.phusionpassenger.com/library/config/apache/reference/#passengerhighperformance). - - Values: 'On', 'Off'. - - Default: `undef`. - -* `passenger_pool_idle_time`: Sets the [`PassengerPoolIdleTime`](https://www.phusionpassenger.com/library/config/apache/reference/#passengerpoolidletime). - - Default: `undef`. - -* `passenger_max_pool_size`: Sets the [`PassengerMaxPoolSize`](https://www.phusionpassenger.com/library/config/apache/reference/#passengermaxpoolsize). - - Default: `undef`. - -* `passenger_max_request_queue_size`: Sets the [`PassengerMaxRequestQueueSize`](https://www.phusionpassenger.com/library/config/apache/reference/#passengermaxrequestqueuesize). - - Default: `undef`. - -* `passenger_max_requests`: Sets the [`PassengerMaxRequests`](https://www.phusionpassenger.com/library/config/apache/reference/#passengermaxrequests). - - Default: `undef`. - -* `passenger_data_buffer_dir`: Sets the [`PassengerDataBufferDir`](https://www.phusionpassenger.com/library/config/apache/reference/#passengerdatabufferdir). - - Default: `undef`. - -##### Class: `apache::mod::ldap` - -Installs and configures [`mod_ldap`][], and allows you to modify the -[`LDAPTrustedGlobalCert`](https://httpd.apache.org/docs/current/mod/mod_ldap.html#ldaptrustedglobalcert) Directive: - -``` puppet -class { 'apache::mod::ldap': - ldap_trusted_global_cert_file => '/etc/pki/tls/certs/ldap-trust.crt', - ldap_trusted_global_cert_type => 'CA_DER', - ldap_shared_cache_size => '500000', - ldap_cache_entries => '1024', - ldap_cache_ttl => '600', - ldap_opcache_entries => '1024', - ldap_opcache_ttl => '600', -} -``` - -**Parameters** - -* `apache_version`: Specifies the installed Apache version. - - Default: `undef`. - -* `ldap_trusted_global_cert_file`: Specifies the path and file name of the trusted CA certificates to use when establishing SSL or TLS connections to an LDAP server. - -* `ldap_trusted_global_cert_type`: Specifies the global trust certificate format. - - Default: 'CA_BASE64'. - -* `ldap_shared_cache_size`: Specifies the size, in bytes, of the shared memory cache. - -* `ldap_cache_entries`: Specifies the maximum number of entries in the primary LDAP cache. - -* `ldap_cache_ttl`: Specifies the time, in seconds, that cached items remain valid. - -* `ldap_opcache_entries`: Specifies the number of entries used to cache LDAP compare operations. - -* `ldap_opcache_ttl`: Specifies the time, in seconds, that entries in the operation cache remain valid. - -* `package_name`: Specifies the custom package name. - - Default: `undef`. - -##### Class: `apache::mod::negotiation` - -Installs and configures [`mod_negotiation`][]. - -**Parameters**: - -* `force_language_priority`: Sets the `ForceLanguagePriority` option. - - Values: A string. - - Default: `Prefer Fallback`. - -* `language_priority`: An [array][] of languages to set the `LanguagePriority` option of the module. - - Default: [ 'en', 'ca', 'cs', 'da', 'de', 'el', 'eo', 'es', 'et', 'fr', 'he', 'hr', 'it', 'ja', 'ko', 'ltz', 'nl', 'nn', 'no', 'pl', 'pt', 'pt*BR', 'ru', 'sv', 'zh*CN', 'zh*TW' ] - -##### Class: `apache::mod::nss` - -An SSL provider for Apache using the NSS crypto libraries. - -**Parameters:** - -- `transfer_log`: path to access.log -- `error_log`: path to error.log -- `passwd_file`: path to file used for NSSPassPhraseDialog directive -- `port`: SSL port. Defaults to 8443 - -##### Class: `apache::mod::pagespeed` - -Installs and manages [`mod_pagespeed`][], a Google module that rewrites web pages to reduce latency and bandwidth. - -Although this apache module requires the `mod-pagespeed-stable` package, Puppet **does not** manage the software repositories required to automatically install the package. If you declare this class when the package is either not installed or not available to your package manager, your Puppet run will fail. - -> **Note:** Verify that your system is compatible with the latest Google Pagespeed requirements. - -**Parameters**: - -These parameters correspond to the module's directives. See the [module's documentation][`mod_pagespeed`] for details. - -* `inherit_vhost_config`: Default: 'on'. -* `filter_xhtml`: Default: `false`. -* `cache_path`: Default: '/var/cache/mod_pagespeed/'. -* `log_dir`: Default: '/var/log/pagespeed'. -* `memcache_servers`: Default: []. -* `rewrite_level`: Default: 'CoreFilters'. -* `disable_filters`: Default: []. -* `enable_filters`: Default: []. -* `forbid_filters`: Default: []. -* `rewrite_deadline_per_flush_ms`: Default: 10. -* `additional_domains`: Default: `undef`. -* `file_cache_size_kb`: Default: 102400. -* `file_cache_clean_interval_ms`: Default: 3600000. -* `lru_cache_per_process`: Default: 1024. -* `lru_cache_byte_limit`: Default: 16384. -* `css_flatten_max_bytes`: Default: 2048. -* `css_inline_max_bytes`: Default: 2048. -* `css_image_inline_max_bytes`: Default: 2048. -* `image_inline_max_bytes`: Default: 2048. -* `js_inline_max_bytes`: Default: 2048. -* `css_outline_min_bytes`: Default: 3000. -* `js_outline_min_bytes`: Default: 3000. -* `inode_limit`: Default: 500000. -* `image_max_rewrites_at_once`: Default: 8. -* `num_rewrite_threads`: Default: 4. -* `num_expensive_rewrite_threads`: Default: 4. -* `collect_statistics`: Default: 'on'. -* `statistics_logging`: Default: 'on'. -* `allow_view_stats`: Default: []. -* `allow_pagespeed_console`: Default: []. -* `allow_pagespeed_message`: Default: []. -* `message_buffer_size`: Default: 100000. -* `additional_configuration`: A hash of directive value pairs, or an array of lines to insert at the end of the pagespeed configuration. Default: '{ }'. - -##### Class: `apache::mod::passenger` - -Installs and configures `mod_passenger`. - ->**Note**: The passenger module isn't available on RH/CentOS without providing the dependency packages provided by EPEL and the `mod_passengers` custom repository. See the `manage_repo` parameter above and [https://www.phusionpassenger.com/library/install/apache/install/oss/el7/]() - -**Parameters**: [TODO: parameters were not listed (except `manage_repo`), so I pulled them out of the manifest. I need to know what these parameters do and what their values can be OR a link that points external documentation for the parameter mapping (as with mod_pagespeed above) ] - -* `passenger_conf_file`: `$::apache::params::passenger_conf_file` -* `passenger_conf_package_file: `$::apache::params::passenger_conf_package_file` -* `passenger_high_performance`: Default: `undef` -* `passenger_pool_idle_time`: Default: `undef` -* `passenger_max_request_queue_size`: Default: `undef` -* `passenger_max_requests`: Default: `undef` -* `passenger_spawn_method`: Default: `undef` -* `passenger_stat_throttle_rate`: Default: `undef` -* `rack_autodetect`: Default: `undef` -* `rails_autodetect`: Default: `undef` -* `passenger_root` : `$::apache::params::passenger_root` -* `passenger_ruby` : `$::apache::params::passenger_ruby` -* `passenger_default_ruby`: `$::apache::params::passenger_default_ruby` -* `passenger_max_pool_size`: Default: `undef` -* `passenger_min_instances`: Default: `undef` -* `passenger_max_instances_per_app`: Default: `undef` -* `passenger_use_global_queue`: Default: `undef` -* `passenger_app_env`: Default: `undef` -* `passenger_log_file`: Default: `undef` -* `passenger_log_level`: Default: `undef` -* `passenger_data_buffer_dir`: Default: `undef` -* `manage_repo`: Whether to manage the phusionpassenger.com repository. Default: `true`. -* `mod_package`: Default: `undef`. -* `mod_package_ensure`: Default: `undef`. -* `mod_lib`: Default: `undef`. -* `mod_lib_path`: Default: `undef`. -* `mod_id`: Default: `undef`. -* `mod_path`: Default: `undef`. - -##### Class: `apache::mod::proxy` - -Installs `mod_proxy` and uses the `proxy.conf.erb` template to generate its configuration. - -**Parameters within `apache::mod::proxy`**: - -TODO: What do these parameters do? - -- `allow_from`: Default: `undef`. -- `apache_version`: Default: `undef`. -- `package_name`: Default: `undef`. -- `proxy_requests`: Default: 'Off'. -- `proxy_via`: Default: 'On'. - -##### Class: `apache::mod::proxy_balancer` - -Installs and manages [`mod_proxy_balancer`][], which provides load balancing. - -**Parameters**: - -* `manager`: Determines whether to enable balancer manager support. - - Default: `false`. - -* `manager_path`: The server location of the balancer manager. - - Default: '/balancer*manager'. - -* `allow_from`: An [array][] of IPv4 or IPv6 addresses that can access `/balancer*manager`. - - Default: ['127.0.0.1','::1']. - -* `apache_version`: Apache's version number as a string, such as '2.2' or '2.4'. - - Default: the value of [`$::apache::apache_version`][`apache_version`]. On Apache 2.4 or greater, `mod_slotmem_shm` is loaded. - -##### Class: `apache::mod::php` - -Installs and configures [`mod_php`][]. - -**Parameters**: - -Default values for these parameters depend on your operating system. Most of this class's parameters correspond to `mod_php` directives; see the [module's documentation][`mod_php`] for details. - -* `package_name`: Names the package that installs `mod_php`. -* `path`: Defines the path to the `mod_php` shared object (`.so`) file. -* `source`: Defines the path to the default configuration. Values include a `puppet:///` path. -* `template`: Defines the path to the `php.conf` template Puppet uses to generate the configuration file. -* `content`: Adds arbitrary content to `php.conf`. - -##### Class: `apache::mod::proxy_html` - -**Note**: There is no official package available for `mod_proxy_html`, so you must make it available outside of the apache module. - -##### Class: `apache::mod::reqtimeout` - -Installs and configures [`mod_reqtimeout`][]. - -**Parameters** - -* `timeouts`: Sets the [`RequestReadTimeout`][] option. - - Values: A string or [array][]. - - Default: ['header=20-40,MinRate=500', 'body=20,MinRate=500']. - -##### Class: `apache::mod::rewrite` - -Installs and enables the Apache module `mod_rewrite`. - -##### Class: `apache::mod::shib` - -Installs the [Shibboleth](http://shibboleth.net/) Apache module `mod_shib`, which enables SAML2 single sign-on (SSO) authentication by Shibboleth Identity Providers and Shibboleth Federations. Defining this class enables Shibboleth-specific parameters in `apache::vhost` instances. - -This class installs and configures only the Apache components of a web application that consumes Shibboleth SSO identities. You can manage the Shibboleth configuration manually, with Puppet, or using a [Shibboleth Puppet Module](https://github.com/aethylred/puppet-shibboleth). - -**Note**: The shibboleth module isn't available on RH/CentOS without providing dependency packages provided by Shibboleth's repositories. See [http://wiki.aaf.edu.au/tech-info/sp-install-guide]() - -##### Class: `apache::mod::ssl` - -Installs [Apache SSL features][`mod_ssl`] and uses the `ssl.conf.erb` template to generate its configuration. On most operating systems, this `ssl.conf` is placed in the module configuration directory. On Red Hat-based operating systems, this file is placed in `/etc/httpd/conf.d`, the same location in which the RPM stores the configuration. - -To use SSL with a virtual host, you must either set the [`default_ssl_vhost`][] parameter in `::apache` to `true` **or** the [`ssl`][] parameter in [`apache::vhost`][] to `true`. - -- `ssl_cipher`: Default: 'HIGH:MEDIUM:!aNULL:!MD5:!RC4'. -- `ssl_compression`: Default: false. -- `ssl_cryptodevice`: Default: 'builtin'. -- `ssl_honorcipherorder`: Default: true. -- `ssl_openssl_conf_cmd`: Default: undef. -- `ssl_options`: Default: [ 'StdEnvVars' ] -- `ssl_pass_phrase_dialog`: Default: 'builtin'. -- `ssl_protocol`: Default: [ 'all', '-SSLv2', '-SSLv3' ]. -- `ssl_proxy_protocol`: Default: []. -- `ssl_random_seed_bytes`: Valid options: A string. Default: '512'. -- `ssl_sessioncache`: Valid options: A string. Default: '300'. -- `ssl_sessioncachetimeout`: Valid options: A string. Default: '300'. -- `ssl_mutex`: Default: Determined based on the OS. Valid options: See [mod_ssl][mod_ssl] documentation. - - RedHat/FreeBSD/Suse/Gentoo: 'default' - - Debian/Ubuntu + Apache >= 2.4: 'default' - - Debian/Ubuntu + Apache < 2.4: 'file:\${APACHE_RUN_DIR}/ssl_mutex' -**Parameters: - -* `ssl_cipher` - - Default: 'HIGH:MEDIUM:!aNULL:!MD5:!RC4'. - -* `ssl_compression` - - Default: `false`. - -* `ssl_cryptodevice` - - Default: 'builtin'. - -* `ssl_honorcipherorder` - - Default: `true`. - -* `ssl_openssl_conf_cmd` - - Default: `undef`. - -* `ssl_options` - - Default: [ 'StdEnvVars' ] - -* `ssl_pass_phrase_dialog` - - Default: 'builtin'. - -* `ssl_protocol` - - Default: [ 'all', '*SSLv2', '*SSLv3' ]. - -* `ssl_random_seed_bytes` - - Values: A string. - - Default: '512'. - -* `ssl_sessioncachetimeout` - - Values: A string. - - Default: '300'. - -* `ssl_mutex`: - - Values: See [mod_ssl][mod_ssl] documentation. - - Default: Based on the OS: - - * RedHat/FreeBSD/Suse/Gentoo: 'default'. - * Debian/Ubuntu + Apache >= 2.4: 'default'. - * Debian/Ubuntu + Apache < 2.4: 'file:\${APACHE_RUN_DIR}/ssl_mutex'. - * Ubuntu 10.04: 'file:/var/run/apache2/ssl_mutex'. - - -##### Class: `apache::mod::status` - -Installs [`mod_status`][] and uses the `status.conf.erb` template to generate its configuration. - -**Parameters**: - -* `allow_from`: An [array][] of IPv4 or IPv6 addresses that can access `/server-status`. - - Default: ['127.0.0.1','::1']. -* `extended_status`: Determines whether to track extended status information for each request, via the [`ExtendedStatus`][] directive. - - Values: 'Off', 'On'. - - Default: 'On'. - -* `status_path`: The server location of the status page. - - Default: '/server-status'. - -##### Class: `apache::mod::version` - -Installs [`mod_version`][] on many operating systems and Apache configurations. - -If Debian and Ubuntu systems with Apache 2.4 are classified with `apache::mod::version`, Puppet warns that `mod_version` is built-in and can't be loaded. - -##### Class: `apache::mod::security` - -Installs and configures Trustwave's [`mod_security`][]. It is enabled and runs by default on all virtual hosts. - -**Parameters**: - -* `activated_rules`: An [array][] of rules from the `modsec_crs_path` or absolute to activate via symlinks. -* `allowed_methods`: A space*separated list of allowed HTTP methods. - - Default: 'GET HEAD POST OPTIONS'. - -* `content_types`: A list of one or more allowed [MIME types][MIME `content*type`]. - - Default: 'application/x*www*form*urlencoded|multipart/form*data|text/xml|application/xml|application/x*amf'. - -* `crs_package`: Names the package that installs CRS rules. - - Default: `modsec_crs_package` in [`apache::params`][]. - -* `manage_security_crs`: Manage security_crs.conf rules file. - - Default: `true`. - -* `modsec_dir`: Defines the path where Puppet installs the modsec configuration and activated rules links. - - Default: 'On', set by `modsec_dir` in [`apache::params`][]. -${modsec\_dir}/activated\_rules. - -* `modsec_secruleengine`: Configures the modsec rules engine. Values: 'On', 'Off', and 'DetectionOnly'. - - Default: `modsec_secruleengine` in [`apache::params`][]. - -* `restricted_extensions`: A space*separated list of prohibited file extensions. - - Default: '.asa/ .asax/ .ascx/ .axd/ .backup/ .bak/ .bat/ .cdx/ .cer/ .cfg/ .cmd/ .com/ .config/ .conf/ .cs/ .csproj/ .csr/ .dat/ .db/ .dbf/ .dll/ .dos/ .htr/ .htw/ .ida/ .idc/ .idq/ .inc/ .ini/ .key/ .licx/ .lnk/ .log/ .mdb/ .old/ .pass/ .pdb/ .pol/ .printer/ .pwd/ .resources/ .resx/ .sql/ .sys/ .vb/ .vbs/ .vbproj/ .vsdisco/ .webinfo/ .xsd/ .xsx/'. - -* `restricted_headers`: A list of restricted headers separated by slashes and spaces. - - Default: 'Proxy*Connection/ /Lock*Token/ /Content*Range/ /Translate/ /via/ /if/'. - -* `secdefaultaction`: Configures the Mode of Operation, Self-Contained ('deny') or Collaborative Detection ('pass'), for the OWASP ModSecurity Core Rule Set. - - Default: 'deny'. You can also set full values, such as "log,auditlog,deny,status:406,tag:'SLA 24/7'". - -* `secpcrematchlimit`: Sets the number for the match limit in the PCRE library. - - Default: 1500. - -* `secpcrematchlimitrecursion`: Sets the number for the match limit recursion in the PCRE library. - - Default: 1500. - -* `logroot`: Configures the location of audit and debug logs. - - Defaults to the Apache log directory (Redhat: `/var/log/httpd`, Debian: `/var/log/apache2`). - -* `audit_log_releavant_status`: Configures which response status code is to be considered relevant for the purpose of audit logging. - - Default: '^(?:5|4(?!04))'. - -* `audit_log_parts`: Sets the sections to be put in the [audit log][]. - - Default: 'ABIJDEFHZ'. - -* `anomaly_score_blocking`: Activates or deactivates the Collaborative Detection Blocking of the OWASP ModSecurity Core Rule Set. - - Default: 'off'. - -* `inbound_anomaly_threshold`: Sets the scoring threshold level of the inbound blocking rules for the Collaborative Detection Mode in the OWASP ModSecurity Core Rule Set. - - Default: 5. - -* `outbound_anomaly_threshold`: Sets the scoring threshold level of the outbound blocking rules for the Collaborative Detection Mode in the OWASP ModSecurity Core Rule Set. - - Default: 4. - -* `critical_anomaly_score`: Sets the scoring points of the critical severity level for the Collaborative Detection Mode in the OWASP ModSecurity Core Rule Set. - - Default: 5. - -* `error_anomaly_score`: Sets the scoring points of the error severity level for the Collaborative Detection Mode in the OWASP ModSecurity Core Rule Set. - - Default: 4. - -* `warning_anomaly_score`: Sets the scoring points of the warning severity level for the Collaborative Detection Mode in the OWASP ModSecurity Core Rule Set. - - Default: 3. - -* `notice_anomaly_score`: Sets the scoring points of the notice severity level for the Collaborative Detection Mode in the OWASP ModSecurity Core Rule Set. - -Default: 2. - -* `secrequestmaxnumargs`: Sets the Maximum number of arguments in the request. - - Default: 255. - -* `secrequestbodylimit`: Sets the maximum request body size ModSecurity accepts for buffering. - - Default: '13107200'. - -* `secrequestbodynofileslimit`: Sets the maximum request body size ModSecurity accepts for buffering, excluding the size of any files being transported in the request. - - Default: '131072'. - -* `secrequestbodyinmemorylimit`: Sets the maximum request body size that ModSecurity stores in memory. - - Default: '131072' - -##### Class: `apache::mod::wsgi` - -Enables Python support via [`mod_wsgi`][]. - -**Parameters**: - -* `mod_path`: Defines the path to the `mod_wsgi` shared object (`.so`) file. - - Default: `undef`. - - * If the `mod_path` parameter doesn't contain `/`, Puppet prefixes it with your operating system's default module path. Otherwise, Puppet follows it literally. - -* `package_name`: Names the package that installs `mod_wsgi`. - - Default: `undef`. - -* `wsgi_python_home`: Defines the [`WSGIPythonHome`][] directive, such as '/path/to/venv'. - - Values: A string specifying a path. - - Default: `undef`. - -* `wsgi_python_path`: Defines the [`WSGIPythonPath`][] directive, such as '/path/to/venv/site*packages'. - - Values: A string specifying a path. - - Default: `undef`. - -* `wsgi_restrict_embedded`: Defines the [`WSGIRestrictEmbedded`][] directive, such as 'On'. - -Values: On|Off|undef. - -Default: undef. - -* `wsgi_socket_prefix`: Defines the [`WSGISocketPrefix`][] directive, such as "\${APACHE\_RUN\_DIR}WSGI". - - Default: `wsgi_socket_prefix` in [`apache::params`][]. - -The class's parameters correspond to the module's directives. See the [module's documentation][`mod_wsgi`] for details. - -### Private Classes - -#### Class: `apache::confd::no_accf` - -Creates the `no-accf.conf` configuration file in `conf.d`, required by FreeBSD's Apache 2.4. - -#### Class: `apache::default_confd_files` - -Includes `conf.d` files for FreeBSD. - -#### Class: `apache::default_mods` - -Installs the Apache modules required to run the default configuration. See the `apache` class's [`default_mods`][] parameter for details. - -#### Class: `apache::package` - -Installs and configures basic Apache packages. - -#### Class: `apache::params` - -Manages Apache parameters for different operating systems. - -#### Class: `apache::service` - -Manages the Apache daemon. - -#### Class: `apache::version` - -Attempts to automatically detect the Apache version based on the operating system. - -### Public defined types - -#### Defined type: `apache::balancer` - -Creates an Apache load balancing group, also known as a balancer cluster, using [`mod_proxy`][]. Each load balancing group needs one or more balancer members, which you can declare in Puppet with the [`apache::balancermember`][] defined type. - -Declare one `apache::balancer` defined type for each Apache load balancing group. You can export `apache::balancermember` defined types for all balancer members and collect them on a single Apache load balancer server using [exported resources][]. - -**Parameters**: - -##### `name` - -Sets the title of the balancer cluster and name of the `conf.d` file containing its configuration. - -##### `proxy_set` - -Configures key-value pairs as [`ProxySet`][] lines. Values: a [hash][]. Default: '{}'. - -##### `collect_exported` - -Determines whether to use [exported resources][]. - -If you statically declare all of your backend servers, set this parameter to `false` to rely on existing, declared balancer member resources. Also, use `apache::balancermember` with [array][] arguments. - -To dynamically declare backend servers via exported resources collected on a central node, set this parameter to `true` to collect the balancer member resources exported by the balancer member nodes. - -If you don't use exported resources, a single Puppet run configures all balancer members. If you use exported resources, Puppet has to run on the balanced nodes first, then run on the balancer. - -Boolean. Default: `true`. - -#### Defined type: `apache::balancermember` - -Defines members of [`mod_proxy_balancer`][], which sets up a balancer member inside a listening service configuration block in the load balancer's `apache.cfg`. - -**Parameters**: - -##### `balancer_cluster` - -**Required**. - -Sets the Apache service's instance name, and must match the name of a declared [`apache::balancer`][] resource. - -##### `url` - -Specifies the URL used to contact the balancer member server. - -Default: 'http://${::fqdn}/'. - -##### `options` - -Specifies an [array][] of [options](https://httpd.apache.org/docs/current/mod/mod_proxy.html#balancermember) after the URL, and accepts any key-value pairs available to [`ProxyPass`][]. - -Default: an empty array. - -#### Defined type: `apache::custom_config` - -Adds a custom configuration file to the Apache server's `conf.d` directory. If the file is invalid and this defined type's [`verify_config`][] parameter's value is `true`, Puppet throws an error during a Puppet run. - -**Parameters**: - -##### `ensure` - -Specifies whether the configuration file should be present. - -Values: 'absent', 'present'. - -Default: 'present'. - -##### `confdir` - -Sets the directory in which Puppet places configuration files. - -Default: the value of [`$::apache::confd_dir`][`confd_dir`]. - -##### `content` - -Sets the configuration file's content. The `content` and [`source`][] parameters are exclusive of each other. - -Default: `undef` - -##### `filename` - -Sets the name of the file under `confdir` in which Puppet stores the configuration. - -Default: Filename generated from the `priority` parameter and the resource name. - -##### `priority` - -Sets the configuration file's priority by prefixing its filename with this parameter's numeric value, as Apache processes configuration files in alphanumeric order. - -To omit the priority prefix in the configuration file's name, set this parameter to `false`. - -Default: '25'. - -##### `source` - -Points to the configuration file's source. The [`content`][] and `source` parameters are exclusive of each other. TODO: is this required or does it have a default value? - -Default: `undef` - -##### `verify_command` - -Specifies the command Puppet uses to verify the configuration file. Use a fully qualified command. - -This parameter is used only if the [`verify_config`][] parameter's value is `true`. If the `verify_command` fails, the Puppet run deletes the configuration file and raises an error, but does not notify the Apache service. - -Default: '/usr/sbin/apachectl -t'. - -##### `verify_config` - -Specifies whether to validate the configuration file before notifying the Apache service. - -Boolean. Default: `true`. - -#### Defined type: `apache::fastcgi::server` - -Defines one or more external FastCGI servers to handle specific file types. Use this defined type with [`mod_fastcgi`][FastCGI]. - -**Parameters** - -##### `host` - -Determines the FastCGI's hostname or IP address and TCP port number (1-65535). - -Default: '127.0.0.1:9000'. - -##### `timeout` - -Sets the number of seconds a [FastCGI][] application can be inactive before aborting the request and logging the event at the error LogLevel. The inactivity timer applies only as long as a connection is pending with the FastCGI application. If a request is queued to an application, but the application doesn't respond by writing and flushing within this period, the request is aborted. If communication is complete with the application but incomplete with the client (the response is buffered), the timeout does not apply. - -Default: 15. - -##### `flush` - -Forces [`mod_fastcgi`][FastCGI] to write to the client as data is received from the application. By default, `mod_fastcgi` buffers data in order to free the application as quickly as possible. - -Default: `false`. - -##### `faux_path` - -Apache has [FastCGI][] handle URIs that resolve to this filename. The path set in this parameter does not have to exist in the local filesystem. - -Default: "/var/www/${name}.fcgi". - -##### `alias` - -Internally links actions with the FastCGI server. This alias must be unique. - -Default: "/${name}.fcgi". - -##### `file_type` - -Sets the [MIME `content-type`][] of the file to be processed by the FastCGI server. - -Default: 'application/x-httpd-php'. - -#### Defined type: `apache::listen` - -Adds [`Listen`][] directives to `ports.conf` in the Apache configuration directory that define the Apache server's or a virtual host's listening address and port. The [`apache::vhost`][] class uses this defined type, and titles take the form ``, `:`, or `:`. - -#### Defined type: `apache::mod` - -Installs packages for an Apache module that doesn't have a corresponding [`apache::mod::`][] class, and checks for or places the module's default configuration files in the Apache server's `module` and `enable` directories. The default locations depend on your operating system. - -**Parameters**: - -##### `package` - -**Required**. - -Names the package Puppet uses to install the Apache module. - -Default: `undef`. - -##### `package_ensure` - -Determines whether Puppet ensures the Apache module should be installed. - -Values: 'absent', 'present'. - -Default: 'present'. - -##### `lib` - -Defines the module's shared object name. Do not configure manually without special reason. - -Default: `mod_$name.so`. - -##### `lib_path` - -Specifies a path to the module's libraries. Do not manually set this parameter without special reason. The [`path`][] parameter overrides this value. - -Default: The `apache` class's [`lib_path`][] parameter. - - -##### `loadfile_name` - -Sets the filename for the module's [`LoadFile`][] directive, which can also set the module load order as Apache processes them in alphanumeric order. - -Values: Filenames formatted `\*.load`. - -Default: the resource's name followed by 'load', as in '$name.load'. - -##### `loadfiles` - -Specifies an array of [`LoadFile`][] directives. - -Default: `undef`. - -##### `path` - -Specifies a path to the module. Do not manually set this parameter without a special reason. - -Default: [`lib_path`][]/[`lib`][]. - -#### Defined type: `apache::namevirtualhost` - -Enables [name-based virtual hosts][] and adds all related directives to the `ports.conf` file in the Apache HTTPD configuration directory. Titles can take the forms '\*', '\*:\', '\_default\_:\, '\', or '\:\'. - -#### Defined type: `apache::vhost` - -The apache module allows a lot of flexibility in the setup and configuration of virtual hosts. This flexibility is due, in part, to `vhost` being a defined resource type, which allows Apache to evaluate it multiple times with different parameters. - -The `apache::vhost` defined type allows you to have specialized configurations for virtual hosts that have requirements outside the defaults. You can set up a default virtual host within the base `::apache` class, as well as set a customized virtual host as the default. Customized virtual hosts have a lower numeric [`priority`][] than the base class's, causing Apache to process the customized virtual host first. - -The `apache::vhost` defined type uses `concat::fragment` to build the configuration file. To inject custom fragments for pieces of the configuration that the defined type doesn't inherently support, add a custom fragment. - -For the custom fragment's `order` parameter, the `apache::vhost` defined type uses multiples of 10, so any `order` that isn't a multiple of 10 should work. - -**Parameters**: - -##### `access_log` - -Determines whether to configure `*_access.log` directives (`*_file`,`*_pipe`, or `*_syslog`). - -Boolean. Default: `true`. - -##### `access_log_env_var` - -Specifies that only requests with particular environment variables be logged. - -Default: `undef`. - -##### `access_log_file` - -Sets the filename of the `*_access.log` placed in [`logroot`][]. Given a virtual host---for instance, example.com---it defaults to 'example.com_ssl.log' for [SSL-encrypted][SSL encryption] virtual hosts and 'example.com_access.log' for unencrypted virtual hosts. - -Default: `false`. - -##### `access_log_format` - -Specifies the use of either a [`LogFormat`][] nickname or a custom-formatted string for the access log. - -Default: 'combined'. - -##### `access_log_pipe` - -Specifies a pipe where Apache sends access log messages. - -Default: `undef`. - -##### `access_log_syslog` - -Sends all access log messages to syslog. - -Default: `undef`. - -##### `add_default_charset` - -Sets a default media charset value for the [`AddDefaultCharset`][] directive, which is added to `text/plain` and `text/html` responses. - -Default: `undef`. - -##### `add_listen` - -Determines whether the virtual host creates a [`Listen`][] statement. - -Setting `add_listen` to `false` prevents the virtual host from creating a `Listen` statement. This is important when combining virtual hosts that aren't passed an `ip` parameter with those that are. - -Boolean. Default: `true`. - -##### `use_optional_includes` - -Specifies whether Apache uses the [`IncludeOptional`][] directive instead of [`Include`][] for `additional_includes` in Apache 2.4 or newer. - -Boolean. Default: `false`. - -##### `additional_includes` - -Specifies paths to additional static, virtual host-specific Apache configuration files. You can use this parameter to implement a unique, custom configuration not supported by this module. - -Values: a string or [array][] of strings specifying paths. - -Default: an empty array. - -##### `aliases` - -Passes a list of [hashes][hash] to the virtual host to create [`Alias`][], [`AliasMatch`][], [`ScriptAlias`][] or [`ScriptAliasMatch`][] directives as per the [`mod_alias`][] documentation. - -For example: - -``` puppet -aliases => [ - { aliasmatch => '^/image/(.*)\.jpg$', - path => '/files/jpg.images/$1.jpg', - }, - { alias => '/image', - path => '/ftp/pub/image', - }, - { scriptaliasmatch => '^/cgi-bin(.*)', - path => '/usr/local/share/cgi-bin$1', - }, - { scriptalias => '/nagios/cgi-bin/', - path => '/usr/lib/nagios/cgi-bin/', - }, - { alias => '/nagios', - path => '/usr/share/nagios/html', - }, -], -``` - -For the `alias`, `aliasmatch`, `scriptalias` and `scriptaliasmatch` keys to work, each needs a corresponding context, such as `` or ``. Puppet creates the directives in the order specified in the `aliases` parameter. As described in the [`mod_alias`][] documentation, add more specific `alias`, `aliasmatch`, `scriptalias` or `scriptaliasmatch` parameters before the more general ones to avoid shadowing. - -> **Note**: Use the `aliases` parameter instead of the `scriptaliases` parameter because you can precisely control the order of various alias directives. Defining `ScriptAliases` using the `scriptaliases` parameter means *all* `ScriptAlias` directives will come after *all* `Alias` directives, which can lead to `Alias` directives shadowing `ScriptAlias` directives. This often causes problems; for example, this could cause problems with Nagios. - -If [`apache::mod::passenger`][] is loaded and `PassengerHighPerformance` is `true`, the `Alias` directive might not be able to honor the `PassengerEnabled => off` statement. See [this article](http://www.conandalton.net/2010/06/passengerenabled-off-not-working.html) for details. - -##### `allow_encoded_slashes` - -Sets the [`AllowEncodedSlashes`][] declaration for the virtual host, overriding the server default. This modifies the virtual host responses to URLs with `\` and `/` characters. Values: 'nodecode', 'off', 'on'. The default setting omits the declaration from the server configuration and selects the Apache default setting of 'Off'. - -Default: `undef` - -##### `block` - -Specifies the list of things to which Apache blocks access. Valid option: 'scm', which blocks web access to `.svn`, `.git`, and `.bzr` directories. - -Default: an empty [array][]. - -##### `cas_attribute_prefix` - -Adds a header with the value of this header being the attribute values when SAML validation is enabled. - -Defaults: The value set by [`apache::mod::auth_cas`][]. - -##### `cas_attribute_delimiter` - -Sets the delimiter between attribute values in the header created by `cas_attribute_prefix`. - -Default: The value set by [`apache::mod::auth_cas`][]. - -##### `cas_login_url` - -Sets the URL to which the module redirects users when they attempt to access a CAS-protected resource and -don't have an active session. - -Default: The value set by [`apache::mod::auth_cas`][]. - -##### `cas_scrub_request_headers` - -Remove inbound request headers that may have special meaning within mod_auth_cas. - -Default: The value set by [`apache::mod::auth_cas`][]. - -##### `cas_sso_enabled` - -Enables experimental support for single sign out (may mangle POST data). - -Default: The value set by [`apache::mod::auth_cas`][]. - -##### `cas_validate_saml` - -Parse response from CAS server for SAML. Default: The value set by [`apache::mod::auth_cas`][]. - -##### `cas_validate_url` - -Sets the URL to use when validating a client-presented ticket in an HTTP query string. - -Defaults to the value set by [`apache::mod::auth_cas`][]. - -##### `custom_fragment` - -Passes a string of custom configuration directives to place at the end of the virtual host configuration. - -Default: `undef`. - -##### `default_vhost` - -Sets a given `apache::vhost` defined type as the default to serve requests that do not match any other `apache::vhost` defined types. - -Default: `false`. - -##### `directories` - -See the [`directories`](#parameter-directories-for-apachevhost) section. - -##### `directoryindex` - -Sets the list of resources to look for when a client requests an index of the directory by specifying a '/' at the end of the directory name. See the [`DirectoryIndex`][] directive documentation for details. - -Default: `undef`. - -##### `docroot` - -**Required**. - -Sets the [`DocumentRoot`][] location, from which Apache serves files. - -If `docroot` and [`manage_docroot`][] are both set to `false`, no [`DocumentRoot`][] will be set and the accompanying `` block will not be created. - -Values: A string specifying a directory path. - -##### `docroot_group` - -Sets group access to the [`docroot`][] directory. - -Values: A string specifying a system group. - -Default: 'root'. - -##### `docroot_owner` - -Sets individual user access to the [`docroot`][] directory. - -Values: A string specifying a user account. - -Default: 'root'. - -##### `docroot_mode` - -Sets access permissions for the [`docroot`][] directory, in numeric notation. - -Values: A string. - -Default: `undef`. - -##### `manage_docroot` - -Determines whether Puppet manages the [`docroot`][] directory. - -Boolean. Default: `true`. - -##### `error_log` - -Specifies whether `*_error.log` directives should be configured. - -Boolean. Default: `true`. - -##### `error_log_file` - -Points the virtual host's error logs to a `*_error.log` file. If this parameter is undefined, Puppet checks for values in [`error_log_pipe`][], then [`error_log_syslog`][]. - -If none of these parameters is set, given a virtual host `example.com`, Puppet defaults to '$logroot/example.com_error_ssl.log' for SSL virtual hosts and '$logroot/example.com_error.log' for non-SSL virtual hosts. - -Default: `undef`. - -##### `error_log_pipe` - -Specifies a pipe to send error log messages to. - -This parameter has no effect if the [`error_log_file`][] parameter has a value. If neither this parameter nor `error_log_file` has a value, Puppet then checks [`error_log_syslog`][]. - -Default: `undef`. - -##### `error_log_syslog` - -Determines whether to send all error log messages to syslog. - -This parameter has no effect if either of the [`error_log_file`][] or [`error_log_pipe`][] parameters has a value. If none of these parameters has a value, given a virtual host `example.com`, Puppet defaults to '$logroot/example.com_error_ssl.log' for SSL virtual hosts and '$logroot/example.com_error.log' for non-SSL virtual hosts. - -Boolean. Default: `undef`. - -##### `error_documents` - -A list of hashes which can be used to override the [ErrorDocument](https://httpd.apache.org/docs/current/mod/core.html#errordocument) settings for this virtual host. - -For example: - -``` puppet -apache::vhost { 'sample.example.net': - error_documents => [ - { 'error_code' => '503', 'document' => '/service-unavail' }, - { 'error_code' => '407', 'document' => 'https://example.com/proxy/login' }, - ], -} -``` - -Default: '[]'. - -##### `ensure` - -Specifies if the virtual host is present or absent. - -Values: 'absent', 'present'. - -Default: 'present'. - -##### `fallbackresource` - -Sets the [FallbackResource](https://httpd.apache.org/docs/current/mod/mod_dir.html#fallbackresource) directive, which specifies an action to take for any URL that doesn't map to anything in your filesystem and would otherwise return 'HTTP 404 (Not Found)'. Values must either begin with a '/' or be 'disabled'. - -Default: `undef`. - -#####`fastcgi_idle_timeout` - -If using fastcgi, this option sets the timeout for the server to respond. - -Default: `undef`. - -##### `file_e_tag` - -Sets the server default for the [`FileETag`][] declaration, which modifies the response header field for static files. - -Values: 'INode', 'MTime', 'Size', 'All', 'None'. - -Default: `undef`, which uses Apache's default setting of 'MTime Size'. - -##### `filters` - -[Filters](https://httpd.apache.org/docs/current/mod/mod_filter.html) enable smart, context-sensitive configuration of output content filters. - -``` puppet -apache::vhost { "$::fqdn": - filters => [ - 'FilterDeclare COMPRESS', - 'FilterProvider COMPRESS DEFLATE resp=Content-Type $text/html', - 'FilterChain COMPRESS', - 'FilterProtocol COMPRESS DEFLATE change=yes;byteranges=no', - ], -} -``` - -##### `force_type` - -Sets the [`ForceType`][] directive, which forces Apache to serve all matching files with a [MIME `content-type`][] matching this parameter's value. - -#### `add_charset` - -Lets Apache set custom content character sets per directory and/or file extension - -##### `headers` - -Adds lines to replace, merge, or remove response headers. See [Apache's mod_headers documentation](https://httpd.apache.org/docs/current/mod/mod_headers.html#header) for more information. - -Values: A string or an array of strings. - -Default: `undef`. - -##### `ip` - -Sets the IP address the virtual host listens on. By default, uses Apache's default behavior of listening on all IPs. - -Values: A string or an array of strings. - -Default: `undef`. - -##### `ip_based` - -Enables an [IP-based](https://httpd.apache.org/docs/current/vhosts/ip-based.html) virtual host. This parameter inhibits the creation of a NameVirtualHost directive, since those are used to funnel requests to name-based virtual hosts. - -Default: `false`. - -##### `itk` - -Configures [ITK](http://mpm-itk.sesse.net/) in a hash. - -Usage typically looks something like: - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - itk => { - user => 'someuser', - group => 'somegroup', - }, -} -``` - -Values: a hash, which can include the keys: - -* user + group -* `assignuseridexpr` -* `assigngroupidexpr` -* `maxclientvhost` -* `nice` -* `limituidrange` (Linux 3.5.0 or newer) -* `limitgidrange` (Linux 3.5.0 or newer) - -Usage typically looks like: - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - itk => { - user => 'someuser', - group => 'somegroup', - }, -} -``` - -Default: `undef`. - -##### `jk_mounts` - -Sets up a virtual host with 'JkMount' and 'JkUnMount' directives to handle the paths for URL mapping between Tomcat and Apache. - -The parameter must be an array of hashes where each hash must contain the 'worker' and either the 'mount' or 'unmount' keys. - -Usage typically looks like: - -``` puppet -apache::vhost { 'sample.example.net': - jk_mounts => [ - { mount => '/*', worker => 'tcnode1', }, - { unmount => '/*.jpg', worker => 'tcnode1', }, - ], -} -``` -Default: `undef`. - -##### `keepalive` - -Determines whether to enable persistent HTTP connections with the [`KeepAlive`][] directive for the virtual host. By default, the global, server-wide [`KeepAlive`][] setting is in effect. - -Use the `keepalive_timeout` and `max_keepalive_requests` parameters to set relevant options for the virtual host. - -Values: 'Off', 'On'. - -Default: `undef` - -##### `keepalive_timeout` - -Sets the [`KeepAliveTimeout`] directive for the virtual host, which determines the amount of time to wait for subsequent requests on a persistent HTTP connection. By default, the global, server-wide [`KeepAlive`][] setting is in effect. - -This parameter is only relevant if either the global, server-wide [`keepalive` parameter][] or the per-vhost `keepalive` parameter is enabled. - -Default: `undef` - -##### `max_keepalive_requests` - -Limits the number of requests allowed per connection to the virtual host. By default, the global, server-wide [`KeepAlive`][] setting is in effect. - -This parameter is only relevant if either the global, server-wide [`keepalive` parameter][] or the per-vhost `keepalive` parameter is enabled. - -Default: `undef`. - -##### `auth_kerb` - -Enable [`mod_auth_kerb`][] parameters for a virtual host. - -Usage typically looks like: - -``` puppet -apache::vhost { 'sample.example.net': - auth_kerb => `true`, - krb_method_negotiate => 'on', - krb_auth_realms => ['EXAMPLE.ORG'], - krb_local_user_mapping => 'on', - directories => { - path => '/var/www/html', - auth_name => 'Kerberos Login', - auth_type => 'Kerberos', - auth_require => 'valid-user', - }, -} -``` - -Related parameters follow the names of `mod_auth_kerb` directives: - -- `krb_method_negotiate`: Determines whether to use the Negotiate method. Default: 'on'. -- `krb_method_k5passwd`: Determines whether to use password-based authentication for Kerberos v5. Default: 'on'. -- `krb_authoritative`: If set to 'off', authentication controls can be passed on to another module. Default: 'on'. -- `krb_auth_realms`: Specifies an array of Kerberos realms to use for authentication. Default: '[]'. -- `krb_5keytab`: Specifies the Kerberos v5 keytab file's location. Default: `undef`. -- `krb_local_user_mapping`: Strips @REALM from usernames for further use. Default: `undef`. - -Boolean. Default: `false`. - -##### `krb_verify_kdc` - -This option can be used to disable the verification tickets against local keytab to prevent KDC spoofing attacks. - -Default: 'on'. - -##### `krb_servicename` - -Specifies the service name that will be used by Apache for authentication. Corresponding key of this name must be stored in the keytab. - -Default: 'HTTP'. - -##### `krb_save_credentials` - -This option enables credential saving functionality. - -Default is 'off' - -##### `logroot` - -Specifies the location of the virtual host's logfiles. - -Default: '/var/log//'. - -##### `$logroot_ensure` - -Determines whether or not to remove the logroot directory for a virtual host. - -Values: 'directory', 'absent'. - -Default: 'directory'. - -##### `logroot_mode` - -Overrides the mode the logroot directory is set to. Do *not* grant write access to the directory the logs are stored in without being aware of the consequences; for more information, see [Apache's log security documentation](https://httpd.apache.org/docs/2.4/logs.html#security). - -Default: `undef`. - -##### `logroot_owner` - -Sets individual user access to the logroot directory. - -Defaults to `undef`. - -##### `logroot_group` - -Sets group access to the [`logroot`][] directory. - -Defaults to `undef`. - -##### `log_level` - -Specifies the verbosity of the error log. - -Values: 'emerg', 'alert', 'crit', 'error', 'warn', 'notice', 'info' or 'debug'. - -Default: 'warn' for the global server configuration. Can be overridden on a per-virtual host basis. - -###### `modsec_body_limit` - -Configures the maximum request body size (in bytes) ModSecurity accepts for buffering. - -Values: An integer. - -Default: `undef`. - -###### `modsec_disable_vhost` - -Disables [`mod_security`][] on a virtual host. Only valid if [`apache::mod::security`][] is included. - -Boolean. Default: `undef`. - -###### `modsec_disable_ids` - -Removes `mod_security` IDs from the virtual host. - -Values: An array of `mod_security` IDs to remove from the virtual host. Also takes a hash allowing removal of an ID from a specific location. - -``` puppet -apache::vhost { 'sample.example.net': - modsec_disable_ids => [ 90015, 90016 ], -} -``` - -``` puppet -apache::vhost { 'sample.example.net': - modsec_disable_ids => { '/location1' => [ 90015, 90016 ] }, -} -``` - -Default: `undef`. - -###### `modsec_disable_ips` - -Specifies an array of IP addresses to exclude from [`mod_security`][] rule matching. - -Default: `undef`. - -###### `modsec_disable_msgs` - -Array of mod_security Msgs to remove from the virtual host. Also takes a hash allowing removal of an Msg from a specific location. - -``` puppet -apache::vhost { 'sample.example.net': - modsec_disable_msgs => [ 'Blind SQL Injection Attack', 'Session Fixation Attack' ], -} -``` - -``` puppet -apache::vhost { 'sample.example.net': - modsec_disable_msgs => { '/location1' => [ 'Blind SQL Injection Attack', 'Session Fixation Attack' ] }, -} -``` - -Default: `undef`. - -###### `modsec_disable_tags` - -Array of mod_security Tags to remove from the virtual host. Also takes a hash allowing removal of an Tag from a specific location. - -``` puppet -apache::vhost { 'sample.example.net': - modsec_disable_tags => [ 'WEB_ATTACK/SQL_INJECTION', 'WEB_ATTACK/XSS' ], -} -``` - -``` puppet -apache::vhost { 'sample.example.net': - modsec_disable_tags => { '/location1' => [ 'WEB_ATTACK/SQL_INJECTION', 'WEB_ATTACK/XSS' ] }, -} -``` - -Default: `undef`. - -##### `modsec_audit*` - -* `modsec_audit_log` -* `modsec_audit_log_file` -* `modsec_audit_log_pipe` - -These three parameters together determine how to send `mod_security` audit log ([SecAuditLog](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#SecAuditLog)). - -* If `modsec_audit_log_file` is set, it is relative to [`logroot`][]. - - Default: `undef`. - -* If `modsec_audit_log_pipe` is set, it should start with a pipe. Example '|/path/to/mlogc /path/to/mlogc.conf'. - - Default: `undef`. - -* If `modsec_audit_log` is `true`, given a virtual host---for instance, example.com---it defaults to 'example.com\_security\_ssl.log' for [SSL-encrypted][SSL encryption] virtual hosts and 'example.com\_security.log' for unencrypted virtual hosts. - - Default: `false`. - -If none of those parameters are set, the global audit log is used (''/var/log/httpd/modsec\_audit.log''; Debian and derivatives: ''/var/log/apache2/modsec\_audit.log''; others: ). - -##### `no_proxy_uris` - -Specifies URLs you do not want to proxy. This parameter is meant to be used in combination with [`proxy_dest`](#proxy_dest). - -Default: []. - -##### `no_proxy_uris_match` - -This directive is equivalent to [`no_proxy_uris`][], but takes regular expressions. - -Default: []. - -##### `proxy_preserve_host` - -Sets the [ProxyPreserveHost Directive](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypreservehost). - -Setting this parameter to `true` enables the `Host:` line from an incoming request to be proxied to the host instead of hostname. Setting it to `false` sets this directive to 'Off'. - -Boolean. Default: `false`. - -##### `proxy_add_headers` - -Sets the [ProxyAddHeaders Directive](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyaddheaders). - -This parameter controlls whether proxy-related HTTP headers (X-Forwarded-For, X-Forwarded-Host and X-Forwarded-Server) get sent to the backend server. - -Boolean. Default: `false`. - -##### `proxy_error_override` - -Sets the [ProxyErrorOverride Directive](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyerroroverride). This directive controls whether Apache should override error pages for proxied content. - -Boolean. Default: `false`. - -##### `options` - -Sets the [`Options`][] for the specified virtual host. For example: - -``` puppet -apache::vhost { 'site.name.fdqn': - … - options => ['Indexes','FollowSymLinks','MultiViews'], -} -``` - -> **Note**: If you use the [`directories`][] parameter of [`apache::vhost`][], 'Options', 'Override', and 'DirectoryIndex' are ignored because they are parameters within `directories`. - -Default: ['Indexes','FollowSymLinks','MultiViews'], - -##### `override` - -Sets the overrides for the specified virtual host. Accepts an array of [AllowOverride](https://httpd.apache.org/docs/current/mod/core.html#allowoverride) arguments. - -Default: '[none]'. - -##### `passenger_app_root` - -Sets [PassengerRoot](https://www.phusionpassenger.com/library/config/apache/reference/#passengerapproot), the location of the Passenger application root if different from the DocumentRoot. - -Values: A string specifying a path. - -Default: `undef`. - -##### `passenger_app_env` - -Sets [PassengerAppEnv](https://www.phusionpassenger.com/library/config/apache/reference/#passengerappenv), the environment for the Passenger application. If not specified, defaults to the global setting or 'production'. - -Values: A string specifying the name of the environment. - -Default: `undef`. - -##### `passenger_log_file` - -By default, Passenger log messages are written to the Apache global error log. With [PassengerLogFile](https://www.phusionpassenger.com/library/config/apache/reference/#passengerlogfile), you can configure those messages to be logged to a different file. This option is only available since Passenger 5.0.5. - -Values: A string specifying a path. - -Default: `undef`. - -##### `passenger_log_level` - -This option allows to specify how much information should be written to the log file. If not set, [PassengerLogLevel](https://www.phusionpassenger.com/library/config/apache/reference/#passengerloglevel) will not show up in the configuration file and the defaults are used. - -Default: Passenger versions less than 3.0.0: '0'; 5.0.0 and later: '3'. - -##### `passenger_ruby` - -Sets [PassengerRuby](https://www.phusionpassenger.com/library/config/apache/reference/#passengerruby), the Ruby interpreter to use for the application, on this virtual host. - -Default: `undef`. - -##### `passenger_min_instances` - -Sets [PassengerMinInstances](https://www.phusionpassenger.com/library/config/apache/reference/#passengermininstances), the minimum number of application processes to run. - -##### `passenger_max_requests` - -Sets [PassengerMaxRequests](https://www.phusionpassenger.com/library/config/apache/reference/#pas -sengermaxrequests), the maximum number of requests an application process will process. - -##### `passenger_max_instances_per_app` - -Sets [PassengerMaxInstancesPerApp](https://www.phusionpassenger.com/library/config/apache/reference/#passengermaxinstancesperapp), the maximum number of application processes that may simultaneously exist for a single application. - -Default: `undef`. - -##### `passenger_start_timeout` - -Sets [PassengerStartTimeout](https://www.phusionpassenger.com/library/config/apache/reference/#passengerstarttimeout), the timeout for the application startup. - -##### `passenger_pre_start` - -Sets [PassengerPreStart](https://www.phusionpassenger.com/library/config/apache/reference/#passengerprestart), the URL of the application if pre-starting is required. - -##### `passenger_user` - -Sets [PassengerUser](https://www.phusionpassenger.com/library/config/apache/reference/#passengeruser), the running user for sandboxing applications. - -##### `passenger_high_performance` - -Sets the [`PassengerHighPerformance`](https://www.phusionpassenger.com/library/config/apache/reference/#passengerhighperformance) parameter. Values: `true`, `false`. Default: `undef`. - -##### `passenger_nodejs` - -Sets the [`PassengerNodejs`](https://www.phusionpassenger.com/library/config/apache/reference/#passengernodejs), the NodeJS interpreter to use for the application, on this virtual host. - -##### `passenger_sticky_sessions` - -Sets the [`PassengerStickySessions`](https://www.phusionpassenger.com/library/config/apache/reference/#passengerstickysessions) parameter. - -Boolean. Default: `undef`. - -##### `passenger_startup_file` - -Sets the [`PassengerStartupFile`](https://www.phusionpassenger.com/library/config/apache/reference/#passengerstartupfile) path. This path is relative to the application root. - -##### `php_flags & values` - -Allows per-virtual host setting [`php_value`s or `php_flag`s](http://php.net/manual/en/configuration.changes.php). These flags or values can be overwritten by a user or an application. - -Default: '{}'. - -##### `php_admin_flags & values` - -Allows per-virtual host setting [`php_admin_value`s or `php_admin_flag`s](http://php.net/manual/en/configuration.changes.php). These flags or values cannot be overwritten by a user or an application. - -Default: '{}'. - -##### `port` - -Sets the port the host is configured on. The module's defaults ensure the host listens on port 80 for non-SSL virtual hosts and port 443 for SSL virtual hosts. The host only listens on the port set in this parameter. - -##### `priority` - -Sets the relative load-order for Apache HTTPD VirtualHost configuration files. - -If nothing matches the priority, the first name-based virtual host is used. Likewise, passing a higher priority causes the alphabetically first name-based virtual host to be used if no other names match. - -> **Note:** You should not need to use this parameter. However, if you do use it, be aware that the `default_vhost` parameter for `apache::vhost` passes a priority of '15'. - -To omit the priority prefix in file names, pass a priority of `false`. - -Default: '25'. - -##### `proxy_dest` - -Specifies the destination address of a [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass) configuration. - -Default: `undef`. - -##### `proxy_pass` - -Specifies an array of `path => URI` values for a [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass) configuration. Optionally, parameters can be added as an array. - -Default: `undef`. - -``` puppet -apache::vhost { 'site.name.fdqn': - … - proxy_pass => [ - { 'path' => '/a', 'url' => 'http://backend-a/' }, - { 'path' => '/b', 'url' => 'http://backend-b/' }, - { 'path' => '/c', 'url' => 'http://backend-a/c', 'params' => {'max'=>20, 'ttl'=>120, 'retry'=>300}}, - { 'path' => '/l', 'url' => 'http://backend-xy', - 'reverse_urls' => ['http://backend-x', 'http://backend-y'] }, - { 'path' => '/d', 'url' => 'http://backend-a/d', - 'params' => { 'retry' => '0', 'timeout' => '5' }, }, - { 'path' => '/e', 'url' => 'http://backend-a/e', - 'keywords' => ['nocanon', 'interpolate'] }, - { 'path' => '/f', 'url' => 'http://backend-f/', - 'setenv' => ['proxy-nokeepalive 1','force-proxy-request-1.0 1']}, - { 'path' => '/g', 'url' => 'http://backend-g/', - 'reverse_cookies' => [{'path' => '/g', 'url' => 'http://backend-g/',}, {'domain' => 'http://backend-g', 'url' => 'http:://backend-g',},], }, - { 'path' => '/h', 'url' => 'http://backend-h/h', - 'no_proxy_uris' => ['/h/admin', '/h/server-status'] }, - ], -} -``` - -* `reverse_urls`. *Optional.* This setting is useful when used with `mod_proxy_balancer`. Values: an array or string. -* `reverse_cookies`. *Optional.* Sets `ProxyPassReverseCookiePath` and `ProxyPassReverseCookieDomain`. -* `params`. *Optional.* Allows for ProxyPass key-value parameters, such as connection settings. -* `setenv`. *Optional.* Sets [environment variables](https://httpd.apache.org/docs/current/mod/mod_proxy.html#envsettings) for the proxy directive. Values: array. - -##### `proxy_dest_match` - -This directive is equivalent to [`proxy_dest`][], but takes regular expressions, see [ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch) for details. - -##### `proxy_dest_reverse_match` - -Allows you to pass a ProxyPassReverse if [`proxy_dest_match`][] is specified. See [ProxyPassReverse](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassreverse) for details. - -##### `proxy_pass_match` - -This directive is equivalent to [`proxy_pass`][], but takes regular expressions, see [ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch) for details. - -##### `rack_base_uris` - -Specifies the resource identifiers for a rack configuration. The file paths specified are listed as rack application roots for [Phusion Passenger](http://www.modrails.com/documentation/Users%20guide%20Apache.html#_railsbaseuri_and_rackbaseuri) in the _rack.erb template. - -Default: `undef`. - -#####`passenger_base_uris` - -Used to specify that the given URI is a Phusion Passenger-served application. The file paths specified are listed as passenger application roots for [Phusion Passenger](https://www.phusionpassenger.com/documentation/Users%20guide%20Apache.html#PassengerBaseURI) in the _passenger_base_uris.erb template. - -Default: `undef`. - -##### `redirect_dest` - -Specifies the address to redirect to. - -Default: `undef`. - -##### `redirect_source` - -Specifies the source URIs that redirect to the destination specified in `redirect_dest`. If more than one item for redirect is supplied, the source and destination must be the same length, and the items are order-dependent. - -``` puppet -apache::vhost { 'site.name.fdqn': - … - redirect_source => ['/images','/downloads'], - redirect_dest => ['http://img.example.com/','http://downloads.example.com/'], -} -``` - -##### `redirect_status` - -Specifies the status to append to the redirect. - -Default: `undef`. - -``` puppet -apache::vhost { 'site.name.fdqn': - … - redirect_status => ['temp','permanent'], -} -``` - -##### `redirectmatch_*` - -* `redirectmatch_regexp` -* `redirectmatch_status` -* `redirectmatch_dest` - -Determines which server status should be raised for a given regular expression and where to forward the user to. Entered as arrays. - -Default: `undef`. - -``` puppet -apache::vhost { 'site.name.fdqn': - … - redirectmatch_status => ['404','404'], - redirectmatch_regexp => ['\.git(/.*|$)/','\.svn(/.*|$)'], - redirectmatch_dest => ['http://www.example.com/1','http://www.example.com/2'], -} -``` - -##### `request_headers` - -Modifies collected [request headers](https://httpd.apache.org/docs/current/mod/mod_headers.html#requestheader) in various ways, including adding additional request headers, removing request headers, and so on. - -Default: `undef`. - -``` puppet -apache::vhost { 'site.name.fdqn': - … - request_headers => [ - 'append MirrorID "mirror 12"', - 'unset MirrorID', - ], -} -``` - -##### `rewrites` - -Creates URL rewrite rules. Expects an array of hashes. - -Values: Hash keys that are any of 'comment', 'rewrite_base', 'rewrite_cond', 'rewrite_rule' or 'rewrite_map'. - -Default: `undef`. - -For example, you can specify that anyone trying to access index.html is served welcome.html - -``` puppet -apache::vhost { 'site.name.fdqn': - … - rewrites => [ { rewrite_rule => ['^index\.html$ welcome.html'] } ] -} -``` - -The parameter allows rewrite conditions that, when `true`, execute the associated rule. For instance, if you wanted to rewrite URLs only if the visitor is using IE - -``` puppet -apache::vhost { 'site.name.fdqn': - … - rewrites => [ - { - comment => 'redirect IE', - rewrite_cond => ['%{HTTP_USER_AGENT} ^MSIE'], - rewrite_rule => ['^index\.html$ welcome.html'], - }, - ], -} -``` - -You can also apply multiple conditions. For instance, rewrite index.html to welcome.html only when the browser is Lynx or Mozilla (version 1 or 2) - -``` puppet -apache::vhost { 'site.name.fdqn': - … - rewrites => [ - { - comment => 'Lynx or Mozilla v1/2', - rewrite_cond => ['%{HTTP_USER_AGENT} ^Lynx/ [OR]', '%{HTTP_USER_AGENT} ^Mozilla/[12]'], - rewrite_rule => ['^index\.html$ welcome.html'], - }, - ], -} -``` - -Multiple rewrites and conditions are also possible - -``` puppet -apache::vhost { 'site.name.fdqn': - … - rewrites => [ - { - comment => 'Lynx or Mozilla v1/2', - rewrite_cond => ['%{HTTP_USER_AGENT} ^Lynx/ [OR]', '%{HTTP_USER_AGENT} ^Mozilla/[12]'], - rewrite_rule => ['^index\.html$ welcome.html'], - }, - { - comment => 'Internet Explorer', - rewrite_cond => ['%{HTTP_USER_AGENT} ^MSIE'], - rewrite_rule => ['^index\.html$ /index.IE.html [L]'], - }, - { - rewrite_base => /apps/, - rewrite_rule => ['^index\.cgi$ index.php', '^index\.html$ index.php', '^index\.asp$ index.html'], - }, - { comment => 'Rewrite to lower case', - rewrite_cond => ['%{REQUEST_URI} [A-Z]'], - rewrite_map => ['lc int:tolower'], - rewrite_rule => ['(.*) ${lc:$1} [R=301,L]'], - }, - ], -} -``` - -Refer to the [`mod_rewrite` documentation][`mod_rewrite`] for more details on what is possible with rewrite rules and conditions. - -##### `rewrite_inherit` - -Determines whether the virtual host inherits global rewrite rules. - -Default: `false`. - -Rewrite rules may be specified globally (in `$conf_file` or `$confd_dir`) or inside the virtual host `.conf` file. By default, virtual hosts do not inherit global settings. To activate inheritance, specify the `rewrites` parameter and set `rewrite_inherit` parameter to `true`: - -``` puppet -apache::vhost { 'site.name.fdqn': - … - rewrites => [ - , - ], - rewrite_inherit => `true`, -} -``` - -> **Note**: The `rewrites` parameter is **required** for this to have effect - -Apache activates global `Rewrite` rules inheritance if the virtual host files contains the following directives: - -``` ApacheConf -RewriteEngine On -RewriteOptions Inherit -``` - -Refer to the [official `mod_rewrite` documentation](https://httpd.apache.org/docs/2.2/mod/mod_rewrite.html), section "Rewriting in Virtual Hosts". - -##### `scriptalias` - -Defines a directory of CGI scripts to be aliased to the path '/cgi-bin', such as '/usr/scripts'. - -Default: `undef`. - -##### `scriptaliases` - -> **Note**: This parameter is deprecated in favor of the `aliases` parameter. - -Passes an array of hashes to the virtual host to create either ScriptAlias or ScriptAliasMatch statements per the [`mod_alias` documentation][`mod_alias`]. - -``` puppet -scriptaliases => [ - { - alias => '/myscript', - path => '/usr/share/myscript', - }, - { - aliasmatch => '^/foo(.*)', - path => '/usr/share/fooscripts$1', - }, - { - aliasmatch => '^/bar/(.*)', - path => '/usr/share/bar/wrapper.sh/$1', - }, - { - alias => '/neatscript', - path => '/usr/share/neatscript', - }, -] -``` - -The ScriptAlias and ScriptAliasMatch directives are created in the order specified. As with [Alias and AliasMatch](#aliases) directives, specify more specific aliases before more general ones to avoid shadowing. - -##### `serveradmin` - -Specifies the email address Apache displays when it renders one of its error pages. - -Default: `undef`. - -##### `serveraliases` - -Sets the [ServerAliases](https://httpd.apache.org/docs/current/mod/core.html#serveralias) of the site. - -Default: '[]'. - -##### `servername` - -Sets the servername corresponding to the hostname you connect to the virtual host at. - -Default: the title of the resource. - -##### `setenv` - -Used by HTTPD to set environment variables for virtual hosts. - -Default: '[]'. - -Example: - -``` puppet -apache::vhost { 'setenv.example.com': - setenv => ['SPECIAL_PATH /foo/bin'], -} -``` - -##### `setenvif` - -Used by HTTPD to conditionally set environment variables for virtual hosts. - -Default: '[]'. - -##### `setenvifnocase` - -Used by HTTPD to conditionally set environment variables for virtual hosts (caseless matching). - -Default: '[]'. - -##### `suphp_*` - -* `suphp_addhandler` -* `suphp_configpath` -* `suphp_engine` - -Sets up a virtual host with [suPHP](http://suphp.org/DocumentationView.html?file=apache/CONFIG). - -* `suphp_addhandler`. Default: 'php5-script' on RedHat and FreeBSD, and 'x-httpd-php' on Debian and Gentoo. -* `suphp_configpath`. Default: `undef` on RedHat and FreeBSD, and '/etc/php5/apache2' on Debian and Gentoo. -* `suphp_engine`. Values: 'on' or 'off'. Default: 'off'. - -An example virtual host configuration with suPHP: - -``` puppet -apache::vhost { 'suphp.example.com': - port => '80', - docroot => '/home/appuser/myphpapp', - suphp_addhandler => 'x-httpd-php', - suphp_engine => 'on', - suphp_configpath => '/etc/php5/apache2', - directories => { path => '/home/appuser/myphpapp', - 'suphp' => { user => 'myappuser', group => 'myappgroup' }, - } -} -``` - -##### `vhost_name` - -Enables name-based virtual hosting. If no IP is passed to the virtual host, but the virtual host is assigned a port, then the virtual host name is 'vhost_name:port'. If the virtual host has no assigned IP or port, the virtual host name is set to the title of the resource. - -Default: '*'. - -##### `virtual_docroot` - -Sets up a virtual host with a wildcard alias subdomain mapped to a directory with the same name. For example, 'http://example.com' would map to '/var/www/example.com'. - -Default: `false`. - -``` puppet -apache::vhost { 'subdomain.loc': - vhost_name => '*', - port => '80', - virtual_docroot => '/var/www/%-2+', - docroot => '/var/www', - serveraliases => ['*.loc',], -} -``` - -##### `wsgi*` - -* `wsgi_daemon_process` -* `wsgi_daemon_process_options` -* `wsgi_process_group` -* `wsgi_script_aliases` -* `wsgi_pass_authorization` - -Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi). - -* `wsgi_daemon_process`: A hash that sets the name of the WSGI daemon, accepting [certain keys](http://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIDaemonProcess.html). Default: `undef`. -* `wsgi_daemon_process_options`. _Optional._ Default: `undef`. -* `wsgi_process_group`: Sets the group ID that the virtual host runs under. Default: `undef`. -* `wsgi_script_aliases`: Requires a hash of web paths to filesystem .wsgi paths. Default: `undef`. -* `wsgi_script_aliases_match`: Requires a hash of web path regexes to filesystem .wsgi paths. Default: `undef` -* `wsgi_pass_authorization`: Uses the WSGI application to handle authorization instead of Apache when set to 'On'. For more information, see [mod_wsgi's WSGIPassAuthorization documentation] (https://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIPassAuthorization.html). Default: `undef`, leading Apache to use its default value of 'Off'. -* `wsgi_chunked_request`: Enables support for chunked requests. Default: `undef`. - -An example virtual host configuration with WSGI: - -``` puppet -apache::vhost { 'wsgi.example.com': - port => '80', - docroot => '/var/www/pythonapp', - wsgi_daemon_process => 'wsgi', - wsgi_daemon_process_options => - { processes => '2', - threads => '15', - display-name => '%{GROUP}', - }, - wsgi_process_group => 'wsgi', - wsgi_script_aliases => { '/' => '/var/www/demo.wsgi' }, - wsgi_chunked_request => 'On', -} -``` - -#### Parameter `directories` for `apache::vhost` - -The `directories` parameter within the `apache::vhost` class passes an array of hashes to the virtual host to create [Directory](https://httpd.apache.org/docs/current/mod/core.html#directory), [File](https://httpd.apache.org/docs/current/mod/core.html#files), and [Location](https://httpd.apache.org/docs/current/mod/core.html#location) directive blocks. These blocks take the form, '< Directory /path/to/directory>...< /Directory>'. - -The `path` key sets the path for the directory, files, and location blocks. Its value must be a path for the 'directory', 'files', and 'location' providers, or a regex for the 'directorymatch', 'filesmatch', or 'locationmatch' providers. Each hash passed to `directories` **must** contain `path` as one of the keys. - -The `provider` key is optional. If missing, this key defaults to 'directory'. Values: 'directory', 'files', 'proxy', 'location', 'directorymatch', 'filesmatch', 'proxymatch' or 'locationmatch'. If you set `provider` to 'directorymatch', it uses the keyword 'DirectoryMatch' in the Apache config file. - -An example use of `directories`: - -``` puppet -apache::vhost { 'files.example.net': - docroot => '/var/www/files', - directories => [ - { 'path' => '/var/www/files', - 'provider' => 'files', - 'deny' => 'from all', - }, - ], -} -``` - -> **Note:** At least one directory should match the `docroot` parameter. After you start declaring directories, `apache::vhost` assumes that all required Directory blocks will be declared. If not defined, a single default Directory block is created that matches the `docroot` parameter. - -Available handlers, represented as keys, should be placed within the `directory`, `files`, or `location` hashes. This looks like - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ { path => '/path/to/directory', handler => value } ], -} -``` - -Any handlers you do not set in these hashes are considered 'undefined' within Puppet and are not added to the virtual host, resulting in the module using their default values. Supported handlers are: - -##### `addhandlers` - -Sets [AddHandler](https://httpd.apache.org/docs/current/mod/mod_mime.html#addhandler) directives, which map filename extensions to the specified handler. Accepts a list of hashes, with `extensions` serving to list the extensions being managed by the handler, and takes the form: `{ handler => 'handler-name', extensions => ['extension'] }`. - -An example: - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - addhandlers => [{ handler => 'cgi-script', extensions => ['.cgi']}], - }, - ], -} -``` - -##### `allow` - -Sets an [Allow](https://httpd.apache.org/docs/2.2/mod/mod_authz_host.html#allow) directive, which groups authorizations based on hostnames or IPs. **Deprecated:** This parameter is being deprecated due to a change in Apache. It only works with Apache 2.2 and lower. You can use it as a single string for one rule or as an array for more than one. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - allow => 'from example.org', - }, - ], -} -``` - -##### `allow_override` - -Sets the types of directives allowed in [.htaccess](https://httpd.apache.org/docs/current/mod/core.html#allowoverride) files. Accepts an array. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - allow_override => ['AuthConfig', 'Indexes'], - }, - ], -} -``` - -##### `auth_basic_authoritative` - -Sets the value for [AuthBasicAuthoritative](https://httpd.apache.org/docs/current/mod/mod_auth_basic.html#authbasicauthoritative), which determines whether authorization and authentication are passed to lower level Apache modules. - -##### `auth_basic_fake` - -Sets the value for [AuthBasicFake](https://httpd.apache.org/docs/current/mod/mod_auth_basic.html#authbasicfake), which statically configures authorization credentials for a given directive block. - -##### `auth_basic_provider` - -Sets the value for [AuthBasicProvider](https://httpd.apache.org/docs/current/mod/mod_auth_basic.html#authbasicprovider), which sets the authentication provider for a given location. - -##### `auth_digest_algorithm` - -Sets the value for [AuthDigestAlgorithm](https://httpd.apache.org/docs/current/mod/mod_auth_digest.html#authdigestalgorithm), which selects the algorithm used to calculate the challenge and response hashes. - -###### `auth_digest_domain` - -Sets the value for [AuthDigestDomain](https://httpd.apache.org/docs/current/mod/mod_auth_digest.html#authdigestdomain), which allows you to specify one or more URIs in the same protection space for digest authentication. - -##### `auth_digest_nonce_lifetime` - -Sets the value for [AuthDigestNonceLifetime](https://httpd.apache.org/docs/current/mod/mod_auth_digest.html#authdigestnoncelifetime), which controls how long the server nonce is valid. - -##### `auth_digest_provider` - -Sets the value for [AuthDigestProvider](https://httpd.apache.org/docs/current/mod/mod_auth_digest.html#authdigestprovider), which sets the authentication provider for a given location. - -##### `auth_digest_qop` - -Sets the value for [AuthDigestQop](https://httpd.apache.org/docs/current/mod/mod_auth_digest.html#authdigestqop), which determines the quality-of-protection to use in digest authentication. - -##### `auth_digest_shmem_size` - -Sets the value for [AuthAuthDigestShmemSize](https://httpd.apache.org/docs/current/mod/mod_auth_digest.html#authdigestshmemsize), which defines the amount of shared memory allocated to the server for keeping track of clients. - -##### `auth_group_file` - -Sets the value for [AuthGroupFile](https://httpd.apache.org/docs/current/mod/mod_authz_groupfile.html#authgroupfile), which sets the name of the text file containing the list of user groups for authorization. - -##### `auth_name` - -Sets the value for [AuthName](https://httpd.apache.org/docs/current/mod/mod_authn_core.html#authname), which sets the name of the authorization realm. - -##### `auth_require` - -Sets the entity name you're requiring to allow access. Read more about [Require](https://httpd.apache.org/docs/current/mod/mod_authz_host.html#requiredirectives). - -##### `auth_type` - -Sets the value for [AuthType](https://httpd.apache.org/docs/current/mod/mod_authn_core.html#authtype), which guides the type of user authentication. - -##### `auth_user_file` - -Sets the value for [AuthUserFile](https://httpd.apache.org/docs/current/mod/mod_authn_file.html#authuserfile), which sets the name of the text file containing the users/passwords for authentication. - -##### `auth_merging` - -Sets the value for [AuthMerging](https://httpd.apache.org/docs/current/mod/mod_authz_core.html#authmerging), which determines if authorization logic should be combined - -##### `auth_ldap_url` - -Sets the value for [AuthLDAPURL](https://httpd.apache.org/docs/current/mod/mod_authnz_ldap.html#authldapurl), which determines URL of LDAP-server(s) if AuthBasicProvider 'ldap' is used - -##### `auth_ldap_bind_dn` - -Sets the value for [AuthLDAPBindDN](https://httpd.apache.org/docs/current/mod/mod_authnz_ldap.html#authldapbinddn), which allows use of an optional DN used to bind to the LDAP-server when searching for entries if AuthBasicProvider 'ldap' is used. - -##### `auth_ldap_bind_password` - -Sets the value for [AuthLDAPBindPassword](https://httpd.apache.org/docs/current/mod/mod_authnz_ldap.html#authldapbindpassword), which allows use of an optional bind password to use in conjunction with the bind DN if AuthBasicProvider 'ldap' is used. - -##### `auth_ldap_group_attribute` - -Array of values for [AuthLDAPGroupAttribute](https://httpd.apache.org/docs/current/mod/mod_authnz_ldap.html#authldapgroupattribute), specifies which LDAP attributes are used to check for user members within ldap-groups. Defaults are: "member" and "uniquemember". - -##### `auth_ldap_group_attribute_is_dn` - -Sets value for [AuthLDAPGroupAttributeIsDN](https://httpd.apache.org/docs/current/mod/mod_authnz_ldap.html#authldapgroupattributeisdn), specifies if member of a ldapgroup is a dn or simple username. When set on, this directive says to use the distinguished name of the client username when checking for group membership. Otherwise, the username will be used. valid values are: "on" or "off" - -##### `custom_fragment` - -Pass a string of custom configuration directives to be placed at the end of the directory configuration. - -``` puppet -apache::vhost { 'monitor': - … - directories => [ - { - path => '/path/to/directory', - custom_fragment => ' - - SetHandler balancer-manager - Order allow,deny - Allow from all - - - SetHandler server-status - Order allow,deny - Allow from all - -ProxyStatus On', - }, - ] -} -``` - -##### `dav` - -Sets the value for [Dav](http://httpd.apache.org/docs/current/mod/mod_dav.html#dav), which determines if the WebDAV HTTP methods should be enabled. The value can be either 'On', 'Off' or the name of the provider. A value of 'On' enables the default filesystem provider implemented by the `mod_dav_fs` module. - -##### `dav_depth_infinity` - -Sets the value for [DavDepthInfinity](http://httpd.apache.org/docs/current/mod/mod_dav.html#davdepthinfinity), which is used to enable the processing of `PROPFIND` requests having a `Depth: Infinity` header. - -##### `dav_min_timeout` - -Sets the value for [DavMinTimeout](http://httpd.apache.org/docs/current/mod/mod_dav.html#davmintimeout), which sets the time the server holds a lock on a DAV resource. The value should be the number of seconds to set. - -##### `deny` - -Sets a [Deny](https://httpd.apache.org/docs/2.2/mod/mod_authz_host.html#deny) directive, specifying which hosts are denied access to the server. **Deprecated:** This parameter is being deprecated due to a change in Apache. It only works with Apache 2.2 and lower. You can use it as a single string for one rule or as an array for more than one. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - deny => 'from example.org', - }, - ], -} -``` - -##### `error_documents` - -An array of hashes used to override the [ErrorDocument](https://httpd.apache.org/docs/current/mod/core.html#errordocument) settings for the directory. - -``` puppet -apache::vhost { 'sample.example.net': - directories => [ - { path => '/srv/www', - error_documents => [ - { 'error_code' => '503', - 'document' => '/service-unavail', - }, - ], - }, - ], -} -``` - -##### `ext_filter_options` - -Sets the [ExtFilterOptions](https://httpd.apache.org/docs/current/mod/mod_ext_filter.html) directive. -Note that you must declare `class { 'apache::mod::ext_filter': }` before using this directive. - -``` puppet -apache::vhost { 'filter.example.org': - docroot => '/var/www/filter', - directories => [ - { path => '/var/www/filter', - ext_filter_options => 'LogStderr Onfail=abort', - }, - ], -} -``` - -##### `geoip_enable` - -Sets the [GeoIPEnable](http://dev.maxmind.com/geoip/legacy/mod_geoip2/#Configuration) directive. -Note that you must declare `class {'apache::mod::geoip': }` before using this directive. - -``` puppet -apache::vhost { 'first.example.com': - docroot => '/var/www/first', - directories => [ - { path => '/var/www/first', - geoip_enable => `true`, - }, - ], -} -``` - -##### `headers` - -Adds lines for [Header](https://httpd.apache.org/docs/current/mod/mod_headers.html#header) directives. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => { - path => '/path/to/directory', - headers => 'Set X-Robots-Tag "noindex, noarchive, nosnippet"', - }, -} -``` - -##### `index_options` - -Allows configuration settings for [directory indexing](https://httpd.apache.org/docs/current/mod/mod_autoindex.html#indexoptions). - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - directoryindex => 'disabled', # this is needed on Apache 2.4 or mod_autoindex doesn't work - options => ['Indexes','FollowSymLinks','MultiViews'], - index_options => ['IgnoreCase', 'FancyIndexing', 'FoldersFirst', 'NameWidth=*', 'DescriptionWidth=*', 'SuppressHTMLPreamble'], - }, - ], -} -``` - -##### `index_order_default` - -Sets the [default ordering](https://httpd.apache.org/docs/current/mod/mod_autoindex.html#indexorderdefault) of the directory index. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - order => 'Allow,Deny', - index_order_default => ['Descending', 'Date'], - }, - ], -} -``` - -###### `index_style_sheet` - -Sets the [IndexStyleSheet](https://httpd.apache.org/docs/current/mod/mod_autoindex.html#indexstylesheet), which adds a CSS stylesheet to the directory index. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - options => ['Indexes','FollowSymLinks','MultiViews'], - index_options => ['FancyIndexing'], - index_style_sheet => '/styles/style.css', - }, - ], -} -``` - -##### `limit` - -Creates a [Limit](https://httpd.apache.org/docs/current/mod/core.html#limit) block inside the Directory block, which can also contain `require` directives. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/docroot', - directories => [ - { path => '/', - provider => 'location', - limit => [ - { methods => 'GET HEAD', - require => ['valid-user'] - }, - ], - }, - ], -} -``` - -##### `limit_except` - -Creates a [LimitExcept](https://httpd.apache.org/docs/current/mod/core.html#limitexcept) block inside the Directory block, which can also contain `require` directives. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/docroot', - directories => [ - { path => '/', - provider => 'location', - limit_except => [ - { methods => 'GET HEAD', - require => ['valid-user'] - }, - ], - }, - ], -} -``` - -##### `mellon_enable` - -Sets the [MellonEnable][`mod_auth_mellon`] directory to enable [`mod_auth_mellon`][]. You can use [`apache::mod::auth_mellon`][] to install `mod_auth_mellon`. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/', - provider => 'directory', - mellon_enable => 'info', - mellon_sp_private_key_file => '/etc/certs/${::fqdn}.key', - mellon_endpoint_path => '/mellon', - mellon_set_env_no_prefix => { 'ADFS_GROUP' => 'http://schemas.xmlsoap.org/claims/Group', - 'ADFS_EMAIL' => 'http://schemas.xmlsoap.org/claims/EmailAddress', }, - mellon_user => 'ADFS_LOGIN', - }, - { path => '/protected', - provider => 'location', - mellon_enable => 'auth', - auth_type => 'Mellon', - auth_require => 'valid-user', - mellon_cond => ['ADFS_LOGIN userA [MAP]','ADFS_LOGIN userB [MAP]'], - }, - ] -} -``` - -Related parameters follow the names of `mod_auth_mellon` directives: - -- `mellon_cond`: Takes an array of mellon conditions that must be met to grant access, and creates a [MellonCond][`mod_auth_mellon`] directive for each item in the array. -- `mellon_endpoint_path`: Sets the [MellonEndpointPath][`mod_auth_mellon`] to set the mellon endpoint path. -- `mellon_sp_metadata_file`: Sets the [MellonSPMetadataFile][`mod_auth_mellon`] location of the SP metadata file. -- `mellon_idp_metadata_file`: Sets the [MellonIDPMetadataFile][`mod_auth_mellon`] location of the IDP metadata file. -- `mellon_saml_rsponse_dump`: Sets the [MellonSamlResponseDump][`mod_auth_mellon`] directive to enable debug of SAML. -- `mellon_set_env_no_prefix`: Sets the [MellonSetEnvNoPrefix][`mod_auth_mellon`] directive to a hash of attribute names to map -to environment variables. -- `mellon_sp_private_key_file`: Sets the [MellonSPPrivateKeyFile][`mod_auth_mellon`] directive for the private key location of the service provider. -- `mellon_sp_cert_file`: Sets the [MellonSPCertFile][`mod_auth_mellon`] directive for the public key location of the service provider. -- `mellon_user`: Sets the [MellonUser][`mod_auth_mellon`] attribute to use for the username. - -##### `options` - -Lists the [Options](https://httpd.apache.org/docs/current/mod/core.html#options) for the given Directory block. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - options => ['Indexes','FollowSymLinks','MultiViews'], - }, - ], -} -``` - -##### `order` - -Sets the order of processing Allow and Deny statements as per [Apache core documentation](https://httpd.apache.org/docs/2.2/mod/mod_authz_host.html#order). **Deprecated:** This parameter is being deprecated due to a change in Apache. It only works with Apache 2.2 and lower. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - order => 'Allow,Deny', - }, - ], -} -``` - -##### `passenger_enabled` - -Sets the value for the [PassengerEnabled](http://www.modrails.com/documentation/Users%20guide%20Apache.html#PassengerEnabled) directive to 'on' or 'off'. Requires `apache::mod::passenger` to be included. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - passenger_enabled => 'on', - }, - ], -} -``` - -> **Note:** There is an [issue](http://www.conandalton.net/2010/06/passengerenabled-off-not-working.html) using the PassengerEnabled directive with the PassengerHighPerformance directive. - -##### `php_value` and `php_flag` - -`php_value` sets the value of the directory, and `php_flag` uses a boolean to configure the directory. Further information can be found [here](http://php.net/manual/en/configuration.changes.php). - -##### `php_admin_value` and `php_admin_flag` - -`php_admin_value` sets the value of the directory, and `php_admin_flag` uses a boolean to configure the directory. Further information can be found [here](http://php.net/manual/en/configuration.changes.php). - - -##### `require` - - -Sets a `Require` directive as per the [Apache Authz documentation](https://httpd.apache.org/docs/current/mod/mod_authz_core.html#require). If no `require` is set, it will default to `Require all granted`. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - require => 'ip 10.17.42.23', - } - ], -} -``` - -When more complex sets of requirement are needed, apache >= 2.4 provides the use of [RequireAll](https://httpd.apache.org/docs/2.4/mod/mod_authz_core.html#requireall), [RequireNone](https://httpd.apache.org/docs/2.4/mod/mod_authz_core.html#requirenone) or [RequireAny](https://httpd.apache.org/docs/2.4/mod/mod_authz_core.html#requireany) directives. -Using the 'enforce' key, which only supports 'any','none','all' (other values are silently ignored), this could be established like: - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - require => { - enforce => 'any', - requires => [ - 'ip 1.2.3.4', - 'not host host.example.com', - 'user xyz', - ], - }, - }, - ], -} -``` - -If `require` is set to `unmanaged` it will not be set at all. This is useful for complex authentication/authorization requirements which are handled in a custom fragment. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - require => 'unmanaged', - } - ], -} -``` - - - -##### `satisfy` - -Sets a `Satisfy` directive per the [Apache Core documentation](https://httpd.apache.org/docs/2.2/mod/core.html#satisfy). **Deprecated:** This parameter is deprecated due to a change in Apache and only works with Apache 2.2 and lower. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - satisfy => 'Any', - } - ], -} -``` - -##### `sethandler` - -Sets a `SetHandler` directive per the [Apache Core documentation](https://httpd.apache.org/docs/2.2/mod/core.html#sethandler). - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - sethandler => 'None', - } - ], -} -``` - -##### `set_output_filter` - -Sets a `SetOutputFilter` directive per the [Apache Core documentation](https://httpd.apache.org/docs/current/mod/core.html#setoutputfilter). - -``` puppet -apache::vhost{ 'filter.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - set_output_filter => puppetdb-strip-resource-params, - }, - ], -} -``` - -##### `rewrites` - -Creates URL [`rewrites`](#rewrites) rules in virtual host directories. Expects an array of hashes, and the hash keys can be any of 'comment', 'rewrite_base', 'rewrite_cond', or 'rewrite_rule'. - -``` puppet -apache::vhost { 'secure.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - rewrites => [ { comment => 'Permalink Rewrites', - rewrite_base => '/' - }, - { rewrite_rule => [ '^index\.php$ - [L]' ] - }, - { rewrite_cond => [ '%{REQUEST_FILENAME} !-f', - '%{REQUEST_FILENAME} !-d', - ], - rewrite_rule => [ '. /index.php [L]' ], - } - ], - }, - ], -} -``` - -> **Note**: If you include rewrites in your directories, also include `apache::mod::rewrite` and consider setting the rewrites using the `rewrites` parameter in `apache::vhost` rather than setting the rewrites in the virtual host's directories. - -##### `shib_request_settings` - -Allows a valid content setting to be set or altered for the application request. This command takes two parameters: the name of the content setting, and the value to set it to. Check the Shibboleth [content setting documentation](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPContentSettings) for valid settings. This key is disabled if `apache::mod::shib` is not defined. Check the [`mod_shib` documentation](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPApacheConfig#NativeSPApacheConfig-Server/VirtualHostOptions) for more details. - -``` puppet -apache::vhost { 'secure.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - shib_request_settings => { 'requiresession' => 'On' }, - shib_use_headers => 'On', - }, - ], -} -``` - -##### `shib_use_headers` - -When set to 'On', this turns on the use of request headers to publish attributes to applications. Values for this key is 'On' or 'Off', and the default value is 'Off'. This key is disabled if `apache::mod::shib` is not defined. Check the [`mod_shib` documentation](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPApacheConfig#NativeSPApacheConfig-Server/VirtualHostOptions) for more details. - -##### `ssl_options` - -String or list of [SSLOptions](https://httpd.apache.org/docs/current/mod/mod_ssl.html#ssloptions), which configure SSL engine run-time options. This handler takes precedence over SSLOptions set in the parent block of the virtual host. - -``` puppet -apache::vhost { 'secure.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - ssl_options => '+ExportCertData', - }, - { path => '/path/to/different/dir', - ssl_options => [ '-StdEnvVars', '+ExportCertData'], - }, - ], -} -``` - -##### `suphp` - -A hash containing the 'user' and 'group' keys for the [suPHP_UserGroup](http://www.suphp.org/DocumentationView.html?file=apache/CONFIG) setting. It must be used with `suphp_engine => on` in the virtual host declaration, and can only be passed within `directories`. - -``` puppet -apache::vhost { 'secure.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/directory', - suphp => { - user => 'myappuser', - group => 'myappgroup', - }, - }, - ], -} -``` -##### `additional_includes` - -Specifies paths to additional static, specific Apache configuration files in virtual host directories. Values: a array of string path. - -``` puppet -apache::vhost { 'sample.example.net': - docroot => '/path/to/directory', - directories => [ - { path => '/path/to/different/dir', - additional_includes => [ '/custom/path/includes', '/custom/path/another_includes', ], - }, - ], -} -``` - -#### SSL parameters for `apache::vhost` - -All of the SSL parameters for `::vhost` default to whatever is set in the base `apache` class. Use the below parameters to tweak individual SSL settings for specific virtual hosts. - -##### `ssl` - -Enables SSL for the virtual host. SSL virtual hosts only respond to HTTPS queries. Values: Boolean. - -Default: `false`. - -##### `ssl_ca` - -Specifies the SSL certificate authority. - -Default: `undef`. - -##### `ssl_cert` - -Specifies the SSL certification. Defaults are based on your OS. - -* RedHat: '/etc/pki/tls/certs/localhost.crt' -* Debian: '/etc/ssl/certs/ssl-cert-snakeoil.pem' -* FreeBSD: '/usr/local/etc/apache22/server.crt' -* Gentoo: '/etc/ssl/apache2/server.crt' - -##### `ssl_protocol` - -Specifies [SSLProtocol](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslprotocol). Expects an array or space separated string of accepted protocols. - -Defaults: 'all', '-SSLv2', '-SSLv3'. - -##### `ssl_cipher` - -Specifies [SSLCipherSuite](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslciphersuite). - -Default: 'HIGH:MEDIUM:!aNULL:!MD5'. - -##### `ssl_honorcipherorder` - -Sets [SSLHonorCipherOrder](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslhonorcipherorder), to cause Apache to use the server's preferred order of ciphers rather than the client's preferred order. Values: - -Values: Boolean, 'on', 'off'. - -Default: `true`. - -##### `ssl_certs_dir` - -Specifies the location of the SSL certification directory. Default: Depends on operating system. - -- Debian: '/etc/ssl/certs' -- Red Hat: '/etc/pki/tls/certs' -- FreeBSD: `undef` -- Gentoo: '/etc/ssl/apache2' - -##### `ssl_chain` - -Specifies the SSL chain. This default works out of the box, but it must be updated in the base `apache` class with your specific certificate information before being used in production. - -Default: `undef`. - -##### `ssl_crl` - -Specifies the certificate revocation list to use. (This default works out of the box but must be updated in the base `apache` class with your specific certificate information before being used in production.) - -Default: `undef`. - -##### `ssl_crl_path` - -Specifies the location of the certificate revocation list. (This default works out of the box but must be updated in the base `apache` class with your specific certificate information before being used in production.) - -Default: `undef`. - -##### `ssl_crl_check` - -Sets the certificate revocation check level via the [SSLCARevocationCheck directive](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslcarevocationcheck). The default works out of the box but must be specified when using CRLs in production. Only applicable to Apache 2.4 or higher; the value is ignored on older versions. - -Default: `undef`. - -##### `ssl_key` - -Specifies the SSL key. Defaults are based on your operating system. Default work out of the box but must be updated in the base `apache` class with your specific certificate information before being used in production. - -* RedHat: '/etc/pki/tls/private/localhost.key' -* Debian: '/etc/ssl/private/ssl-cert-snakeoil.key' -* FreeBSD: '/usr/local/etc/apache22/server.key' -* Gentoo: '/etc/ssl/apache2/server.key' - -##### `ssl_verify_client` - -Sets the [SSLVerifyClient](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslverifyclient) directive, which sets the certificate verification level for client authentication. - -``` puppet -apache::vhost { 'sample.example.net': - … - ssl_verify_client => 'optional', -} -``` - -Values: 'none', 'optional', 'require', and 'optional_no_ca'. - -Default: `undef`. - - -##### `ssl_verify_depth` - -Sets the [SSLVerifyDepth](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslverifydepth) directive, which specifies the maximum depth of CA certificates in client certificate verification. - -``` puppet -apache::vhost { 'sample.example.net': - … - ssl_verify_depth => 1, -} -``` - -Default: `undef`. - -##### `ssl_proxy_protocol` - -Sets the [SSLProxyProtocol](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyprotocol) directive, which controls which SSL protocol flavors `mod_ssl` should use when establishing its server environment for proxy. It connects to servers using only one of the provided protocols. - -Default: `undef`. - -##### `ssl_proxy_verify` - -Sets the [SSLProxyVerify](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyverify) directive, which configures certificate verification of the remote server when a proxy is configured to forward requests to a remote SSL server. - -Default: `undef`. - -##### `ssl_proxy_verify_depth` - -Sets the [SSLProxyVerifyDepth](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyverifydepth) directive, which configures how deeply mod_ssl should verify before deciding that the remote server does not have a valid certificate. - -A depth of 0 means that only self-signed remote server certificates are accepted, the default depth of 1 means the remote server certificate can be self-signed or signed by a CA that is directly known to the server. - -Default: `undef` - -##### `ssl_proxy_ca_cert` - -Sets the [SSLProxyCACertificateFile](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycacertificatefile) directive, which specifies an all-in-one file where you can assemble the Certificates of Certification Authorities (CA) whose remote servers you deal with. These are used for Remote Server Authentication. This file should be a concatenation of the PEM-encoded certificate files in order of preference. - -Default: `undef` - -##### `ssl_proxy_machine_cert` - -Sets the [SSLProxyMachineCertificateFile](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxymachinecertificatefile) directive, which specifies an all-in-one file where you keep the certs and keys used for this server to authenticate itself to remote servers. This file should be a concatenation of the PEM-encoded certificate files in order of preference. - -``` puppet -apache::vhost { 'sample.example.net': - … - ssl_proxy_machine_cert => '/etc/httpd/ssl/client_certificate.pem', -} -``` - -Default: `undef` - -##### `ssl_proxy_check_peer_cn` - -Sets the [SSLProxyCheckPeerCN](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeercn) directive, which specifies whether the remote server certificate's CN field is compared against the hostname of the request URL. - -Values: 'on', 'off'. - -Default: `undef` - -##### `ssl_proxy_check_peer_name` - -Sets the [SSLProxyCheckPeerName](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeername) directive, which specifies whether the remote server certificate's CN field is compared against the hostname of the request URL. - -Values: 'on', 'off'. - -Default: `undef` - -##### `ssl_proxy_check_peer_expire` - -Sets the [SSLProxyCheckPeerExpire](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeerexpire) directive, which specifies whether the remote server certificate is checked for expiration or not. - -Values: 'on', 'off'. - -Default: `undef` - -##### `ssl_options` - -Sets the [SSLOptions](https://httpd.apache.org/docs/current/mod/mod_ssl.html#ssloptions) directive, which configures various SSL engine run-time options. This is the global setting for the given virtual host and can be a string or an array. - -A string: - -``` puppet -apache::vhost { 'sample.example.net': - … - ssl_options => '+ExportCertData', -} -``` - -An array: - -``` puppet -apache::vhost { 'sample.example.net': - … - ssl_options => [ '+StrictRequire', '+ExportCertData' ], -} -``` - -Default: `undef`. - -##### `ssl_openssl_conf_cmd` - -Sets the [SSLOpenSSLConfCmd](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslopensslconfcmd) directive, which provides direct configuration of OpenSSL parameters. - -Default: `undef` - -##### `ssl_proxyengine` - -Specifies whether or not to use [SSLProxyEngine](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyengine). - -Boolean. - -Default: `true`. - -##### `ssl_stapling` - -Specifies whether or not to use [SSLUseStapling](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslusestapling). By default, uses what is set globally. - -This parameter only applies to Apache 2.4 or higher and is ignored on older versions. - -Boolean or `undef`. - -Default: `undef` - -##### `ssl_stapling_timeout` - -Can be used to set the [SSLStaplingResponderTimeout](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslstaplingrespondertimeout) directive. - -This parameter only applies to Apache 2.4 or higher and is ignored on older versions. - -Default: none. - -##### `ssl_stapling_return_errors` - -Can be used to set the [SSLStaplingReturnResponderErrors](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslstaplingreturnrespondererrors) directive. - -This parameter only applies to Apache 2.4 or higher and is ignored on older versions. - -Default: none. - -#### Defined type: FastCGI Server - -This type is intended for use with mod\_fastcgi. It allows you to define one or more external FastCGI servers to handle specific file types. - -** Note ** If using Ubuntu 10.04+, you'll need to manually enable the multiverse repository. - -Ex: - -``` puppet -apache::fastcgi::server { 'php': - host => '127.0.0.1:9000', - timeout => 15, - flush => `false`, - faux_path => '/var/www/php.fcgi', - fcgi_alias => '/php.fcgi', - file_type => 'application/x-httpd-php', - pass_header => '' -} -``` - -Within your virtual host, you can then configure the specified file type to be handled by the fastcgi server specified above. - -``` puppet -apache::vhost { 'www': - ... - custom_fragment => 'AddType application/x-httpd-php .php' - ... -} -``` - -##### `host` - -The hostname or IP address and TCP port number (1-65535) of the FastCGI server. - -It is also possible to pass a unix socket: - -``` puppet -apache::fastcgi::server { 'php': - host => '/var/run/fcgi.sock', -} -``` - -##### `timeout` - -The number of seconds of FastCGI application inactivity allowed before the request is aborted and the event is logged (at the error LogLevel). The inactivity timer applies only as long as a connection is pending with the FastCGI application. If a request is queued to an application, but the application doesn't respond (by writing and flushing) within this period, the request is aborted. If communication is complete with the application but incomplete with the client (the response is buffered), the timeout does not apply. - -##### `flush` - -Force a write to the client as data is received from the application. By default, `mod_fastcgi` buffers data in order to free the application as quickly as possible. - -##### `faux_path` - -Does not have to exist in the local filesystem. URIs that Apache resolves to this filename are handled by this external FastCGI application. - -##### `alias` - -A unique alias. This is used internally to link the action with the FastCGI server. - -##### `file_type` - -The MIME-type of the file to be processed by the FastCGI server. - -##### `pass_header` - -The name of an HTTP Request Header to be passed in the request environment. This option makes available the contents of headers which are normally not available (e.g. Authorization) to a CGI environment. - -#### Defined type: `apache::vhost::custom` - -The `apache::vhost::custom` defined type is a thin wrapper around the `apache::custom_config` defined type, and simply overrides some of its default settings specific to the virtual host directory in Apache. - -**Parameters within `apache::vhost::custom`**: - -##### `content` - -Sets the configuration file's content. - -##### `ensure` - -Specifies if the virtual host file is present or absent. - -Values: 'absent', 'present'. - -Default: 'present'. - -##### `priority` - -Sets the relative load order for Apache HTTPD VirtualHost configuration files. - -Default: '25'. - -##### `verify_config` - -Specifies whether to validate the configuration file before notifying the Apache service. - -Boolean. - -Default: `true`. - -### Private defined types - -#### Defined type: `apache::peruser::multiplexer` - -This defined type checks if an Apache module has a class. If it does, it includes that class. If it does not, it passes the module name to the [`apache::mod`][] defined type. - -#### Defined type: `apache::peruser::multiplexer` - -Enables the [`Peruser`][] module for FreeBSD only. - -#### Defined type: `apache::peruser::processor` - -Enables the [`Peruser`][] module for FreeBSD only. - -#### Defined type: `apache::security::file_link` - -Links the `activated_rules` from [`apache::mod::security`][] to the respective CRS rules on disk. +For information on classes, types and functions see the [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-apache/blob/main/REFERENCE.md) ### Templates -The Apache module relies heavily on templates to enable the [`apache::vhost`][] and [`apache::mod`][] defined types. These templates are built based on [Facter][] facts specific to your operating system. Unless explicitly called out, most templates are not meant for configuration. +The Apache module relies heavily on templates to enable the [`apache::vhost`][] and [`apache::mod`][] defined types. These templates are built based on [Facter][] facts that are specific to your operating system. Unless explicitly called out, most templates are not meant for configuration. +### Tasks + +The Apache module has a task that allows a user to reload the Apache config without restarting the service. Please refer to to the [PE documentation](https://puppet.com/docs/pe/2017.3/orchestrator/running_tasks.html) or [Bolt documentation](https://puppet.com/docs/bolt/latest/bolt.html) on how to execute a task. + + ## Limitations -### General - -This module is CI tested against both [open source Puppet][] and [Puppet Enterprise][] on: - -- CentOS 5 and 6 -- Ubuntu 12.04 and 14.04 -- Debian 7 -- RHEL 5, 6, and 7 - -This module also provides functions for other distributions and operating systems, such as FreeBSD, Gentoo, and Amazon Linux, but is not formally tested on them and are subject to regressions. +For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-apache/blob/main/metadata.json) ### FreeBSD @@ -5089,6 +841,7 @@ In order to use this module on FreeBSD, you _must_ use apache24-2.4.12 (www/apac On Gentoo, this module depends on the [`gentoo/puppet-portage`][] Puppet module. Although several options apply or enable certain features and settings for Gentoo, it is not a [supported operating system][] for this module. ### RHEL/CentOS + The [`apache::mod::auth_cas`][], [`apache::mod::passenger`][], [`apache::mod::proxy_html`][] and [`apache::mod::shib`][] classes are not functional on RH/CentOS without providing dependency packages from extra repositories. See their respective documentation below for related repositories and packages. @@ -5099,7 +852,7 @@ The [`apache::mod::passenger`][] and [`apache::mod::proxy_html`][] classes are u #### RHEL/CentOS 6 -The [`apache::mod::passenger`][] class is not installing, because the the EL6 repository is missing compatible packages. +The [`apache::mod::passenger`][] class is not installing, because the EL6 repository is missing compatible packages. #### RHEL/CentOS 7 @@ -5150,43 +903,106 @@ apache::vhost { 'test.server': } ``` +**NOTE:** On RHEL 8, the SELinux packages contained in `policycoreutils-python` have been replaced by the `policycoreutils-python-utils` package. +See [here](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/considerations_in_adopting_rhel_8/index#selinux-python3_security) for more details. + You must set the contexts using `semanage fcontext` instead of `chcon` because Puppet's `file` resources reset the values' context in the database if the resource doesn't specify it. -### Ubuntu 10.04 - -The [`apache::vhost::WSGIImportScript`][] parameter creates a statement inside the virtual host that is unsupported on older versions of Apache, causing it to fail. This will be remedied in a future refactoring. - ### Ubuntu 16.04 The [`apache::mod::suphp`][] class is untested since repositories are missing compatible packages. + ## Development -### Contributing - -[Puppet][] modules on the [Puppet Forge][] are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. - -We want to make it as easy as possible to contribute changes so our modules work in your environment, but we also need contributors to follow a few guidelines to help us maintain and improve the modules' quality. - -For more information, please read the complete [module contribution guide][]. - ### Testing -This project contains tests for both [rspec-puppet][] and [beaker-rspec][] to verify functionality. For detailed information on using these tools, please see their respective documentation. - -#### Testing quickstart: Ruby > 1.8.7 +To run the unit tests, install the necessary gems: ``` -gem install bundler bundle install -bundle exec rake spec -bundle exec rspec spec/acceptance -RS_DEBUG=yes bundle exec rspec spec/acceptance ``` -#### Testing quickstart: Ruby = 1.8.7 +And then execute the command: ``` -gem install bundler -bundle install --without system_tests -bundle exec rake spec +bundle exec rake parallel_spec ``` + +To check the code coverage, run: + +``` +COVERAGE=yes bundle exec rake parallel_spec +``` + + + +Acceptance tests for this module leverage [puppet_litmus](https://github.com/puppetlabs/puppet_litmus). +To run the acceptance tests follow the instructions [here](https://github.com/puppetlabs/puppet_litmus/wiki/Tutorial:-use-Litmus-to-execute-acceptance-tests-with-a-sample-module-(MoTD)#install-the-necessary-gems-for-the-module). +You can also find a tutorial and walkthrough of using Litmus and the PDK on [YouTube](https://www.youtube.com/watch?v=FYfR7ZEGHoE). + +### Development Support +If you run into an issue with this module, or if you would like to request a feature, please [file a ticket](https://tickets.puppetlabs.com/browse/MODULES/). +Every Monday the Puppet IA Content Team has [office hours](https://puppet.com/community/office-hours) in the [Puppet Community Slack](http://slack.puppet.com/), alternating between an EMEA friendly time (1300 UTC) and an Americas friendly time (0900 Pacific, 1700 UTC). + +If you have problems getting this module up and running, please [contact Support](http://puppetlabs.com/services/customer-support). + +If you submit a change to this module, be sure to regenerate the reference documentation as follows: + +```bash +puppet strings generate --format markdown --out REFERENCE.md +``` + +### Apache MOD Test & Support Lifecycle +#### Adding Support for a new Apache MOD +Support for new [Apache Modules] can be added under the [`apache::mod`] namespace. +Acceptance tests should be added for each new [Apache Module][Apache Modules] added. +Ideally, the acceptance tests should run on all compatible platforms that this module is supported on (see `metdata.json`), however there are cases when a more niche module is difficult to set up and install on a particular Linux distro. +This could be for one or more of the following reasons: +- Package not available in default repositories of distro +- Package dependencies not available in default repositories of distro +- Package (and/or its dependencies) are only available in a specific version of an OS + +In these cases, it is possible to exclude a module from a test platform using a specific tag, defined above the class declaration: +```puppet +# @note Unsupported platforms: OS: ver, ver; OS: ver, ver, ver; OS: all +class apache::mod::foobar { +... +} +``` +For example: +```puppet +# @note Unsupported platforms: RedHat: 5, 6; Ubuntu: 14.04; SLES: all; Scientific: 11 SP1 +class apache::mod::actions { +... +} +``` +Please be aware of the following format guidelines for the tag: +- All OS/Version declarations must be preceded with `@note Unsupported platforms:` +- The tag must be declared ABOVE the class declaration (i.e. not as footer at the bottom of the file) +- Each OS/Version declaration must be separated by semicolons (`;`) +- Each version must be separated by a comma (`,`) +- Versions CANNOT be declared in ranges (e.g. `RedHat:5-7`), they should be explicitly declared (e.g. `RedHat:5,6,7`) +- However, to declare all versions of an OS as unsupported, use the word `all` (e.g. `SLES:all`) +- OSs with word characters as part of their versions are acceptable (e.g. `Scientific: 11 SP1, 11 SP2, 12, 13`) +- Spaces are permitted between OS/Version declarations and version numbers within a declaration +- Refer to the `operatingsystem_support` values in the `metadata.json` to find the acceptable OS name and version syntax: + - E.g. `OracleLinux` OR `oraclelinux`, not: `Oracle` or `OraLinux` + - E.g. `RedHat` OR `redhat`, not: `Red Hat Enterprise Linux`, `RHEL`, or `Red Hat` + +If the tag is incorrectly formatted, a warning will be printed out at the end of the test run, indicating what tag(s) could not be parsed. +This will not halt the execution of other tests. + +Once the class is tagged, it is possible to exclude a test for that particular [Apache MOD][Apache Modules] using RSpec's filtering and a helper method: +```ruby +describe 'auth_oidc', if: mod_supported_on_platform('apache::mod::auth_openidc') do +``` +The `mod_supported_on_platform` helper method takes the [Apache Module][Apache Modules] class definition as defined in the manifests under `manifest/mod`. + +This functionality can be disabled by setting the `DISABLE_MOD_TEST_EXCLUSION` environment variable. +When set, all exclusions will be ignored. +#### Test Support Lifecycle +The puppetlabs-apache module supports a large number of compatible platforms and [Apache Modules][Apache modules]. +As a result, Apache Module tests can fail because a package or package dependency has been removed from a Linux distribution repository. +The [IAC Team][IAC Team] will try to resolve these issues and keep instructions updated, but due to limited resources this won’t always be possible. +In these cases, we will exclude test(s) from certain platforms. +As always, we welcome help from our community members, and the IAC team is here to assist and answer questions. diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/REFERENCE.md b/modules/services/unix/http/apache_stretch_compatible/apache/REFERENCE.md new file mode 100644 index 000000000..9d6758639 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/REFERENCE.md @@ -0,0 +1,11319 @@ +# Reference + + + +## Table of Contents + +### Classes + +#### Public Classes + +* [`apache`](#apache): Guides the basic setup and installation of Apache on your system. +* [`apache::dev`](#apachedev): Installs Apache development libraries. +* [`apache::mod::actions`](#apachemodactions): Installs Apache mod_actions +* [`apache::mod::alias`](#apachemodalias): Installs and configures `mod_alias`. +* [`apache::mod::apreq2`](#apachemodapreq2): Installs `mod_apreq2`. +* [`apache::mod::auth_basic`](#apachemodauth_basic): Installs `mod_auth_basic` +* [`apache::mod::auth_cas`](#apachemodauth_cas): Installs and configures `mod_auth_cas`. +* [`apache::mod::auth_gssapi`](#apachemodauth_gssapi): Installs `mod_auth_gsappi`. +* [`apache::mod::auth_kerb`](#apachemodauth_kerb): Installs `mod_auth_kerb` +* [`apache::mod::auth_mellon`](#apachemodauth_mellon): Installs and configures `mod_auth_mellon`. +* [`apache::mod::auth_openidc`](#apachemodauth_openidc): Installs and configures `mod_auth_openidc`. +* [`apache::mod::authn_core`](#apachemodauthn_core): Installs `mod_authn_core`. +* [`apache::mod::authn_dbd`](#apachemodauthn_dbd): Installs `mod_authn_dbd`. +* [`apache::mod::authn_file`](#apachemodauthn_file): Installs `mod_authn_file`. +* [`apache::mod::authnz_ldap`](#apachemodauthnz_ldap): Installs `mod_authnz_ldap`. +* [`apache::mod::authnz_pam`](#apachemodauthnz_pam): Installs `mod_authnz_pam`. +* [`apache::mod::authz_default`](#apachemodauthz_default): Installs and configures `mod_authz_default`. +* [`apache::mod::authz_user`](#apachemodauthz_user): Installs `mod_authz_user` +* [`apache::mod::autoindex`](#apachemodautoindex): Installs `mod_autoindex` +* [`apache::mod::cache`](#apachemodcache): Installs `mod_cache` +* [`apache::mod::cgi`](#apachemodcgi): Installs `mod_cgi`. +* [`apache::mod::cgid`](#apachemodcgid): Installs `mod_cgid`. +* [`apache::mod::cluster`](#apachemodcluster): Installs `mod_cluster`. +* [`apache::mod::data`](#apachemoddata): Installs and configures `mod_data`. +* [`apache::mod::dav`](#apachemoddav): Installs `mod_dav`. +* [`apache::mod::dav_fs`](#apachemoddav_fs): Installs `mod_dav_fs`. +* [`apache::mod::dav_svn`](#apachemoddav_svn): Installs and configures `mod_dav_svn`. +* [`apache::mod::dbd`](#apachemoddbd): Installs `mod_dbd`. +* [`apache::mod::deflate`](#apachemoddeflate): Installs and configures `mod_deflate`. +* [`apache::mod::dev`](#apachemoddev): Installs `mod_dev`. +* [`apache::mod::dir`](#apachemoddir): Installs and configures `mod_dir`. +* [`apache::mod::disk_cache`](#apachemoddisk_cache): Installs and configures `mod_disk_cache`. +* [`apache::mod::dumpio`](#apachemoddumpio): Installs and configures `mod_dumpio`. +* [`apache::mod::env`](#apachemodenv): Installs `mod_env`. +* [`apache::mod::event`](#apachemodevent): Installs and configures `mod_event`. +* [`apache::mod::expires`](#apachemodexpires): Installs and configures `mod_expires`. +* [`apache::mod::ext_filter`](#apachemodext_filter): Installs and configures `mod_ext_filter`. +* [`apache::mod::fastcgi`](#apachemodfastcgi): Installs `mod_fastcgi`. +* [`apache::mod::fcgid`](#apachemodfcgid): Installs and configures `mod_fcgid`. +* [`apache::mod::filter`](#apachemodfilter): Installs `mod_filter`. +* [`apache::mod::geoip`](#apachemodgeoip): Installs and configures `mod_geoip`. +* [`apache::mod::headers`](#apachemodheaders): Installs and configures `mod_headers`. +* [`apache::mod::http2`](#apachemodhttp2): Installs and configures `mod_http2`. +* [`apache::mod::include`](#apachemodinclude): Installs `mod_include`. +* [`apache::mod::info`](#apachemodinfo): Installs and configures `mod_info`. +* [`apache::mod::intercept_form_submit`](#apachemodintercept_form_submit): Installs `mod_intercept_form_submit`. +* [`apache::mod::itk`](#apachemoditk): Installs MPM `mod_itk`. +* [`apache::mod::jk`](#apachemodjk): Installs `mod_jk`. +* [`apache::mod::ldap`](#apachemodldap): Installs and configures `mod_ldap`. +* [`apache::mod::lookup_identity`](#apachemodlookup_identity): Installs `mod_lookup_identity` +* [`apache::mod::macro`](#apachemodmacro): Installs `mod_macro`. +* [`apache::mod::md`](#apachemodmd): Installs and configures `mod_md`. +* [`apache::mod::mime`](#apachemodmime): Installs and configures `mod_mime`. +* [`apache::mod::mime_magic`](#apachemodmime_magic): Installs and configures `mod_mime_magic`. +* [`apache::mod::negotiation`](#apachemodnegotiation): Installs and configures `mod_negotiation`. +* [`apache::mod::nss`](#apachemodnss): Installs and configures `mod_nss`. +* [`apache::mod::pagespeed`](#apachemodpagespeed): Installs and configures `mod_pagespeed`. +* [`apache::mod::passenger`](#apachemodpassenger): Installs `mod_pasenger`. +* [`apache::mod::perl`](#apachemodperl): Installs `mod_perl`. +* [`apache::mod::peruser`](#apachemodperuser): Installs `mod_peruser`. +* [`apache::mod::php`](#apachemodphp): Installs `mod_php`. +* [`apache::mod::prefork`](#apachemodprefork): Installs and configures MPM `prefork`. +* [`apache::mod::proxy`](#apachemodproxy): Installs and configures `mod_proxy`. +* [`apache::mod::proxy_ajp`](#apachemodproxy_ajp): Installs `mod_proxy_ajp`. +* [`apache::mod::proxy_balancer`](#apachemodproxy_balancer): Installs and configures `mod_proxy_balancer`. +* [`apache::mod::proxy_connect`](#apachemodproxy_connect): Installs `mod_proxy_connect`. +* [`apache::mod::proxy_fcgi`](#apachemodproxy_fcgi): Installs `mod_proxy_fcgi`. +* [`apache::mod::proxy_html`](#apachemodproxy_html): Installs `mod_proxy_html`. +* [`apache::mod::proxy_http`](#apachemodproxy_http): Installs `mod_proxy_http`. +* [`apache::mod::proxy_wstunnel`](#apachemodproxy_wstunnel): Installs `mod_proxy_wstunnel`. +* [`apache::mod::python`](#apachemodpython): Installs and configures `mod_python`. +* [`apache::mod::remoteip`](#apachemodremoteip): Installs and configures `mod_remoteip`. +* [`apache::mod::reqtimeout`](#apachemodreqtimeout): Installs and configures `mod_reqtimeout`. +* [`apache::mod::rewrite`](#apachemodrewrite): Installs `mod_rewrite`. +* [`apache::mod::rpaf`](#apachemodrpaf): Installs and configures `mod_rpaf`. +* [`apache::mod::security`](#apachemodsecurity): Installs and configures `mod_security`. +* [`apache::mod::setenvif`](#apachemodsetenvif): Installs `mod_setenvif`. +* [`apache::mod::shib`](#apachemodshib): Installs and configures `mod_shib`. +* [`apache::mod::socache_shmcb`](#apachemodsocache_shmcb): Installs `mod_socache_shmcb`. +* [`apache::mod::speling`](#apachemodspeling): Installs `mod_spelling`. +* [`apache::mod::ssl`](#apachemodssl): Installs `mod_ssl`. +* [`apache::mod::status`](#apachemodstatus): Installs and configures `mod_status`. +* [`apache::mod::suexec`](#apachemodsuexec): Installs `mod_suexec`. +* [`apache::mod::suphp`](#apachemodsuphp): Installs `mod_suphp`. +* [`apache::mod::userdir`](#apachemoduserdir): Installs and configures `mod_userdir`. +* [`apache::mod::version`](#apachemodversion): Installs `mod_version`. +* [`apache::mod::vhost_alias`](#apachemodvhost_alias): Installs Apache `mod_vhost_alias`. +* [`apache::mod::watchdog`](#apachemodwatchdog): Installs and configures `mod_watchdog`. +* [`apache::mod::worker`](#apachemodworker): Installs and manages the MPM `worker`. +* [`apache::mod::wsgi`](#apachemodwsgi): Installs and configures `mod_wsgi`. +* [`apache::mod::xsendfile`](#apachemodxsendfile): Installs `mod_xsendfile`. +* [`apache::mpm::disable_mpm_event`](#apachempmdisable_mpm_event) +* [`apache::mpm::disable_mpm_prefork`](#apachempmdisable_mpm_prefork) +* [`apache::mpm::disable_mpm_worker`](#apachempmdisable_mpm_worker) +* [`apache::vhosts`](#apachevhosts): Creates `apache::vhost` defined types. + +#### Private Classes + +* `apache::confd::no_accf`: Manages the `no-accf.conf` file. +* `apache::default_confd_files`: Helper for setting up default conf.d files. +* `apache::default_mods`: Installs and congfigures default mods for Apache +* `apache::mod::ssl::reload`: Manages the puppet_ssl folder for ssl file copies, which is needed to track changes for reloading service on changes +* `apache::package`: Installs an Apache MPM. +* `apache::params`: This class manages Apache parameters +* `apache::php`: This class installs PHP for Apache. +* `apache::proxy`: This class enabled the proxy module for Apache. +* `apache::python`: This class installs Python for Apache +* `apache::service`: Installs and configures Apache service. +* `apache::ssl`: This class installs Apache SSL capabilities +* `apache::version`: Try to automatically detect the version by OS + +### Defined types + +#### Public Defined types + +* [`apache::balancer`](#apachebalancer): This type will create an apache balancer cluster file inside the conf.d +directory. +* [`apache::balancermember`](#apachebalancermember): Defines members of `mod_proxy_balancer` +* [`apache::custom_config`](#apachecustom_config): Adds a custom configuration file to the Apache server's `conf.d` directory. +* [`apache::fastcgi::server`](#apachefastcgiserver): Defines one or more external FastCGI servers to handle specific file types. Use this +defined type with `mod_fastcgi`. +* [`apache::listen`](#apachelisten): Adds `Listen` directives to `ports.conf` that define the +Apache server's or a virtual host's listening address and port. +* [`apache::mod`](#apachemod): Installs packages for an Apache module that doesn't have a corresponding +`apache::mod::` class. +* [`apache::namevirtualhost`](#apachenamevirtualhost): Enables name-based virtual hosts +* [`apache::vhost`](#apachevhost): Allows specialised configurations for virtual hosts that possess requirements +outside of the defaults. +* [`apache::vhost::custom`](#apachevhostcustom): A wrapper around the `apache::custom_config` defined type. +* [`apache::vhost::fragment`](#apachevhostfragment): Define a fragment within a vhost + +#### Private Defined types + +* `apache::default_mods::load`: Helper used by `apache::default_mods` +* `apache::mpm`: Enables the use of Apache MPMs. +* `apache::peruser::multiplexer`: Checks if an Apache module has a class. +* `apache::peruser::processor`: Enables the `Peruser` module for FreeBSD only. +* `apache::security::rule_link`: Links the activated_rules from `apache::mod::security` to the respective CRS rules on disk. + +### Resource types + +* [`a2mod`](#a2mod): Manage Apache 2 modules + +### Functions + +* [`apache::apache_pw_hash`](#apacheapache_pw_hash): DEPRECATED. Use the function [`apache::pw_hash`](#apachepw_hash) instead. +* [`apache::bool2httpd`](#apachebool2httpd): Transform a supposed boolean to On or Off. Passes all other values through. +* [`apache::pw_hash`](#apachepw_hash): Hashes a password in a format suitable for htpasswd files read by apache. +* [`apache_pw_hash`](#apache_pw_hash): DEPRECATED. Use the namespaced function [`apache::pw_hash`](#apachepw_hash) instead. +* [`bool2httpd`](#bool2httpd): DEPRECATED. Use the namespaced function [`apache::bool2httpd`](#apachebool2httpd) instead. + +### Data types + +* [`Apache::LogLevel`](#apacheloglevel): A string that conforms to the Apache `LogLevel` syntax. +* [`Apache::OIDCSettings`](#apacheoidcsettings): https://github.com/zmartzone/mod_auth_openidc/blob/master/auth_openidc.conf + +### Tasks + +* [`init`](#init): Allows you to perform apache service functions + +## Classes + +### `apache` + +When this class is declared with the default options, Puppet: +- Installs the appropriate Apache software package and [required Apache modules](#default_mods) for your operating system. +- Places the required configuration files in a directory, with the [default location](#conf_dir) determined by your operating system. +- Configures the server with a default virtual host and standard port (`80`) and address (`\*`) bindings. +- Creates a document root directory determined by your operating system, typically `/var/www`. +- Starts the Apache service. + +If an ldaps:// URL is specified, the mode becomes SSL and the setting of LDAPTrustedMode is ignored. + +#### Examples + +##### + +```puppet +class { 'apache': } +``` + +#### Parameters + +The following parameters are available in the `apache` class: + +* [`allow_encoded_slashes`](#allow_encoded_slashes) +* [`apache_version`](#apache_version) +* [`conf_dir`](#conf_dir) +* [`conf_template`](#conf_template) +* [`confd_dir`](#confd_dir) +* [`default_charset`](#default_charset) +* [`default_confd_files`](#default_confd_files) +* [`default_mods`](#default_mods) +* [`default_ssl_ca`](#default_ssl_ca) +* [`default_ssl_cert`](#default_ssl_cert) +* [`default_ssl_chain`](#default_ssl_chain) +* [`default_ssl_crl`](#default_ssl_crl) +* [`default_ssl_crl_path`](#default_ssl_crl_path) +* [`default_ssl_crl_check`](#default_ssl_crl_check) +* [`default_ssl_key`](#default_ssl_key) +* [`default_ssl_reload_on_change`](#default_ssl_reload_on_change) +* [`default_ssl_vhost`](#default_ssl_vhost) +* [`default_type`](#default_type) +* [`default_vhost`](#default_vhost) +* [`dev_packages`](#dev_packages) +* [`docroot`](#docroot) +* [`error_documents`](#error_documents) +* [`group`](#group) +* [`httpd_dir`](#httpd_dir) +* [`http_protocol_options`](#http_protocol_options) +* [`keepalive`](#keepalive) +* [`keepalive_timeout`](#keepalive_timeout) +* [`max_keepalive_requests`](#max_keepalive_requests) +* [`hostname_lookups`](#hostname_lookups) +* [`ldap_trusted_mode`](#ldap_trusted_mode) +* [`ldap_verify_server_cert`](#ldap_verify_server_cert) +* [`lib_path`](#lib_path) +* [`log_level`](#log_level) +* [`log_formats`](#log_formats) +* [`logroot`](#logroot) +* [`logroot_mode`](#logroot_mode) +* [`manage_group`](#manage_group) +* [`supplementary_groups`](#supplementary_groups) +* [`manage_user`](#manage_user) +* [`mod_dir`](#mod_dir) +* [`mod_libs`](#mod_libs) +* [`mod_packages`](#mod_packages) +* [`mpm_module`](#mpm_module) +* [`package_ensure`](#package_ensure) +* [`pidfile`](#pidfile) +* [`ports_file`](#ports_file) +* [`protocols`](#protocols) +* [`protocols_honor_order`](#protocols_honor_order) +* [`purge_configs`](#purge_configs) +* [`purge_vhost_dir`](#purge_vhost_dir) +* [`rewrite_lock`](#rewrite_lock) +* [`sendfile`](#sendfile) +* [`serveradmin`](#serveradmin) +* [`servername`](#servername) +* [`server_root`](#server_root) +* [`server_signature`](#server_signature) +* [`server_tokens`](#server_tokens) +* [`service_enable`](#service_enable) +* [`service_ensure`](#service_ensure) +* [`service_name`](#service_name) +* [`service_manage`](#service_manage) +* [`service_restart`](#service_restart) +* [`timeout`](#timeout) +* [`trace_enable`](#trace_enable) +* [`use_canonical_name`](#use_canonical_name) +* [`use_systemd`](#use_systemd) +* [`file_mode`](#file_mode) +* [`root_directory_options`](#root_directory_options) +* [`root_directory_secured`](#root_directory_secured) +* [`vhost_dir`](#vhost_dir) +* [`vhost_include_pattern`](#vhost_include_pattern) +* [`user`](#user) +* [`apache_name`](#apache_name) +* [`error_log`](#error_log) +* [`scriptalias`](#scriptalias) +* [`access_log_file`](#access_log_file) +* [`limitreqfields`](#limitreqfields) +* [`limitreqfieldsize`](#limitreqfieldsize) +* [`ip`](#ip) +* [`purge_vdir`](#purge_vdir) +* [`conf_enabled`](#conf_enabled) +* [`vhost_enable_dir`](#vhost_enable_dir) +* [`mod_enable_dir`](#mod_enable_dir) +* [`ssl_file`](#ssl_file) +* [`file_e_tag`](#file_e_tag) +* [`use_optional_includes`](#use_optional_includes) +* [`mime_types_additional`](#mime_types_additional) + +##### `allow_encoded_slashes` + +Data type: `Optional[Enum['on', 'off', 'nodecode']]` + +Sets the server default for the `AllowEncodedSlashes` declaration, which modifies the +responses to URLs containing '\' and '/' characters. If not specified, this parameter omits +the declaration from the server's configuration and uses Apache's default setting of 'off'. + +Default value: ``undef`` + +##### `apache_version` + +Data type: `Any` + +Configures module template behavior, package names, and default Apache modules by defining +the version of Apache to use. We do not recommend manually configuring this parameter +without reason. + +Default value: `$apache::version::default` + +##### `conf_dir` + +Data type: `Any` + +Sets the directory where the Apache server's main configuration file is located. + +Default value: `$apache::params::conf_dir` + +##### `conf_template` + +Data type: `Any` + +Defines the template used for the main Apache configuration file. Modifying this +parameter is potentially risky, as the apache module is designed to use a minimal +configuration file customized by `conf.d` entries. + +Default value: `$apache::params::conf_template` + +##### `confd_dir` + +Data type: `Any` + +Sets the location of the Apache server's custom configuration directory. + +Default value: `$apache::params::confd_dir` + +##### `default_charset` + +Data type: `Any` + +Used as the `AddDefaultCharset` directive in the main configuration file. + +Default value: ``undef`` + +##### `default_confd_files` + +Data type: `Boolean` + +Determines whether Puppet generates a default set of includable Apache configuration files +in the directory defined by the `confd_dir` parameter. These configuration files +correspond to what is typically installed with the Apache package on the server's +operating system. + +Default value: ``true`` + +##### `default_mods` + +Data type: `Any` + +Determines whether to configure and enable a set of default Apache modules depending on +your operating system.
+If `false`, Puppet includes only the Apache modules required to make the HTTP daemon work +on your operating system, and you can declare any other modules separately using the +`apache::mod::` class or `apache::mod` defined type.
+If `true`, Puppet installs additional modules, depending on the operating system and +the values of `apache_version` and `mpm_module` parameters. Because these lists of +modules can change frequently, consult the Puppet module's code for up-to-date lists.
+If this parameter contains an array, Puppet instead enables all passed Apache modules. + +Default value: ``true`` + +##### `default_ssl_ca` + +Data type: `Any` + +Sets the default certificate authority for the Apache server.
+Although the default value results in a functioning Apache server, you **must** update +this parameter with your certificate authority information before deploying this server in +a production environment. + +Default value: ``undef`` + +##### `default_ssl_cert` + +Data type: `Any` + +Sets the SSL encryption certificate location.
+Although the default value results in a functioning Apache server, you **must** update this +parameter with your certificate location before deploying this server in a production environment. + +Default value: `$apache::params::default_ssl_cert` + +##### `default_ssl_chain` + +Data type: `Any` + +Sets the default SSL chain location.
+Although this default value results in a functioning Apache server, you **must** update +this parameter with your SSL chain before deploying this server in a production environment. + +Default value: ``undef`` + +##### `default_ssl_crl` + +Data type: `Any` + +Sets the path of the default certificate revocation list (CRL) file to use.
+Although this default value results in a functioning Apache server, you **must** update +this parameter with the CRL file path before deploying this server in a production +environment. You can use this parameter with or in place of the `default_ssl_crl_path`. + +Default value: ``undef`` + +##### `default_ssl_crl_path` + +Data type: `Any` + +Sets the server's certificate revocation list path, which contains your CRLs.
+Although this default value results in a functioning Apache server, you **must** update +this parameter with the CRL file path before deploying this server in a production environment. + +Default value: ``undef`` + +##### `default_ssl_crl_check` + +Data type: `Any` + +Sets the default certificate revocation check level via the `SSLCARevocationCheck` directive. +This parameter applies only to Apache 2.4 or higher and is ignored on older versions.
+Although this default value results in a functioning Apache server, you **must** specify +this parameter when using certificate revocation lists in a production environment. + +Default value: ``undef`` + +##### `default_ssl_key` + +Data type: `Any` + +Sets the SSL certificate key file location. +Although the default values result in a functioning Apache server, you **must** update +this parameter with your SSL key's location before deploying this server in a production +environment. + +Default value: `$apache::params::default_ssl_key` + +##### `default_ssl_reload_on_change` + +Data type: `Boolean` + +Enable reloading of apache if the content of ssl files have changed. + +Default value: ``false`` + +##### `default_ssl_vhost` + +Data type: `Boolean` + +Configures a default SSL virtual host. +If `true`, Puppet automatically configures the following virtual host using the +`apache::vhost` defined type: +```puppet +apache::vhost { 'default-ssl': + port => 443, + ssl => true, + docroot => $docroot, + scriptalias => $scriptalias, + serveradmin => $serveradmin, + access_log_file => "ssl_${access_log_file}", +} +``` +**Note**: SSL virtual hosts only respond to HTTPS queries. + +Default value: ``false`` + +##### `default_type` + +Data type: `Any` + +_Apache 2.2 only_. Sets the MIME `content-type` sent if the server cannot otherwise +determine an appropriate `content-type`. This directive is deprecated in Apache 2.4 and +newer, and is only for backwards compatibility in configuration files. + +Default value: `'none'` + +##### `default_vhost` + +Data type: `Boolean` + +Configures a default virtual host when the class is declared.
+To configure customized virtual hosts, set this parameter's +value to `false`.
+> **Note**: Apache will not start without at least one virtual host. If you set this +to `false` you must configure a virtual host elsewhere. + +Default value: ``true`` + +##### `dev_packages` + +Data type: `Any` + +Configures a specific dev package to use.
+For example, using httpd 2.4 from the IUS yum repo:
+``` puppet +include ::apache::dev +class { 'apache': + apache_name => 'httpd24u', + dev_packages => 'httpd24u-devel', +} +``` + +Default value: `$apache::params::dev_packages` + +##### `docroot` + +Data type: `Any` + +Sets the default `DocumentRoot` location. + +Default value: `$apache::params::docroot` + +##### `error_documents` + +Data type: `Any` + +Determines whether to enable [custom error documents](https://httpd.apache.org/docs/current/custom-error.html) on the Apache server. + +Default value: ``false`` + +##### `group` + +Data type: `Any` + +Sets the group ID that owns any Apache processes spawned to answer requests.
+By default, Puppet attempts to manage this group as a resource under the `apache` +class, determining the group based on the operating system as detected by the +`apache::params` class. To prevent the group resource from being created and use a group +created by another Puppet module, set the `manage_group` parameter's value to `false`.
+> **Note**: Modifying this parameter only changes the group ID that Apache uses to spawn +child processes to access resources. It does not change the user that owns the parent server +process. + +Default value: `$apache::params::group` + +##### `httpd_dir` + +Data type: `Any` + +Sets the Apache server's base configuration directory. This is useful for specially +repackaged Apache server builds but might have unintended consequences when combined +with the default distribution packages. + +Default value: `$apache::params::httpd_dir` + +##### `http_protocol_options` + +Data type: `Any` + +Specifies the strictness of HTTP protocol checks.
+Valid options: any sequence of the following alternative values: `Strict` or `Unsafe`, +`RegisteredMethods` or `LenientMethods`, and `Allow0.9` or `Require1.0`. + +Default value: `$apache::params::http_protocol_options` + +##### `keepalive` + +Data type: `Any` + +Determines whether to enable persistent HTTP connections with the `KeepAlive` directive. +If you set this to `On`, use the `keepalive_timeout` and `max_keepalive_requests` parameters +to set relevant options.
+ +Default value: `$apache::params::keepalive` + +##### `keepalive_timeout` + +Data type: `Any` + +Sets the `KeepAliveTimeout` directive, which determines the amount of time the Apache +server waits for subsequent requests on a persistent HTTP connection. This parameter is +only relevant if the `keepalive` parameter is enabled. + +Default value: `$apache::params::keepalive_timeout` + +##### `max_keepalive_requests` + +Data type: `Any` + +Limits the number of requests allowed per connection when the `keepalive` parameter is enabled. + +Default value: `$apache::params::max_keepalive_requests` + +##### `hostname_lookups` + +Data type: `Enum['Off', 'On', 'Double', 'off', 'on', 'double']` + +This directive enables DNS lookups so that host names can be logged and passed to +CGIs/SSIs in REMOTE_HOST.
+> **Note**: If enabled, it impacts performance significantly. + +Default value: `$apache::params::hostname_lookups` + +##### `ldap_trusted_mode` + +Data type: `Any` + +The following modes are supported: + + NONE - no encryption + SSL - ldaps:// encryption on default port 636 + TLS - STARTTLS encryption on default port 389 +Not all LDAP toolkits support all the above modes. An error message will be logged at +runtime if a mode is not supported, and the connection to the LDAP server will fail. + +Default value: ``undef`` + +##### `ldap_verify_server_cert` + +Data type: `Any` + +Specifies whether to force the verification of a server certificate when establishing an SSL +connection to the LDAP server. +On|Off + +Default value: ``undef`` + +##### `lib_path` + +Data type: `Any` + +Specifies the location whereApache module files are stored.
+> **Note**: Do not configure this parameter manually without special reason. + +Default value: `$apache::params::lib_path` + +##### `log_level` + +Data type: `Apache::LogLevel` + +Configures the apache [LogLevel](https://httpd.apache.org/docs/current/mod/core.html#loglevel) directive +which adjusts the verbosity of the messages recorded in the error logs. + +Default value: `$apache::params::log_level` + +##### `log_formats` + +Data type: `Any` + +Define additional `LogFormat` directives. Values: A hash, such as: +``` puppet +$log_formats = { vhost_common => '%v %h %l %u %t \"%r\" %>s %b' } +``` + There are a number of predefined `LogFormats` in the `httpd.conf` that Puppet creates: +``` httpd + LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined + LogFormat "%h %l %u %t \"%r\" %>s %b" common + LogFormat "%{Referer}i -> %U" referer + LogFormat "%{User-agent}i" agent + LogFormat "%{X-Forwarded-For}i %l %u %t \"%r\" %s %b \"%{Referer}i\" \"%{User-agent}i\"" forwarded +``` +If your `log_formats` parameter contains one of those, it will be overwritten with **your** definition. + +Default value: `{}` + +##### `logroot` + +Data type: `Any` + +Changes the directory of Apache log files for the virtual host. + +Default value: `$apache::params::logroot` + +##### `logroot_mode` + +Data type: `Any` + +Overrides the default `logroot` directory's mode.
+> **Note**: Do _not_ grant write access to the directory where the logs are stored +without being aware of the consequences. See the [Apache documentation](https://httpd.apache.org/docs/current/logs.html#security) +for details. + +Default value: `$apache::params::logroot_mode` + +##### `manage_group` + +Data type: `Boolean` + +When `false`, stops Puppet from creating the group resource.
+If you have a group created from another Puppet module that you want to use to run Apache, +set this to `false`. Without this parameter, attempting to use a previously established +group results in a duplicate resource error. + +Default value: ``true`` + +##### `supplementary_groups` + +Data type: `Any` + +A list of groups to which the user belongs. These groups are in addition to the primary group.
+Notice: This option only has an effect when `manage_user` is set to true. + +Default value: `[]` + +##### `manage_user` + +Data type: `Boolean` + +When `false`, stops Puppet from creating the user resource.
+This is for instances when you have a user, created from another Puppet module, you want +to use to run Apache. Without this parameter, attempting to use a previously established +user would result in a duplicate resource error. + +Default value: ``true`` + +##### `mod_dir` + +Data type: `Any` + +Sets where Puppet places configuration files for your Apache modules. + +Default value: `$apache::params::mod_dir` + +##### `mod_libs` + +Data type: `Any` + +Allows the user to override default module library names. +```puppet +include apache::params +class { 'apache': + mod_libs => merge($::apache::params::mod_libs, { + 'wsgi' => 'mod_wsgi_python3.so', + }) +} +``` + +Default value: `$apache::params::mod_libs` + +##### `mod_packages` + +Data type: `Any` + +Allows the user to override default module package names. +```puppet +include apache::params +class { 'apache': + mod_packages => merge($::apache::params::mod_packages, { + 'auth_kerb' => 'httpd24-mod_auth_kerb', + }) +} +``` + +Default value: `$apache::params::mod_packages` + +##### `mpm_module` + +Data type: `Any` + +Determines which [multi-processing module](https://httpd.apache.org/docs/current/mpm.html) (MPM) is loaded and configured for the +HTTPD process. Valid values are: `event`, `itk`, `peruser`, `prefork`, `worker` or `false`.
+You must set this to `false` to explicitly declare the following classes with custom parameters: +- `apache::mod::event` +- `apache::mod::itk` +- `apache::mod::peruser` +- `apache::mod::prefork` +- `apache::mod::worker` + +Default value: `$apache::params::mpm_module` + +##### `package_ensure` + +Data type: `Any` + +Controls the `package` resource's `ensure` attribute. Valid values are: `absent`, `installed` +(or equivalent `present`), or a version string. + +Default value: `'installed'` + +##### `pidfile` + +Data type: `Any` + +Allows settting a custom location for the pid file. Useful if using a custom-built Apache rpm. + +Default value: `$apache::params::pidfile` + +##### `ports_file` + +Data type: `Any` + +Sets the path to the file containing Apache ports configuration. + +Default value: `$apache::params::ports_file` + +##### `protocols` + +Data type: `Array[Enum['h2', 'h2c', 'http/1.1']]` + +Sets the [Protocols](https://httpd.apache.org/docs/current/en/mod/core.html#protocols) +directive, which lists available protocols for the server. + +Default value: `[]` + +##### `protocols_honor_order` + +Data type: `Optional[Boolean]` + +Sets the [ProtocolsHonorOrder](https://httpd.apache.org/docs/current/en/mod/core.html#protocolshonororder) +directive which determines whether the order of Protocols sets precedence during negotiation. + +Default value: ``undef`` + +##### `purge_configs` + +Data type: `Any` + +Removes all other Apache configs and virtual hosts.
+Setting this to `false` is a stopgap measure to allow the apache module to coexist with +existing or unmanaged configurations. We recommend moving your configuration to resources +within this module. For virtual host configurations, see `purge_vhost_dir`. + +Default value: ``true`` + +##### `purge_vhost_dir` + +Data type: `Any` + +If the `vhost_dir` parameter's value differs from the `confd_dir` parameter's, this parameter +determines whether Puppet removes any configurations inside `vhost_dir` that are _not_ managed +by Puppet.
+Setting `purge_vhost_dir` to `false` is a stopgap measure to allow the apache module to +coexist with existing or otherwise unmanaged configurations within `vhost_dir`. + +Default value: ``undef`` + +##### `rewrite_lock` + +Data type: `Optional[Stdlib::Absolutepath]` + +Allows setting a custom location for a rewrite lock - considered best practice if using +a RewriteMap of type prg in the `rewrites` parameter of your virtual host. This parameter +only applies to Apache version 2.2 or lower and is ignored on newer versions. + +Default value: ``undef`` + +##### `sendfile` + +Data type: `Enum['On', 'Off', 'on', 'off']` + +Forces Apache to use the Linux kernel's `sendfile` support to serve static files, via the +`EnableSendfile` directive. + +Default value: `'On'` + +##### `serveradmin` + +Data type: `Any` + +Sets the Apache server administrator's contact information via Apache's `ServerAdmin` directive. + +Default value: `'root@localhost'` + +##### `servername` + +Data type: `Any` + +Sets the Apache server name via Apache's `ServerName` directive. +Setting to `false` will not set ServerName at all. + +Default value: `$apache::params::servername` + +##### `server_root` + +Data type: `Any` + +Sets the Apache server's root directory via Apache's `ServerRoot` directive. + +Default value: `$apache::params::server_root` + +##### `server_signature` + +Data type: `Any` + +Configures a trailing footer line to display at the bottom of server-generated documents, +such as error documents and output of certain Apache modules, via Apache's `ServerSignature` +directive. Valid values are: `On` or `Off`. + +Default value: `'On'` + +##### `server_tokens` + +Data type: `Any` + +Controls how much information Apache sends to the browser about itself and the operating +system, via Apache's `ServerTokens` directive. + +Default value: `'Prod'` + +##### `service_enable` + +Data type: `Boolean` + +Determines whether Puppet enables the Apache HTTPD service when the system is booted. + +Default value: ``true`` + +##### `service_ensure` + +Data type: `Any` + +Determines whether Puppet should make sure the service is running. +Valid values are: `true` (or `running`) or `false` (or `stopped`).
+The `false` or `stopped` values set the 'httpd' service resource's `ensure` parameter +to `false`, which is useful when you want to let the service be managed by another +application, such as Pacemaker.
+ +Default value: `'running'` + +##### `service_name` + +Data type: `Any` + +Sets the name of the Apache service. + +Default value: `$apache::params::service_name` + +##### `service_manage` + +Data type: `Boolean` + +Determines whether Puppet manages the HTTPD service's state. + +Default value: ``true`` + +##### `service_restart` + +Data type: `Any` + +Determines whether Puppet should use a specific command to restart the HTTPD service. +Values: a command to restart the Apache service. + +Default value: ``undef`` + +##### `timeout` + +Data type: `Any` + +Sets Apache's `TimeOut` directive, which defines the number of seconds Apache waits for +certain events before failing a request. + +Default value: `'60'` + +##### `trace_enable` + +Data type: `Any` + +Controls how Apache handles `TRACE` requests (per RFC 2616) via the `TraceEnable` directive. + +Default value: `'On'` + +##### `use_canonical_name` + +Data type: `Optional[Enum['On', 'on', 'Off', 'off', 'DNS', 'dns']]` + +Controls Apache's `UseCanonicalName` directive which controls how Apache handles +self-referential URLs. If not specified, this parameter omits the declaration from the +server's configuration and uses Apache's default setting of 'off'. + +Default value: ``undef`` + +##### `use_systemd` + +Data type: `Any` + +Controls whether the systemd module should be installed on Centos 7 servers, this is +especially useful if using custom-built RPMs. + +Default value: `$apache::params::use_systemd` + +##### `file_mode` + +Data type: `Any` + +Sets the desired permissions mode for config files. +Valid values are: a string, with permissions mode in symbolic or numeric notation. + +Default value: `$apache::params::file_mode` + +##### `root_directory_options` + +Data type: `Any` + +Array of the desired options for the `/` directory in httpd.conf. + +Default value: `$apache::params::root_directory_options` + +##### `root_directory_secured` + +Data type: `Boolean` + +Sets the default access policy for the `/` directory in httpd.conf. A value of `false` +allows access to all resources that are missing a more specific access policy. A value of +`true` denies access to all resources by default. If `true`, more specific rules must be +used to allow access to these resources (for example, in a directory block using the +`directories` parameter). + +Default value: ``false`` + +##### `vhost_dir` + +Data type: `Any` + +Changes your virtual host configuration files' location. + +Default value: `$apache::params::vhost_dir` + +##### `vhost_include_pattern` + +Data type: `Any` + +Defines the pattern for files included from the `vhost_dir`. +If set to a value like `[^.#]\*.conf[^~]` to make sure that files accidentally created in +this directory (such as files created by version control systems or editor backups) are +*not* included in your server configuration.
+Some operating systems use a value of `*.conf`. By default, this module creates configuration +files ending in `.conf`. + +Default value: `$apache::params::vhost_include_pattern` + +##### `user` + +Data type: `Any` + +Changes the user that Apache uses to answer requests. Apache's parent process continues +to run as root, but child processes access resources as the user defined by this parameter. +To prevent Puppet from managing the user, set the `manage_user` parameter to `false`. + +Default value: `$apache::params::user` + +##### `apache_name` + +Data type: `Any` + +The name of the Apache package to install. If you are using a non-standard Apache package +you might need to override the default setting.
+For CentOS/RHEL Software Collections (SCL), you can also use `apache::version::scl_httpd_version`. + +Default value: `$apache::params::apache_name` + +##### `error_log` + +Data type: `Any` + +The name of the error log file for the main server instance. If the string starts with +`/`, `|`, or `syslog`: the full path is set. Otherwise, the filename is prefixed with +`$logroot`. + +Default value: `$apache::params::error_log` + +##### `scriptalias` + +Data type: `Any` + +Directory to use for global script alias + +Default value: `$apache::params::scriptalias` + +##### `access_log_file` + +Data type: `Any` + +The name of the access log file for the main server instance. + +Default value: `$apache::params::access_log_file` + +##### `limitreqfields` + +Data type: `Any` + +The `limitreqfields` parameter sets the maximum number of request header fields in +an HTTP request. This directive gives the server administrator greater control over +abnormal client request behavior, which may be useful for avoiding some forms of +denial-of-service attacks. The value should be increased if normal clients see an error +response from the server that indicates too many fields were sent in the request. + +Default value: `'100'` + +##### `limitreqfieldsize` + +Data type: `Any` + +The `limitreqfieldsize` parameter sets the maximum ammount of _bytes_ that will +be allowed within a request header. + +Default value: `'8190'` + +##### `ip` + +Data type: `Any` + +Specifies the ip address + +Default value: ``undef`` + +##### `purge_vdir` + +Data type: `Any` + +Removes all other Apache configs and virtual hosts.
+> **Note**: This parameter is deprecated in favor of the `purge_config` parameter.
+ +Default value: ``false`` + +##### `conf_enabled` + +Data type: `Any` + +Whether the additional config files in `/etc/apache2/conf-enabled` should be managed. + +Default value: `$apache::params::conf_enabled` + +##### `vhost_enable_dir` + +Data type: `Any` + +Set's whether the vhost definitions will be stored in sites-availible and if +they will be symlinked to and from sites-enabled. + +Default value: `$apache::params::vhost_enable_dir` + +##### `mod_enable_dir` + +Data type: `Any` + +Set's whether the mods-enabled directory should be managed. + +Default value: `$apache::params::mod_enable_dir` + +##### `ssl_file` + +Data type: `Any` + +This parameter allows you to set an ssl.conf file to be managed in order to implement +an SSL Certificate. + +Default value: ``undef`` + +##### `file_e_tag` + +Data type: `Any` + +Sets the server default for the `FileETag` declaration, which modifies the response header +field for static files. + +Default value: ``undef`` + +##### `use_optional_includes` + +Data type: `Boolean` + +Specifies whether Apache uses the `IncludeOptional` directive instead of `Include` for +`additional_includes` in Apache 2.4 or newer. + +Default value: `$apache::params::use_optional_includes` + +##### `mime_types_additional` + +Data type: `Any` + +Specifies any idditional Internet media (mime) types that you wish to be configured. + +Default value: `$apache::params::mime_types_additional` + +### `apache::dev` + +The libraries installed depends on the `dev_packages` parameter of the `apache::params` +class, based on your operating system: +- **Debian** : `libaprutil1-dev`, `libapr1-dev`; `apache2-dev` +- **FreeBSD**: `undef`; on FreeBSD, you must declare the `apache::package` or `apache` classes before declaring `apache::dev`. +- **Gentoo**: `undef`. +- **Red Hat**: `httpd-devel`. + +### `apache::mod::actions` + +Installs Apache mod_actions + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_actions.html + * for additional documentation. + +### `apache::mod::alias` + +Installs and configures `mod_alias`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_alias.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::alias` class: + +* [`apache_version`](#apache_version) +* [`icons_options`](#icons_options) +* [`icons_path`](#icons_path) +* [`icons_path`](#icons_path) +* [`icons_prefix`](#icons_prefix) + +##### `apache_version` + +Data type: `Any` + +The version of Apache, if not set will be retrieved from the init class. + +Default value: ``undef`` + +##### `icons_options` + +Data type: `Any` + +Disables directory listings for the icons directory, via Apache [Options](https://httpd.apache.org/docs/current/mod/core.html#options) +directive. + +Default value: `'Indexes MultiViews'` + +##### `icons_path` + +Data type: `Any` + +Sets the local path for an /icons/ Alias. Default depends on operating system: +- Debian: /usr/share/apache2/icons +- FreeBSD: /usr/local/www/apache24/icons +- Gentoo: /var/www/icons +- Red Hat: /var/www/icons, except on Apache 2.4, where it's /usr/share/httpd/icons + +Default value: `$apache::params::alias_icons_path` + +##### `icons_path` + +Change the alias for /icons/. + +Default value: `$apache::params::alias_icons_path` + +##### `icons_prefix` + +Data type: `Any` + + + +Default value: `$apache::params::icons_prefix` + +### `apache::mod::apreq2` + +Installs `mod_apreq2`. + +* **Note** Unsupported platforms: CentOS: all; Debian: 8; OracleLinux: all; RedHat: all; Scientific: all; SLES: all; Ubuntu: all + +* **See also** + * http://httpd.apache.org/apreq/docs/libapreq2/group__mod__apreq2.html + * for additional documentation. + +### `apache::mod::auth_basic` + +Installs `mod_auth_basic` + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_auth_basic.html + * for additional documentation. + +### `apache::mod::auth_cas` + +Installs and configures `mod_auth_cas`. + +* **Note** The auth_cas module isn't available on RH/CentOS without providing dependency packages provided by EPEL. + +* **See also** + * https://github.com/apereo/mod_auth_cas + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::auth_cas` class: + +* [`cas_login_url`](#cas_login_url) +* [`cas_validate_url`](#cas_validate_url) +* [`cas_cookie_path`](#cas_cookie_path) +* [`cas_cookie_path_mode`](#cas_cookie_path_mode) +* [`cas_version`](#cas_version) +* [`cas_debug`](#cas_debug) +* [`cas_validate_server`](#cas_validate_server) +* [`cas_validatedepth`](#cas_validatedepth) +* [`cas_proxy_validate_url`](#cas_proxy_validate_url) +* [`cas_root_proxied_as`](#cas_root_proxied_as) +* [`cas_cookie_entropy`](#cas_cookie_entropy) +* [`cas_timeout`](#cas_timeout) +* [`cas_idle_timeout`](#cas_idle_timeout) +* [`cas_cache_clean_interval`](#cas_cache_clean_interval) +* [`cas_cookie_domain`](#cas_cookie_domain) +* [`cas_cookie_http_only`](#cas_cookie_http_only) +* [`cas_authoritative`](#cas_authoritative) +* [`cas_validate_saml`](#cas_validate_saml) +* [`cas_sso_enabled`](#cas_sso_enabled) +* [`cas_attribute_prefix`](#cas_attribute_prefix) +* [`cas_attribute_delimiter`](#cas_attribute_delimiter) +* [`cas_scrub_request_headers`](#cas_scrub_request_headers) +* [`suppress_warning`](#suppress_warning) +* [`cas_validate_depth`](#cas_validate_depth) +* [`cas_certificate_path`](#cas_certificate_path) + +##### `cas_login_url` + +Data type: `String` + +Sets the URL to which the module redirects users when they attempt to access a +CAS-protected resource and don't have an active session. + +##### `cas_validate_url` + +Data type: `String` + +Sets the URL to use when validating a client-presented ticket in an HTTP query string. + +##### `cas_cookie_path` + +Data type: `String` + +Sets the location where information on the current session should be stored. This should +be writable by the web server only. + +Default value: `$apache::params::cas_cookie_path` + +##### `cas_cookie_path_mode` + +Data type: `Any` + +The mode of cas_cookie_path. + +Default value: `'0750'` + +##### `cas_version` + +Data type: `Any` + +The version of the CAS protocol to adhere to. + +Default value: `2` + +##### `cas_debug` + +Data type: `Any` + +Whether to enable or disable debug mode. + +Default value: `'Off'` + +##### `cas_validate_server` + +Data type: `Any` + +Whether to validate the presented certificate. This has been deprecated and +removed from Version 1.1-RC1 onward. + +Default value: ``undef`` + +##### `cas_validatedepth` + +The maximum depth for chained certificate validation. + +##### `cas_proxy_validate_url` + +Data type: `Any` + +The URL to use when performing a proxy validation. + +Default value: ``undef`` + +##### `cas_root_proxied_as` + +Data type: `Any` + +Sets the URL end users see when access to this Apache server is proxied per vhost. +This URL should not include a trailing slash. + +Default value: ``undef`` + +##### `cas_cookie_entropy` + +Data type: `Any` + +When creating a local session, this many random bytes are used to create a unique +session identifier. + +Default value: ``undef`` + +##### `cas_timeout` + +Data type: `Any` + +The hard limit, in seconds, for a mod_auth_cas session. + +Default value: ``undef`` + +##### `cas_idle_timeout` + +Data type: `Any` + +The limit, in seconds, of how long a mod_auth_cas session can be idle. + +Default value: ``undef`` + +##### `cas_cache_clean_interval` + +Data type: `Any` + +The minimum amount of time that must pass inbetween cache cleanings. + +Default value: ``undef`` + +##### `cas_cookie_domain` + +Data type: `Any` + +The value for the 'Domain=' parameter in the Set-Cookie header. + +Default value: ``undef`` + +##### `cas_cookie_http_only` + +Data type: `Any` + +Setting this flag prevents the mod_auth_cas cookies from being accessed by +client side Javascript. + +Default value: ``undef`` + +##### `cas_authoritative` + +Data type: `Any` + +Determines whether an optional authorization directive is authoritative and thus binding. + +Default value: ``undef`` + +##### `cas_validate_saml` + +Data type: `Any` + +Parse response from CAS server for SAML. + +Default value: ``undef`` + +##### `cas_sso_enabled` + +Data type: `Any` + +Enables experimental support for single sign out (may mangle POST data). + +Default value: ``undef`` + +##### `cas_attribute_prefix` + +Data type: `Any` + +Adds a header with the value of this header being the attribute values when SAML +validation is enabled. + +Default value: ``undef`` + +##### `cas_attribute_delimiter` + +Data type: `Any` + +Sets the delimiter between attribute values in the header created by `cas_attribute_prefix`. + +Default value: ``undef`` + +##### `cas_scrub_request_headers` + +Data type: `Any` + +Remove inbound request headers that may have special meaning within mod_auth_cas. + +Default value: ``undef`` + +##### `suppress_warning` + +Data type: `Any` + +Suppress warning about being on RedHat (mod_auth_cas package is now available in epel-testing repo). + +Default value: ``false`` + +##### `cas_validate_depth` + +Data type: `Any` + + + +Default value: ``undef`` + +##### `cas_certificate_path` + +Data type: `Any` + + + +Default value: ``undef`` + +### `apache::mod::auth_gssapi` + +Installs `mod_auth_gsappi`. + +* **See also** + * https://github.com/modauthgssapi/mod_auth_gssapi + * for additional documentation. + +### `apache::mod::auth_kerb` + +Installs `mod_auth_kerb` + +* **See also** + * http://modauthkerb.sourceforge.net + * for additional documentation. + +### `apache::mod::auth_mellon` + +Installs and configures `mod_auth_mellon`. + +* **See also** + * https://github.com/Uninett/mod_auth_mellon + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::auth_mellon` class: + +* [`mellon_cache_size`](#mellon_cache_size) +* [`mellon_lock_file`](#mellon_lock_file) +* [`mellon_post_directory`](#mellon_post_directory) +* [`mellon_cache_entry_size`](#mellon_cache_entry_size) +* [`mellon_post_ttl`](#mellon_post_ttl) +* [`mellon_post_size`](#mellon_post_size) +* [`mellon_post_count`](#mellon_post_count) + +##### `mellon_cache_size` + +Data type: `Any` + +Maximum number of sessions which can be active at once. + +Default value: `$apache::params::mellon_cache_size` + +##### `mellon_lock_file` + +Data type: `Any` + +Full path to a file used for synchronizing access to the session data. + +Default value: `$apache::params::mellon_lock_file` + +##### `mellon_post_directory` + +Data type: `Any` + +Full path of a directory where POST requests are saved during authentication. + +Default value: `$apache::params::mellon_post_directory` + +##### `mellon_cache_entry_size` + +Data type: `Any` + +Maximum size for a single session entry in bytes. + +Default value: ``undef`` + +##### `mellon_post_ttl` + +Data type: `Any` + +Delay in seconds before a saved POST request can be flushed. + +Default value: ``undef`` + +##### `mellon_post_size` + +Data type: `Any` + +Maximum size for saved POST requests. + +Default value: ``undef`` + +##### `mellon_post_count` + +Data type: `Any` + +Maximum amount of saved POST requests. + +Default value: ``undef`` + +### `apache::mod::auth_openidc` + +Installs and configures `mod_auth_openidc`. + +* **See also** + * https://github.com/zmartzone/mod_auth_openidc + * for additional documentation. + +### `apache::mod::authn_core` + +Installs `mod_authn_core`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_authn_core.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::authn_core` class: + +* [`apache_version`](#apache_version) + +##### `apache_version` + +Data type: `Any` + +The version of apache being run. + +Default value: `$apache::apache_version` + +### `apache::mod::authn_dbd` + +Installs `mod_authn_dbd`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_authn_dbd.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::authn_dbd` class: + +* [`authn_dbd_params`](#authn_dbd_params) +* [`authn_dbd_dbdriver`](#authn_dbd_dbdriver) +* [`authn_dbd_query`](#authn_dbd_query) +* [`authn_dbd_min`](#authn_dbd_min) +* [`authn_dbd_max`](#authn_dbd_max) +* [`authn_dbd_keep`](#authn_dbd_keep) +* [`authn_dbd_exptime`](#authn_dbd_exptime) +* [`authn_dbd_alias`](#authn_dbd_alias) + +##### `authn_dbd_params` + +Data type: `Any` + +The params needed for the mod to function. + +##### `authn_dbd_dbdriver` + +Data type: `Any` + +Selects an apr_dbd driver by name. + +Default value: `'mysql'` + +##### `authn_dbd_query` + +Data type: `Any` + + + +Default value: ``undef`` + +##### `authn_dbd_min` + +Data type: `Any` + +Set the minimum number of connections per process. + +Default value: `'4'` + +##### `authn_dbd_max` + +Data type: `Any` + +Set the maximum number of connections per process. + +Default value: `'20'` + +##### `authn_dbd_keep` + +Data type: `Any` + +Set the maximum number of connections per process to be sustained. + +Default value: `'8'` + +##### `authn_dbd_exptime` + +Data type: `Any` + +Set the time to keep idle connections alive when the number of +connections specified in DBDKeep has been exceeded. + +Default value: `'300'` + +##### `authn_dbd_alias` + +Data type: `Any` + +Sets an alias for `AuthnProvider. + +Default value: ``undef`` + +### `apache::mod::authn_file` + +Installs `mod_authn_file`. + +* **See also** + * https://httpd.apache.org/docs/2.4/mod/mod_authn_file.html + * for additional documentation. + +### `apache::mod::authnz_ldap` + +Installs `mod_authnz_ldap`. + +* **Note** Unsupported platforms: RedHat: 6, 8; CentOS: 6, 8; OracleLinux: 6, 8; Ubuntu: all; Debian: all; SLES: all + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_authnz_ldap.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::authnz_ldap` class: + +* [`verify_server_cert`](#verify_server_cert) +* [`package_name`](#package_name) + +##### `verify_server_cert` + +Data type: `Boolean` + +Whether to force te verification of a server cert or not. + +Default value: ``true`` + +##### `package_name` + +Data type: `Any` + +The name of the ldap package. + +Default value: ``undef`` + +### `apache::mod::authnz_pam` + +Installs `mod_authnz_pam`. + +* **See also** + * https://www.adelton.com/apache/mod_authnz_pam + * for additional documentation. + +### `apache::mod::authz_default` + +Installs and configures `mod_authz_default`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_authz_default.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::authz_default` class: + +* [`apache_version`](#apache_version) + +##### `apache_version` + +Data type: `Any` + +Version of Apache to install module on. + +Default value: `$apache::apache_version` + +### `apache::mod::authz_user` + +Installs `mod_authz_user` + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_authz_user.html + * for additional documentation. + +### `apache::mod::autoindex` + +Installs `mod_autoindex` + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_autoindex.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::autoindex` class: + +* [`icons_prefix`](#icons_prefix) + +##### `icons_prefix` + +Data type: `Any` + + + +Default value: `$apache::params::icons_prefix` + +### `apache::mod::cache` + +Installs `mod_cache` + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_cache.html + * for additional documentation. + +### `apache::mod::cgi` + +Installs `mod_cgi`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_cgi.html + * for additional documentation. + +### `apache::mod::cgid` + +Installs `mod_cgid`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_cgid.html + +### `apache::mod::cluster` + +Installs `mod_cluster`. + +* **Note** There is no official package available for mod_cluster, so you must make it available outside of the apache module. +Binaries can be found [here](https://modcluster.io/). + +* **See also** + * https://modcluster.io/ + * for additional documentation. + +#### Examples + +##### + +```puppet +class { '::apache::mod::cluster': + ip => '172.17.0.1', + allowed_network => '172.17.0.', + balancer_name => 'mycluster', + version => '1.3.1' +} +``` + +#### Parameters + +The following parameters are available in the `apache::mod::cluster` class: + +* [`allowed_network`](#allowed_network) +* [`balancer_name`](#balancer_name) +* [`ip`](#ip) +* [`version`](#version) +* [`enable_mcpm_receive`](#enable_mcpm_receive) +* [`port`](#port) +* [`keep_alive_timeout`](#keep_alive_timeout) +* [`manager_allowed_network`](#manager_allowed_network) +* [`max_keep_alive_requests`](#max_keep_alive_requests) +* [`server_advertise`](#server_advertise) +* [`advertise_frequency`](#advertise_frequency) + +##### `allowed_network` + +Data type: `Any` + +Balanced members network. + +##### `balancer_name` + +Data type: `Any` + +Name of balancer. + +##### `ip` + +Data type: `Any` + +Specifies the IP address to listen to. + +##### `version` + +Data type: `Any` + +Specifies the mod_cluster version. Version 1.3.0 or greater is required for httpd 2.4. + +##### `enable_mcpm_receive` + +Data type: `Any` + +Whether MCPM should be enabled. + +Default value: ``true`` + +##### `port` + +Data type: `Any` + +mod_cluster listen port. + +Default value: `'6666'` + +##### `keep_alive_timeout` + +Data type: `Any` + +Specifies how long Apache should wait for a request, in seconds. + +Default value: `60` + +##### `manager_allowed_network` + +Data type: `Any` + +Whether to allow the network to access the mod_cluster_manager. + +Default value: `'127.0.0.1'` + +##### `max_keep_alive_requests` + +Data type: `Any` + +Maximum number of requests kept alive. + +Default value: `0` + +##### `server_advertise` + +Data type: `Any` + +Whether the server should advertise. + +Default value: ``true`` + +##### `advertise_frequency` + +Data type: `Any` + +Sets the interval between advertise messages in seconds. + +Default value: ``undef`` + +### `apache::mod::data` + +Installs and configures `mod_data`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_data.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::data` class: + +* [`apache_version`](#apache_version) + +##### `apache_version` + +Data type: `Any` + +Version of Apache to install module on. + +Default value: ``undef`` + +### `apache::mod::dav` + +Installs `mod_dav`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_dav.html + * for additional documentation. + +### `apache::mod::dav_fs` + +Installs `mod_dav_fs`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_dav_fs.html + * for additional documentation. + +### `apache::mod::dav_svn` + +Installs and configures `mod_dav_svn`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_dav_svn.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::dav_svn` class: + +* [`authz_svn_enabled`](#authz_svn_enabled) + +##### `authz_svn_enabled` + +Data type: `Any` + +Specifies whether to install Apache mod_authz_svn + +Default value: ``false`` + +### `apache::mod::dbd` + +Installs `mod_dbd`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_dbd.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::dbd` class: + +* [`apache_version`](#apache_version) + +##### `apache_version` + +Used to verify that the Apache version you have requested is compatible with the module. + +### `apache::mod::deflate` + +Installs and configures `mod_deflate`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_deflate.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::deflate` class: + +* [`types`](#types) +* [`notes`](#notes) + +##### `types` + +Data type: `Any` + +An array of MIME types to be deflated. See https://www.iana.org/assignments/media-types/media-types.xhtml. + +Default value: `[ + 'text/html text/plain text/xml', + 'text/css', + 'application/x-javascript application/javascript application/ecmascript', + 'application/rss+xml', + 'application/json', + ]` + +##### `notes` + +Data type: `Any` + +A Hash where the key represents the type and the value represents the note name. + +Default value: `{ + 'Input' => 'instream', + 'Output' => 'outstream', + 'Ratio' => 'ratio', + }` + +### `apache::mod::dev` + +Installs `mod_dev`. + +* **Note** This module is deprecated. Please use `apache::dev`. + +### `apache::mod::dir` + +Installs and configures `mod_dir`. + +* **TODO** This sets the global DirectoryIndex directive, so it may be necessary to consider being able to modify the apache::vhost to declare +DirectoryIndex statements in a vhost configuration + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_dir.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::dir` class: + +* [`types`](#types) +* [`indexes`](#indexes) +* [`dir`](#dir) + +##### `types` + +Specifies the text-based content types to compress. + +##### `indexes` + +Data type: `Array[String]` + +Provides a string for the DirectoryIndex directive + +Default value: `['index.html','index.html.var','index.cgi','index.pl','index.php','index.xhtml']` + +##### `dir` + +Data type: `Any` + + + +Default value: `'public_html'` + +### `apache::mod::disk_cache` + +Installs and configures `mod_disk_cache`. + +* **Note** Apache 2.2, mod_disk_cache installed. On Apache 2.4, mod_cache_disk installed. + +* **See also** + * https://httpd.apache.org/docs/2.2/mod/mod_disk_cache.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::disk_cache` class: + +* [`cache_root`](#cache_root) +* [`cache_ignore_headers`](#cache_ignore_headers) +* [`default_cache_enable`](#default_cache_enable) + +##### `cache_root` + +Data type: `Any` + +Defines the name of the directory on the disk to contain cache files. +Default depends on the Apache version and operating system: +- Debian: /var/cache/apache2/mod_cache_disk +- FreeBSD: /var/cache/mod_cache_disk +- Red Hat, Apache 2.4: /var/cache/httpd/proxy +- Red Hat, Apache 2.2: /var/cache/mod_proxy + +Default value: ``undef`` + +##### `cache_ignore_headers` + +Data type: `Any` + +Specifies HTTP header(s) that should not be stored in the cache. + +Default value: ``undef`` + +##### `default_cache_enable` + +Data type: `Boolean` + +Default value is true, which enables "CacheEnable disk /" in disk_cache.conf for the webserver. This would cache +every request to apache by default for every vhost. If set to false the default cache all behaviour is supressed. +You can then control this behaviour in individual vhosts by explicitly defining CacheEnable. + +Default value: ``true`` + +### `apache::mod::dumpio` + +Installs and configures `mod_dumpio`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_dumpio.html + * for additional documentation. + +#### Examples + +##### + +```puppet +class{'apache': + default_mods => false, + log_level => 'dumpio:trace7', +} +class{'apache::mod::dumpio': + dump_io_input => 'On', + dump_io_output => 'Off', +} +``` + +#### Parameters + +The following parameters are available in the `apache::mod::dumpio` class: + +* [`dump_io_input`](#dump_io_input) +* [`dump_io_output`](#dump_io_output) + +##### `dump_io_input` + +Data type: `Enum['Off', 'On', 'off', 'on']` + +Dump all input data to the error log + +Default value: `'Off'` + +##### `dump_io_output` + +Data type: `Enum['Off', 'On', 'off', 'on']` + +Dump all output data to the error log + +Default value: `'Off'` + +### `apache::mod::env` + +Installs `mod_env`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_env.html + * for additional documentation. + +### `apache::mod::event` + +Installs and configures `mod_event`. + +* **Note** You cannot include apache::mod::event with apache::mod::itk, apache::mod::peruser, apache::mod::prefork, or +apache::mod::worker on the same server. + +* **See also** + * https://httpd.apache.org/docs/current/mod/event.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::event` class: + +* [`startservers`](#startservers) +* [`maxclients`](#maxclients) +* [`maxrequestworkers`](#maxrequestworkers) +* [`minsparethreads`](#minsparethreads) +* [`maxsparethreads`](#maxsparethreads) +* [`threadsperchild`](#threadsperchild) +* [`maxrequestsperchild`](#maxrequestsperchild) +* [`maxconnectionsperchild`](#maxconnectionsperchild) +* [`serverlimit`](#serverlimit) +* [`apache_version`](#apache_version) +* [`threadlimit`](#threadlimit) +* [`listenbacklog`](#listenbacklog) + +##### `startservers` + +Data type: `Any` + +Sets the number of child server processes created at startup, via the module's `StartServers` directive. Setting this to `false` +removes the parameter. + +Default value: `'2'` + +##### `maxclients` + +Data type: `Any` + +Apache 2.3.12 or older alias for the `MaxRequestWorkers` directive. + +Default value: `'150'` + +##### `maxrequestworkers` + +Data type: `Any` + +Sets the maximum number of connections Apache can simultaneously process, via the module's `MaxRequestWorkers` directive. Setting +these to `false` removes the parameters. + +Default value: ``undef`` + +##### `minsparethreads` + +Data type: `Any` + +Sets the minimum number of idle threads, via the `MinSpareThreads` directive. Setting this to `false` removes the parameters. + +Default value: `'25'` + +##### `maxsparethreads` + +Data type: `Any` + +Sets the maximum number of idle threads, via the `MaxSpareThreads` directive. Setting this to `false` removes the parameters. + +Default value: `'75'` + +##### `threadsperchild` + +Data type: `Any` + +Number of threads created by each child process. + +Default value: `'25'` + +##### `maxrequestsperchild` + +Data type: `Any` + +Apache 2.3.8 or older alias for the `MaxConnectionsPerChild` directive. + +Default value: `'0'` + +##### `maxconnectionsperchild` + +Data type: `Any` + +Limit on the number of connections that an individual child server will handle during its life. + +Default value: ``undef`` + +##### `serverlimit` + +Data type: `Any` + +Limits the configurable number of processes via the `ServerLimit` directive. Setting this to `false` removes the parameter. + +Default value: `'25'` + +##### `apache_version` + +Data type: `Any` + +Version of Apache to install module on. + +Default value: ``undef`` + +##### `threadlimit` + +Data type: `Any` + +Limits the number of event threads via the module's `ThreadLimit` directive. Setting this to `false` removes the parameter. + +Default value: `'64'` + +##### `listenbacklog` + +Data type: `Any` + +Sets the maximum length of the pending connections queue via the module's `ListenBackLog` directive. Setting this to `false` removes +the parameter. + +Default value: `'511'` + +### `apache::mod::expires` + +Installs and configures `mod_expires`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_expires.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::expires` class: + +* [`expires_active`](#expires_active) +* [`expires_default`](#expires_default) +* [`expires_by_type`](#expires_by_type) + +##### `expires_active` + +Data type: `Any` + +Enables generation of Expires headers. + +Default value: ``true`` + +##### `expires_default` + +Data type: `Any` + +Specifies the default algorithm for calculating expiration time using ExpiresByType syntax or interval syntax. + +Default value: ``undef`` + +##### `expires_by_type` + +Data type: `Any` + +Describes a set of [MIME content-types](https://www.iana.org/assignments/media-types/media-types.xhtml) and their expiration +times. This should be used as an array of Hashes, with each Hash's key a valid MIME content-type (i.e. 'text/json') and its +value following valid interval syntax. + +Default value: ``undef`` + +### `apache::mod::ext_filter` + +Installs and configures `mod_ext_filter`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_ext_filter.html + * for additional documentation. + +#### Examples + +##### + +```puppet +class { 'apache::mod::ext_filter': + ext_filter_define => { + 'slowdown' => 'mode=output cmd=/bin/cat preservescontentlength', + 'puppetdb-strip' => 'mode=output outtype=application/json cmd="pdb-resource-filter"', + }, +} +``` + +#### Parameters + +The following parameters are available in the `apache::mod::ext_filter` class: + +* [`ext_filter_define`](#ext_filter_define) + +##### `ext_filter_define` + +Data type: `Optional[Hash]` + +Hash of filter names and their parameters. + +Default value: ``undef`` + +### `apache::mod::fastcgi` + +Installs `mod_fastcgi`. + +* **See also** + * https://github.com/FastCGI-Archives/mod_fastcgi + * for additional documentation. + +### `apache::mod::fcgid` + +loaded first; Puppet will not automatically enable it if you set the fcgiwrapper parameter in apache::vhost. + include apache::mod::fcgid + + apache::vhost { 'example.org': + docroot => '/var/www/html', + directories => { + path => '/var/www/html', + fcgiwrapper => { + command => '/usr/local/bin/fcgiwrapper', + } + }, + } + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_fcgid.html + * for additional documentation. + +#### Examples + +##### The class does not individually parameterize all available options. Instead, configure mod_fcgid using the options hash. + +```puppet +class { 'apache::mod::fcgid': + options => { + 'FcgidIPCDir' => '/var/run/fcgidsock', + 'SharememPath' => '/var/run/fcgid_shm', + 'AddHandler' => 'fcgid-script .fcgi', + }, +} +``` + +##### If you include apache::mod::fcgid, you can set the [FcgidWrapper][] per directory, per virtual host. The module must be + +```puppet + +``` + +#### Parameters + +The following parameters are available in the `apache::mod::fcgid` class: + +* [`expires_active`](#expires_active) +* [`expires_default`](#expires_default) +* [`expires_by_type`](#expires_by_type) +* [`options`](#options) + +##### `expires_active` + +Enables generation of Expires headers. + +##### `expires_default` + +Default algorithm for calculating expiration time. + +##### `expires_by_type` + +Value of the Expires header configured by MIME type. + +##### `options` + +Data type: `Any` + + + +Default value: `{}` + +### `apache::mod::filter` + +Installs `mod_filter`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_filter.html + * for additional documentation. + +### `apache::mod::geoip` + +Installs and configures `mod_geoip`. + +* **See also** + * https://dev.maxmind.com/geoip/legacy/mod_geoip2 + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::geoip` class: + +* [`enable`](#enable) +* [`db_file`](#db_file) +* [`flag`](#flag) +* [`output`](#output) +* [`enable_utf8`](#enable_utf8) +* [`scan_proxy_headers`](#scan_proxy_headers) +* [`scan_proxy_headers_field`](#scan_proxy_headers_field) +* [`use_last_xforwarededfor_ip`](#use_last_xforwarededfor_ip) +* [`scan_proxy_header_field`](#scan_proxy_header_field) + +##### `enable` + +Data type: `Any` + +Toggles whether to enable geoip. + +Default value: ``false`` + +##### `db_file` + +Data type: `Any` + +Path to database for GeoIP to use. + +Default value: `'/usr/share/GeoIP/GeoIP.dat'` + +##### `flag` + +Data type: `Any` + +Caching directive to use. Values: 'CheckCache', 'IndexCache', 'MemoryCache', 'Standard'. + +Default value: `'Standard'` + +##### `output` + +Data type: `Any` + +Output variable locations. Values: 'All', 'Env', 'Request', 'Notes'. + +Default value: `'All'` + +##### `enable_utf8` + +Data type: `Any` + +Changes the output from ISO88591 (Latin1) to UTF8. + +Default value: ``undef`` + +##### `scan_proxy_headers` + +Data type: `Any` + +Enables the GeoIPScanProxyHeaders option. + +Default value: ``undef`` + +##### `scan_proxy_headers_field` + +Specifies the header mod_geoip uses to determine the client's IP address. + +##### `use_last_xforwarededfor_ip` + +Data type: `Any` + +Determines whether to use the first or last IP address for the client's IP in a comma-separated list of IP addresses is found. + +Default value: ``undef`` + +##### `scan_proxy_header_field` + +Data type: `Any` + + + +Default value: ``undef`` + +### `apache::mod::headers` + +Installs and configures `mod_headers`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_headers.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::headers` class: + +* [`apache_version`](#apache_version) + +##### `apache_version` + +Version of Apache to install module on. + +### `apache::mod::http2` + +Installs and configures `mod_http2`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_http2.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::http2` class: + +* [`h2_copy_files`](#h2_copy_files) +* [`h2_direct`](#h2_direct) +* [`h2_early_hints`](#h2_early_hints) +* [`h2_max_session_streams`](#h2_max_session_streams) +* [`h2_max_worker_idle_seconds`](#h2_max_worker_idle_seconds) +* [`h2_max_workers`](#h2_max_workers) +* [`h2_min_workers`](#h2_min_workers) +* [`h2_modern_tls_only`](#h2_modern_tls_only) +* [`h2_push`](#h2_push) +* [`h2_push_diary_size`](#h2_push_diary_size) +* [`h2_priority`](#h2_priority) +* [`h2_push_resource`](#h2_push_resource) +* [`h2_serialize_headers`](#h2_serialize_headers) +* [`h2_stream_max_mem_size`](#h2_stream_max_mem_size) +* [`h2_tls_cool_down_secs`](#h2_tls_cool_down_secs) +* [`h2_tls_warm_up_size`](#h2_tls_warm_up_size) +* [`h2_upgrade`](#h2_upgrade) +* [`h2_window_size`](#h2_window_size) +* [`apache_version`](#apache_version) +* [`h2_push_priority`](#h2_push_priority) + +##### `h2_copy_files` + +Data type: `Optional[Boolean]` + +Determine file handling in responses. + +Default value: ``undef`` + +##### `h2_direct` + +Data type: `Optional[Boolean]` + +H2 Direct Protocol Switch. + +Default value: ``undef`` + +##### `h2_early_hints` + +Data type: `Optional[Boolean]` + +Determine sending of 103 status codes. + +Default value: ``undef`` + +##### `h2_max_session_streams` + +Data type: `Optional[Integer]` + +Sets maximum number of active streams per HTTP/2 session. + +Default value: ``undef`` + +##### `h2_max_worker_idle_seconds` + +Data type: `Optional[Integer]` + +Sets maximum number of seconds h2 workers remain idle until shut down. + +Default value: ``undef`` + +##### `h2_max_workers` + +Data type: `Optional[Integer]` + +Sets maximum number of worker threads to use per child process. + +Default value: ``undef`` + +##### `h2_min_workers` + +Data type: `Optional[Integer]` + +Sets minimal number of worker threads to use per child process. + +Default value: ``undef`` + +##### `h2_modern_tls_only` + +Data type: `Optional[Boolean]` + +Toggles the security checks on HTTP/2 connections in TLS mode + +Default value: ``undef`` + +##### `h2_push` + +Data type: `Optional[Boolean]` + +Toggles the usage of the HTTP/2 server push protocol feature. + +Default value: ``undef`` + +##### `h2_push_diary_size` + +Data type: `Optional[Integer]` + +Sets maximum number of HTTP/2 server pushes that are remembered per HTTP/2 connection. + +Default value: ``undef`` + +##### `h2_priority` + +Require HTTP/2 connections to be "modern TLS" only + +##### `h2_push_resource` + +Data type: `Array[String]` + +When added to a directory/location, HTTP/2 PUSHes will be attempted for all paths added +via this directive + +Default value: `[]` + +##### `h2_serialize_headers` + +Data type: `Optional[Boolean]` + +Toggles if HTTP/2 requests shall be serialized in HTTP/1.1 format for processing by httpd +core or if received binary data shall be passed into the request_recs directly. + +Default value: ``undef`` + +##### `h2_stream_max_mem_size` + +Data type: `Optional[Integer]` + +Sets the maximum number of outgoing data bytes buffered in memory for an active streams. + +Default value: ``undef`` + +##### `h2_tls_cool_down_secs` + +Data type: `Optional[Integer]` + +Sets the number of seconds of idle time on a TLS connection before the TLS write size falls +back to small (~1300 bytes) length. + +Default value: ``undef`` + +##### `h2_tls_warm_up_size` + +Data type: `Optional[Integer]` + +Sets the number of bytes to be sent in small TLS records (~1300 bytes) until doing maximum +sized writes (16k) on https: HTTP/2 connections. + +Default value: ``undef`` + +##### `h2_upgrade` + +Data type: `Optional[Boolean]` + +Toggles the usage of the HTTP/1.1 Upgrade method for switching to HTTP/2. + +Default value: ``undef`` + +##### `h2_window_size` + +Data type: `Optional[Integer]` + +Sets the size of the window that is used for flow control from client to server and limits +the amount of data the server has to buffer. + +Default value: ``undef`` + +##### `apache_version` + +Data type: `Optional[String]` + +Version of Apache to install module on. + +Default value: ``undef`` + +##### `h2_push_priority` + +Data type: `Array[String]` + + + +Default value: `[]` + +### `apache::mod::include` + +Installs `mod_include`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_include.html + * for additional documentation. + +### `apache::mod::info` + +Installs and configures `mod_info`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_info.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::info` class: + +* [`allow_from`](#allow_from) +* [`apache_version`](#apache_version) +* [`restrict_access`](#restrict_access) +* [`info_path`](#info_path) + +##### `allow_from` + +Data type: `Any` + +Allowlist of IPv4 or IPv6 addresses or ranges that can access the info path. + +Default value: `['127.0.0.1','::1']` + +##### `apache_version` + +Data type: `Any` + +Version of Apache to install module on. + +Default value: ``undef`` + +##### `restrict_access` + +Data type: `Any` + +Toggles whether to restrict access to info path. If `false`, the `allow_from` allowlist is ignored and any IP address can +access the info path. + +Default value: ``true`` + +##### `info_path` + +Data type: `Any` + +Path on server to file containing server configuration information. + +Default value: `'/server-info'` + +### `apache::mod::intercept_form_submit` + +Installs `mod_intercept_form_submit`. + +* **See also** + * https://www.adelton.com/apache/mod_intercept_form_submit + * for additional documentation. + +### `apache::mod::itk` + +Installs MPM `mod_itk`. + +* **Note** Unsupported platforms: CentOS: 8; RedHat: 8; SLES: all + +* **See also** + * http://mpm-itk.sesse.net + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::itk` class: + +* [`startservers`](#startservers) +* [`minspareservers`](#minspareservers) +* [`maxspareservers`](#maxspareservers) +* [`serverlimit`](#serverlimit) +* [`maxclients`](#maxclients) +* [`maxrequestsperchild`](#maxrequestsperchild) +* [`enablecapabilities`](#enablecapabilities) +* [`apache_version`](#apache_version) + +##### `startservers` + +Data type: `Any` + +Number of child server processes created on startup. + +Default value: `'8'` + +##### `minspareservers` + +Data type: `Any` + +Minimum number of idle child server processes. + +Default value: `'5'` + +##### `maxspareservers` + +Data type: `Any` + +Maximum number of idle child server processes. + +Default value: `'20'` + +##### `serverlimit` + +Data type: `Any` + +Maximum configured value for `MaxRequestWorkers` for the lifetime of the Apache httpd process. + +Default value: `'256'` + +##### `maxclients` + +Data type: `Any` + +Limit on the number of simultaneous requests that will be served. + +Default value: `'256'` + +##### `maxrequestsperchild` + +Data type: `Any` + +Limit on the number of connections that an individual child server process will handle. + +Default value: `'4000'` + +##### `enablecapabilities` + +Data type: `Any` + +Drop most root capabilities in the parent process, and instead run as the user given by the User/Group directives with some extra +capabilities (in particular setuid). Somewhat more secure, but can cause problems when serving from filesystems that do not honor +capabilities, such as NFS. + +Default value: ``undef`` + +##### `apache_version` + +Data type: `Any` + +Used to verify that the Apache version you have requested is compatible with the module. + +Default value: ``undef`` + +### `apache::mod::jk` + +Installs `mod_jk`. + +* **Note** shm_file and log_file +Depending on how these files are specified, the class creates their final path differently: + +Relative path: prepends supplied path with logroot (see below) +Absolute path or pipe: uses supplied path as-is + +``` +shm_file => 'shm_file' +# Ends up in +$shm_path = '/var/log/httpd/shm_file' + +shm_file => '/run/shm_file' +# Ends up in +$shm_path = '/run/shm_file' + +shm_file => '"|rotatelogs /var/log/httpd/mod_jk.log.%Y%m%d 86400 -180"' +# Ends up in +$shm_path = '"|rotatelogs /var/log/httpd/mod_jk.log.%Y%m%d 86400 -180"' +``` + +* **See also** + * https://tomcat.apache.org/connectors-doc/reference/apache.html + * for additional documentation. + +#### Examples + +##### + +```puppet +class { '::apache::mod::jk': + ip => '192.168.2.15', + workers_file => 'conf/workers.properties', + mount_file => 'conf/uriworkermap.properties', + shm_file => 'run/jk.shm', + shm_size => '50M', + workers_file_content => { + + }, +} +``` + +#### Parameters + +The following parameters are available in the `apache::mod::jk` class: + +* [`ip`](#ip) +* [`port`](#port) +* [`add_listen`](#add_listen) +* [`workers_file`](#workers_file) +* [`worker_property`](#worker_property) +* [`logroot`](#logroot) +* [`shm_file`](#shm_file) +* [`shm_size`](#shm_size) +* [`mount_file`](#mount_file) +* [`mount_file_reload`](#mount_file_reload) +* [`mount`](#mount) +* [`un_mount`](#un_mount) +* [`auto_alias`](#auto_alias) +* [`mount_copy`](#mount_copy) +* [`worker_indicator`](#worker_indicator) +* [`watchdog_interval`](#watchdog_interval) +* [`log_file`](#log_file) +* [`log_level`](#log_level) +* [`log_stamp_format`](#log_stamp_format) +* [`request_log_format`](#request_log_format) +* [`extract_ssl`](#extract_ssl) +* [`https_indicator`](#https_indicator) +* [`sslprotocol_indicator`](#sslprotocol_indicator) +* [`certs_indicator`](#certs_indicator) +* [`cipher_indicator`](#cipher_indicator) +* [`certchain_prefix`](#certchain_prefix) +* [`session_indicator`](#session_indicator) +* [`keysize_indicator`](#keysize_indicator) +* [`local_name_indicator`](#local_name_indicator) +* [`ignore_cl_indicator`](#ignore_cl_indicator) +* [`local_addr_indicator`](#local_addr_indicator) +* [`local_port_indicator`](#local_port_indicator) +* [`remote_host_indicator`](#remote_host_indicator) +* [`remote_addr_indicator`](#remote_addr_indicator) +* [`remote_port_indicator`](#remote_port_indicator) +* [`remote_user_indicator`](#remote_user_indicator) +* [`auth_type_indicator`](#auth_type_indicator) +* [`options`](#options) +* [`env_var`](#env_var) +* [`strip_session`](#strip_session) +* [`workers_file_content`](#workers_file_content) +* [`mount_file_content`](#mount_file_content) +* [`location_list`](#location_list) + +##### `ip` + +Data type: `Optional[String]` + +IP for binding to mod_jk. Useful when the binding address is not the primary network interface IP. + +Default value: ``undef`` + +##### `port` + +Data type: `Integer` + +Port for binding to mod_jk. Useful when something else, like a reverse proxy or cache, is receiving requests at port 80, then +needs to forward them to Apache at a different port. + +Default value: `80` + +##### `add_listen` + +Data type: `Boolean` + +Defines if a Listen directive according to parameters ip and port (see below), so that Apache listens to the IP/port combination +and redirect to mod_jk. Useful when another Listen directive, like Listen *: or Listen , can conflict with the one +necessary for mod_jk binding. + +Default value: ``true`` + +##### `workers_file` + +Data type: `Any` + +The name of a worker file for the Tomcat servlet containers. + +Default value: ``undef`` + +##### `worker_property` + +Data type: `Any` + +Enables setting worker properties inside Apache configuration file. + +Default value: `{}` + +##### `logroot` + +Data type: `Any` + +The base directory for shm_file and log_file is determined by the logroot parameter. If unspecified, defaults to +apache::params::logroot. The default logroot is sane enough therefore it is not recommended to override it. + +Default value: ``undef`` + +##### `shm_file` + +Data type: `Any` + +Shared memory file name. + +Default value: `'jk-runtime-status'` + +##### `shm_size` + +Data type: `Any` + +Size of the shared memory file name. + +Default value: ``undef`` + +##### `mount_file` + +Data type: `Any` + +File containing multiple mappings from a context to a Tomcat worker. + +Default value: ``undef`` + +##### `mount_file_reload` + +Data type: `Any` + +This directive configures the reload check interval in seconds. + +Default value: ``undef`` + +##### `mount` + +Data type: `Any` + +A mount point from a context to a Tomcat worker. + +Default value: `{}` + +##### `un_mount` + +Data type: `Any` + +An exclusion mount point from a context to a Tomcat worker. + +Default value: `{}` + +##### `auto_alias` + +Data type: `Any` + +Automatically Alias webapp context directories into the Apache document space + +Default value: ``undef`` + +##### `mount_copy` + +Data type: `Any` + +If this directive is set to "On" in some virtual server, the mounts from the global server will be copied +to this virtual server, more precisely all mounts defined by JkMount or JkUnMount. + +Default value: ``undef`` + +##### `worker_indicator` + +Data type: `Any` + +Name of the Apache environment variable that can be used to set worker names in combination with SetHandler +jakarta-servlet. + +Default value: ``undef`` + +##### `watchdog_interval` + +Data type: `Any` + +This directive configures the watchdog thread interval in seconds. + +Default value: ``undef`` + +##### `log_file` + +Data type: `Any` + +Full or server relative path to the mod_jk log file. + +Default value: `'mod_jk.log'` + +##### `log_level` + +Data type: `Any` + +The mod_jk log level, can be debug, info, warn error or trace. + +Default value: ``undef`` + +##### `log_stamp_format` + +Data type: `Any` + +The mod_jk date log format, using an extended strftime syntax. + +Default value: ``undef`` + +##### `request_log_format` + +Data type: `Any` + +Request log format string. + +Default value: ``undef`` + +##### `extract_ssl` + +Data type: `Any` + +Turns on SSL processing and information gathering by mod_jk. + +Default value: ``undef`` + +##### `https_indicator` + +Data type: `Any` + +Name of the Apache environment variable that contains SSL indication. + +Default value: ``undef`` + +##### `sslprotocol_indicator` + +Data type: `Any` + +Name of the Apache environment variable that contains the SSL protocol name. + +Default value: ``undef`` + +##### `certs_indicator` + +Data type: `Any` + +Name of the Apache environment variable that contains SSL client certificates. + +Default value: ``undef`` + +##### `cipher_indicator` + +Data type: `Any` + +Name of the Apache environment variable that contains SSL client cipher. + +Default value: ``undef`` + +##### `certchain_prefix` + +Data type: `Any` + +Name of the Apache environment (prefix) that contains SSL client chain certificates. + +Default value: ``undef`` + +##### `session_indicator` + +Data type: `Any` + +Name of the Apache environment variable that contains SSL session. + +Default value: ``undef`` + +##### `keysize_indicator` + +Data type: `Any` + +Name of the Apache environment variable that contains SSL key size in use. + +Default value: ``undef`` + +##### `local_name_indicator` + +Data type: `Any` + +Name of the Apache environment variable which can be used to overwrite the forwarded local name. + +Default value: ``undef`` + +##### `ignore_cl_indicator` + +Data type: `Any` + +Name of the Apache environment variable which forces to ignore an existing Content-Length request header. + +Default value: ``undef`` + +##### `local_addr_indicator` + +Data type: `Any` + +Name of the Apache environment variable which can be used to overwrite the forwarded local IP address. + +Default value: ``undef`` + +##### `local_port_indicator` + +Data type: `Any` + +Name of the Apache environment variable which can be used to overwrite the forwarded local port. + +Default value: ``undef`` + +##### `remote_host_indicator` + +Data type: `Any` + +Name of the Apache environment variable which can be used to overwrite the forwarded remote (client) host name. + +Default value: ``undef`` + +##### `remote_addr_indicator` + +Data type: `Any` + +Name of the Apache environment variable which can be used to overwrite the forwarded remote (client) IP address. + +Default value: ``undef`` + +##### `remote_port_indicator` + +Data type: `Any` + +Name of the Apache environment variable which can be used to overwrite the forwarded remote (client) IP address. + +Default value: ``undef`` + +##### `remote_user_indicator` + +Data type: `Any` + +Name of the Apache environment variable which can be used to overwrite the forwarded user name. + +Default value: ``undef`` + +##### `auth_type_indicator` + +Data type: `Any` + +Name of the Apache environment variable which can be used to overwrite the forwarded authentication type. + +Default value: ``undef`` + +##### `options` + +Data type: `Any` + +Set one of more options to configure the mod_jk module. + +Default value: `[]` + +##### `env_var` + +Data type: `Any` + +Adds a name and an optional default value of environment variable that should be sent to servlet-engine as a request attribute. + +Default value: `{}` + +##### `strip_session` + +Data type: `Any` + +If this directive is set to On in some virtual server, the session IDs ;jsessionid=... will be removed for URLs which are not +forwarded but instead are handled by the local server. + +Default value: ``undef`` + +##### `workers_file_content` + +Data type: `Any` + +Each directive has the format worker..=. This maps as a hash of hashes, where the outer hash specifies +workers, and each inner hash specifies each worker properties and values. Plus, there are two global directives, 'worker.list' and +'worker.maintain' For example, the workers file below should be parameterized as follows: + +Worker file: +``` +worker.list = status +worker.list = some_name,other_name + +worker.maintain = 60 + +# Optional comment +worker.some_name.type=ajp13 +worker.some_name.socket_keepalive=true + +# I just like comments +worker.other_name.type=ajp12 (why would you?) +worker.other_name.socket_keepalive=false +``` + +Puppet file: +``` +$workers_file_content = { + worker_lists => ['status', 'some_name,other_name'], + worker_maintain => '60', + some_name => { + comment => 'Optional comment', + type => 'ajp13', + socket_keepalive => 'true', + }, + other_name => { + comment => 'I just like comments', + type => 'ajp12', + socket_keepalive => 'false', + }, +} +``` + +Default value: `{}` + +##### `mount_file_content` + +Data type: `Any` + +Each directive has the format = . This maps as a hash of hashes, where the outer hash specifies workers, and +each inner hash contains two items: +- uri_list-an array with URIs to be mapped to the worker +- comment-an optional string with a comment for the worker. For example, the mount file below should be parameterized as Figure 2: + +Worker file: +``` +# Worker 1 +/context_1/ = worker_1 +/context_1/* = worker_1 + +# Worker 2 +/ = worker_2 +/context_2/ = worker_2 +/context_2/* = worker_2 +``` + +Puppet file: +``` +$mount_file_content = { + worker_1 => { + uri_list => ['/context_1/', '/context_1/*'], + comment => 'Worker 1', + }, + worker_2 => { + uri_list => ['/context_2/', '/context_2/*'], + comment => 'Worker 2', + }, +}, +``` + +Default value: `{}` + +##### `location_list` + +Data type: `Any` + + + +Default value: `[]` + +### `apache::mod::ldap` + +Installs and configures `mod_ldap`. + +* **Note** Unsupported platforms: CentOS: 8; RedHat: 8 + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_ldap.html + * for additional documentation. + +#### Examples + +##### + +```puppet +class { 'apache::mod::ldap': + ldap_trusted_global_cert_file => '/etc/pki/tls/certs/ldap-trust.crt', + ldap_trusted_global_cert_type => 'CA_DER', + ldap_trusted_mode => 'TLS', + ldap_shared_cache_size => '500000', + ldap_cache_entries => '1024', + ldap_cache_ttl => '600', + ldap_opcache_entries => '1024', + ldap_opcache_ttl => '600', +} +``` + +#### Parameters + +The following parameters are available in the `apache::mod::ldap` class: + +* [`apache_version`](#apache_version) +* [`package_name`](#package_name) +* [`ldap_trusted_global_cert_file`](#ldap_trusted_global_cert_file) +* [`ldap_trusted_global_cert_type`](#ldap_trusted_global_cert_type) +* [`ldap_shared_cache_size`](#ldap_shared_cache_size) +* [`ldap_cache_entries`](#ldap_cache_entries) +* [`ldap_cache_ttl`](#ldap_cache_ttl) +* [`ldap_opcache_entries`](#ldap_opcache_entries) +* [`ldap_opcache_ttl`](#ldap_opcache_ttl) +* [`ldap_trusted_mode`](#ldap_trusted_mode) +* [`ldap_path`](#ldap_path) + +##### `apache_version` + +Data type: `Any` + +Used to verify that the Apache version you have requested is compatible with the module. + +Default value: ``undef`` + +##### `package_name` + +Data type: `Any` + +Specifies the custom package name. + +Default value: ``undef`` + +##### `ldap_trusted_global_cert_file` + +Data type: `Any` + +Sets the file or database containing global trusted Certificate Authority or global client certificates. + +Default value: ``undef`` + +##### `ldap_trusted_global_cert_type` + +Data type: `Optional[String]` + +Sets the certificate parameter of the global trusted Certificate Authority or global client certificates. + +Default value: `'CA_BASE64'` + +##### `ldap_shared_cache_size` + +Data type: `Any` + +Size in bytes of the shared-memory cache + +Default value: ``undef`` + +##### `ldap_cache_entries` + +Data type: `Any` + +Maximum number of entries in the primary LDAP cache + +Default value: ``undef`` + +##### `ldap_cache_ttl` + +Data type: `Any` + +Time that cached items remain valid (in seconds). + +Default value: ``undef`` + +##### `ldap_opcache_entries` + +Data type: `Any` + +Number of entries used to cache LDAP compare operations + +Default value: ``undef`` + +##### `ldap_opcache_ttl` + +Data type: `Any` + +Time that entries in the operation cache remain valid (in seconds). + +Default value: ``undef`` + +##### `ldap_trusted_mode` + +Data type: `Any` + +Specifies the SSL/TLS mode to be used when connecting to an LDAP server. + +Default value: ``undef`` + +##### `ldap_path` + +Data type: `String` + +The server location of the ldap status page. + +Default value: `'/ldap-status'` + +### `apache::mod::lookup_identity` + +Installs `mod_lookup_identity` + +* **See also** + * https://www.adelton.com/apache/mod_lookup_identity + * for additional documentation. + +### `apache::mod::macro` + +Installs `mod_macro`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_macro.html + * for additional documentation. + +### `apache::mod::md` + +Installs and configures `mod_md`. + +* **Note** Unsupported platforms: CentOS: 6, 7; Debian: 8, 9; OracleLinux: all; RedHat: 6, 7; Scientific: all; SLES: all; Ubuntu: 14, 16, 18 + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_md.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::md` class: + +* [`md_activation_delay`](#md_activation_delay) +* [`md_base_server`](#md_base_server) +* [`md_ca_challenges`](#md_ca_challenges) +* [`md_certificate_agreement`](#md_certificate_agreement) +* [`md_certificate_authority`](#md_certificate_authority) +* [`md_certificate_check`](#md_certificate_check) +* [`md_certificate_monitor`](#md_certificate_monitor) +* [`md_certificate_protocol`](#md_certificate_protocol) +* [`md_certificate_status`](#md_certificate_status) +* [`md_challenge_dns01`](#md_challenge_dns01) +* [`md_contact_email`](#md_contact_email) +* [`md_http_proxy`](#md_http_proxy) +* [`md_members`](#md_members) +* [`md_message_cmd`](#md_message_cmd) +* [`md_must_staple`](#md_must_staple) +* [`md_notify_cmd`](#md_notify_cmd) +* [`md_port_map`](#md_port_map) +* [`md_private_keys`](#md_private_keys) +* [`md_renew_mode`](#md_renew_mode) +* [`md_renew_window`](#md_renew_window) +* [`md_require_https`](#md_require_https) +* [`md_server_status`](#md_server_status) +* [`md_staple_others`](#md_staple_others) +* [`md_stapling`](#md_stapling) +* [`md_stapling_keep_response`](#md_stapling_keep_response) +* [`md_stapling_renew_window`](#md_stapling_renew_window) +* [`md_store_dir`](#md_store_dir) +* [`md_warn_window`](#md_warn_window) + +##### `md_activation_delay` + +Data type: `Optional[String]` + +- + +Default value: ``undef`` + +##### `md_base_server` + +Data type: `Optional[Enum['on', 'off']]` + +Control if base server may be managed or only virtual hosts. + +Default value: ``undef`` + +##### `md_ca_challenges` + +Data type: `Optional[Array[Enum['dns-01', 'http-01', 'tls-alpn-01']]]` + +Type of ACME challenge used to prove domain ownership. + +Default value: ``undef`` + +##### `md_certificate_agreement` + +Data type: `Optional[Enum['accepted']]` + +You confirm that you accepted the Terms of Service of the Certificate +Authority. + +Default value: ``undef`` + +##### `md_certificate_authority` + +Data type: `Optional[Stdlib::HTTPUrl]` + +The URL of the ACME Certificate Authority service. + +Default value: ``undef`` + +##### `md_certificate_check` + +Data type: `Optional[String]` + +- + +Default value: ``undef`` + +##### `md_certificate_monitor` + +Data type: `Optional[String]` + +The URL of a certificate log monitor. + +Default value: ``undef`` + +##### `md_certificate_protocol` + +Data type: `Optional[Enum['ACME']]` + +The protocol to use with the Certificate Authority. + +Default value: ``undef`` + +##### `md_certificate_status` + +Data type: `Optional[Enum['on', 'off']]` + +Exposes public certificate information in JSON. + +Default value: ``undef`` + +##### `md_challenge_dns01` + +Data type: `Optional[Stdlib::Absolutepath]` + +Define a program to be called when the `dns-01` challenge needs to be +setup/torn down. + +Default value: ``undef`` + +##### `md_contact_email` + +Data type: `Optional[String]` + +The ACME protocol requires you to give a contact url when you sign up. + +Default value: ``undef`` + +##### `md_http_proxy` + +Data type: `Optional[Stdlib::HTTPUrl]` + +Define a proxy for outgoing connections. + +Default value: ``undef`` + +##### `md_members` + +Data type: `Optional[Enum['auto', 'manual']]` + +Control if the alias domain names are automatically added. + +Default value: ``undef`` + +##### `md_message_cmd` + +Data type: `Optional[Stdlib::Absolutepath]` + +Handle events for Manage Domains. + +Default value: ``undef`` + +##### `md_must_staple` + +Data type: `Optional[Enum['on', 'off']]` + +Control if new certificates carry the OCSP Must Staple flag. + +Default value: ``undef`` + +##### `md_notify_cmd` + +Data type: `Optional[Stdlib::Absolutepath]` + +Run a program when a Managed Domain is ready. + +Default value: ``undef`` + +##### `md_port_map` + +Data type: `Optional[String]` + +Map external to internal ports for domain ownership verification. + +Default value: ``undef`` + +##### `md_private_keys` + +Data type: `Optional[String]` + +Set type and size of the private keys generated. + +Default value: ``undef`` + +##### `md_renew_mode` + +Data type: `Optional[Enum['always', 'auto', 'manual']]` + +Controls if certificates shall be renewed. + +Default value: ``undef`` + +##### `md_renew_window` + +Data type: `Optional[String]` + +Control when a certificate will be renewed. + +Default value: ``undef`` + +##### `md_require_https` + +Data type: `Optional[Enum['off', 'permanent', 'temporary']]` + +Redirects http: traffic to https: for Managed Domains. +An http: Virtual Host must nevertheless be setup for that domain. + +Default value: ``undef`` + +##### `md_server_status` + +Data type: `Optional[Enum['on', 'off']]` + +Control if Managed Domain information is added to server-status. + +Default value: ``undef`` + +##### `md_staple_others` + +Data type: `Optional[Enum['on', 'off']]` + +Enable stapling for certificates not managed by mod_md. + +Default value: ``undef`` + +##### `md_stapling` + +Data type: `Optional[Enum['on', 'off']]` + +Enable stapling for all or a particular MDomain. + +Default value: ``undef`` + +##### `md_stapling_keep_response` + +Data type: `Optional[String]` + +Controls when old responses should be removed. + +Default value: ``undef`` + +##### `md_stapling_renew_window` + +Data type: `Optional[String]` + +Control when the stapling responses will be renewed. + +Default value: ``undef`` + +##### `md_store_dir` + +Data type: `Optional[Stdlib::Absolutepath]` + +Path on the local file system to store the Managed Domains data. + +Default value: ``undef`` + +##### `md_warn_window` + +Data type: `Optional[String]` + +Define the time window when you want to be warned about an expiring +certificate. + +Default value: ``undef`` + +### `apache::mod::mime` + +Installs and configures `mod_mime`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_mime.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::mime` class: + +* [`mime_support_package`](#mime_support_package) +* [`mime_types_config`](#mime_types_config) +* [`mime_types_additional`](#mime_types_additional) + +##### `mime_support_package` + +Data type: `Any` + +Name of the MIME package to be installed. + +Default value: `$apache::params::mime_support_package` + +##### `mime_types_config` + +Data type: `Any` + +The location of the mime.types file. + +Default value: `$apache::params::mime_types_config` + +##### `mime_types_additional` + +Data type: `Any` + +List of additional MIME types to include. + +Default value: ``undef`` + +### `apache::mod::mime_magic` + +Installs and configures `mod_mime_magic`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_mime_magic.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::mime_magic` class: + +* [`magic_file`](#magic_file) + +##### `magic_file` + +Data type: `Any` + +Enable MIME-type determination based on file contents using the specified magic file. + +Default value: ``undef`` + +### `apache::mod::negotiation` + +Installs and configures `mod_negotiation`. + +* **See also** + * [https://httpd.apache.org/docs/current/mod/mod_negotiation.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::negotiation` class: + +* [`force_language_priority`](#force_language_priority) +* [`language_priority`](#language_priority) + +##### `force_language_priority` + +Data type: `Variant[Array[String], String]` + +Action to take if a single acceptable document is not found. + +Default value: `'Prefer Fallback'` + +##### `language_priority` + +Data type: `Variant[Array[String], String]` + +The precedence of language variants for cases where the client does not express a preference. + +Default value: `['en', 'ca', 'cs', 'da', 'de', 'el', 'eo', 'es', 'et', + 'fr', 'he', 'hr', 'it', 'ja', 'ko', 'ltz', 'nl', 'nn', + 'no', 'pl', 'pt', 'pt-BR', 'ru', 'sv', 'zh-CN', + 'zh-TW']` + +### `apache::mod::nss` + +Installs and configures `mod_nss`. + +* **See also** + * https://pagure.io/mod_nss + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::nss` class: + +* [`transfer_log`](#transfer_log) +* [`error_Log`](#error_Log) +* [`passwd_file`](#passwd_file) +* [`port`](#port) +* [`error_log`](#error_log) + +##### `transfer_log` + +Data type: `Any` + +Path to `access.log`. + +Default value: `"${apache::params::logroot}/access.log"` + +##### `error_Log` + +Path to `error.log` + +##### `passwd_file` + +Data type: `Any` + +Path to file containing token passwords used for NSSPassPhraseDialog. + +Default value: ``undef`` + +##### `port` + +Data type: `Any` + +Sets the SSL port that should be used by mod_nss. + +Default value: `8443` + +##### `error_log` + +Data type: `Any` + + + +Default value: `"${apache::params::logroot}/error.log"` + +### `apache::mod::pagespeed` + +Although this apache module requires the mod-pagespeed-stable package, Puppet does not manage the software repositories required to +automatically install the package. If you declare this class when the package is either not installed or not available to your +package manager, your Puppet run will fail. + +* **TODO** Add docs + +* **Note** Verify that your system is compatible with the latest Google Pagespeed requirements. + +* **See also** + * https://developers.google.com/speed/pagespeed/module/ + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::pagespeed` class: + +* [`inherit_vhost_config`](#inherit_vhost_config) +* [`filter_xhtml`](#filter_xhtml) +* [`cache_path`](#cache_path) +* [`log_dir`](#log_dir) +* [`memcache_servers`](#memcache_servers) +* [`rewrite_level`](#rewrite_level) +* [`disable_filters`](#disable_filters) +* [`enable_filters`](#enable_filters) +* [`forbid_filters`](#forbid_filters) +* [`rewrite_deadline_per_flush_ms`](#rewrite_deadline_per_flush_ms) +* [`additional_domains`](#additional_domains) +* [`file_cache_size_kb`](#file_cache_size_kb) +* [`file_cache_clean_interval_ms`](#file_cache_clean_interval_ms) +* [`lru_cache_per_process`](#lru_cache_per_process) +* [`lru_cache_byte_limit`](#lru_cache_byte_limit) +* [`css_flatten_max_bytes`](#css_flatten_max_bytes) +* [`css_inline_max_bytes`](#css_inline_max_bytes) +* [`css_image_inline_max_bytes`](#css_image_inline_max_bytes) +* [`image_inline_max_bytes`](#image_inline_max_bytes) +* [`js_inline_max_bytes`](#js_inline_max_bytes) +* [`css_outline_min_bytes`](#css_outline_min_bytes) +* [`js_outline_min_bytes`](#js_outline_min_bytes) +* [`inode_limit`](#inode_limit) +* [`image_max_rewrites_at_once`](#image_max_rewrites_at_once) +* [`num_rewrite_threads`](#num_rewrite_threads) +* [`num_expensive_rewrite_threads`](#num_expensive_rewrite_threads) +* [`collect_statistics`](#collect_statistics) +* [`statistics_logging`](#statistics_logging) +* [`allow_view_stats`](#allow_view_stats) +* [`allow_pagespeed_console`](#allow_pagespeed_console) +* [`allow_pagespeed_message`](#allow_pagespeed_message) +* [`message_buffer_size`](#message_buffer_size) +* [`additional_configuration`](#additional_configuration) +* [`apache_version`](#apache_version) +* [`package_ensure`](#package_ensure) + +##### `inherit_vhost_config` + +Data type: `Any` + + + +Default value: `'on'` + +##### `filter_xhtml` + +Data type: `Any` + + + +Default value: ``false`` + +##### `cache_path` + +Data type: `Any` + + + +Default value: `'/var/cache/mod_pagespeed/'` + +##### `log_dir` + +Data type: `Any` + + + +Default value: `'/var/log/pagespeed'` + +##### `memcache_servers` + +Data type: `Any` + + + +Default value: `[]` + +##### `rewrite_level` + +Data type: `Any` + + + +Default value: `'CoreFilters'` + +##### `disable_filters` + +Data type: `Any` + + + +Default value: `[]` + +##### `enable_filters` + +Data type: `Any` + + + +Default value: `[]` + +##### `forbid_filters` + +Data type: `Any` + + + +Default value: `[]` + +##### `rewrite_deadline_per_flush_ms` + +Data type: `Any` + + + +Default value: `10` + +##### `additional_domains` + +Data type: `Any` + + + +Default value: ``undef`` + +##### `file_cache_size_kb` + +Data type: `Any` + + + +Default value: `102400` + +##### `file_cache_clean_interval_ms` + +Data type: `Any` + + + +Default value: `3600000` + +##### `lru_cache_per_process` + +Data type: `Any` + + + +Default value: `1024` + +##### `lru_cache_byte_limit` + +Data type: `Any` + + + +Default value: `16384` + +##### `css_flatten_max_bytes` + +Data type: `Any` + + + +Default value: `2048` + +##### `css_inline_max_bytes` + +Data type: `Any` + + + +Default value: `2048` + +##### `css_image_inline_max_bytes` + +Data type: `Any` + + + +Default value: `2048` + +##### `image_inline_max_bytes` + +Data type: `Any` + + + +Default value: `2048` + +##### `js_inline_max_bytes` + +Data type: `Any` + + + +Default value: `2048` + +##### `css_outline_min_bytes` + +Data type: `Any` + + + +Default value: `3000` + +##### `js_outline_min_bytes` + +Data type: `Any` + + + +Default value: `3000` + +##### `inode_limit` + +Data type: `Any` + + + +Default value: `500000` + +##### `image_max_rewrites_at_once` + +Data type: `Any` + + + +Default value: `8` + +##### `num_rewrite_threads` + +Data type: `Any` + + + +Default value: `4` + +##### `num_expensive_rewrite_threads` + +Data type: `Any` + + + +Default value: `4` + +##### `collect_statistics` + +Data type: `Any` + + + +Default value: `'on'` + +##### `statistics_logging` + +Data type: `Any` + + + +Default value: `'on'` + +##### `allow_view_stats` + +Data type: `Any` + + + +Default value: `[]` + +##### `allow_pagespeed_console` + +Data type: `Any` + + + +Default value: `[]` + +##### `allow_pagespeed_message` + +Data type: `Any` + + + +Default value: `[]` + +##### `message_buffer_size` + +Data type: `Any` + + + +Default value: `100000` + +##### `additional_configuration` + +Data type: `Any` + + + +Default value: `{}` + +##### `apache_version` + +Data type: `Any` + + + +Default value: ``undef`` + +##### `package_ensure` + +Data type: `Any` + + + +Default value: ``undef`` + +### `apache::mod::passenger` + +The current set of server configurations settings were taken directly from the Passenger Reference. To enable deprecation warnings +and removal failure messages, set the passenger_installed_version to the version number installed on the server. + +Change Log: + - As of 08/13/2017 there are 84 available/deprecated/removed settings. + - Around 08/20/2017 UnionStation was discontinued options were removed. + - As of 08/20/2017 there are 77 available/deprecated/removed settings. + +* **Note** In Passenger source code you can strip out what are all the available options by looking in + - src/apache2_module/Configuration.cpp + - src/apache2_module/ConfigurationCommands.cpp +There are also several undocumented settings. + +* **See also** + * https://www.phusionpassenger.com/docs/references/config_reference/apache/ + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::passenger` class: + +* [`manage_repo`](#manage_repo) +* [`mod_id`](#mod_id) +* [`mod_lib`](#mod_lib) +* [`mod_lib_path`](#mod_lib_path) +* [`mod_package`](#mod_package) +* [`mod_package_ensure`](#mod_package_ensure) +* [`mod_path`](#mod_path) +* [`passenger_allow_encoded_slashes`](#passenger_allow_encoded_slashes) +* [`passenger_app_env`](#passenger_app_env) +* [`passenger_app_group_name`](#passenger_app_group_name) +* [`passenger_app_root`](#passenger_app_root) +* [`passenger_app_type`](#passenger_app_type) +* [`passenger_base_uri`](#passenger_base_uri) +* [`passenger_buffer_response`](#passenger_buffer_response) +* [`passenger_buffer_upload`](#passenger_buffer_upload) +* [`passenger_concurrency_model`](#passenger_concurrency_model) +* [`passenger_conf_file`](#passenger_conf_file) +* [`passenger_conf_package_file`](#passenger_conf_package_file) +* [`passenger_data_buffer_dir`](#passenger_data_buffer_dir) +* [`passenger_debug_log_file`](#passenger_debug_log_file) +* [`passenger_debugger`](#passenger_debugger) +* [`passenger_default_group`](#passenger_default_group) +* [`passenger_default_ruby`](#passenger_default_ruby) +* [`passenger_default_user`](#passenger_default_user) +* [`passenger_disable_security_update_check`](#passenger_disable_security_update_check) +* [`passenger_enabled`](#passenger_enabled) +* [`passenger_error_override`](#passenger_error_override) +* [`passenger_file_descriptor_log_file`](#passenger_file_descriptor_log_file) +* [`passenger_fly_with`](#passenger_fly_with) +* [`passenger_force_max_concurrent_requests_per_process`](#passenger_force_max_concurrent_requests_per_process) +* [`passenger_friendly_error_pages`](#passenger_friendly_error_pages) +* [`passenger_group`](#passenger_group) +* [`passenger_high_performance`](#passenger_high_performance) +* [`passenger_installed_version`](#passenger_installed_version) +* [`passenger_instance_registry_dir`](#passenger_instance_registry_dir) +* [`passenger_load_shell_envvars`](#passenger_load_shell_envvars) +* [`passenger_log_file`](#passenger_log_file) +* [`passenger_log_level`](#passenger_log_level) +* [`passenger_lve_min_uid`](#passenger_lve_min_uid) +* [`passenger_max_instances`](#passenger_max_instances) +* [`passenger_max_instances_per_app`](#passenger_max_instances_per_app) +* [`passenger_max_pool_size`](#passenger_max_pool_size) +* [`passenger_max_preloader_idle_time`](#passenger_max_preloader_idle_time) +* [`passenger_max_request_queue_size`](#passenger_max_request_queue_size) +* [`passenger_max_request_time`](#passenger_max_request_time) +* [`passenger_max_requests`](#passenger_max_requests) +* [`passenger_memory_limit`](#passenger_memory_limit) +* [`passenger_meteor_app_settings`](#passenger_meteor_app_settings) +* [`passenger_min_instances`](#passenger_min_instances) +* [`passenger_nodejs`](#passenger_nodejs) +* [`passenger_pool_idle_time`](#passenger_pool_idle_time) +* [`passenger_pre_start`](#passenger_pre_start) +* [`passenger_python`](#passenger_python) +* [`passenger_resist_deployment_errors`](#passenger_resist_deployment_errors) +* [`passenger_resolve_symlinks_in_document_root`](#passenger_resolve_symlinks_in_document_root) +* [`passenger_response_buffer_high_watermark`](#passenger_response_buffer_high_watermark) +* [`passenger_restart_dir`](#passenger_restart_dir) +* [`passenger_rolling_restarts`](#passenger_rolling_restarts) +* [`passenger_root`](#passenger_root) +* [`passenger_ruby`](#passenger_ruby) +* [`passenger_security_update_check_proxy`](#passenger_security_update_check_proxy) +* [`passenger_show_version_in_header`](#passenger_show_version_in_header) +* [`passenger_socket_backlog`](#passenger_socket_backlog) +* [`passenger_spawn_method`](#passenger_spawn_method) +* [`passenger_start_timeout`](#passenger_start_timeout) +* [`passenger_startup_file`](#passenger_startup_file) +* [`passenger_stat_throttle_rate`](#passenger_stat_throttle_rate) +* [`passenger_sticky_sessions`](#passenger_sticky_sessions) +* [`passenger_sticky_sessions_cookie_name`](#passenger_sticky_sessions_cookie_name) +* [`passenger_thread_count`](#passenger_thread_count) +* [`passenger_use_global_queue`](#passenger_use_global_queue) +* [`passenger_user`](#passenger_user) +* [`passenger_user_switching`](#passenger_user_switching) +* [`rack_auto_detect`](#rack_auto_detect) +* [`rack_autodetect`](#rack_autodetect) +* [`rack_base_uri`](#rack_base_uri) +* [`rack_env`](#rack_env) +* [`rails_allow_mod_rewrite`](#rails_allow_mod_rewrite) +* [`rails_app_spawner_idle_time`](#rails_app_spawner_idle_time) +* [`rails_auto_detect`](#rails_auto_detect) +* [`rails_autodetect`](#rails_autodetect) +* [`rails_base_uri`](#rails_base_uri) +* [`rails_default_user`](#rails_default_user) +* [`rails_env`](#rails_env) +* [`rails_framework_spawner_idle_time`](#rails_framework_spawner_idle_time) +* [`rails_ruby`](#rails_ruby) +* [`rails_spawn_method`](#rails_spawn_method) +* [`rails_user_switching`](#rails_user_switching) +* [`wsgi_auto_detect`](#wsgi_auto_detect) +* [`passenger_anonymous_telemetry_proxy`](#passenger_anonymous_telemetry_proxy) +* [`passenger_disable_anonymous_telemetry`](#passenger_disable_anonymous_telemetry) +* [`passenger_disable_log_prefix`](#passenger_disable_log_prefix) +* [`passenger_spawn_dir`](#passenger_spawn_dir) +* [`passenger_sticky_sessions_cookie_attributes`](#passenger_sticky_sessions_cookie_attributes) + +##### `manage_repo` + +Data type: `Any` + +Toggle whether to manage yum repo if on a RedHat node. + +Default value: ``true`` + +##### `mod_id` + +Data type: `Any` + +Specifies the package id. + +Default value: ``undef`` + +##### `mod_lib` + +Data type: `Any` + +Defines the module's shared object name. Do not configure manually without special reason. + +Default value: ``undef`` + +##### `mod_lib_path` + +Data type: `Any` + +Specifies a path to the module's libraries. Do not manually set this parameter without special reason. The `path` parameter overrides +this value. + +Default value: ``undef`` + +##### `mod_package` + +Data type: `Any` + +Name of the module package to install. + +Default value: ``undef`` + +##### `mod_package_ensure` + +Data type: `Any` + +Determines whether Puppet ensures the module should be installed. + +Default value: ``undef`` + +##### `mod_path` + +Data type: `Any` + +Specifies a path to the module. Do not manually set this parameter without a special reason. + +Default value: ``undef`` + +##### `passenger_allow_encoded_slashes` + +Data type: `Any` + +Toggle whether URLs with encoded slashes (%2f) can be used (by default Apache does not support this). + +Default value: ``undef`` + +##### `passenger_app_env` + +Data type: `Any` + +This option sets, for the current application, the value of the following environment variables: +- RAILS_ENV +- RACK_ENV +- WSGI_ENV +- NODE_ENV +- PASSENGER_APP_ENV + +Default value: ``undef`` + +##### `passenger_app_group_name` + +Data type: `Any` + +Sets the name of the application group that the current application should belong to. + +Default value: ``undef`` + +##### `passenger_app_root` + +Data type: `Any` + +Path to the application root which allows access independent from the DocumentRoot. + +Default value: ``undef`` + +##### `passenger_app_type` + +Data type: `Any` + +Specifies the type of the application. If you set this option, then you must also set PassengerAppRoot, otherwise Passenger will +not properly recognize your application. + +Default value: ``undef`` + +##### `passenger_base_uri` + +Data type: `Any` + +Used to specify that the given URI is an distinct application that should be served by Passenger. + +Default value: ``undef`` + +##### `passenger_buffer_response` + +Data type: `Any` + +Toggle whether application-generated responses are buffered by Apache. Buffering will happen in memory. + +Default value: ``undef`` + +##### `passenger_buffer_upload` + +Data type: `Any` + +Toggle whether HTTP client request bodies are buffered before they are sent to the application. + +Default value: ``undef`` + +##### `passenger_concurrency_model` + +Data type: `Any` + +Specifies the I/O concurrency model that should be used for Ruby application processes. + +Default value: ``undef`` + +##### `passenger_conf_file` + +Data type: `Any` + + + +Default value: `$apache::params::passenger_conf_file` + +##### `passenger_conf_package_file` + +Data type: `Any` + + + +Default value: `$apache::params::passenger_conf_package_file` + +##### `passenger_data_buffer_dir` + +Data type: `Any` + +Specifies the directory in which to store data buffers. + +Default value: ``undef`` + +##### `passenger_debug_log_file` + +Data type: `Any` + + + +Default value: ``undef`` + +##### `passenger_debugger` + +Data type: `Any` + +Turns support for Ruby application debugging on or off. + +Default value: ``undef`` + +##### `passenger_default_group` + +Data type: `Any` + +Allows you to specify the group that applications must run as, if user switching fails or is disabled. + +Default value: ``undef`` + +##### `passenger_default_ruby` + +Data type: `Any` + +File path to desired ruby interpreter to use by default. + +Default value: `$apache::params::passenger_default_ruby` + +##### `passenger_default_user` + +Data type: `Any` + +Allows you to specify the user that applications must run as, if user switching fails or is disabled. + +Default value: ``undef`` + +##### `passenger_disable_security_update_check` + +Data type: `Any` + +Allows disabling the Passenger security update check, a daily check with https://securitycheck.phusionpassenger.com for important +security updates that might be available. + +Default value: ``undef`` + +##### `passenger_enabled` + +Data type: `Any` + +Toggles whether Passenger should be enabled for that particular context. + +Default value: ``undef`` + +##### `passenger_error_override` + +Data type: `Any` + +Toggles whether Apache will intercept and handle responses with HTTP status codes of 400 and higher. + +Default value: ``undef`` + +##### `passenger_file_descriptor_log_file` + +Data type: `Any` + +Log file descriptor debug tracing messages to the given file. + +Default value: ``undef`` + +##### `passenger_fly_with` + +Data type: `Any` + +Enables the Flying Passenger mode, and configures Apache to connect to the Flying Passenger daemon that's listening on the +given socket filename. + +Default value: ``undef`` + +##### `passenger_force_max_concurrent_requests_per_process` + +Data type: `Any` + +Use this option to tell Passenger how many concurrent requests the application can handle per process. + +Default value: ``undef`` + +##### `passenger_friendly_error_pages` + +Data type: `Any` + +Toggles whether Passenger should display friendly error pages whenever an application fails to start. + +Default value: ``undef`` + +##### `passenger_group` + +Data type: `Any` + +Allows you to override that behavior and explicitly set a group to run the web application as, regardless of the ownership of the +startup file. + +Default value: ``undef`` + +##### `passenger_high_performance` + +Data type: `Any` + +Toggles whether to enable PassengerHighPerformance which will make Passenger will be a little faster, in return for reduced +compatibility with other Apache modules. + +Default value: ``undef`` + +##### `passenger_installed_version` + +Data type: `Any` + + + +Default value: ``undef`` + +##### `passenger_instance_registry_dir` + +Data type: `Any` + +Specifies the directory that Passenger should use for registering its current instance. + +Default value: ``undef`` + +##### `passenger_load_shell_envvars` + +Data type: `Any` + +Enables or disables the loading of shell environment variables before spawning the application. + +Default value: ``undef`` + +##### `passenger_log_file` + +Data type: `Optional[Stdlib::Absolutepath]` + +File path to log file. By default Passenger log messages are written to the Apache global error log. + +Default value: ``undef`` + +##### `passenger_log_level` + +Data type: `Any` + +Specifies how much information Passenger should log to its log file. A higher log level value means that more +information will be logged. + +Default value: ``undef`` + +##### `passenger_lve_min_uid` + +Data type: `Any` + +When using Passenger on a LVE-enabled kernel, a security check (enter) is run for spawning application processes. This options +tells the check to only allow processes with UIDs equal to, or higher than, the specified value. + +Default value: ``undef`` + +##### `passenger_max_instances` + +Data type: `Any` + +The maximum number of application processes that may simultaneously exist for an application. + +Default value: ``undef`` + +##### `passenger_max_instances_per_app` + +Data type: `Any` + +The maximum number of application processes that may simultaneously exist for a single application. + +Default value: ``undef`` + +##### `passenger_max_pool_size` + +Data type: `Any` + +The maximum number of application processes that may simultaneously exist. + +Default value: ``undef`` + +##### `passenger_max_preloader_idle_time` + +Data type: `Any` + +Set the preloader's idle timeout, in seconds. A value of 0 means that it should never idle timeout. + +Default value: ``undef`` + +##### `passenger_max_request_queue_size` + +Data type: `Any` + +Specifies the maximum size for the queue of all incoming requests. + +Default value: ``undef`` + +##### `passenger_max_request_time` + +Data type: `Any` + +The maximum amount of time, in seconds, that an application process may take to process a request. + +Default value: ``undef`` + +##### `passenger_max_requests` + +Data type: `Any` + +The maximum number of requests an application process will process. + +Default value: ``undef`` + +##### `passenger_memory_limit` + +Data type: `Any` + +The maximum amount of memory that an application process may use, in megabytes. + +Default value: ``undef`` + +##### `passenger_meteor_app_settings` + +Data type: `Any` + +When using a Meteor application in non-bundled mode, use this option to specify a JSON file with settings for the application. + +Default value: ``undef`` + +##### `passenger_min_instances` + +Data type: `Any` + +Specifies the minimum number of application processes that should exist for a given application. + +Default value: ``undef`` + +##### `passenger_nodejs` + +Data type: `Any` + +Specifies the Node.js command to use for serving Node.js web applications. + +Default value: ``undef`` + +##### `passenger_pool_idle_time` + +Data type: `Any` + +The maximum number of seconds that an application process may be idle. + +Default value: ``undef`` + +##### `passenger_pre_start` + +Data type: `Optional[Variant[String,Array[String]]]` + +URL of the web application you want to pre-start. + +Default value: ``undef`` + +##### `passenger_python` + +Data type: `Any` + +Specifies the Python interpreter to use for serving Python web applications. + +Default value: ``undef`` + +##### `passenger_resist_deployment_errors` + +Data type: `Any` + +Enables or disables resistance against deployment errors. + +Default value: ``undef`` + +##### `passenger_resolve_symlinks_in_document_root` + +Data type: `Any` + +This option is no longer available in version 5.2.0. Switch to PassengerAppRoot if you are setting the application root via a +document root containing symlinks. + +Default value: ``undef`` + +##### `passenger_response_buffer_high_watermark` + +Data type: `Any` + +Configures the maximum size of the real-time disk-backed response buffering system. + +Default value: ``undef`` + +##### `passenger_restart_dir` + +Data type: `Any` + +Path to directory containing restart.txt file. Can be either absolute or relative. + +Default value: ``undef`` + +##### `passenger_rolling_restarts` + +Data type: `Any` + +Enables or disables support for zero-downtime application restarts through restart.txt. + +Default value: ``undef`` + +##### `passenger_root` + +Data type: `Any` + +Refers to the location to the Passenger root directory, or to a location configuration file. + +Default value: `$apache::params::passenger_root` + +##### `passenger_ruby` + +Data type: `Any` + +Specifies the Ruby interpreter to use for serving Ruby web applications. + +Default value: `$apache::params::passenger_ruby` + +##### `passenger_security_update_check_proxy` + +Data type: `Any` + +Allows use of an intermediate proxy for the Passenger security update check. + +Default value: ``undef`` + +##### `passenger_show_version_in_header` + +Data type: `Any` + +Toggle whether Passenger will output its version number in the X-Powered-By header in all Passenger-served requests: + +Default value: ``undef`` + +##### `passenger_socket_backlog` + +Data type: `Any` + +This option can be raised if Apache manages to overflow the backlog queue. + +Default value: ``undef`` + +##### `passenger_spawn_method` + +Data type: `Optional[Enum['smart', 'direct', 'smart-lv2', 'conservative']]` + +Controls whether Passenger spawns applications directly, or using a prefork copy-on-write mechanism. + +Default value: ``undef`` + +##### `passenger_start_timeout` + +Data type: `Any` + +Specifies a timeout for the startup of application processes. + +Default value: ``undef`` + +##### `passenger_startup_file` + +Data type: `Any` + +Specifies the startup file that Passenger should use when loading the application. + +Default value: ``undef`` + +##### `passenger_stat_throttle_rate` + +Data type: `Any` + +Setting this option to a value of x means that certain filesystem checks will be performed at most once every x seconds. + +Default value: ``undef`` + +##### `passenger_sticky_sessions` + +Data type: `Any` + +Toggles whether all requests that a client sends will be routed to the same originating application process, whenever possible. + +Default value: ``undef`` + +##### `passenger_sticky_sessions_cookie_name` + +Data type: `Any` + +Sets the name of the sticky sessions cookie. + +Default value: ``undef`` + +##### `passenger_thread_count` + +Data type: `Any` + +Specifies the number of threads that Passenger should spawn per Ruby application process. + +Default value: ``undef`` + +##### `passenger_use_global_queue` + +Data type: `Any` + +N/A. + +Default value: ``undef`` + +##### `passenger_user` + +Data type: `Any` + +Allows you to override that behavior and explicitly set a user to run the web application as, regardless of the ownership of the +startup file. + +Default value: ``undef`` + +##### `passenger_user_switching` + +Data type: `Any` + +Toggles whether to attempt to enable user account sandboxing, also known as user switching. + +Default value: ``undef`` + +##### `rack_auto_detect` + +Data type: `Any` + +This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. + +Default value: ``undef`` + +##### `rack_autodetect` + +Data type: `Any` + +This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. + +Default value: ``undef`` + +##### `rack_base_uri` + +Data type: `Any` + +Deprecated in 3.0.0 in favor of PassengerBaseURI. + +Default value: ``undef`` + +##### `rack_env` + +Data type: `Any` + +Alias for PassengerAppEnv. + +Default value: ``undef`` + +##### `rails_allow_mod_rewrite` + +Data type: `Any` + +This option doesn't do anything anymore since version 4.0.0. + +Default value: ``undef`` + +##### `rails_app_spawner_idle_time` + +Data type: `Any` + +This option has been removed in version 4.0.0, and replaced with PassengerMaxPreloaderIdleTime. + +Default value: ``undef`` + +##### `rails_auto_detect` + +Data type: `Any` + +This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. + +Default value: ``undef`` + +##### `rails_autodetect` + +Data type: `Any` + +This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. + +Default value: ``undef`` + +##### `rails_base_uri` + +Data type: `Any` + +Deprecated in 3.0.0 in favor of PassengerBaseURI. + +Default value: ``undef`` + +##### `rails_default_user` + +Data type: `Any` + +Deprecated in 3.0.0 in favor of PassengerDefaultUser + +Default value: ``undef`` + +##### `rails_env` + +Data type: `Any` + +Alias for PassengerAppEnv. + +Default value: ``undef`` + +##### `rails_framework_spawner_idle_time` + +Data type: `Any` + +This option is no longer available in version 4.0.0. There is no alternative because framework spawning has been removed +altogether. You should use smart spawning instead. + +Default value: ``undef`` + +##### `rails_ruby` + +Data type: `Any` + +Deprecated in 3.0.0 in favor of PassengerRuby. + +Default value: ``undef`` + +##### `rails_spawn_method` + +Data type: `Any` + +Deprecated in 3.0.0 in favor of PassengerSpawnMethod. + +Default value: ``undef`` + +##### `rails_user_switching` + +Data type: `Any` + +Deprecated in 3.0.0 in favor of PassengerUserSwitching. + +Default value: ``undef`` + +##### `wsgi_auto_detect` + +Data type: `Any` + +This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. + +Default value: ``undef`` + +##### `passenger_anonymous_telemetry_proxy` + +Data type: `Optional[String]` + + + +Default value: ``undef`` + +##### `passenger_disable_anonymous_telemetry` + +Data type: `Optional[Boolean]` + + + +Default value: ``undef`` + +##### `passenger_disable_log_prefix` + +Data type: `Optional[Boolean]` + + + +Default value: ``undef`` + +##### `passenger_spawn_dir` + +Data type: `Optional[String]` + + + +Default value: ``undef`` + +##### `passenger_sticky_sessions_cookie_attributes` + +Data type: `Optional[String]` + + + +Default value: ``undef`` + +### `apache::mod::perl` + +Installs `mod_perl`. + +* **See also** + * https://perl.apache.org + * for additional documentation. + +### `apache::mod::peruser` + +Installs `mod_peruser`. + +* **TODO** Add docs + +#### Parameters + +The following parameters are available in the `apache::mod::peruser` class: + +* [`minspareprocessors`](#minspareprocessors) +* [`minprocessors`](#minprocessors) +* [`maxprocessors`](#maxprocessors) +* [`maxclients`](#maxclients) +* [`maxrequestsperchild`](#maxrequestsperchild) +* [`idletimeout`](#idletimeout) +* [`expiretimeout`](#expiretimeout) +* [`keepalive`](#keepalive) + +##### `minspareprocessors` + +Data type: `Any` + + + +Default value: `'2'` + +##### `minprocessors` + +Data type: `Any` + + + +Default value: `'2'` + +##### `maxprocessors` + +Data type: `Any` + + + +Default value: `'10'` + +##### `maxclients` + +Data type: `Any` + + + +Default value: `'150'` + +##### `maxrequestsperchild` + +Data type: `Any` + + + +Default value: `'1000'` + +##### `idletimeout` + +Data type: `Any` + + + +Default value: `'120'` + +##### `expiretimeout` + +Data type: `Any` + + + +Default value: `'120'` + +##### `keepalive` + +Data type: `Any` + + + +Default value: `'Off'` + +### `apache::mod::php` + +Installs `mod_php`. + +* **TODO** Add docs + +#### Parameters + +The following parameters are available in the `apache::mod::php` class: + +* [`package_name`](#package_name) +* [`package_ensure`](#package_ensure) +* [`path`](#path) +* [`extensions`](#extensions) +* [`content`](#content) +* [`template`](#template) +* [`source`](#source) +* [`root_group`](#root_group) +* [`php_version`](#php_version) +* [`libphp_prefix`](#libphp_prefix) + +##### `package_name` + +Data type: `Any` + + + +Default value: ``undef`` + +##### `package_ensure` + +Data type: `Any` + + + +Default value: `'present'` + +##### `path` + +Data type: `Any` + + + +Default value: ``undef`` + +##### `extensions` + +Data type: `Array` + + + +Default value: `['.php']` + +##### `content` + +Data type: `Any` + + + +Default value: ``undef`` + +##### `template` + +Data type: `Any` + + + +Default value: `'apache/mod/php.conf.erb'` + +##### `source` + +Data type: `Any` + + + +Default value: ``undef`` + +##### `root_group` + +Data type: `Any` + + + +Default value: `$apache::params::root_group` + +##### `php_version` + +Data type: `Any` + + + +Default value: `$apache::params::php_version` + +##### `libphp_prefix` + +Data type: `Any` + + + +Default value: `'libphp'` + +### `apache::mod::prefork` + +Installs and configures MPM `prefork`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/prefork.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::prefork` class: + +* [`startservers`](#startservers) +* [`minspareservers`](#minspareservers) +* [`maxspareservers`](#maxspareservers) +* [`serverlimit`](#serverlimit) +* [`maxclients`](#maxclients) +* [`maxrequestworkers`](#maxrequestworkers) +* [`maxrequestsperchild`](#maxrequestsperchild) +* [`maxconnectionsperchild`](#maxconnectionsperchild) +* [`apache_version`](#apache_version) +* [`listenbacklog`](#listenbacklog) + +##### `startservers` + +Data type: `Any` + +Number of child server processes created at startup. + +Default value: `'8'` + +##### `minspareservers` + +Data type: `Any` + +Minimum number of idle child server processes. + +Default value: `'5'` + +##### `maxspareservers` + +Data type: `Any` + +Maximum number of idle child server processes. + +Default value: `'20'` + +##### `serverlimit` + +Data type: `Any` + +Upper limit on configurable number of processes. + +Default value: `'256'` + +##### `maxclients` + +Data type: `Any` + +Old alias for MaxRequestWorkers. + +Default value: `'256'` + +##### `maxrequestworkers` + +Data type: `Any` + +Maximum number of connections that will be processed simultaneously. + +Default value: ``undef`` + +##### `maxrequestsperchild` + +Data type: `Any` + +Old alias for MaxConnectionsPerChild. + +Default value: `'4000'` + +##### `maxconnectionsperchild` + +Data type: `Any` + +Limit on the number of connections that an individual child server will handle during its life. + +Default value: ``undef`` + +##### `apache_version` + +Data type: `Any` + +Used to verify that the Apache version you have requested is compatible with the module. + +Default value: ``undef`` + +##### `listenbacklog` + +Data type: `Any` + +Maximum length of the queue of pending connections. + +Default value: `'511'` + +### `apache::mod::proxy` + +Installs and configures `mod_proxy`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_proxy.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::proxy` class: + +* [`proxy_requests`](#proxy_requests) +* [`allow_from`](#allow_from) +* [`apache_version`](#apache_version) +* [`package_name`](#package_name) +* [`proxy_via`](#proxy_via) +* [`proxy_timeout`](#proxy_timeout) +* [`proxy_iobuffersize`](#proxy_iobuffersize) + +##### `proxy_requests` + +Data type: `Any` + +Enables forward (standard) proxy requests. + +Default value: `'Off'` + +##### `allow_from` + +Data type: `Any` + +List of IPs allowed to access proxy. + +Default value: ``undef`` + +##### `apache_version` + +Data type: `Any` + +Used to verify that the Apache version you have requested is compatible with the module. + +Default value: ``undef`` + +##### `package_name` + +Data type: `Any` + +Name of the proxy package to install. + +Default value: ``undef`` + +##### `proxy_via` + +Data type: `Any` + +Set local IP address for outgoing proxy connections. + +Default value: `'On'` + +##### `proxy_timeout` + +Data type: `Any` + +Network timeout for proxied requests. + +Default value: ``undef`` + +##### `proxy_iobuffersize` + +Data type: `Any` + +Set the size of internal data throughput buffer + +Default value: ``undef`` + +### `apache::mod::proxy_ajp` + +Installs `mod_proxy_ajp`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_proxy_ajp.html + * for additional documentation. + +### `apache::mod::proxy_balancer` + +Installs and configures `mod_proxy_balancer`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_proxy_balancer.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::proxy_balancer` class: + +* [`manager`](#manager) +* [`maanger_path`](#maanger_path) +* [`allow_from`](#allow_from) +* [`apache_version`](#apache_version) +* [`manager_path`](#manager_path) + +##### `manager` + +Data type: `Boolean` + +Toggle whether to enable balancer manager support. + +Default value: ``false`` + +##### `maanger_path` + +Server relative path to balancer manager. + +##### `allow_from` + +Data type: `Array` + +List of IPs from which the balancer manager can be accessed. + +Default value: `['127.0.0.1','::1']` + +##### `apache_version` + +Data type: `Any` + +Version of Apache to install module on. + +Default value: `$apache::apache_version` + +##### `manager_path` + +Data type: `Stdlib::Absolutepath` + + + +Default value: `'/balancer-manager'` + +### `apache::mod::proxy_connect` + +Installs `mod_proxy_connect`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_proxy_connect.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::proxy_connect` class: + +* [`apache_version`](#apache_version) + +##### `apache_version` + +Data type: `Any` + +Used to verify that the Apache version you have requested is compatible with the module. + +Default value: ``undef`` + +### `apache::mod::proxy_fcgi` + +Installs `mod_proxy_fcgi`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_proxy_fcgi.html + * for additional documentation. + +### `apache::mod::proxy_html` + +Installs `mod_proxy_html`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_proxy_html.html + * for additional documentation. + +### `apache::mod::proxy_http` + +Installs `mod_proxy_http`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_proxy_http.html + * for additional documentation. + +### `apache::mod::proxy_wstunnel` + +Installs `mod_proxy_wstunnel`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_proxy_wstunnel.html + * for additional documentation. + +### `apache::mod::python` + +Installs and configures `mod_python`. + +* **See also** + * https://github.com/grisha/mod_python + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::python` class: + +* [`loadfile_name`](#loadfile_name) + +##### `loadfile_name` + +Data type: `Optional[String]` + +Sets the name of the configuration file that is used to load the python module. + +Default value: ``undef`` + +### `apache::mod::remoteip` + +Installs and configures `mod_remoteip`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_remoteip.html + * https://httpd.apache.org/docs/current/mod/mod_remoteip.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::remoteip` class: + +* [`header`](#header) +* [`internal_proxy`](#internal_proxy) +* [`proxy_ips`](#proxy_ips) +* [`internal_proxy_list`](#internal_proxy_list) +* [`proxies_header`](#proxies_header) +* [`proxy_protocol`](#proxy_protocol) +* [`proxy_protocol_exceptions`](#proxy_protocol_exceptions) +* [`trusted_proxy`](#trusted_proxy) +* [`trusted_proxy_ips`](#trusted_proxy_ips) +* [`trusted_proxy_list`](#trusted_proxy_list) +* [`apache_version`](#apache_version) + +##### `header` + +Data type: `String` + +The header field in which `mod_remoteip` will look for the useragent IP. + +Default value: `'X-Forwarded-For'` + +##### `internal_proxy` + +Data type: `Optional[Array[Variant[Stdlib::Host,Stdlib::IP::Address]]]` + +A list of IP addresses, IP blocks or hostname that are trusted to set a +valid value inside specified header. Unlike the `$trusted_proxy_ips` +parameter, any IP address (including private addresses) presented by these +proxies will trusted by `mod_remoteip`. + +Default value: ``undef`` + +##### `proxy_ips` + +Data type: `Optional[Array[Variant[Stdlib::Host,Stdlib::IP::Address]]]` + +*Deprecated*: use `$internal_proxy` instead. + +Default value: ``undef`` + +##### `internal_proxy_list` + +Data type: `Optional[Stdlib::Absolutepath]` + +The path to a file containing a list of IP addresses, IP blocks or hostname +that are trusted to set a valid value inside the specified header. See +`$internal_proxy` for details. + +Default value: ``undef`` + +##### `proxies_header` + +Data type: `Optional[String]` + +A header into which `mod_remoteip` will collect a list of all of the +intermediate client IP addresses trusted to resolve the useragent IP of the +request (e.g. `X-Forwarded-By`). + +Default value: ``undef`` + +##### `proxy_protocol` + +Data type: `Boolean` + +Wether or not to enable the PROXY protocol header handling. If enabled +upstream clients must set the header every time they open a connection. + +Default value: ``false`` + +##### `proxy_protocol_exceptions` + +Data type: `Optional[Array[Variant[Stdlib::Host,Stdlib::IP::Address]]]` + +A list of IP address or IP blocks that are not required to use the PROXY +protocol. + +Default value: ``undef`` + +##### `trusted_proxy` + +Data type: `Optional[Array[Stdlib::Host]]` + +A list of IP addresses, IP blocks or hostname that are trusted to set a +valid value inside the specified header. Unlike the `$proxy_ips` parameter, +any private IP presented by these proxies will be disgarded by +`mod_remoteip`. + +Default value: ``undef`` + +##### `trusted_proxy_ips` + +Data type: `Optional[Array[Stdlib::Host]]` + +*Deprecated*: use `$trusted_proxy` instead. + +Default value: ``undef`` + +##### `trusted_proxy_list` + +Data type: `Optional[Stdlib::Absolutepath]` + +The path to a file containing a list of IP addresses, IP blocks or hostname +that are trusted to set a valid value inside the specified header. See +`$trusted_proxy` for details. + +Default value: ``undef`` + +##### `apache_version` + +Data type: `Optional[String]` + +A version string used to validate that your apache version supports +`mod_remoteip`. If not specified, `$::apache::apache_version` is used. + +Default value: ``undef`` + +### `apache::mod::reqtimeout` + +Installs and configures `mod_reqtimeout`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_reqtimeout.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::reqtimeout` class: + +* [`timeouts`](#timeouts) + +##### `timeouts` + +Data type: `Any` + +List of timeouts and data rates for receiving requests. + +Default value: `['header=20-40,minrate=500', 'body=10,minrate=500']` + +### `apache::mod::rewrite` + +Installs `mod_rewrite`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_rewrite.html + * for additional documentation. + +### `apache::mod::rpaf` + +Installs and configures `mod_rpaf`. + +* **See also** + * https://github.com/gnif/mod_rpaf + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::rpaf` class: + +* [`sethostname`](#sethostname) +* [`proxy_ips`](#proxy_ips) +* [`header`](#header) +* [`template`](#template) + +##### `sethostname` + +Data type: `Any` + +Toggles whether to update vhost name so ServerName and ServerAlias work. + +Default value: ``true`` + +##### `proxy_ips` + +Data type: `Any` + +List of IPs & bitmasked subnets to adjust requests for + +Default value: `['127.0.0.1']` + +##### `header` + +Data type: `Any` + +Header to use for the real IP address. + +Default value: `'X-Forwarded-For'` + +##### `template` + +Data type: `Any` + +Path to template to use for configuring mod_rpaf. + +Default value: `'apache/mod/rpaf.conf.erb'` + +### `apache::mod::security` + +Installs and configures `mod_security`. + +* **See also** + * https://github.com/SpiderLabs/ModSecurity/wiki + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::security` class: + +* [`version`](#version) +* [`logroot`](#logroot) +* [`crs_package`](#crs_package) +* [`activated_rules`](#activated_rules) +* [`modsec_dir`](#modsec_dir) +* [`modsec_secruleengine`](#modsec_secruleengine) +* [`audit_log_relevant_status`](#audit_log_relevant_status) +* [`audit_log_parts`](#audit_log_parts) +* [`audit_log_type`](#audit_log_type) +* [`audit_log_storage_dir`](#audit_log_storage_dir) +* [`secpcrematchlimit`](#secpcrematchlimit) +* [`secpcrematchlimitrecursion`](#secpcrematchlimitrecursion) +* [`allowed_methods`](#allowed_methods) +* [`content_types`](#content_types) +* [`restricted_extensions`](#restricted_extensions) +* [`restricted_headers`](#restricted_headers) +* [`secdefaultaction`](#secdefaultaction) +* [`anomaly_score_blocking`](#anomaly_score_blocking) +* [`inbound_anomaly_threshold`](#inbound_anomaly_threshold) +* [`outbound_anomaly_threshold`](#outbound_anomaly_threshold) +* [`critical_anomaly_score`](#critical_anomaly_score) +* [`error_anomaly_score`](#error_anomaly_score) +* [`warning_anomaly_score`](#warning_anomaly_score) +* [`notice_anomaly_score`](#notice_anomaly_score) +* [`secrequestmaxnumargs`](#secrequestmaxnumargs) +* [`secrequestbodylimit`](#secrequestbodylimit) +* [`secrequestbodynofileslimit`](#secrequestbodynofileslimit) +* [`secrequestbodyinmemorylimit`](#secrequestbodyinmemorylimit) +* [`manage_security_crs`](#manage_security_crs) +* [`custom_rules`](#custom_rules) +* [`custom_rules_set`](#custom_rules_set) + +##### `version` + +Data type: `Any` + +Manage mod_security or mod_security2 + +Default value: `$apache::params::modsec_version` + +##### `logroot` + +Data type: `Any` + +Configures the location of audit and debug logs. + +Default value: `$apache::params::logroot` + +##### `crs_package` + +Data type: `Any` + +Name of package that installs CRS rules. + +Default value: `$apache::params::modsec_crs_package` + +##### `activated_rules` + +Data type: `Any` + +An array of rules from the modsec_crs_path or absolute to activate via symlinks. + +Default value: `$apache::params::modsec_default_rules` + +##### `modsec_dir` + +Data type: `Any` + +Defines the path where Puppet installs the modsec configuration and activated rules links. + +Default value: `$apache::params::modsec_dir` + +##### `modsec_secruleengine` + +Data type: `Any` + +Configures the rules engine. + +Default value: `$apache::params::modsec_secruleengine` + +##### `audit_log_relevant_status` + +Data type: `Any` + +Configures which response status code is to be considered relevant for the purpose of audit logging. + +Default value: `'^(?:5|4(?!04))'` + +##### `audit_log_parts` + +Data type: `Any` + +Defines which parts of each transaction are going to be recorded in the audit log. Each part is assigned a single letter; when a +letter appears in the list then the equivalent part will be recorded. + +Default value: `$apache::params::modsec_audit_log_parts` + +##### `audit_log_type` + +Data type: `Any` + +Defines the type of audit logging mechanism to be used. + +Default value: `$apache::params::modsec_audit_log_type` + +##### `audit_log_storage_dir` + +Data type: `Any` + +Defines the directory where concurrent audit log entries are to be stored. This directive is only needed when concurrent audit logging is used. + +Default value: ``undef`` + +##### `secpcrematchlimit` + +Data type: `Any` + +Sets the match limit in the PCRE library. + +Default value: `$apache::params::secpcrematchlimit` + +##### `secpcrematchlimitrecursion` + +Data type: `Any` + +Sets the match limit recursion in the PCRE library. + +Default value: `$apache::params::secpcrematchlimitrecursion` + +##### `allowed_methods` + +Data type: `Any` + +A space-separated list of allowed HTTP methods. + +Default value: `'GET HEAD POST OPTIONS'` + +##### `content_types` + +Data type: `Any` + +A list of one or more allowed MIME types. + +Default value: `'application/x-www-form-urlencoded|multipart/form-data|text/xml|application/xml|application/x-amf'` + +##### `restricted_extensions` + +Data type: `Any` + +A space-sparated list of prohibited file extensions. + +Default value: `'.asa/ .asax/ .ascx/ .axd/ .backup/ .bak/ .bat/ .cdx/ .cer/ .cfg/ .cmd/ .com/ .config/ .conf/ .cs/ .csproj/ .csr/ .dat/ .db/ .dbf/ .dll/ .dos/ .htr/ .htw/ .ida/ .idc/ .idq/ .inc/ .ini/ .key/ .licx/ .lnk/ .log/ .mdb/ .old/ .pass/ .pdb/ .pol/ .printer/ .pwd/ .resources/ .resx/ .sql/ .sys/ .vb/ .vbs/ .vbproj/ .vsdisco/ .webinfo/ .xsd/ .xsx/'` + +##### `restricted_headers` + +Data type: `Any` + +A list of restricted headers separated by slashes and spaces. + +Default value: `'/Proxy-Connection/ /Lock-Token/ /Content-Range/ /Translate/ /via/ /if/'` + +##### `secdefaultaction` + +Data type: `Any` + +Defines the default list of actions, which will be inherited by the rules in the same configuration context. + +Default value: `'deny'` + +##### `anomaly_score_blocking` + +Data type: `Any` + +Activates or deactivates the Collaborative Detection Blocking of the OWASP ModSecurity Core Rule Set. + +Default value: `'off'` + +##### `inbound_anomaly_threshold` + +Data type: `Any` + +Sets the scoring threshold level of the inbound blocking rules for the Collaborative Detection Mode in the OWASP ModSecurity Core Rule Set. + +Default value: `'5'` + +##### `outbound_anomaly_threshold` + +Data type: `Any` + +Sets the scoring threshold level of the outbound blocking rules for the Collaborative Detection Mode in the OWASP ModSecurity Core Rule Set. + +Default value: `'4'` + +##### `critical_anomaly_score` + +Data type: `Any` + +Sets the Anomaly Score for rules assigned with a critical severity. + +Default value: `'5'` + +##### `error_anomaly_score` + +Data type: `Any` + +Sets the Anomaly Score for rules assigned with a error severity. + +Default value: `'4'` + +##### `warning_anomaly_score` + +Data type: `Any` + +Sets the Anomaly Score for rules assigned with a warning severity. + +Default value: `'3'` + +##### `notice_anomaly_score` + +Data type: `Any` + +Sets the Anomaly Score for rules assigned with a notice severity. + +Default value: `'2'` + +##### `secrequestmaxnumargs` + +Data type: `Any` + +Sets the maximum number of arguments in the request. + +Default value: `'255'` + +##### `secrequestbodylimit` + +Data type: `Any` + +Sets the maximum request body size ModSecurity will accept for buffering. + +Default value: `'13107200'` + +##### `secrequestbodynofileslimit` + +Data type: `Any` + +Configures the maximum request body size ModSecurity will accept for buffering, excluding the size of any files being transported +in the request. + +Default value: `'131072'` + +##### `secrequestbodyinmemorylimit` + +Data type: `Any` + +Configures the maximum request body size that ModSecurity will store in memory. + +Default value: `'131072'` + +##### `manage_security_crs` + +Data type: `Any` + +Toggles whether to manage ModSecurity Core Rule Set + +Default value: ``true`` + +##### `custom_rules` + +Data type: `Any` + + + +Default value: `$apache::params::modsec_custom_rules` + +##### `custom_rules_set` + +Data type: `Any` + + + +Default value: `$apache::params::modsec_custom_rules_set` + +### `apache::mod::setenvif` + +Installs `mod_setenvif`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_setenvif.html + * for additional documentation. + +### `apache::mod::shib` + +This class installs and configures only the Apache components of a web application that consumes Shibboleth SSO identities. You +can manage the Shibboleth configuration manually, with Puppet, or using a [Shibboleth Puppet Module](https://github.com/aethylred/puppet-shibboleth). + +* **Note** The Shibboleth module isn't available on RH/CentOS without providing dependency packages provided by Shibboleth's repositories. +See the [Shibboleth Service Provider Installation Guide](http://wiki.aaf.edu.au/tech-info/sp-install-guide). + +* **See also** + * https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPApacheConfig + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::shib` class: + +* [`suppress_warning`](#suppress_warning) +* [`mod_full_path`](#mod_full_path) +* [`package_name`](#package_name) +* [`mod_lib`](#mod_lib) + +##### `suppress_warning` + +Data type: `Any` + +Toggles whether to trigger warning on RedHat nodes. + +Default value: ``false`` + +##### `mod_full_path` + +Data type: `Any` + +Specifies a path to the module. Do not manually set this parameter without a special reason. + +Default value: ``undef`` + +##### `package_name` + +Data type: `Any` + +Name of the Shibboleth package to be installed. + +Default value: ``undef`` + +##### `mod_lib` + +Data type: `Any` + +Specifies a path to the module's libraries. Do not manually set this parameter without special reason. The `path` parameter +overrides this value. + +Default value: ``undef`` + +### `apache::mod::socache_shmcb` + +Installs `mod_socache_shmcb`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_socache_shmcb.html + * for additional documentation. + +### `apache::mod::speling` + +Installs `mod_spelling`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_speling.html + * for additional documentation. + +### `apache::mod::ssl` + +On most operating systems, the ssl.conf is placed in the module configuration directory. On Red Hat based operating systems, this +file is placed in /etc/httpd/conf.d, the same location in which the RPM stores the configuration. + +To use SSL with a virtual host, you must either set the default_ssl_vhost parameter in ::apache to true or the ssl parameter in +apache::vhost to true. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_ssl.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::ssl` class: + +* [`ssl_compression`](#ssl_compression) +* [`ssl_cryptodevice`](#ssl_cryptodevice) +* [`ssl_options`](#ssl_options) +* [`ssl_openssl_conf_cmd`](#ssl_openssl_conf_cmd) +* [`ssl_cert`](#ssl_cert) +* [`ssl_key`](#ssl_key) +* [`ssl_ca`](#ssl_ca) +* [`ssl_cipher`](#ssl_cipher) +* [`ssl_honorcipherorder`](#ssl_honorcipherorder) +* [`ssl_protocol`](#ssl_protocol) +* [`ssl_proxy_protocol`](#ssl_proxy_protocol) +* [`ssl_pass_phrase_dialog`](#ssl_pass_phrase_dialog) +* [`ssl_random_seed_bytes`](#ssl_random_seed_bytes) +* [`ssl_sessioncache`](#ssl_sessioncache) +* [`ssl_sessioncachetimeout`](#ssl_sessioncachetimeout) +* [`ssl_stapling`](#ssl_stapling) +* [`ssl_stapling_return_errors`](#ssl_stapling_return_errors) +* [`ssl_mutex`](#ssl_mutex) +* [`ssl_reload_on_change`](#ssl_reload_on_change) +* [`apache_version`](#apache_version) +* [`package_name`](#package_name) +* [`ssl_sessiontickets`](#ssl_sessiontickets) +* [`stapling_cache`](#stapling_cache) + +##### `ssl_compression` + +Data type: `Boolean` + +Enable compression on the SSL level. + +Default value: ``false`` + +##### `ssl_cryptodevice` + +Data type: `Any` + +Enable use of a cryptographic hardware accelerator. + +Default value: `'builtin'` + +##### `ssl_options` + +Data type: `Any` + +Configure various SSL engine run-time options. + +Default value: `['StdEnvVars']` + +##### `ssl_openssl_conf_cmd` + +Data type: `Any` + +Configure OpenSSL parameters through its SSL_CONF API. + +Default value: ``undef`` + +##### `ssl_cert` + +Data type: `Optional[String]` + +Path to server PEM-encoded X.509 certificate data file. + +Default value: ``undef`` + +##### `ssl_key` + +Data type: `Optional[String]` + +Path to server PEM-encoded private key file + +Default value: ``undef`` + +##### `ssl_ca` + +Data type: `Any` + +File of concatenated PEM-encoded CA Certificates for Client Auth. + +Default value: ``undef`` + +##### `ssl_cipher` + +Data type: `Any` + +Cipher Suite available for negotiation in SSL handshake. + +Default value: `'HIGH:MEDIUM:!aNULL:!MD5:!RC4:!3DES'` + +##### `ssl_honorcipherorder` + +Data type: `Variant[Boolean, Enum['on', 'off']]` + +Option to prefer the server's cipher preference order. + +Default value: ``true`` + +##### `ssl_protocol` + +Data type: `Any` + +Configure usable SSL/TLS protocol versions. +Default based on the OS: +- RedHat 8: [ 'all' ]. +- Other Platforms: [ 'all', '-SSLv2', '-SSLv3' ]. + +Default value: `$apache::params::ssl_protocol` + +##### `ssl_proxy_protocol` + +Data type: `Array` + +Configure usable SSL protocol flavors for proxy usage. + +Default value: `[]` + +##### `ssl_pass_phrase_dialog` + +Data type: `Any` + +Type of pass phrase dialog for encrypted private keys. + +Default value: `'builtin'` + +##### `ssl_random_seed_bytes` + +Data type: `Any` + +Pseudo Random Number Generator (PRNG) seeding source. + +Default value: `'512'` + +##### `ssl_sessioncache` + +Data type: `String` + +Configures the storage type of the global/inter-process SSL Session Cache + +Default value: `$apache::params::ssl_sessioncache` + +##### `ssl_sessioncachetimeout` + +Data type: `Any` + +Number of seconds before an SSL session expires in the Session Cache. + +Default value: `'300'` + +##### `ssl_stapling` + +Data type: `Boolean` + +Enable stapling of OCSP responses in the TLS handshake. + +Default value: ``false`` + +##### `ssl_stapling_return_errors` + +Data type: `Optional[Boolean]` + +Pass stapling related OCSP errors on to client. + +Default value: ``undef`` + +##### `ssl_mutex` + +Data type: `Any` + +Configures mutex mechanism and lock file directory for all or specified mutexes. +Default based on the OS and/or Apache version: +- RedHat/FreeBSD/Suse/Gentoo: 'default'. +- Debian/Ubuntu + Apache >= 2.4: 'default'. +- Debian/Ubuntu + Apache < 2.4: 'file:${APACHE_RUN_DIR}/ssl_mutex'. + +Default value: ``undef`` + +##### `ssl_reload_on_change` + +Data type: `Boolean` + +Enable reloading of apache if the content of ssl files have changed. It only affects ssl files configured here and not vhost ones. + +Default value: ``false`` + +##### `apache_version` + +Data type: `Any` + +Used to verify that the Apache version you have requested is compatible with the module. + +Default value: ``undef`` + +##### `package_name` + +Data type: `Any` + +Name of ssl package to install. + +Default value: ``undef`` + +##### `ssl_sessiontickets` + +Data type: `Optional[Boolean]` + + + +Default value: ``undef`` + +##### `stapling_cache` + +Data type: `Optional[String]` + + + +Default value: ``undef`` + +### `apache::mod::status` + +Installs and configures `mod_status`. + +* **See also** + * http://httpd.apache.org/docs/current/mod/mod_status.html + * for additional documentation. + +#### Examples + +##### + +```puppet +# Simple usage allowing access from localhost and a private subnet +class { 'apache::mod::status': + $allow_from => ['127.0.0.1', '10.10.10.10/24'], +} +``` + +#### Parameters + +The following parameters are available in the `apache::mod::status` class: + +* [`allow_from`](#allow_from) +* [`requires`](#requires) +* [`extended_status`](#extended_status) +* [`status_path`](#status_path) +* [`apache_version`](#apache_version) + +##### `allow_from` + +Data type: `Optional[Array]` + +Array of hosts, ip addresses, partial network numbers or networks, in CIDR notation specifying what hosts can view the special +/server-status URL. Defaults to ['127.0.0.1', '::1']. +> Creates Apache < 2.4 directive "Allow from". + +Default value: ``undef`` + +##### `requires` + +Data type: `Optional[Variant[String, Array, Hash]]` + +A Variant type that can be: +- String with: + - '' or 'unmanaged' - Host auth control done elsewhere + - 'ip ' - Allowed IPs/ranges + - 'host ' - Allowed names/domains + - 'all [granted|denied]' +- Array of strings with ip or host as above +- Hash with following keys: + - 'requires' - Value => Array as above + - 'enforce' - Value => String 'Any', 'All' or 'None' + This encloses "Require" directives in "" block + Optional - If unspecified, "Require" directives follow current flow +> Creates Apache >= 2.4 directives "Require" + +Default value: ``undef`` + +##### `extended_status` + +Data type: `Enum['On', 'Off', 'on', 'off']` + +Determines whether to track extended status information for each request, via the ExtendedStatus directive. + +Default value: `'On'` + +##### `status_path` + +Data type: `Any` + +Path assigned to the Location directive which defines the URL to access the server status. + +Default value: `'/server-status'` + +##### `apache_version` + +Data type: `Any` + +Used to verify that the Apache version you have requested is compatible with the module. + +Default value: ``undef`` + +### `apache::mod::suexec` + +Installs `mod_suexec`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_suexec.html + * for additional documentation. + +### `apache::mod::suphp` + +Installs `mod_suphp`. + +* **See also** + * https://www.suphp.org/DocumentationView.html?file=apache/INSTALL + * for additional documentation. + +### `apache::mod::userdir` + +Installs and configures `mod_userdir`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_userdir.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::userdir` class: + +* [`home`](#home) +* [`dir`](#dir) +* [`userdir`](#userdir) +* [`disable_root`](#disable_root) +* [`apache_version`](#apache_version) +* [`path`](#path) +* [`overrides`](#overrides) +* [`options`](#options) +* [`unmanaged_path`](#unmanaged_path) +* [`custom_fragment`](#custom_fragment) + +##### `home` + +Data type: `Any` + +*Deprecated* Path to system home directory. + +Default value: ``undef`` + +##### `dir` + +Data type: `Any` + +*Deprecated* Path from user's home directory to public directory. + +Default value: ``undef`` + +##### `userdir` + +Data type: `Optional[String[1]]` + +Path or directory name to be used as the UserDir. + +Default value: ``undef`` + +##### `disable_root` + +Data type: `Any` + +Toggles whether to allow use of root directory. + +Default value: ``true`` + +##### `apache_version` + +Data type: `Any` + +Used to verify that the Apache version you have requested is compatible with the module. + +Default value: ``undef`` + +##### `path` + +Data type: `Any` + +Path to directory or pattern from which to find user-specific directories. + +Default value: `'/home/*/public_html'` + +##### `overrides` + +Data type: `Any` + +Array of directives that are allowed in .htaccess files. + +Default value: `['FileInfo', 'AuthConfig', 'Limit', 'Indexes']` + +##### `options` + +Data type: `Any` + +Configures what features are available in a particular directory. + +Default value: `['MultiViews', 'Indexes', 'SymLinksIfOwnerMatch', 'IncludesNoExec']` + +##### `unmanaged_path` + +Data type: `Any` + +Toggles whether to manage path in userdir.conf + +Default value: ``false`` + +##### `custom_fragment` + +Data type: `Any` + +Custom configuration to be added to userdir.conf + +Default value: ``undef`` + +### `apache::mod::version` + +Installs `mod_version`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_version.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::version` class: + +* [`apache_version`](#apache_version) + +##### `apache_version` + +Data type: `Any` + +Used to verify that the Apache version you have requested is compatible with the module. + +Default value: `$apache::apache_version` + +### `apache::mod::vhost_alias` + +Installs Apache `mod_vhost_alias`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_vhost_alias.html + * for additional documentation. + +### `apache::mod::watchdog` + +Installs and configures `mod_watchdog`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/mod_watchdog.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::watchdog` class: + +* [`watchdog_interval`](#watchdog_interval) + +##### `watchdog_interval` + +Data type: `Optional[Integer]` + +Sets the interval at which the watchdog_step hook runs. + +Default value: ``undef`` + +### `apache::mod::worker` + +Installs and manages the MPM `worker`. + +* **See also** + * https://httpd.apache.org/docs/current/mod/worker.html + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::worker` class: + +* [`startservers`](#startservers) +* [`maxclients`](#maxclients) +* [`minsparethreads`](#minsparethreads) +* [`maxsparethreads`](#maxsparethreads) +* [`threadsperchild`](#threadsperchild) +* [`maxrequestsperchild`](#maxrequestsperchild) +* [`serverlimit`](#serverlimit) +* [`threadlimit`](#threadlimit) +* [`listenbacklog`](#listenbacklog) +* [`apache_version`](#apache_version) + +##### `startservers` + +Data type: `Any` + +The number of child server processes created on startup + +Default value: `'2'` + +##### `maxclients` + +Data type: `Any` + +The max number of simultaneous requests that will be served. +This is the old name and is still supported. The new name is +MaxRequestWorkers as of 2.3.13. + +Default value: `'150'` + +##### `minsparethreads` + +Data type: `Any` + +Minimum number of idle threads to handle request spikes. + +Default value: `'25'` + +##### `maxsparethreads` + +Data type: `Any` + +Maximum number of idle threads. + +Default value: `'75'` + +##### `threadsperchild` + +Data type: `Any` + +The number of threads created by each child process. + +Default value: `'25'` + +##### `maxrequestsperchild` + +Data type: `Any` + +Limit on the number of connectiojns an individual child server +process will handle. This is the old name and is still supported. The new +name is MaxConnectionsPerChild as of 2.3.9+. + +Default value: `'0'` + +##### `serverlimit` + +Data type: `Any` + +With worker, use this directive only if your MaxRequestWorkers +and ThreadsPerChild settings require more than 16 server processes +(default). Do not set the value of this directive any higher than the +number of server processes required by what you may want for +MaxRequestWorkers and ThreadsPerChild. + +Default value: `'25'` + +##### `threadlimit` + +Data type: `Any` + +This directive sets the maximum configured value for +ThreadsPerChild for the lifetime of the Apache httpd process. + +Default value: `'64'` + +##### `listenbacklog` + +Data type: `Any` + +Maximum length of the queue of pending connections. + +Default value: `'511'` + +##### `apache_version` + +Data type: `Any` + +Used to verify that the Apache version you have requested is compatible with the module. + +Default value: ``undef`` + +### `apache::mod::wsgi` + +Installs and configures `mod_wsgi`. + +* **Note** Unsupported platforms: SLES: all; RedHat: all; CentOS: all; OracleLinux: all; Scientific: all + +* **See also** + * https://github.com/GrahamDumpleton/mod_wsgi + * for additional documentation. + +#### Parameters + +The following parameters are available in the `apache::mod::wsgi` class: + +* [`wsgi_restrict_embedded`](#wsgi_restrict_embedded) +* [`wsgi_socket_prefix`](#wsgi_socket_prefix) +* [`wsgi_python_path`](#wsgi_python_path) +* [`wsgi_python_home`](#wsgi_python_home) +* [`wsgi_python_optimize`](#wsgi_python_optimize) +* [`wsgi_application_group`](#wsgi_application_group) +* [`package_name`](#package_name) +* [`mod_path`](#mod_path) + +##### `wsgi_restrict_embedded` + +Data type: `Any` + +Enable restrictions on use of embedded mode. + +Default value: ``undef`` + +##### `wsgi_socket_prefix` + +Data type: `Any` + +Configure directory to use for daemon sockets. + +Default value: `$apache::params::wsgi_socket_prefix` + +##### `wsgi_python_path` + +Data type: `Any` + +Additional directories to search for Python modules. + +Default value: ``undef`` + +##### `wsgi_python_home` + +Data type: `Any` + +Absolute path to Python prefix/exec_prefix directories. + +Default value: ``undef`` + +##### `wsgi_python_optimize` + +Data type: `Any` + +Enables basic Python optimisation features. + +Default value: ``undef`` + +##### `wsgi_application_group` + +Data type: `Any` + +Sets which application group WSGI application belongs to. + +Default value: ``undef`` + +##### `package_name` + +Data type: `Any` + +Names of package that installs mod_wsgi. + +Default value: ``undef`` + +##### `mod_path` + +Data type: `Any` + +Defines the path to the mod_wsgi shared object (.so) file. + +Default value: ``undef`` + +### `apache::mod::xsendfile` + +Installs `mod_xsendfile`. + +* **See also** + * https://tn123.org/mod_xsendfile/ + * for additional documentation. + +### `apache::mpm::disable_mpm_event` + +The apache::mpm::disable_mpm_event class. + +### `apache::mpm::disable_mpm_prefork` + +The apache::mpm::disable_mpm_prefork class. + +### `apache::mpm::disable_mpm_worker` + +The apache::mpm::disable_mpm_worker class. + +### `apache::vhosts` + +host parameters or Configuring virtual hosts in the README section. + +* **Note** See the `apache::vhost` defined type's reference for a list of all virtual + +#### Examples + +##### To create a [name-based virtual host](https://httpd.apache.org/docs/current/vhosts/name-based.html) `custom_vhost_1` + +```puppet +class { 'apache::vhosts': + vhosts => { + 'custom_vhost_1' => { + 'docroot' => '/var/www/custom_vhost_1', + 'port' => '81', + }, + }, +} +``` + +#### Parameters + +The following parameters are available in the `apache::vhosts` class: + +* [`vhosts`](#vhosts) + +##### `vhosts` + +Data type: `Any` + +A hash, where the key represents the name and the value represents a hash of +`apache::vhost` defined type's parameters. + +Default value: `{}` + +## Defined types + +### `apache::balancer` + +Each balancer cluster needs one or more balancer members (that can +be declared with the apache::balancermember defined resource type). Using +storeconfigs, you can export the apache::balancermember resources on all +balancer members, and then collect them on a single apache load balancer +server. + +* **Note** Currently requires the puppetlabs/concat module on the Puppet Forge and uses +storeconfigs on the Puppet Server to export/collect resources from all +balancer members. + +#### Examples + +##### + +```puppet +apache::balancer { 'puppet00': } +``` + +#### Parameters + +The following parameters are available in the `apache::balancer` defined type: + +* [`name`](#name) +* [`proxy_set`](#proxy_set) +* [`target`](#target) +* [`collect_exported`](#collect_exported) +* [`options`](#options) + +##### `name` + +The namevar of the defined resource type is the balancer clusters name.
+This name is also used in the name of the conf.d file + +##### `proxy_set` + +Data type: `Any` + +Configures key-value pairs to be used as a ProxySet lines in the configuration. + +Default value: `{}` + +##### `target` + +Data type: `Any` + +The path to the file the balancer definition will be written in. + +Default value: ``undef`` + +##### `collect_exported` + +Data type: `Any` + +Determines whether to use exported resources.
+If you statically declare all of your backend servers, set this parameter to false to rely +on existing, declared balancer member resources. Also, use apache::balancermember with array +arguments.
+To dynamically declare backend servers via exported resources collected on a central node, +set this parameter to true to collect the balancer member resources exported by the balancer +member nodes.
+If you don't use exported resources, a single Puppet run configures all balancer members. If +you use exported resources, Puppet has to run on the balanced nodes first, then run on the +balancer. + +Default value: ``true`` + +##### `options` + +Data type: `Any` + +Specifies an array of [options](https://httpd.apache.org/docs/current/mod/mod_proxy.html#balancermember) +after the balancer URL, and accepts any key-value pairs available to `ProxyPass`. + +Default value: `[]` + +### `apache::balancermember` + +Sets up a balancer member inside a listening service configuration block in +the load balancer's `apache.cfg`. + +This type will setup a balancer member inside a listening service +configuration block in /etc/apache/apache.cfg on the load balancer. +Currently it only has the ability to specify the instance name, url and an +array of options. More features can be added as needed. The best way to +implement this is to export this resource for all apache balancer member +servers, and then collect them on the main apache load balancer. + +* **Note** Currently requires the puppetlabs/concat module on the Puppet Forge and +uses storeconfigs on the Puppet Server to export/collect resources +from all balancer members. + +#### Examples + +##### + +```puppet +@@apache::balancermember { 'apache': + balancer_cluster => 'puppet00', + url => "ajp://${::fqdn}:8009" + options => ['ping=5', 'disablereuse=on', 'retry=5', 'ttl=120'], +} +``` + +#### Parameters + +The following parameters are available in the `apache::balancermember` defined type: + +* [`name`](#name) +* [`balancer_cluster`](#balancer_cluster) +* [`url`](#url) +* [`options`](#options) + +##### `name` + +The title of the resource is arbitrary and only utilized in the concat +fragment name. + +##### `balancer_cluster` + +Data type: `Any` + +The apache service's instance name (or, the title of the apache::balancer +resource). This must match up with a declared apache::balancer resource. + +##### `url` + +Data type: `Any` + +The url used to contact the balancer member server. + +Default value: `"http://${::fqdn}/"` + +##### `options` + +Data type: `Any` + +Specifies an array of [options](https://httpd.apache.org/docs/current/mod/mod_proxy.html#balancermember) +after the URL, and accepts any key-value pairs available to `ProxyPass`. + +Default value: `[]` + +### `apache::custom_config` + +If the file is invalid and this defined type's `verify_config` parameter's value is +`true`, Puppet throws an error during a Puppet run. + +#### Parameters + +The following parameters are available in the `apache::custom_config` defined type: + +* [`ensure`](#ensure) +* [`confdir`](#confdir) +* [`content`](#content) +* [`filename`](#filename) +* [`priority`](#priority) +* [`source`](#source) +* [`verify_command`](#verify_command) +* [`verify_config`](#verify_config) +* [`owner`](#owner) +* [`group`](#group) +* [`file_mode`](#file_mode) +* [`show_diff`](#show_diff) + +##### `ensure` + +Data type: `Enum['absent', 'present']` + +Specifies whether the configuration file should be present. + +Default value: `'present'` + +##### `confdir` + +Data type: `Any` + +Sets the directory in which Puppet places configuration files. + +Default value: `$apache::confd_dir` + +##### `content` + +Data type: `Any` + +Sets the configuration file's content. The `content` and `source` parameters are exclusive +of each other. + +Default value: ``undef`` + +##### `filename` + +Data type: `Any` + +Sets the name of the file under `confdir` in which Puppet stores the configuration. + +Default value: ``undef`` + +##### `priority` + +Data type: `Any` + +Sets the configuration file's priority by prefixing its filename with this parameter's +numeric value, as Apache processes configuration files in alphanumeric order.
+To omit the priority prefix in the configuration file's name, set this parameter to `false`. + +Default value: `'25'` + +##### `source` + +Data type: `Any` + +Points to the configuration file's source. The `content` and `source` parameters are +exclusive of each other. + +Default value: ``undef`` + +##### `verify_command` + +Data type: `Any` + +Specifies the command Puppet uses to verify the configuration file. Use a fully qualified +command.
+This parameter is used only if the `verify_config` parameter's value is `true`. If the +`verify_command` fails, the Puppet run deletes the configuration file and raises an error, +but does not notify the Apache service. + +Default value: `$apache::params::verify_command` + +##### `verify_config` + +Data type: `Boolean` + +Specifies whether to validate the configuration file before notifying the Apache service. + +Default value: ``true`` + +##### `owner` + +Data type: `Any` + +File owner of configuration file + +Default value: ``undef`` + +##### `group` + +Data type: `Any` + +File group of configuration file + +Default value: ``undef`` + +##### `file_mode` + +Data type: `Any` + +File mode of configuration file + +Default value: ``undef`` + +##### `show_diff` + +Data type: `Boolean` + +show_diff property for configuration file resource + +Default value: ``true`` + +### `apache::fastcgi::server` + +Defines one or more external FastCGI servers to handle specific file types. Use this +defined type with `mod_fastcgi`. + +#### Parameters + +The following parameters are available in the `apache::fastcgi::server` defined type: + +* [`host`](#host) +* [`timeout`](#timeout) +* [`flush`](#flush) +* [`faux_path`](#faux_path) +* [`fcgi_alias`](#fcgi_alias) +* [`file_type`](#file_type) +* [`pass_header`](#pass_header) + +##### `host` + +Data type: `Any` + +Determines the FastCGI's hostname or IP address and TCP port number (1-65535). + +Default value: `'127.0.0.1:9000'` + +##### `timeout` + +Data type: `Any` + +Sets the number of seconds a [FastCGI](http://www.fastcgi.com/) application can be inactive before aborting the +request and logging the event at the error LogLevel. The inactivity timer applies only as +long as a connection is pending with the FastCGI application. If a request is queued to an +application, but the application doesn't respond by writing and flushing within this period, +the request is aborted. If communication is complete with the application but incomplete with +the client (the response is buffered), the timeout does not apply. + +Default value: `15` + +##### `flush` + +Data type: `Any` + +Forces `mod_fastcgi` to write to the client as data is received from the +application. By default, `mod_fastcgi` buffers data in order to free the application +as quickly as possible. + +Default value: ``false`` + +##### `faux_path` + +Data type: `Any` + +Apache has FastCGI handle URIs that resolve to this filename. The path set in this +parameter does not have to exist in the local filesystem. + +Default value: `"/var/www/${name}.fcgi"` + +##### `fcgi_alias` + +Data type: `Any` + +Internally links actions with the FastCGI server. This alias must be unique. + +Default value: `"/${name}.fcgi"` + +##### `file_type` + +Data type: `Any` + +Sets the MIME `content-type` of the file to be processed by the FastCGI server. + +Default value: `'application/x-httpd-php'` + +##### `pass_header` + +Data type: `Any` + + + +Default value: ``undef`` + +### `apache::listen` + +The `apache::vhost` class uses this defined type, and titles take the form +``, `:`, or `:`. + +### `apache::mod` + +Checks for or places the module's default configuration files in the Apache server's +`module` and `enable` directories. The default locations depend on your operating system. + +#### Parameters + +The following parameters are available in the `apache::mod` defined type: + +* [`package`](#package) +* [`package_ensure`](#package_ensure) +* [`lib`](#lib) +* [`lib_path`](#lib_path) +* [`loadfile_name`](#loadfile_name) +* [`id`](#id) +* [`loadfiles`](#loadfiles) +* [`path`](#path) + +##### `package` + +Data type: `Any` + +**Required**.
+Names the package Puppet uses to install the Apache module. + +Default value: ``undef`` + +##### `package_ensure` + +Data type: `Any` + +Determines whether Puppet ensures the Apache module should be installed. + +Default value: `'present'` + +##### `lib` + +Data type: `Any` + +Defines the module's shared object name. Do not configure manually without special reason. + +Default value: ``undef`` + +##### `lib_path` + +Data type: `Any` + +Specifies a path to the module's libraries. Do not manually set this parameter +without special reason. The `path` parameter overrides this value. + +Default value: `$apache::lib_path` + +##### `loadfile_name` + +Data type: `Any` + +Sets the filename for the module's `LoadFile` directive, which can also set +the module load order as Apache processes them in alphanumeric order. + +Default value: ``undef`` + +##### `id` + +Data type: `Any` + +Specifies the package id + +Default value: ``undef`` + +##### `loadfiles` + +Data type: `Any` + +Specifies an array of `LoadFile` directives. + +Default value: ``undef`` + +##### `path` + +Data type: `Any` + +Specifies a path to the module. Do not manually set this parameter without a special reason. + +Default value: ``undef`` + +### `apache::namevirtualhost` + +Adds all related directives to the `ports.conf` file in the Apache HTTPD configuration +directory. Titles can take the forms `\*`, `\*:\`, `\_default\_:\`, +`\`, or `\:\`. + +### `apache::vhost` + +The apache module allows a lot of flexibility in the setup and configuration of virtual hosts. +This flexibility is due, in part, to `vhost` being a defined resource type, which allows Apache +to evaluate it multiple times with different parameters.
+The `apache::vhost` defined type allows you to have specialized configurations for virtual hosts +that have requirements outside the defaults. You can set up a default virtual host within +the base `::apache` class, as well as set a customized virtual host as the default. +Customized virtual hosts have a lower numeric `priority` than the base class's, causing +Apache to process the customized virtual host first.
+The `apache::vhost` defined type uses `concat::fragment` to build the configuration file. To +inject custom fragments for pieces of the configuration that the defined type doesn't +inherently support, add a custom fragment.
+For the custom fragment's `order` parameter, the `apache::vhost` defined type uses multiples +of 10, so any `order` that isn't a multiple of 10 should work.
+> **Note:** When creating an `apache::vhost`, it cannot be named `default` or `default-ssl`, +because vhosts with these titles are always managed by the module. This means that you cannot +override `Apache::Vhost['default']` or `Apache::Vhost['default-ssl]` resources. An optional +workaround is to create a vhost named something else, such as `my default`, and ensure that the +`default` and `default_ssl` vhosts are set to `false`: + +#### Examples + +##### + +```puppet +class { 'apache': + default_vhost => false, + default_ssl_vhost => false, +} +``` + +#### Parameters + +The following parameters are available in the `apache::vhost` defined type: + +* [`apache_version`](#apache_version) +* [`access_log`](#access_log) +* [`access_log_env_var`](#access_log_env_var) +* [`access_log_file`](#access_log_file) +* [`access_log_format`](#access_log_format) +* [`access_log_pipe`](#access_log_pipe) +* [`access_log_syslog`](#access_log_syslog) +* [`access_logs`](#access_logs) +* [`add_default_charset`](#add_default_charset) +* [`add_listen`](#add_listen) +* [`use_optional_includes`](#use_optional_includes) +* [`additional_includes`](#additional_includes) +* [`aliases`](#aliases) +* [`allow_encoded_slashes`](#allow_encoded_slashes) +* [`block`](#block) +* [`cas_attribute_prefix`](#cas_attribute_prefix) +* [`cas_attribute_delimiter`](#cas_attribute_delimiter) +* [`cas_login_url`](#cas_login_url) +* [`cas_root_proxied_as`](#cas_root_proxied_as) +* [`cas_scrub_request_headers`](#cas_scrub_request_headers) +* [`cas_sso_enabled`](#cas_sso_enabled) +* [`cas_validate_saml`](#cas_validate_saml) +* [`cas_validate_url`](#cas_validate_url) +* [`cas_cookie_path`](#cas_cookie_path) +* [`comment`](#comment) +* [`custom_fragment`](#custom_fragment) +* [`default_vhost`](#default_vhost) +* [`directoryindex`](#directoryindex) +* [`docroot`](#docroot) +* [`docroot_group`](#docroot_group) +* [`docroot_owner`](#docroot_owner) +* [`docroot_mode`](#docroot_mode) +* [`manage_docroot`](#manage_docroot) +* [`error_log`](#error_log) +* [`error_log_file`](#error_log_file) +* [`error_log_pipe`](#error_log_pipe) +* [`error_log_syslog`](#error_log_syslog) +* [`error_log_format`](#error_log_format) +* [`error_documents`](#error_documents) +* [`ensure`](#ensure) +* [`fallbackresource`](#fallbackresource) +* [`fastcgi_server`](#fastcgi_server) +* [`fastcgi_socket`](#fastcgi_socket) +* [`fastcgi_idle_timeout`](#fastcgi_idle_timeout) +* [`fastcgi_dir`](#fastcgi_dir) +* [`filters`](#filters) +* [`h2_copy_files`](#h2_copy_files) +* [`h2_direct`](#h2_direct) +* [`h2_early_hints`](#h2_early_hints) +* [`h2_max_session_streams`](#h2_max_session_streams) +* [`h2_modern_tls_only`](#h2_modern_tls_only) +* [`h2_push`](#h2_push) +* [`h2_push_diary_size`](#h2_push_diary_size) +* [`h2_push_priority`](#h2_push_priority) +* [`h2_push_resource`](#h2_push_resource) +* [`h2_serialize_headers`](#h2_serialize_headers) +* [`h2_stream_max_mem_size`](#h2_stream_max_mem_size) +* [`h2_tls_cool_down_secs`](#h2_tls_cool_down_secs) +* [`h2_tls_warm_up_size`](#h2_tls_warm_up_size) +* [`h2_upgrade`](#h2_upgrade) +* [`h2_window_size`](#h2_window_size) +* [`headers`](#headers) +* [`ip`](#ip) +* [`ip_based`](#ip_based) +* [`itk`](#itk) +* [`action`](#action) +* [`jk_mounts`](#jk_mounts) +* [`http_protocol_options`](#http_protocol_options) +* [`keepalive`](#keepalive) +* [`keepalive_timeout`](#keepalive_timeout) +* [`max_keepalive_requests`](#max_keepalive_requests) +* [`auth_kerb`](#auth_kerb) +* [`krb_method_negotiate`](#krb_method_negotiate) +* [`krb_method_k5passwd`](#krb_method_k5passwd) +* [`krb_authoritative`](#krb_authoritative) +* [`krb_auth_realms`](#krb_auth_realms) +* [`krb_5keytab`](#krb_5keytab) +* [`krb_local_user_mapping`](#krb_local_user_mapping) +* [`krb_verify_kdc`](#krb_verify_kdc) +* [`krb_servicename`](#krb_servicename) +* [`krb_save_credentials`](#krb_save_credentials) +* [`logroot`](#logroot) +* [`logroot_ensure`](#logroot_ensure) +* [`logroot_mode`](#logroot_mode) +* [`logroot_owner`](#logroot_owner) +* [`logroot_group`](#logroot_group) +* [`log_level`](#log_level) +* [`modsec_body_limit`](#modsec_body_limit) +* [`modsec_disable_vhost`](#modsec_disable_vhost) +* [`modsec_disable_ids`](#modsec_disable_ids) +* [`modsec_disable_ips`](#modsec_disable_ips) +* [`modsec_disable_msgs`](#modsec_disable_msgs) +* [`modsec_disable_tags`](#modsec_disable_tags) +* [`modsec_audit_log_file`](#modsec_audit_log_file) +* [`modsec_audit_log_pipe`](#modsec_audit_log_pipe) +* [`modsec_audit_log`](#modsec_audit_log) +* [`no_proxy_uris`](#no_proxy_uris) +* [`no_proxy_uris_match`](#no_proxy_uris_match) +* [`proxy_preserve_host`](#proxy_preserve_host) +* [`proxy_add_headers`](#proxy_add_headers) +* [`proxy_error_override`](#proxy_error_override) +* [`options`](#options) +* [`override`](#override) +* [`passenger_enabled`](#passenger_enabled) +* [`passenger_base_uri`](#passenger_base_uri) +* [`passenger_ruby`](#passenger_ruby) +* [`passenger_python`](#passenger_python) +* [`passenger_nodejs`](#passenger_nodejs) +* [`passenger_meteor_app_settings`](#passenger_meteor_app_settings) +* [`passenger_app_env`](#passenger_app_env) +* [`passenger_app_root`](#passenger_app_root) +* [`passenger_app_group_name`](#passenger_app_group_name) +* [`passenger_app_start_command`](#passenger_app_start_command) +* [`passenger_app_type`](#passenger_app_type) +* [`passenger_startup_file`](#passenger_startup_file) +* [`passenger_restart_dir`](#passenger_restart_dir) +* [`passenger_spawn_method`](#passenger_spawn_method) +* [`passenger_load_shell_envvars`](#passenger_load_shell_envvars) +* [`passenger_rolling_restarts`](#passenger_rolling_restarts) +* [`passenger_resist_deployment_errors`](#passenger_resist_deployment_errors) +* [`passenger_user`](#passenger_user) +* [`passenger_group`](#passenger_group) +* [`passenger_friendly_error_pages`](#passenger_friendly_error_pages) +* [`passenger_min_instances`](#passenger_min_instances) +* [`passenger_max_instances`](#passenger_max_instances) +* [`passenger_max_preloader_idle_time`](#passenger_max_preloader_idle_time) +* [`passenger_force_max_concurrent_requests_per_process`](#passenger_force_max_concurrent_requests_per_process) +* [`passenger_start_timeout`](#passenger_start_timeout) +* [`passenger_concurrency_model`](#passenger_concurrency_model) +* [`passenger_thread_count`](#passenger_thread_count) +* [`passenger_max_requests`](#passenger_max_requests) +* [`passenger_max_request_time`](#passenger_max_request_time) +* [`passenger_memory_limit`](#passenger_memory_limit) +* [`passenger_stat_throttle_rate`](#passenger_stat_throttle_rate) +* [`passenger_pre_start`](#passenger_pre_start) +* [`passenger_high_performance`](#passenger_high_performance) +* [`passenger_buffer_upload`](#passenger_buffer_upload) +* [`passenger_buffer_response`](#passenger_buffer_response) +* [`passenger_error_override`](#passenger_error_override) +* [`passenger_max_request_queue_size`](#passenger_max_request_queue_size) +* [`passenger_max_request_queue_time`](#passenger_max_request_queue_time) +* [`passenger_sticky_sessions`](#passenger_sticky_sessions) +* [`passenger_sticky_sessions_cookie_name`](#passenger_sticky_sessions_cookie_name) +* [`passenger_sticky_sessions_cookie_attributes`](#passenger_sticky_sessions_cookie_attributes) +* [`passenger_allow_encoded_slashes`](#passenger_allow_encoded_slashes) +* [`passenger_app_log_file`](#passenger_app_log_file) +* [`passenger_debugger`](#passenger_debugger) +* [`passenger_lve_min_uid`](#passenger_lve_min_uid) +* [`php_values`](#php_values) +* [`php_flags`](#php_flags) +* [`php_admin_values`](#php_admin_values) +* [`php_admin_flags`](#php_admin_flags) +* [`port`](#port) +* [`priority`](#priority) +* [`protocols`](#protocols) +* [`protocols_honor_order`](#protocols_honor_order) +* [`proxy_dest`](#proxy_dest) +* [`proxy_pass`](#proxy_pass) +* [`proxy_dest_match`](#proxy_dest_match) +* [`proxy_dest_reverse_match`](#proxy_dest_reverse_match) +* [`proxy_pass_match`](#proxy_pass_match) +* [`redirect_dest`](#redirect_dest) +* [`redirect_source`](#redirect_source) +* [`redirect_status`](#redirect_status) +* [`redirectmatch_regexp`](#redirectmatch_regexp) +* [`redirectmatch_status`](#redirectmatch_status) +* [`redirectmatch_dest`](#redirectmatch_dest) +* [`request_headers`](#request_headers) +* [`rewrites`](#rewrites) +* [`rewrite_base`](#rewrite_base) +* [`rewrite_rule`](#rewrite_rule) +* [`rewrite_cond`](#rewrite_cond) +* [`rewrite_inherit`](#rewrite_inherit) +* [`scriptalias`](#scriptalias) +* [`scriptaliases`](#scriptaliases) +* [`serveradmin`](#serveradmin) +* [`serveraliases`](#serveraliases) +* [`servername`](#servername) +* [`setenv`](#setenv) +* [`setenvif`](#setenvif) +* [`setenvifnocase`](#setenvifnocase) +* [`suexec_user_group`](#suexec_user_group) +* [`suphp_addhandler`](#suphp_addhandler) +* [`suphp_configpath`](#suphp_configpath) +* [`suphp_engine`](#suphp_engine) +* [`vhost_name`](#vhost_name) +* [`virtual_docroot`](#virtual_docroot) +* [`virtual_use_default_docroot`](#virtual_use_default_docroot) +* [`wsgi_daemon_process`](#wsgi_daemon_process) +* [`wsgi_daemon_process_options`](#wsgi_daemon_process_options) +* [`wsgi_application_group`](#wsgi_application_group) +* [`wsgi_import_script`](#wsgi_import_script) +* [`wsgi_import_script_options`](#wsgi_import_script_options) +* [`wsgi_chunked_request`](#wsgi_chunked_request) +* [`wsgi_process_group`](#wsgi_process_group) +* [`wsgi_script_aliases`](#wsgi_script_aliases) +* [`wsgi_script_aliases_match`](#wsgi_script_aliases_match) +* [`wsgi_pass_authorization`](#wsgi_pass_authorization) +* [`directories`](#directories) +* [`custom_fragment`](#custom_fragment) +* [`error_documents`](#error_documents) +* [`h2_copy_files`](#h2_copy_files) +* [`h2_push_resource`](#h2_push_resource) +* [`headers`](#headers) +* [`options`](#options) +* [`shib_compat_valid_user`](#shib_compat_valid_user) +* [`ssl_options`](#ssl_options) +* [`additional_includes`](#additional_includes) +* [`gssapi`](#gssapi) +* [`ssl`](#ssl) +* [`ssl_ca`](#ssl_ca) +* [`ssl_cert`](#ssl_cert) +* [`ssl_protocol`](#ssl_protocol) +* [`ssl_cipher`](#ssl_cipher) +* [`ssl_honorcipherorder`](#ssl_honorcipherorder) +* [`ssl_certs_dir`](#ssl_certs_dir) +* [`ssl_chain`](#ssl_chain) +* [`ssl_crl`](#ssl_crl) +* [`ssl_crl_path`](#ssl_crl_path) +* [`ssl_crl_check`](#ssl_crl_check) +* [`ssl_key`](#ssl_key) +* [`ssl_verify_client`](#ssl_verify_client) +* [`ssl_verify_depth`](#ssl_verify_depth) +* [`ssl_proxy_protocol`](#ssl_proxy_protocol) +* [`ssl_proxy_verify`](#ssl_proxy_verify) +* [`ssl_proxy_verify_depth`](#ssl_proxy_verify_depth) +* [`ssl_proxy_cipher_suite`](#ssl_proxy_cipher_suite) +* [`ssl_proxy_ca_cert`](#ssl_proxy_ca_cert) +* [`ssl_proxy_machine_cert`](#ssl_proxy_machine_cert) +* [`ssl_proxy_machine_cert_chain`](#ssl_proxy_machine_cert_chain) +* [`ssl_proxy_check_peer_cn`](#ssl_proxy_check_peer_cn) +* [`ssl_proxy_check_peer_name`](#ssl_proxy_check_peer_name) +* [`ssl_proxy_check_peer_expire`](#ssl_proxy_check_peer_expire) +* [`ssl_options`](#ssl_options) +* [`ssl_openssl_conf_cmd`](#ssl_openssl_conf_cmd) +* [`ssl_proxyengine`](#ssl_proxyengine) +* [`ssl_stapling`](#ssl_stapling) +* [`ssl_stapling_timeout`](#ssl_stapling_timeout) +* [`ssl_stapling_return_errors`](#ssl_stapling_return_errors) +* [`ssl_user_name`](#ssl_user_name) +* [`ssl_reload_on_change`](#ssl_reload_on_change) +* [`use_canonical_name`](#use_canonical_name) +* [`define`](#define) +* [`auth_oidc`](#auth_oidc) +* [`oidc_settings`](#oidc_settings) +* [`limitreqfields`](#limitreqfields) +* [`limitreqfieldsize`](#limitreqfieldsize) +* [`limitreqline`](#limitreqline) +* [`limitreqbody`](#limitreqbody) +* [`$use_servername_for_filenames`](#$use_servername_for_filenames) +* [`$use_port_for_filenames`](#$use_port_for_filenames) +* [`$mdomain`](#$mdomain) +* [`use_servername_for_filenames`](#use_servername_for_filenames) +* [`use_port_for_filenames`](#use_port_for_filenames) +* [`proxy_requests`](#proxy_requests) +* [`mdomain`](#mdomain) + +##### `apache_version` + +Data type: `Any` + +Apache's version number as a string, such as '2.2' or '2.4'. + +Default value: `$apache::apache_version` + +##### `access_log` + +Data type: `Boolean` + +Determines whether to configure `*_access.log` directives (`*_file`,`*_pipe`, or `*_syslog`). + +Default value: ``true`` + +##### `access_log_env_var` + +Data type: `Any` + +Specifies that only requests with particular environment variables be logged. + +Default value: ``false`` + +##### `access_log_file` + +Data type: `Any` + +Sets the filename of the `*_access.log` placed in `logroot`. Given a virtual host ---for +instance, example.com--- it defaults to 'example.com_ssl.log' for +[SSL-encrypted](https://httpd.apache.org/docs/current/ssl/index.html) virtual hosts and +`example.com_access.log` for unencrypted virtual hosts. + +Default value: ``false`` + +##### `access_log_format` + +Data type: `Any` + +Specifies the use of either a `LogFormat` nickname or a custom-formatted string for the +access log. + +Default value: ``false`` + +##### `access_log_pipe` + +Data type: `Any` + +Specifies a pipe where Apache sends access log messages. + +Default value: ``false`` + +##### `access_log_syslog` + +Data type: `Any` + +Sends all access log messages to syslog. + +Default value: ``false`` + +##### `access_logs` + +Data type: `Optional[Array]` + +Allows you to give a hash that specifies the state of each of the `access_log_*` +directives shown above, i.e. `access_log_pipe` and `access_log_syslog`. + +Default value: ``undef`` + +##### `add_default_charset` + +Data type: `Any` + +Sets a default media charset value for the `AddDefaultCharset` directive, which is +added to `text/plain` and `text/html` responses. + +Default value: ``undef`` + +##### `add_listen` + +Data type: `Any` + +Determines whether the virtual host creates a `Listen` statement.
+Setting `add_listen` to `false` prevents the virtual host from creating a `Listen` +statement. This is important when combining virtual hosts that aren't passed an `ip` +parameter with those that are. + +Default value: ``true`` + +##### `use_optional_includes` + +Data type: `Any` + +Specifies whether Apache uses the `IncludeOptional` directive instead of `Include` for +`additional_includes` in Apache 2.4 or newer. + +Default value: `$apache::use_optional_includes` + +##### `additional_includes` + +Data type: `Any` + +Specifies paths to additional static, virtual host-specific Apache configuration files. +You can use this parameter to implement a unique, custom configuration not supported by +this module. + +Default value: `[]` + +##### `aliases` + +Data type: `Any` + +Passes a list of [hashes][hash] to the virtual host to create `Alias`, `AliasMatch`, +`ScriptAlias` or `ScriptAliasMatch` directives as per the `mod_alias` documentation.
+For example: +``` puppet +aliases => [ + { aliasmatch => '^/image/(.*)\.jpg$', + path => '/files/jpg.images/$1.jpg', + }, + { alias => '/image', + path => '/ftp/pub/image', + }, + { scriptaliasmatch => '^/cgi-bin(.*)', + path => '/usr/local/share/cgi-bin$1', + }, + { scriptalias => '/nagios/cgi-bin/', + path => '/usr/lib/nagios/cgi-bin/', + }, + { alias => '/nagios', + path => '/usr/share/nagios/html', + }, +], +``` +For the `alias`, `aliasmatch`, `scriptalias` and `scriptaliasmatch` keys to work, each needs +a corresponding context, such as `` or +``. Puppet creates the directives in the order specified in +the `aliases` parameter. As described in the `mod_alias` documentation, add more specific +`alias`, `aliasmatch`, `scriptalias` or `scriptaliasmatch` parameters before the more +general ones to avoid shadowing.
+> **Note**: Use the `aliases` parameter instead of the `scriptaliases` parameter because +you can precisely control the order of various alias directives. Defining `ScriptAliases` +using the `scriptaliases` parameter means *all* `ScriptAlias` directives will come after +*all* `Alias` directives, which can lead to `Alias` directives shadowing `ScriptAlias` +directives. This often causes problems; for example, this could cause problems with Nagios.
+If `apache::mod::passenger` is loaded and `PassengerHighPerformance` is `true`, the `Alias` +directive might not be able to honor the `PassengerEnabled => off` statement. See +[this article](http://www.conandalton.net/2010/06/passengerenabled-off-not-working.html) for details. + +Default value: ``undef`` + +##### `allow_encoded_slashes` + +Data type: `Optional[Enum['on', 'off', 'nodecode']]` + +Sets the `AllowEncodedSlashes` declaration for the virtual host, overriding the server +default. This modifies the virtual host responses to URLs with `\` and `/` characters. The +default setting omits the declaration from the server configuration and selects the +Apache default setting of `Off`. + +Default value: ``undef`` + +##### `block` + +Data type: `Any` + +Specifies the list of things to which Apache blocks access. Valid options are: `scm` (which +blocks web access to `.svn`), `.git`, and `.bzr` directories. + +Default value: `[]` + +##### `cas_attribute_prefix` + +Data type: `Any` + +Adds a header with the value of this header being the attribute values when SAML +validation is enabled. + +Default value: ``undef`` + +##### `cas_attribute_delimiter` + +Data type: `Any` + +Sets the delimiter between attribute values in the header created by `cas_attribute_prefix`. + +Default value: ``undef`` + +##### `cas_login_url` + +Data type: `Any` + +Sets the URL to which the module redirects users when they attempt to access a +CAS-protected resource and don't have an active session. + +Default value: ``undef`` + +##### `cas_root_proxied_as` + +Data type: `Any` + +Sets the URL end users see when access to this Apache server is proxied per vhost. +This URL should not include a trailing slash. + +Default value: ``undef`` + +##### `cas_scrub_request_headers` + +Data type: `Any` + +Remove inbound request headers that may have special meaning within mod_auth_cas. + +Default value: ``undef`` + +##### `cas_sso_enabled` + +Data type: `Any` + +Enables experimental support for single sign out (may mangle POST data). + +Default value: ``undef`` + +##### `cas_validate_saml` + +Data type: `Any` + +Parse response from CAS server for SAML. + +Default value: ``undef`` + +##### `cas_validate_url` + +Data type: `Any` + +Sets the URL to use when validating a client-presented ticket in an HTTP query string. + +Default value: ``undef`` + +##### `cas_cookie_path` + +Data type: `Any` + +Sets the location where information on the current session should be stored. This should +be writable by the web server only. + +Default value: ``undef`` + +##### `comment` + +Data type: `Optional[Variant[String,Array[String]]]` + +Adds comments to the header of the configuration file. Pass as string or an array of strings. +For example: +``` puppet +comment => "Account number: 123B", +``` +Or: +``` puppet +comment => [ + "Customer: X", + "Frontend domain: x.example.org", +] +``` + +Default value: ``undef`` + +##### `custom_fragment` + +Data type: `Optional[String]` + +Passes a string of custom configuration directives to place at the end of the virtual +host configuration. + +Default value: ``undef`` + +##### `default_vhost` + +Data type: `Boolean` + +Sets a given `apache::vhost` defined type as the default to serve requests that do not +match any other `apache::vhost` defined types. + +Default value: ``false`` + +##### `directoryindex` + +Data type: `Any` + +Sets the list of resources to look for when a client requests an index of the directory +by specifying a '/' at the end of the directory name. See the `DirectoryIndex` directive +documentation for details. + +Default value: `''` + +##### `docroot` + +Data type: `Variant[Boolean,String]` + +**Required**.
+Sets the `DocumentRoot` location, from which Apache serves files.
+If `docroot` and `manage_docroot` are both set to `false`, no `DocumentRoot` will be set +and the accompanying `` block will not be created. + +##### `docroot_group` + +Data type: `Any` + +Sets group access to the `docroot` directory. + +Default value: `$apache::params::root_group` + +##### `docroot_owner` + +Data type: `Any` + +Sets individual user access to the `docroot` directory. + +Default value: `'root'` + +##### `docroot_mode` + +Data type: `Any` + +Sets access permissions for the `docroot` directory, in numeric notation. + +Default value: ``undef`` + +##### `manage_docroot` + +Data type: `Any` + +Determines whether Puppet manages the `docroot` directory. + +Default value: ``true`` + +##### `error_log` + +Data type: `Boolean` + +Specifies whether `*_error.log` directives should be configured. + +Default value: ``true`` + +##### `error_log_file` + +Data type: `Any` + +Points the virtual host's error logs to a `*_error.log` file. If this parameter is +undefined, Puppet checks for values in `error_log_pipe`, then `error_log_syslog`.
+If none of these parameters is set, given a virtual host `example.com`, Puppet defaults +to `$logroot/example.com_error_ssl.log` for SSL virtual hosts and +`$logroot/example.com_error.log` for non-SSL virtual hosts. + +Default value: ``undef`` + +##### `error_log_pipe` + +Data type: `Any` + +Specifies a pipe to send error log messages to.
+This parameter has no effect if the `error_log_file` parameter has a value. If neither +this parameter nor `error_log_file` has a value, Puppet then checks `error_log_syslog`. + +Default value: ``undef`` + +##### `error_log_syslog` + +Data type: `Any` + +Determines whether to send all error log messages to syslog. +This parameter has no effect if either of the `error_log_file` or `error_log_pipe` +parameters has a value. If none of these parameters has a value, given a virtual host +`example.com`, Puppet defaults to `$logroot/example.com_error_ssl.log` for SSL virtual +hosts and `$logroot/example.com_error.log` for non-SSL virtual hosts. + +Default value: ``undef`` + +##### `error_log_format` + +Data type: `Optional[ + Array[ + Variant[ + String, + Hash[String, Enum['connection', 'request']] + ] + ] + ]` + +Sets the [ErrorLogFormat](https://httpd.apache.org/docs/current/mod/core.html#errorlogformat) +format specification for error log entries inside virtual host +For example: +``` puppet +apache::vhost { 'site.name.fdqn': + ... + error_log_format => [ + '[%{uc}t] [%-m:%-l] [R:%L] [C:%{C}L] %7F: %E: %M', + { '[%{uc}t] [R:%L] Request %k on C:%{c}L pid:%P tid:%T' => 'request' }, + { "[%{uc}t] [R:%L] UA:'%+{User-Agent}i'" => 'request' }, + { "[%{uc}t] [R:%L] Referer:'%+{Referer}i'" => 'request' }, + { '[%{uc}t] [C:%{c}L] local\ %a remote\ %A' => 'connection' }, + ], +} +``` + +Default value: ``undef`` + +##### `error_documents` + +Data type: `Any` + +A list of hashes which can be used to override the +[ErrorDocument](https://httpd.apache.org/docs/current/mod/core.html#errordocument) +settings for this virtual host.
+For example: +``` puppet +apache::vhost { 'sample.example.net': + error_documents => [ + { 'error_code' => '503', 'document' => '/service-unavail' }, + { 'error_code' => '407', 'document' => 'https://example.com/proxy/login' }, + ], +} +``` + +Default value: `[]` + +##### `ensure` + +Data type: `Enum['absent', 'present']` + +Specifies if the virtual host is present or absent.
+ +Default value: `'present'` + +##### `fallbackresource` + +Data type: `Optional[Variant[Stdlib::Absolutepath, Enum['disabled']]]` + +Sets the [FallbackResource](https://httpd.apache.org/docs/current/mod/mod_dir.html#fallbackresource) +directive, which specifies an action to take for any URL that doesn't map to anything in +your filesystem and would otherwise return 'HTTP 404 (Not Found)'. Values must either begin +with a `/` or be `disabled`. + +Default value: ``undef`` + +##### `fastcgi_server` + +Data type: `Any` + +Specify an external FastCGI server to manage a connection to. + +Default value: ``undef`` + +##### `fastcgi_socket` + +Data type: `Any` + +Specify the socket that will be used to communicate with an external FastCGI server. + +Default value: ``undef`` + +##### `fastcgi_idle_timeout` + +Data type: `Any` + +If using fastcgi, this option sets the timeout for the server to respond. + +Default value: ``undef`` + +##### `fastcgi_dir` + +Data type: `Any` + +Specify an internal FastCGI directory that is to be managed. + +Default value: ``undef`` + +##### `filters` + +Data type: `Any` + +[Filters](https://httpd.apache.org/docs/current/mod/mod_filter.html) enable smart, +context-sensitive configuration of output content filters. +``` puppet +apache::vhost { "$::fqdn": + filters => [ + 'FilterDeclare COMPRESS', + 'FilterProvider COMPRESS DEFLATE resp=Content-Type $text/html', + 'FilterChain COMPRESS', + 'FilterProtocol COMPRESS DEFLATE change=yes;byteranges=no', + ], +} +``` + +Default value: ``undef`` + +##### `h2_copy_files` + +Data type: `Optional[Boolean]` + +Sets the [H2CopyFiles](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2copyfiles) +directive which influences how the requestion process pass files to the main connection. + +Default value: ``undef`` + +##### `h2_direct` + +Data type: `Optional[Boolean]` + +Sets the [H2Direct](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2direct) +directive which toggles the usage of the HTTP/2 Direct Mode. + +Default value: ``undef`` + +##### `h2_early_hints` + +Data type: `Optional[Boolean]` + +Sets the [H2EarlyHints](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2earlyhints) +directive which controls if HTTP status 103 interim responses are forwarded to +the client or not. + +Default value: ``undef`` + +##### `h2_max_session_streams` + +Data type: `Optional[Integer]` + +Sets the [H2MaxSessionStreams](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2maxsessionstreams) +directive which sets the maximum number of active streams per HTTP/2 session +that the server allows. + +Default value: ``undef`` + +##### `h2_modern_tls_only` + +Data type: `Optional[Boolean]` + +Sets the [H2ModernTLSOnly](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2moderntlsonly) +directive which toggles the security checks on HTTP/2 connections in TLS mode. + +Default value: ``undef`` + +##### `h2_push` + +Data type: `Optional[Boolean]` + +Sets the [H2Push](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2push) +directive which toggles the usage of the HTTP/2 server push protocol feature. + +Default value: ``undef`` + +##### `h2_push_diary_size` + +Data type: `Optional[Integer]` + +Sets the [H2PushDiarySize](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2pushdiarysize) +directive which toggles the maximum number of HTTP/2 server pushes that are +remembered per HTTP/2 connection. + +Default value: ``undef`` + +##### `h2_push_priority` + +Data type: `Array[String]` + +Sets the [H2PushPriority](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2pushpriority) +directive which defines the priority handling of pushed responses based on the +content-type of the response. + +Default value: `[]` + +##### `h2_push_resource` + +Data type: `Array[String]` + +Sets the [H2PushResource](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2pushresource) +directive which declares resources for early pushing to the client. + +Default value: `[]` + +##### `h2_serialize_headers` + +Data type: `Optional[Boolean]` + +Sets the [H2SerializeHeaders](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2serializeheaders) +directive which toggles if HTTP/2 requests are serialized in HTTP/1.1 +format for processing by httpd core. + +Default value: ``undef`` + +##### `h2_stream_max_mem_size` + +Data type: `Optional[Integer]` + +Sets the [H2StreamMaxMemSize](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2streammaxmemsize) +directive which sets the maximum number of outgoing data bytes buffered in +memory for an active stream. + +Default value: ``undef`` + +##### `h2_tls_cool_down_secs` + +Data type: `Optional[Integer]` + +Sets the [H2TLSCoolDownSecs](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2tlscooldownsecs) +directive which sets the number of seconds of idle time on a TLS connection +before the TLS write size falls back to a small (~1300 bytes) length. + +Default value: ``undef`` + +##### `h2_tls_warm_up_size` + +Data type: `Optional[Integer]` + +Sets the [H2TLSWarmUpSize](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2tlswarmupsize) +directive which sets the number of bytes to be sent in small TLS records (~1300 +bytes) until doing maximum sized writes (16k) on https: HTTP/2 connections. + +Default value: ``undef`` + +##### `h2_upgrade` + +Data type: `Optional[Boolean]` + +Sets the [H2Upgrade](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2upgrade) +directive which toggles the usage of the HTTP/1.1 Upgrade method for switching +to HTTP/2. + +Default value: ``undef`` + +##### `h2_window_size` + +Data type: `Optional[Integer]` + +Sets the [H2WindowSize](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2windowsize) +directive which sets the size of the window that is used for flow control from +client to server and limits the amount of data the server has to buffer. + +Default value: ``undef`` + +##### `headers` + +Data type: `Any` + +Adds lines to replace, merge, or remove response headers. See +[Apache's mod_headers documentation](https://httpd.apache.org/docs/current/mod/mod_headers.html#header) for more information. + +Default value: ``undef`` + +##### `ip` + +Data type: `Any` + +Sets the IP address the virtual host listens on. By default, uses Apache's default behavior +of listening on all IPs. + +Default value: ``undef`` + +##### `ip_based` + +Data type: `Boolean` + +Enables an [IP-based](https://httpd.apache.org/docs/current/vhosts/ip-based.html) virtual +host. This parameter inhibits the creation of a NameVirtualHost directive, since those are +used to funnel requests to name-based virtual hosts. + +Default value: ``false`` + +##### `itk` + +Data type: `Optional[Hash]` + +Configures [ITK](http://mpm-itk.sesse.net/) in a hash.
+Usage typically looks something like: +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + itk => { + user => 'someuser', + group => 'somegroup', + }, +} +``` +Valid values are: a hash, which can include the keys: +* `user` + `group` +* `assignuseridexpr` +* `assigngroupidexpr` +* `maxclientvhost` +* `nice` +* `limituidrange` (Linux 3.5.0 or newer) +* `limitgidrange` (Linux 3.5.0 or newer) + +Default value: ``undef`` + +##### `action` + +Data type: `Any` + +Specifies whether you wish to configure mod_actions action directive which will +activate cgi-script when triggered by a request. + +Default value: ``undef`` + +##### `jk_mounts` + +Data type: `Any` + +Sets up a virtual host with `JkMount` and `JkUnMount` directives to handle the paths +for URL mapping between Tomcat and Apache.
+The parameter must be an array of hashes where each hash must contain the `worker` +and either the `mount` or `unmount` keys.
+Usage typically looks like: +``` puppet +apache::vhost { 'sample.example.net': + jk_mounts => [ + { mount => '/*', worker => 'tcnode1', }, + { unmount => '/*.jpg', worker => 'tcnode1', }, + ], +} +``` + +Default value: ``undef`` + +##### `http_protocol_options` + +Data type: `Optional[Pattern[/^((Strict|Unsafe)?\s*(\b(Registered|Lenient)Methods)?\s*(\b(Allow0\.9|Require1\.0))?)$/]]` + +Specifies the strictness of HTTP protocol checks. + +Default value: ``undef`` + +##### `keepalive` + +Data type: `Optional[Enum['on', 'off']]` + +Determines whether to enable persistent HTTP connections with the `KeepAlive` directive +for the virtual host. By default, the global, server-wide `KeepAlive` setting is in effect.
+Use the `keepalive_timeout` and `max_keepalive_requests` parameters to set relevant options +for the virtual host. + +Default value: ``undef`` + +##### `keepalive_timeout` + +Data type: `Any` + +Sets the `KeepAliveTimeout` directive for the virtual host, which determines the amount +of time to wait for subsequent requests on a persistent HTTP connection. By default, the +global, server-wide `KeepAlive` setting is in effect.
+This parameter is only relevant if either the global, server-wide `keepalive` parameter or +the per-vhost `keepalive` parameter is enabled. + +Default value: ``undef`` + +##### `max_keepalive_requests` + +Data type: `Any` + +Limits the number of requests allowed per connection to the virtual host. By default, +the global, server-wide `KeepAlive` setting is in effect.
+This parameter is only relevant if either the global, server-wide `keepalive` parameter or +the per-vhost `keepalive` parameter is enabled. + +Default value: ``undef`` + +##### `auth_kerb` + +Data type: `Boolean` + +Enable `mod_auth_kerb` parameters for a virtual host.
+Usage typically looks like: +``` puppet +apache::vhost { 'sample.example.net': + auth_kerb => `true`, + krb_method_negotiate => 'on', + krb_auth_realms => ['EXAMPLE.ORG'], + krb_local_user_mapping => 'on', + directories => { + path => '/var/www/html', + auth_name => 'Kerberos Login', + auth_type => 'Kerberos', + auth_require => 'valid-user', + }, +} +``` + +Default value: ``false`` + +##### `krb_method_negotiate` + +Data type: `Any` + +Determines whether to use the Negotiate method. + +Default value: `'on'` + +##### `krb_method_k5passwd` + +Data type: `Any` + +Determines whether to use password-based authentication for Kerberos v5. + +Default value: `'on'` + +##### `krb_authoritative` + +Data type: `Any` + +If set to `off`, authentication controls can be passed on to another module. + +Default value: `'on'` + +##### `krb_auth_realms` + +Data type: `Any` + +Specifies an array of Kerberos realms to use for authentication. + +Default value: `[]` + +##### `krb_5keytab` + +Data type: `Any` + +Specifies the Kerberos v5 keytab file's location. + +Default value: ``undef`` + +##### `krb_local_user_mapping` + +Data type: `Any` + +Strips @REALM from usernames for further use. + +Default value: ``undef`` + +##### `krb_verify_kdc` + +Data type: `Any` + +This option can be used to disable the verification tickets against local keytab to prevent +KDC spoofing attacks. + +Default value: `'on'` + +##### `krb_servicename` + +Data type: `Any` + +Specifies the service name that will be used by Apache for authentication. Corresponding +key of this name must be stored in the keytab. + +Default value: `'HTTP'` + +##### `krb_save_credentials` + +Data type: `Any` + +This option enables credential saving functionality. + +Default value: `'off'` + +##### `logroot` + +Data type: `Any` + +Specifies the location of the virtual host's logfiles. + +Default value: `$apache::logroot` + +##### `logroot_ensure` + +Data type: `Enum['directory', 'absent']` + +Determines whether or not to remove the logroot directory for a virtual host. + +Default value: `'directory'` + +##### `logroot_mode` + +Data type: `Any` + +Overrides the mode the logroot directory is set to. Do *not* grant write access to the +directory the logs are stored in without being aware of the consequences; for more +information, see [Apache's log security documentation](https://httpd.apache.org/docs/2.4/logs.html#security). + +Default value: ``undef`` + +##### `logroot_owner` + +Data type: `Any` + +Sets individual user access to the logroot directory. + +Default value: ``undef`` + +##### `logroot_group` + +Data type: `Any` + +Sets group access to the `logroot` directory. + +Default value: ``undef`` + +##### `log_level` + +Data type: `Optional[Apache::LogLevel]` + +Specifies the verbosity of the error log. + +Default value: ``undef`` + +##### `modsec_body_limit` + +Data type: `Any` + +Configures the maximum request body size (in bytes) ModSecurity accepts for buffering. + +Default value: ``undef`` + +##### `modsec_disable_vhost` + +Data type: `Any` + +Disables `mod_security` on a virtual host. Only valid if `apache::mod::security` is included. + +Default value: ``undef`` + +##### `modsec_disable_ids` + +Data type: `Optional[Variant[Hash, Array]]` + +Removes `mod_security` IDs from the virtual host.
+Also takes a hash allowing removal of an ID from a specific location. +``` puppet +apache::vhost { 'sample.example.net': + modsec_disable_ids => [ 90015, 90016 ], +} +``` + +``` puppet +apache::vhost { 'sample.example.net': + modsec_disable_ids => { '/location1' => [ 90015, 90016 ] }, +} +``` + +Default value: ``undef`` + +##### `modsec_disable_ips` + +Data type: `Any` + +Specifies an array of IP addresses to exclude from `mod_security` rule matching. + +Default value: ``undef`` + +##### `modsec_disable_msgs` + +Data type: `Optional[Variant[Hash, Array]]` + +Array of mod_security Msgs to remove from the virtual host. Also takes a hash allowing +removal of an Msg from a specific location. +``` puppet +apache::vhost { 'sample.example.net': + modsec_disable_msgs => ['Blind SQL Injection Attack', 'Session Fixation Attack'], +} +``` +``` puppet +apache::vhost { 'sample.example.net': + modsec_disable_msgs => { '/location1' => ['Blind SQL Injection Attack', 'Session Fixation Attack'] }, +} +``` + +Default value: ``undef`` + +##### `modsec_disable_tags` + +Data type: `Optional[Variant[Hash, Array]]` + +Array of mod_security Tags to remove from the virtual host. Also takes a hash allowing +removal of an Tag from a specific location. +``` puppet +apache::vhost { 'sample.example.net': + modsec_disable_tags => ['WEB_ATTACK/SQL_INJECTION', 'WEB_ATTACK/XSS'], +} +``` +``` puppet +apache::vhost { 'sample.example.net': + modsec_disable_tags => { '/location1' => ['WEB_ATTACK/SQL_INJECTION', 'WEB_ATTACK/XSS'] }, +} +``` + +Default value: ``undef`` + +##### `modsec_audit_log_file` + +Data type: `Any` + +If set, it is relative to `logroot`.
+One of the parameters that determines how to send `mod_security` audit +log ([SecAuditLog](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#SecAuditLog)). +If none of those parameters are set, the global audit log is used +(`/var/log/httpd/modsec\_audit.log`; Debian and derivatives: `/var/log/apache2/modsec\_audit.log`; others: ). + +Default value: ``undef`` + +##### `modsec_audit_log_pipe` + +Data type: `Any` + +If `modsec_audit_log_pipe` is set, it should start with a pipe. Example +`|/path/to/mlogc /path/to/mlogc.conf`.
+One of the parameters that determines how to send `mod_security` audit +log ([SecAuditLog](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#SecAuditLog)). +If none of those parameters are set, the global audit log is used +(`/var/log/httpd/modsec\_audit.log`; Debian and derivatives: `/var/log/apache2/modsec\_audit.log`; others: ). + +Default value: ``undef`` + +##### `modsec_audit_log` + +Data type: `Any` + +If `modsec_audit_log` is `true`, given a virtual host ---for instance, example.com--- it +defaults to `example.com\_security\_ssl.log` for SSL-encrypted virtual hosts +and `example.com\_security.log` for unencrypted virtual hosts.
+One of the parameters that determines how to send `mod_security` audit +log ([SecAuditLog](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#SecAuditLog)).
+If none of those parameters are set, the global audit log is used +(`/var/log/httpd/modsec\_audit.log`; Debian and derivatives: `/var/log/apache2/modsec\_audit.log`; others: ). + +Default value: ``undef`` + +##### `no_proxy_uris` + +Data type: `Any` + +Specifies URLs you do not want to proxy. This parameter is meant to be used in combination +with [`proxy_dest`](#proxy_dest). + +Default value: `[]` + +##### `no_proxy_uris_match` + +Data type: `Any` + +This directive is equivalent to `no_proxy_uris`, but takes regular expressions. + +Default value: `[]` + +##### `proxy_preserve_host` + +Data type: `Any` + +Sets the [ProxyPreserveHost Directive](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypreservehost).
+Setting this parameter to `true` enables the `Host:` line from an incoming request to be +proxied to the host instead of hostname. Setting it to `false` sets this directive to 'Off'. + +Default value: ``false`` + +##### `proxy_add_headers` + +Data type: `Any` + +Sets the [ProxyAddHeaders Directive](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyaddheaders).
+This parameter controlls whether proxy-related HTTP headers (X-Forwarded-For, +X-Forwarded-Host and X-Forwarded-Server) get sent to the backend server. + +Default value: ``undef`` + +##### `proxy_error_override` + +Data type: `Any` + +Sets the [ProxyErrorOverride Directive](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyerroroverride). +This directive controls whether Apache should override error pages for proxied content. + +Default value: ``false`` + +##### `options` + +Data type: `Any` + +Sets the `Options` for the specified virtual host. For example: +``` puppet +apache::vhost { 'site.name.fdqn': + ... + options => ['Indexes','FollowSymLinks','MultiViews'], +} +``` +> **Note**: If you use the `directories` parameter of `apache::vhost`, 'Options', +'Override', and 'DirectoryIndex' are ignored because they are parameters within `directories`. + +Default value: `['Indexes','FollowSymLinks','MultiViews']` + +##### `override` + +Data type: `Any` + +Sets the overrides for the specified virtual host. Accepts an array of +[AllowOverride](https://httpd.apache.org/docs/current/mod/core.html#allowoverride) arguments. + +Default value: `['None']` + +##### `passenger_enabled` + +Data type: `Optional[Boolean]` + +Sets the value for the [PassengerEnabled](http://www.modrails.com/documentation/Users%20guide%20Apache.html#PassengerEnabled) +directive to `on` or `off`. Requires `apache::mod::passenger` to be included. +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + passenger_enabled => 'on', + }, + ], +} +``` +> **Note:** There is an [issue](http://www.conandalton.net/2010/06/passengerenabled-off-not-working.html) +using the PassengerEnabled directive with the PassengerHighPerformance directive. + +Default value: ``undef`` + +##### `passenger_base_uri` + +Data type: `Optional[String]` + +Sets [PassengerBaseURI](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerbase_rui), + to specify that the given URI is a distinct application served by Passenger. + +Default value: ``undef`` + +##### `passenger_ruby` + +Data type: `Optional[Stdlib::Absolutepath]` + +Sets [PassengerRuby](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerruby), +specifying the Ruby interpreter to use when serving the relevant web applications. + +Default value: ``undef`` + +##### `passenger_python` + +Data type: `Optional[Stdlib::Absolutepath]` + +Sets [PassengerPython](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerpython), +specifying the Python interpreter to use when serving the relevant web applications. + +Default value: ``undef`` + +##### `passenger_nodejs` + +Data type: `Optional[Stdlib::Absolutepath]` + +Sets the [`PassengerNodejs`](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengernodejs), +specifying Node.js command to use when serving the relevant web applications. + +Default value: ``undef`` + +##### `passenger_meteor_app_settings` + +Data type: `Optional[String]` + +Sets [PassengerMeteorAppSettings](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermeteorappsettings), +specifying a JSON file with settings for the application when using a Meteor +application in non-bundled mode. + +Default value: ``undef`` + +##### `passenger_app_env` + +Data type: `Optional[String]` + +Sets [PassengerAppEnv](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerappenv), +the environment for the Passenger application. If not specified, defaults to the global +setting or 'production'. + +Default value: ``undef`` + +##### `passenger_app_root` + +Data type: `Optional[Stdlib::Absolutepath]` + +Sets [PassengerRoot](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerapproot), +the location of the Passenger application root if different from the DocumentRoot. + +Default value: ``undef`` + +##### `passenger_app_group_name` + +Data type: `Optional[String]` + +Sets [PassengerAppGroupName](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerappgroupname), + the name of the application group that the current application should belong to. + +Default value: ``undef`` + +##### `passenger_app_start_command` + +Data type: `Optional[String]` + +Sets [PassengerAppStartCommand](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerappstartcommand), + how Passenger should start your app on a specific port. + +Default value: ``undef`` + +##### `passenger_app_type` + +Data type: `Optional[Enum['meteor', 'node', 'rack', 'wsgi']]` + +Sets [PassengerAppType](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerapptype), + to force Passenger to recognize the application as a specific type. + +Default value: ``undef`` + +##### `passenger_startup_file` + +Data type: `Optional[String]` + +Sets the [PassengerStartupFile](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstartupfile), +path. This path is relative to the application root. + +Default value: ``undef`` + +##### `passenger_restart_dir` + +Data type: `Optional[String]` + +Sets the [PassengerRestartDir](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerrestartdir), + to customize the directory in which `restart.txt` is searched for. + +Default value: ``undef`` + +##### `passenger_spawn_method` + +Data type: `Optional[Enum['direct', 'smart']]` + +Sets [PassengerSpawnMethod](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerspawnmethod), +whether Passenger spawns applications directly, or using a prefork copy-on-write mechanism. + +Default value: ``undef`` + +##### `passenger_load_shell_envvars` + +Data type: `Optional[Boolean]` + +Sets [PassengerLoadShellEnvvars](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerloadshellenvvars), +to enable or disable the loading of shell environment variables before spawning the application. + +Default value: ``undef`` + +##### `passenger_rolling_restarts` + +Data type: `Optional[Boolean]` + +Sets [PassengerRollingRestarts](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerrollingrestarts), +to enable or disable support for zero-downtime application restarts through `restart.txt`. + +Default value: ``undef`` + +##### `passenger_resist_deployment_errors` + +Data type: `Optional[Boolean]` + +Sets [PassengerResistDeploymentErrors](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerresistdeploymenterrors), +to enable or disable resistance against deployment errors. + +Default value: ``undef`` + +##### `passenger_user` + +Data type: `Optional[String]` + +Sets [PassengerUser](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengeruser), +the running user for sandboxing applications. + +Default value: ``undef`` + +##### `passenger_group` + +Data type: `Optional[String]` + +Sets [PassengerGroup](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengergroup), +the running group for sandboxing applications. + +Default value: ``undef`` + +##### `passenger_friendly_error_pages` + +Data type: `Optional[Boolean]` + +Sets [PassengerFriendlyErrorPages](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerfriendlyerrorpages), +which can display friendly error pages whenever an application fails to start. This +friendly error page presents the startup error message, some suggestions for solving +the problem, a backtrace and a dump of the environment variables. + +Default value: ``undef`` + +##### `passenger_min_instances` + +Data type: `Optional[Integer]` + +Sets [PassengerMinInstances](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermininstances), +the minimum number of application processes to run. + +Default value: ``undef`` + +##### `passenger_max_instances` + +Data type: `Optional[Integer]` + +Sets [PassengerMaxInstances](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxinstances), +the maximum number of application processes to run. + +Default value: ``undef`` + +##### `passenger_max_preloader_idle_time` + +Data type: `Optional[Integer]` + +Sets [PassengerMaxPreloaderIdleTime](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxpreloaderidletime), +the maximum amount of time the preloader waits before shutting down an idle process. + +Default value: ``undef`` + +##### `passenger_force_max_concurrent_requests_per_process` + +Data type: `Optional[Integer]` + +Sets [PassengerForceMaxConcurrentRequestsPerProcess](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerforcemaxconcurrentrequestsperprocess), +the maximum amount of concurrent requests the application can handle per process. + +Default value: ``undef`` + +##### `passenger_start_timeout` + +Data type: `Optional[Integer]` + +Sets [PassengerStartTimeout](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstarttimeout), +the timeout for the application startup. + +Default value: ``undef`` + +##### `passenger_concurrency_model` + +Data type: `Optional[Enum['process', 'thread']]` + +Sets [PassengerConcurrencyModel](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerconcurrencyodel), +to specify the I/O concurrency model that should be used for Ruby application processes. +Passenger supports two concurrency models:
+* `process` - single-threaded, multi-processed I/O concurrency. +* `thread` - multi-threaded, multi-processed I/O concurrency. + +Default value: ``undef`` + +##### `passenger_thread_count` + +Data type: `Optional[Integer]` + +Sets [PassengerThreadCount](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerthreadcount), +the number of threads that Passenger should spawn per Ruby application process.
+This option only has effect if PassengerConcurrencyModel is `thread`. + +Default value: ``undef`` + +##### `passenger_max_requests` + +Data type: `Optional[Integer]` + +Sets [PassengerMaxRequests](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxrequests), +the maximum number of requests an application process will process. + +Default value: ``undef`` + +##### `passenger_max_request_time` + +Data type: `Optional[Integer]` + +Sets [PassengerMaxRequestTime](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxrequesttime), +the maximum amount of time, in seconds, that an application process may take to +process a request. + +Default value: ``undef`` + +##### `passenger_memory_limit` + +Data type: `Optional[Integer]` + +Sets [PassengerMemoryLimit](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermemorylimit), +the maximum amount of memory that an application process may use, in megabytes. + +Default value: ``undef`` + +##### `passenger_stat_throttle_rate` + +Data type: `Optional[Integer]` + +Sets [PassengerStatThrottleRate](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstatthrottlerate), +to set a limit, in seconds, on how often Passenger will perform it's filesystem checks. + +Default value: ``undef`` + +##### `passenger_pre_start` + +Data type: `Optional[Variant[String,Array[String]]]` + +Sets [PassengerPreStart](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerprestart), +the URL of the application if pre-starting is required. + +Default value: ``undef`` + +##### `passenger_high_performance` + +Data type: `Optional[Boolean]` + +Sets [PassengerHighPerformance](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerhighperformance), +to enhance performance in return for reduced compatibility. + +Default value: ``undef`` + +##### `passenger_buffer_upload` + +Data type: `Optional[Boolean]` + +Sets [PassengerBufferUpload](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerbufferupload), +to buffer HTTP client request bodies before they are sent to the application. + +Default value: ``undef`` + +##### `passenger_buffer_response` + +Data type: `Optional[Boolean]` + +Sets [PassengerBufferResponse](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerbufferresponse), +to buffer Happlication-generated responses. + +Default value: ``undef`` + +##### `passenger_error_override` + +Data type: `Optional[Boolean]` + +Sets [PassengerErrorOverride](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengererroroverride), +to specify whether Apache will intercept and handle response with HTTP status codes of +400 and higher. + +Default value: ``undef`` + +##### `passenger_max_request_queue_size` + +Data type: `Optional[Integer]` + +Sets [PassengerMaxRequestQueueSize](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxrequestqueuesize), +to specify the maximum amount of requests that are allowed to queue whenever the maximum +concurrent request limit is reached. If the queue is already at this specified limit, then +Passenger immediately sends a "503 Service Unavailable" error to any incoming requests.
+A value of 0 means that the queue size is unbounded. + +Default value: ``undef`` + +##### `passenger_max_request_queue_time` + +Data type: `Optional[Integer]` + +Sets [PassengerMaxRequestQueueTime](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxrequestqueuetime), +to specify the maximum amount of time that requests are allowed to stay in the queue +whenever the maximum concurrent request limit is reached. If a request reaches this specified +limit, then Passenger immeaditly sends a "504 Gateway Timeout" error for that request.
+A value of 0 means that the queue time is unbounded. + +Default value: ``undef`` + +##### `passenger_sticky_sessions` + +Data type: `Optional[Boolean]` + +Sets [PassengerStickySessions](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstickysessions), +to specify that, whenever possible, all requests sent by a client will be routed to the same +originating application process. + +Default value: ``undef`` + +##### `passenger_sticky_sessions_cookie_name` + +Data type: `Optional[String]` + +Sets [PassengerStickySessionsCookieName](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstickysessionscookiename), +to specify the name of the sticky sessions cookie. + +Default value: ``undef`` + +##### `passenger_sticky_sessions_cookie_attributes` + +Data type: `Optional[String]` + +Sets [PassengerStickySessionsCookieAttributes](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstickysessionscookieattributes), +the attributes of the sticky sessions cookie. + +Default value: ``undef`` + +##### `passenger_allow_encoded_slashes` + +Data type: `Optional[Boolean]` + +Sets [PassengerAllowEncodedSlashes](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerallowencodedslashes), +to allow URLs with encoded slashes. Please note that this feature will not work properly +unless Apache's `AllowEncodedSlashes` is also enabled. + +Default value: ``undef`` + +##### `passenger_app_log_file` + +Data type: `Optional[String]` + +Sets [PassengerAppLogFile](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerapplogfile), +app specific messages logged to a different file in addition to Passenger log file. + +Default value: ``undef`` + +##### `passenger_debugger` + +Data type: `Optional[Boolean]` + +Sets [PassengerDebugger](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerdebugger), +to turn support for Ruby application debugging on or off. + +Default value: ``undef`` + +##### `passenger_lve_min_uid` + +Data type: `Optional[Integer]` + +Sets [PassengerLveMinUid](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerlveminuid), +to only allow the spawning of application processes with UIDs equal to, or higher than, this +specified value on LVE-enabled kernels. + +Default value: ``undef`` + +##### `php_values` + +Data type: `Any` + +Allows per-virtual host setting [`php_value`s](http://php.net/manual/en/configuration.changes.php). +These flags or values can be overwritten by a user or an application. +Within a vhost declaration: +``` puppet + php_values => [ 'include_path ".:/usr/local/example-app/include"' ], +``` + +Default value: `{}` + +##### `php_flags` + +Data type: `Any` + +Allows per-virtual host setting [`php_flags\``](http://php.net/manual/en/configuration.changes.php). +These flags or values can be overwritten by a user or an application. + +Default value: `{}` + +##### `php_admin_values` + +Data type: `Any` + +Allows per-virtual host setting [`php_admin_value`](http://php.net/manual/en/configuration.changes.php). +These flags or values cannot be overwritten by a user or an application. + +Default value: `{}` + +##### `php_admin_flags` + +Data type: `Any` + +Allows per-virtual host setting [`php_admin_flag`](http://php.net/manual/en/configuration.changes.php). +These flags or values cannot be overwritten by a user or an application. + +Default value: `{}` + +##### `port` + +Data type: `Any` + +Sets the port the host is configured on. The module's defaults ensure the host listens +on port 80 for non-SSL virtual hosts and port 443 for SSL virtual hosts. The host only +listens on the port set in this parameter. + +Default value: ``undef`` + +##### `priority` + +Data type: `Any` + +Sets the relative load-order for Apache HTTPD VirtualHost configuration files.
+If nothing matches the priority, the first name-based virtual host is used. Likewise, +passing a higher priority causes the alphabetically first name-based virtual host to be +used if no other names match.
+> **Note:** You should not need to use this parameter. However, if you do use it, be +aware that the `default_vhost` parameter for `apache::vhost` passes a priority of '15'.
+To omit the priority prefix in file names, pass a priority of `false`. + +Default value: ``undef`` + +##### `protocols` + +Data type: `Array[Enum['h2', 'h2c', 'http/1.1']]` + +Sets the [Protocols](https://httpd.apache.org/docs/current/en/mod/core.html#protocols) +directive, which lists available protocols for the virutal host. + +Default value: `[]` + +##### `protocols_honor_order` + +Data type: `Optional[Boolean]` + +Sets the [ProtocolsHonorOrder](https://httpd.apache.org/docs/current/en/mod/core.html#protocolshonororder) +directive which determines wether the order of Protocols sets precedence during negotiation. + +Default value: ``undef`` + +##### `proxy_dest` + +Data type: `Any` + +Specifies the destination address of a [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass) configuration. + +Default value: ``undef`` + +##### `proxy_pass` + +Data type: `Any` + +Specifies an array of `path => URI` values for a [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass) +configuration. Optionally, parameters can be added as an array. +``` puppet +apache::vhost { 'site.name.fdqn': + ... + proxy_pass => [ + { 'path' => '/a', 'url' => 'http://backend-a/' }, + { 'path' => '/b', 'url' => 'http://backend-b/' }, + { 'path' => '/c', 'url' => 'http://backend-a/c', 'params' => {'max'=>20, 'ttl'=>120, 'retry'=>300}}, + { 'path' => '/l', 'url' => 'http://backend-xy', + 'reverse_urls' => ['http://backend-x', 'http://backend-y'] }, + { 'path' => '/d', 'url' => 'http://backend-a/d', + 'params' => { 'retry' => '0', 'timeout' => '5' }, }, + { 'path' => '/e', 'url' => 'http://backend-a/e', + 'keywords' => ['nocanon', 'interpolate'] }, + { 'path' => '/f', 'url' => 'http://backend-f/', + 'setenv' => ['proxy-nokeepalive 1','force-proxy-request-1.0 1']}, + { 'path' => '/g', 'url' => 'http://backend-g/', + 'reverse_cookies' => [{'path' => '/g', 'url' => 'http://backend-g/',}, {'domain' => 'http://backend-g', 'url' => 'http:://backend-g',},], }, + { 'path' => '/h', 'url' => 'http://backend-h/h', + 'no_proxy_uris' => ['/h/admin', '/h/server-status'] }, + ], +} +``` +* `reverse_urls`. *Optional.* This setting is useful when used with `mod_proxy_balancer`. Values: an array or string. +* `reverse_cookies`. *Optional.* Sets `ProxyPassReverseCookiePath` and `ProxyPassReverseCookieDomain`. +* `params`. *Optional.* Allows for ProxyPass key-value parameters, such as connection settings. +* `setenv`. *Optional.* Sets [environment variables](https://httpd.apache.org/docs/current/mod/mod_proxy.html#envsettings) for the proxy directive. Values: array. + +Default value: ``undef`` + +##### `proxy_dest_match` + +Data type: `Any` + +This directive is equivalent to `proxy_dest`, but takes regular expressions, see +[ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch) +for details. + +Default value: ``undef`` + +##### `proxy_dest_reverse_match` + +Data type: `Any` + +Allows you to pass a ProxyPassReverse if `proxy_dest_match` is specified. See +[ProxyPassReverse](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassreverse) +for details. + +Default value: ``undef`` + +##### `proxy_pass_match` + +Data type: `Any` + +This directive is equivalent to `proxy_pass`, but takes regular expressions, see +[ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch) +for details. + +Default value: ``undef`` + +##### `redirect_dest` + +Data type: `Any` + +Specifies the address to redirect to. + +Default value: ``undef`` + +##### `redirect_source` + +Data type: `Any` + +Specifies the source URIs that redirect to the destination specified in `redirect_dest`. +If more than one item for redirect is supplied, the source and destination must be the same +length, and the items are order-dependent. +``` puppet +apache::vhost { 'site.name.fdqn': + ... + redirect_source => ['/images','/downloads'], + redirect_dest => ['http://img.example.com/','http://downloads.example.com/'], +} +``` + +Default value: `'/'` + +##### `redirect_status` + +Data type: `Any` + +Specifies the status to append to the redirect. +``` puppet + apache::vhost { 'site.name.fdqn': + ... + redirect_status => ['temp','permanent'], +} +``` + +Default value: ``undef`` + +##### `redirectmatch_regexp` + +Data type: `Any` + +Determines which server status should be raised for a given regular expression +and where to forward the user to. Entered as an array alongside redirectmatch_status +and redirectmatch_dest. +``` puppet +apache::vhost { 'site.name.fdqn': + ... + redirectmatch_status => ['404','404'], + redirectmatch_regexp => ['\.git(/.*|$)/','\.svn(/.*|$)'], + redirectmatch_dest => ['http://www.example.com/$1','http://www.example.com/$2'], +} +``` + +Default value: ``undef`` + +##### `redirectmatch_status` + +Data type: `Any` + +Determines which server status should be raised for a given regular expression +and where to forward the user to. Entered as an array alongside redirectmatch_regexp +and redirectmatch_dest. +``` puppet +apache::vhost { 'site.name.fdqn': + ... + redirectmatch_status => ['404','404'], + redirectmatch_regexp => ['\.git(/.*|$)/','\.svn(/.*|$)'], + redirectmatch_dest => ['http://www.example.com/$1','http://www.example.com/$2'], +} +``` + +Default value: ``undef`` + +##### `redirectmatch_dest` + +Data type: `Any` + +Determines which server status should be raised for a given regular expression +and where to forward the user to. Entered as an array alongside redirectmatch_status +and redirectmatch_regexp. +``` puppet +apache::vhost { 'site.name.fdqn': + ... + redirectmatch_status => ['404','404'], + redirectmatch_regexp => ['\.git(/.*|$)/','\.svn(/.*|$)'], + redirectmatch_dest => ['http://www.example.com/$1','http://www.example.com/$2'], +} +``` + +Default value: ``undef`` + +##### `request_headers` + +Data type: `Any` + +Modifies collected [request headers](https://httpd.apache.org/docs/current/mod/mod_headers.html#requestheader) +in various ways, including adding additional request headers, removing request headers, +and so on. +``` puppet +apache::vhost { 'site.name.fdqn': + ... + request_headers => [ + 'append MirrorID "mirror 12"', + 'unset MirrorID', + ], +} +``` + +Default value: ``undef`` + +##### `rewrites` + +Data type: `Optional[Array]` + +Creates URL rewrite rules. Expects an array of hashes.
+Valid Hash keys include `comment`, `rewrite_base`, `rewrite_cond`, `rewrite_rule` +or `rewrite_map`.
+For example, you can specify that anyone trying to access index.html is served welcome.html +``` puppet +apache::vhost { 'site.name.fdqn': + ... + rewrites => [ { rewrite_rule => ['^index\.html$ welcome.html'] } ] +} +``` +The parameter allows rewrite conditions that, when `true`, execute the associated rule. +For instance, if you wanted to rewrite URLs only if the visitor is using IE +``` puppet +apache::vhost { 'site.name.fdqn': + ... + rewrites => [ + { + comment => 'redirect IE', + rewrite_cond => ['%{HTTP_USER_AGENT} ^MSIE'], + rewrite_rule => ['^index\.html$ welcome.html'], + }, + ], +} +``` +You can also apply multiple conditions. For instance, rewrite index.html to welcome.html +only when the browser is Lynx or Mozilla (version 1 or 2) +``` puppet +apache::vhost { 'site.name.fdqn': + ... + rewrites => [ + { + comment => 'Lynx or Mozilla v1/2', + rewrite_cond => ['%{HTTP_USER_AGENT} ^Lynx/ [OR]', '%{HTTP_USER_AGENT} ^Mozilla/[12]'], + rewrite_rule => ['^index\.html$ welcome.html'], + }, + ], +} +``` +Multiple rewrites and conditions are also possible +``` puppet +apache::vhost { 'site.name.fdqn': + ... + rewrites => [ + { + comment => 'Lynx or Mozilla v1/2', + rewrite_cond => ['%{HTTP_USER_AGENT} ^Lynx/ [OR]', '%{HTTP_USER_AGENT} ^Mozilla/[12]'], + rewrite_rule => ['^index\.html$ welcome.html'], + }, + { + comment => 'Internet Explorer', + rewrite_cond => ['%{HTTP_USER_AGENT} ^MSIE'], + rewrite_rule => ['^index\.html$ /index.IE.html [L]'], + }, + { + rewrite_base => /apps/, + rewrite_rule => ['^index\.cgi$ index.php', '^index\.html$ index.php', '^index\.asp$ index.html'], + }, + { comment => 'Rewrite to lower case', + rewrite_cond => ['%{REQUEST_URI} [A-Z]'], + rewrite_map => ['lc int:tolower'], + rewrite_rule => ['(.*) ${lc:$1} [R=301,L]'], + }, + ], +} +``` +Refer to the [`mod_rewrite` documentation](https://httpd.apache.org/docs/2.4/mod/mod_rewrite.html) +for more details on what is possible with rewrite rules and conditions.
+> **Note**: If you include rewrites in your directories, also include `apache::mod::rewrite` +and consider setting the rewrites using the `rewrites` parameter in `apache::vhost` rather +than setting the rewrites in the virtual host's directories. + +Default value: ``undef`` + +##### `rewrite_base` + +Data type: `Any` + +The parameter [`rewrite_base`](https://httpd.apache.org/docs/current/mod/mod_rewrite.html#rewritebase) +specifies the URL prefix to be used for per-directory (htaccess) RewriteRule directives +that substitue a relative path. + +Default value: ``undef`` + +##### `rewrite_rule` + +Data type: `Any` + +The parameter [`rewrite_rile`](https://httpd.apache.org/docs/current/mod/mod_rewrite.html#rewriterule) +allows the user to define the rules that will be used by the rewrite engine. + +Default value: ``undef`` + +##### `rewrite_cond` + +Data type: `Any` + +The parameter [`rewrite_cond`](https://httpd.apache.org/docs/current/mod/mod_rewrite.html#rewritecond) +defines a rule condition, that when satisfied will implement that rule within the +rewrite engine. + +Default value: ``undef`` + +##### `rewrite_inherit` + +Data type: `Any` + +Determines whether the virtual host inherits global rewrite rules.
+Rewrite rules may be specified globally (in `$conf_file` or `$confd_dir`) or +inside the virtual host `.conf` file. By default, virtual hosts do not inherit +global settings. To activate inheritance, specify the `rewrites` parameter and set +`rewrite_inherit` parameter to `true`: +``` puppet +apache::vhost { 'site.name.fdqn': + ... + rewrites => [ + , + ], + rewrite_inherit => `true`, +} +``` +> **Note**: The `rewrites` parameter is **required** for this to have effect
+Apache activates global `Rewrite` rules inheritance if the virtual host files contains +the following directives: +``` ApacheConf +RewriteEngine On +RewriteOptions Inherit +``` +Refer to the official [`mod_rewrite`](https://httpd.apache.org/docs/2.2/mod/mod_rewrite.html) +documentation, section "Rewriting in Virtual Hosts". + +Default value: ``false`` + +##### `scriptalias` + +Data type: `Any` + +Defines a directory of CGI scripts to be aliased to the path '/cgi-bin', such as +'/usr/scripts'. + +Default value: ``undef`` + +##### `scriptaliases` + +Data type: `Any` + +> **Note**: This parameter is deprecated in favor of the `aliases` parameter.
+Passes an array of hashes to the virtual host to create either ScriptAlias or +ScriptAliasMatch statements per the `mod_alias` documentation. +``` puppet +scriptaliases => [ + { + alias => '/myscript', + path => '/usr/share/myscript', + }, + { + aliasmatch => '^/foo(.*)', + path => '/usr/share/fooscripts$1', + }, + { + aliasmatch => '^/bar/(.*)', + path => '/usr/share/bar/wrapper.sh/$1', + }, + { + alias => '/neatscript', + path => '/usr/share/neatscript', + }, +] +``` +The ScriptAlias and ScriptAliasMatch directives are created in the order specified. +As with [Alias and AliasMatch](#aliases) directives, specify more specific aliases +before more general ones to avoid shadowing. + +Default value: `[]` + +##### `serveradmin` + +Data type: `Any` + +Specifies the email address Apache displays when it renders one of its error pages. + +Default value: ``undef`` + +##### `serveraliases` + +Data type: `Any` + +Sets the [ServerAliases](https://httpd.apache.org/docs/current/mod/core.html#serveralias) +of the site. + +Default value: `[]` + +##### `servername` + +Data type: `Any` + +Sets the servername corresponding to the hostname you connect to the virtual host at. + +Default value: `$name` + +##### `setenv` + +Data type: `Any` + +Used by HTTPD to set environment variables for virtual hosts.
+Example: +``` puppet +apache::vhost { 'setenv.example.com': + setenv => ['SPECIAL_PATH /foo/bin'], +} +``` + +Default value: `[]` + +##### `setenvif` + +Data type: `Any` + +Used by HTTPD to conditionally set environment variables for virtual hosts. + +Default value: `[]` + +##### `setenvifnocase` + +Data type: `Any` + +Used by HTTPD to conditionally set environment variables for virtual hosts (caseless matching). + +Default value: `[]` + +##### `suexec_user_group` + +Data type: `Optional[Pattern[/^[\w-]+ [\w-]+$/]]` + +Allows the spcification of user and group execution privileges for CGI programs through +inclusion of the `mod_suexec` module. + +Default value: ``undef`` + +##### `suphp_addhandler` + +Data type: `Any` + +Sets up a virtual host with [suPHP](http://suphp.org/DocumentationView.html?file=apache/CONFIG) +working together with suphp_configpath and suphp_engine.
+An example virtual host configuration with suPHP: +``` puppet +apache::vhost { 'suphp.example.com': + port => '80', + docroot => '/home/appuser/myphpapp', + suphp_addhandler => 'x-httpd-php', + suphp_engine => 'on', + suphp_configpath => '/etc/php5/apache2', + directories => { path => '/home/appuser/myphpapp', + 'suphp' => { user => 'myappuser', group => 'myappgroup' }, + } +} +``` + +Default value: `$apache::params::suphp_addhandler` + +##### `suphp_configpath` + +Data type: `Any` + +Sets up a virtual host with [suPHP](http://suphp.org/DocumentationView.html?file=apache/CONFIG) +working together with suphp_addhandler and suphp_engine.
+An example virtual host configuration with suPHP: +``` puppet +apache::vhost { 'suphp.example.com': + port => '80', + docroot => '/home/appuser/myphpapp', + suphp_addhandler => 'x-httpd-php', + suphp_engine => 'on', + suphp_configpath => '/etc/php5/apache2', + directories => { path => '/home/appuser/myphpapp', + 'suphp' => { user => 'myappuser', group => 'myappgroup' }, + } +} +``` + +Default value: `$apache::params::suphp_configpath` + +##### `suphp_engine` + +Data type: `Enum['on', 'off']` + +Sets up a virtual host with [suPHP](http://suphp.org/DocumentationView.html?file=apache/CONFIG) +working together with suphp_configpath and suphp_addhandler.
+An example virtual host configuration with suPHP: +``` puppet +apache::vhost { 'suphp.example.com': + port => '80', + docroot => '/home/appuser/myphpapp', + suphp_addhandler => 'x-httpd-php', + suphp_engine => 'on', + suphp_configpath => '/etc/php5/apache2', + directories => { path => '/home/appuser/myphpapp', + 'suphp' => { user => 'myappuser', group => 'myappgroup' }, + } +} +``` + +Default value: `$apache::params::suphp_engine` + +##### `vhost_name` + +Data type: `Any` + +Enables name-based virtual hosting. If no IP is passed to the virtual host, but the +virtual host is assigned a port, then the virtual host name is `vhost_name:port`. +If the virtual host has no assigned IP or port, the virtual host name is set to the +title of the resource. + +Default value: `'*'` + +##### `virtual_docroot` + +Data type: `Any` + +Sets up a virtual host with a wildcard alias subdomain mapped to a directory with the +same name. For example, `http://example.com` would map to `/var/www/example.com`. +Note that the `DocumentRoot` directive will not be present even though there is a value +set for `docroot` in the manifest. See [`virtual_use_default_docroot`](#virtual_use_default_docroot) to change this behavior. +``` puppet +apache::vhost { 'subdomain.loc': + vhost_name => '*', + port => '80', + virtual_docroot => '/var/www/%-2+', + docroot => '/var/www', + serveraliases => ['*.loc',], +} +``` + +Default value: ``false`` + +##### `virtual_use_default_docroot` + +Data type: `Any` + +By default, when using `virtual_docroot`, the value of `docroot` is ignored. Setting this +to `true` will mean both directives will be added to the configuration. +``` puppet +apache::vhost { 'subdomain.loc': + vhost_name => '*', + port => '80', + virtual_docroot => '/var/www/%-2+', + docroot => '/var/www', + virtual_use_default_docroot => true, + serveraliases => ['*.loc',], +} +``` + +Default value: ``false`` + +##### `wsgi_daemon_process` + +Data type: `Optional[Variant[String,Hash]]` + +Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +wsgi_daemon_process_options, wsgi_process_group, +wsgi_script_aliases and wsgi_pass_authorization.
+A hash that sets the name of the WSGI daemon, accepting +[certain keys](http://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIDaemonProcess.html).
+An example virtual host configuration with WSGI: +``` puppet +apache::vhost { 'wsgi.example.com': + port => '80', + docroot => '/var/www/pythonapp', + wsgi_daemon_process => 'wsgi', + wsgi_daemon_process_options => + { processes => '2', + threads => '15', + display-name => '%{GROUP}', + }, + wsgi_process_group => 'wsgi', + wsgi_script_aliases => { '/' => '/var/www/demo.wsgi' }, + wsgi_chunked_request => 'On', +} +``` + +Default value: ``undef`` + +##### `wsgi_daemon_process_options` + +Data type: `Optional[Hash]` + +Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +wsgi_daemon_process, wsgi_process_group, +wsgi_script_aliases and wsgi_pass_authorization.
+Sets the group ID that the virtual host runs under. + +Default value: ``undef`` + +##### `wsgi_application_group` + +Data type: `Any` + +Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group, +and wsgi_pass_authorization.
+This parameter defines the [`WSGIApplicationGroup directive`](https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIApplicationGroup.html), +thus allowing you to specify which application group the WSGI application belongs to, +with all WSGI applications within the same group executing within the context of the +same Python sub interpreter. + +Default value: ``undef`` + +##### `wsgi_import_script` + +Data type: `Any` + +Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group, +and wsgi_pass_authorization.
+This parameter defines the [`WSGIImportScript directive`](https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIImportScript.html), +which can be used in order to specify a script file to be loaded upon a process starting. + +Default value: ``undef`` + +##### `wsgi_import_script_options` + +Data type: `Optional[Hash]` + +Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group, +and wsgi_pass_authorization.
+This parameter defines the [`WSGIImportScript directive`](https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIImportScript.html), +which can be used in order to specify a script file to be loaded upon a process starting.
+Specifies the process and aplication groups of the script. + +Default value: ``undef`` + +##### `wsgi_chunked_request` + +Data type: `Any` + +Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group, +and wsgi_pass_authorization.
+This parameter defines the [`WSGIChunkedRequest directive`](https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIChunkedRequest.html), +allowing you to enable support for chunked request content.
+WSGI is technically incapable of supporting chunked request content without all chunked +request content having first been read in and buffered. + +Default value: ``undef`` + +##### `wsgi_process_group` + +Data type: `Any` + +Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +wsgi_daemon_process, wsgi_daemon_process_options, +wsgi_script_aliases and wsgi_pass_authorization.
+Requires a hash of web paths to filesystem `.wsgi paths/`. + +Default value: ``undef`` + +##### `wsgi_script_aliases` + +Data type: `Optional[Hash]` + +Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group, +and wsgi_pass_authorization.
+Uses the WSGI application to handle authorization instead of Apache when set to `On`.
+For more information, see mod_wsgi's [WSGIPassAuthorization documentation](https://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIPassAuthorization.html). + +Default value: ``undef`` + +##### `wsgi_script_aliases_match` + +Data type: `Optional[Hash]` + +Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group, +and wsgi_pass_authorization.
+Uses the WSGI application to handle authorization instead of Apache when set to `On`.
+This directive is similar to `wsgi_script_aliases`, but makes use of regular expressions +in place of simple prefix matching.
+For more information, see mod_wsgi's [WSGIPassAuthorization documentation](https://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIPassAuthorization.html). + +Default value: ``undef`` + +##### `wsgi_pass_authorization` + +Data type: `Optional[Enum['on', 'off', 'On', 'Off']]` + +Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group and +wsgi_script_aliases.
+Enables support for chunked requests. + +Default value: ``undef`` + +##### `directories` + +Data type: `Optional[Variant[Hash, Array[Variant[Array,Hash]]]]` + +The `directories` parameter within the `apache::vhost` class passes an array of hashes +to the virtual host to create [Directory](https://httpd.apache.org/docs/current/mod/core.html#directory), +[File](https://httpd.apache.org/docs/current/mod/core.html#files), and +[Location](https://httpd.apache.org/docs/current/mod/core.html#location) directive blocks. +These blocks take the form, `< Directory /path/to/directory>...< /Directory>`.
+The `path` key sets the path for the directory, files, and location blocks. Its value +must be a path for the `directory`, `files`, and `location` providers, or a regex for +the `directorymatch`, `filesmatch`, or `locationmatch` providers. Each hash passed to +`directories` **must** contain `path` as one of the keys.
+The `provider` key is optional. If missing, this key defaults to `directory`. + Values: `directory`, `files`, `proxy`, `location`, `directorymatch`, `filesmatch`, +`proxymatch` or `locationmatch`. If you set `provider` to `directorymatch`, it +uses the keyword `DirectoryMatch` in the Apache config file.
+An example use of `directories`: +``` puppet +apache::vhost { 'files.example.net': + docroot => '/var/www/files', + directories => [ + { 'path' => '/var/www/files', + 'provider' => 'files', + 'deny' => 'from all', + }, + ], +} +``` +> **Note:** At least one directory should match the `docroot` parameter. After you +start declaring directories, `apache::vhost` assumes that all required Directory blocks +will be declared. If not defined, a single default Directory block is created that matches +the `docroot` parameter.
+Available handlers, represented as keys, should be placed within the `directory`, +`files`, or `location` hashes. This looks like +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ { path => '/path/to/directory', handler => value } ], +} +``` +Any handlers you do not set in these hashes are considered `undefined` within Puppet and +are not added to the virtual host, resulting in the module using their default values. + +Default value: ``undef`` + +##### `custom_fragment` + +Pass a string of custom configuration directives to be placed at the end of the directory +configuration. +``` puppet +apache::vhost { 'monitor': + ... + directories => [ + { + path => '/path/to/directory', + custom_fragment => ' + + SetHandler balancer-manager + Order allow,deny + Allow from all + + + SetHandler server-status + Order allow,deny + Allow from all + +ProxyStatus On', + }, + ] +} +``` + +Default value: ``undef`` + +##### `error_documents` + +An array of hashes used to override the [ErrorDocument](https://httpd.apache.org/docs/current/mod/core.html#errordocument) +settings for the directory. +``` puppet +apache::vhost { 'sample.example.net': + directories => [ + { path => '/srv/www', + error_documents => [ + { 'error_code' => '503', + 'document' => '/service-unavail', + }, + ], + }, + ], +} +``` + +Default value: `[]` + +##### `h2_copy_files` + +Sets the [H2CopyFiles](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2copyfiles) directive.
+Note that you must declare `class {'apache::mod::http2': }` before using this directive. + +Default value: ``undef`` + +##### `h2_push_resource` + +Sets the [H2PushResource](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2pushresource) directive.
+Note that you must declare `class {'apache::mod::http2': }` before using this directive. + +Default value: `[]` + +##### `headers` + +Adds lines for [Header](https://httpd.apache.org/docs/current/mod/mod_headers.html#header) directives. +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => { + path => '/path/to/directory', + headers => 'Set X-Robots-Tag "noindex, noarchive, nosnippet"', + }, +} +``` + +Default value: ``undef`` + +##### `options` + +Lists the [Options](https://httpd.apache.org/docs/current/mod/core.html#options) for the +given Directory block. +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + options => ['Indexes','FollowSymLinks','MultiViews'], + }, + ], +} +``` + +Default value: `['Indexes','FollowSymLinks','MultiViews']` + +##### `shib_compat_valid_user` + +Data type: `Optional[String]` + +Default is Off, matching the behavior prior to this command's existence. Addresses a conflict +when using Shibboleth in conjunction with other auth/auth modules by restoring `standard` +Apache behavior when processing the `valid-user` and `user` Require rules. See the +[`mod_shib`documentation](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPApacheConfig#NativeSPApacheConfig-Server/VirtualHostOptions), +and [NativeSPhtaccess](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPhtaccess) +topic for more details. This key is disabled if `apache::mod::shib` is not defined. + +Default value: ``undef`` + +##### `ssl_options` + +Data type: `Any` + +String or list of [SSLOptions](https://httpd.apache.org/docs/current/mod/mod_ssl.html#ssloptions), +which configure SSL engine run-time options. This handler takes precedence over SSLOptions +set in the parent block of the virtual host. +``` puppet +apache::vhost { 'secure.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + ssl_options => '+ExportCertData', + }, + { path => '/path/to/different/dir', + ssl_options => ['-StdEnvVars', '+ExportCertData'], + }, + ], +} +``` + +Default value: ``undef`` + +##### `additional_includes` + +Specifies paths to additional static, specific Apache configuration files in virtual +host directories. +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/different/dir', + additional_includes => ['/custom/path/includes', '/custom/path/another_includes',], + }, + ], +} +``` + +Default value: `[]` + +##### `gssapi` + +Specfies mod_auth_gssapi parameters for particular directories in a virtual host directory +```puppet + include apache::mod::auth_gssapi + apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/different/dir', + gssapi => { + credstore => 'keytab:/foo/bar.keytab', + localname => 'Off', + sslonly => 'On', + } + }, + ], + } + ``` + +##### `ssl` + +Data type: `Boolean` + +Enables SSL for the virtual host. SSL virtual hosts only respond to HTTPS queries. + +Default value: ``false`` + +##### `ssl_ca` + +Data type: `Any` + +Specifies the SSL certificate authority to be used to verify client certificates used +for authentication. + +Default value: `$apache::default_ssl_ca` + +##### `ssl_cert` + +Data type: `Any` + +Specifies the SSL certification. + +Default value: `$apache::default_ssl_cert` + +##### `ssl_protocol` + +Data type: `Any` + +Specifies [SSLProtocol](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslprotocol). +Expects an array or space separated string of accepted protocols. + +Default value: ``undef`` + +##### `ssl_cipher` + +Data type: `Any` + +Specifies [SSLCipherSuite](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslciphersuite). + +Default value: ``undef`` + +##### `ssl_honorcipherorder` + +Data type: `Variant[Boolean, Enum['on', 'On', 'off', 'Off'], Undef]` + +Sets [SSLHonorCipherOrder](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslhonorcipherorder), +to cause Apache to use the server's preferred order of ciphers rather than the client's +preferred order. + +Default value: ``undef`` + +##### `ssl_certs_dir` + +Data type: `Any` + +Specifies the location of the SSL certification directory to verify client certs. + +Default value: `$apache::params::ssl_certs_dir` + +##### `ssl_chain` + +Data type: `Any` + +Specifies the SSL chain. This default works out of the box, but it must be updated in +the base `apache` class with your specific certificate information before being used in +production. + +Default value: `$apache::default_ssl_chain` + +##### `ssl_crl` + +Data type: `Any` + +Specifies the certificate revocation list to use. (This default works out of the box but +must be updated in the base `apache` class with your specific certificate information +before being used in production.) + +Default value: `$apache::default_ssl_crl` + +##### `ssl_crl_path` + +Data type: `Any` + +Specifies the location of the certificate revocation list to verify certificates for +client authentication with. (This default works out of the box but must be updated in +the base `apache` class with your specific certificate information before being used in +production.) + +Default value: `$apache::default_ssl_crl_path` + +##### `ssl_crl_check` + +Data type: `Any` + +Sets the certificate revocation check level via the [SSLCARevocationCheck directive](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslcarevocationcheck) +for ssl client authentication. The default works out of the box but must be specified when +using CRLs in production. Only applicable to Apache 2.4 or higher; the value is ignored on +older versions. + +Default value: `$apache::default_ssl_crl_check` + +##### `ssl_key` + +Data type: `Any` + +Specifies the SSL key.
+Defaults are based on your operating system. Default work out of the box but must be +updated in the base `apache` class with your specific certificate information before +being used in production. + +Default value: `$apache::default_ssl_key` + +##### `ssl_verify_client` + +Data type: `Optional[Enum['none', 'optional', 'require', 'optional_no_ca']]` + +Sets the [SSLVerifyClient](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslverifyclient) +directive, which sets the certificate verification level for client authentication. +``` puppet +apache::vhost { 'sample.example.net': + ... + ssl_verify_client => 'optional', +} +``` + +Default value: ``undef`` + +##### `ssl_verify_depth` + +Data type: `Any` + +Sets the [SSLVerifyDepth](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslverifydepth) +directive, which specifies the maximum depth of CA certificates in client certificate +verification. You must set `ssl_verify_client` for it to take effect. +``` puppet +apache::vhost { 'sample.example.net': + ... + ssl_verify_client => 'require', + ssl_verify_depth => 1, +} +``` + +Default value: ``undef`` + +##### `ssl_proxy_protocol` + +Data type: `Any` + +Sets the [SSLProxyProtocol](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyprotocol) +directive, which controls which SSL protocol flavors `mod_ssl` should use when establishing +its server environment for proxy. It connects to servers using only one of the provided +protocols. + +Default value: ``undef`` + +##### `ssl_proxy_verify` + +Data type: `Optional[Enum['none', 'optional', 'require', 'optional_no_ca']]` + +Sets the [SSLProxyVerify](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyverify) +directive, which configures certificate verification of the remote server when a proxy is +configured to forward requests to a remote SSL server. + +Default value: ``undef`` + +##### `ssl_proxy_verify_depth` + +Data type: `Optional[Integer[0]]` + +Sets the [SSLProxyVerifyDepth](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyverifydepth) +directive, which configures how deeply mod_ssl should verify before deciding that the +remote server does not have a valid certificate.
+A depth of 0 means that only self-signed remote server certificates are accepted, +the default depth of 1 means the remote server certificate can be self-signed or +signed by a CA that is directly known to the server. + +Default value: ``undef`` + +##### `ssl_proxy_cipher_suite` + +Data type: `Any` + +Sets the [SSLProxyCipherSuite](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyciphersuite) +directive, which controls cipher suites supported for ssl proxy traffic. + +Default value: ``undef`` + +##### `ssl_proxy_ca_cert` + +Data type: `Any` + +Sets the [SSLProxyCACertificateFile](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycacertificatefile) +directive, which specifies an all-in-one file where you can assemble the Certificates +of Certification Authorities (CA) whose remote servers you deal with. These are used +for Remote Server Authentication. This file should be a concatenation of the PEM-encoded +certificate files in order of preference. + +Default value: ``undef`` + +##### `ssl_proxy_machine_cert` + +Data type: `Any` + +Sets the [SSLProxyMachineCertificateFile](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxymachinecertificatefile) +directive, which specifies an all-in-one file where you keep the certs and keys used +for this server to authenticate itself to remote servers. This file should be a +concatenation of the PEM-encoded certificate files in order of preference. +``` puppet +apache::vhost { 'sample.example.net': + ... + ssl_proxy_machine_cert => '/etc/httpd/ssl/client_certificate.pem', +} +``` + +Default value: ``undef`` + +##### `ssl_proxy_machine_cert_chain` + +Data type: `Any` + +Sets the [SSLProxyMachineCertificateChainFile](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxymachinecertificatechainfile) +directive, which specifies an all-in-one file where you keep the certificate chain for +all of the client certs in use. This directive will be needed if the remote server +presents a list of CA certificates that are not direct signers of one of the configured +client certificates. This referenced file is simply the concatenation of the various +PEM-encoded certificate files. Upon startup, each client certificate configured will be +examined and a chain of trust will be constructed. + +Default value: ``undef`` + +##### `ssl_proxy_check_peer_cn` + +Data type: `Optional[Enum['on', 'off']]` + +Sets the [SSLProxyCheckPeerCN](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeercn) +directive, which specifies whether the remote server certificate's CN field is compared +against the hostname of the request URL. + +Default value: ``undef`` + +##### `ssl_proxy_check_peer_name` + +Data type: `Optional[Enum['on', 'off']]` + +Sets the [SSLProxyCheckPeerName](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeername) +directive, which specifies whether the remote server certificate's CN field is compared +against the hostname of the request URL. + +Default value: ``undef`` + +##### `ssl_proxy_check_peer_expire` + +Data type: `Optional[Enum['on', 'off']]` + +Sets the [SSLProxyCheckPeerExpire](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeerexpire) +directive, which specifies whether the remote server certificate is checked for expiration +or not. + +Default value: ``undef`` + +##### `ssl_options` + +Sets the [SSLOptions](https://httpd.apache.org/docs/current/mod/mod_ssl.html#ssloptions) +directive, which configures various SSL engine run-time options. This is the global +setting for the given virtual host and can be a string or an array.
+A string: +``` puppet +apache::vhost { 'sample.example.net': + ... + ssl_options => '+ExportCertData', +} +``` +An array: +``` puppet +apache::vhost { 'sample.example.net': + ... + ssl_options => ['+StrictRequire', '+ExportCertData'], +} +``` + +Default value: ``undef`` + +##### `ssl_openssl_conf_cmd` + +Data type: `Any` + +Sets the [SSLOpenSSLConfCmd](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslopensslconfcmd) +directive, which provides direct configuration of OpenSSL parameters. + +Default value: ``undef`` + +##### `ssl_proxyengine` + +Data type: `Boolean` + +Specifies whether or not to use [SSLProxyEngine](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyengine). + +Default value: ``false`` + +##### `ssl_stapling` + +Data type: `Optional[Boolean]` + +Specifies whether or not to use [SSLUseStapling](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslusestapling). +By default, uses what is set globally.
+This parameter only applies to Apache 2.4 or higher and is ignored on older versions. + +Default value: ``undef`` + +##### `ssl_stapling_timeout` + +Data type: `Any` + +Can be used to set the [SSLStaplingResponderTimeout](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslstaplingrespondertimeout) directive.
+This parameter only applies to Apache 2.4 or higher and is ignored on older versions. + +Default value: ``undef`` + +##### `ssl_stapling_return_errors` + +Data type: `Any` + +Can be used to set the [SSLStaplingReturnResponderErrors](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslstaplingreturnrespondererrors) directive.
+This parameter only applies to Apache 2.4 or higher and is ignored on older versions. + +Default value: ``undef`` + +##### `ssl_user_name` + +Data type: `Optional[String]` + +Sets the [SSLUserName](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslusername) directive. + +Default value: ``undef`` + +##### `ssl_reload_on_change` + +Data type: `Boolean` + +Enable reloading of apache if the content of ssl files have changed. + +Default value: `$apache::default_ssl_reload_on_change` + +##### `use_canonical_name` + +Data type: `Optional[Enum['On', 'on', 'Off', 'off', 'DNS', 'dns']]` + +Specifies whether to use the [`UseCanonicalName directive`](https://httpd.apache.org/docs/2.4/mod/core.html#usecanonicalname), +which allows you to configure how the server determines it's own name and port. + +Default value: ``undef`` + +##### `define` + +Data type: `Hash` + +this lets you define configuration variables inside a vhost using [`Define`](https://httpd.apache.org/docs/2.4/mod/core.html#define), +these can then be used to replace configuration values. All Defines are Undefined at the end of the VirtualHost. + +Default value: `{}` + +##### `auth_oidc` + +Data type: `Boolean` + +Enable `mod_auth_openidc` parameters for OpenID Connect authentication. + +Default value: ``false`` + +##### `oidc_settings` + +Data type: `Optional[Apache::OIDCSettings]` + +An Apache::OIDCSettings Struct containing (mod_auth_openidc settings)[https://github.com/zmartzone/mod_auth_openidc/blob/master/auth_openidc.conf]. + +Default value: ``undef`` + +##### `limitreqfields` + +Data type: `Optional[Integer]` + +The `limitreqfields` parameter sets the maximum number of request header fields in +an HTTP request. This directive gives the server administrator greater control over +abnormal client request behavior, which may be useful for avoiding some forms of +denial-of-service attacks. The value should be increased if normal clients see an error +response from the server that indicates too many fields were sent in the request. + +Default value: ``undef`` + +##### `limitreqfieldsize` + +Data type: `Optional[Integer]` + +The `limitreqfieldsize` parameter sets the maximum ammount of _bytes_ that will +be allowed within a request header. + +Default value: ``undef`` + +##### `limitreqline` + +Data type: `Optional[Integer]` + +Limit the size of the HTTP request line that will be accepted from the client +This directive sets the number of bytes that will be allowed on the HTTP +request-line. The LimitRequestLine directive allows the server administrator +to set the limit on the allowed size of a client's HTTP request-line. Since +the request-line consists of the HTTP method, URI, and protocol version, the +LimitRequestLine directive places a restriction on the length of a request-URI +allowed for a request on the server. A server needs this value to be large +enough to hold any of its resource names, including any information that might +be passed in the query part of a GET request. + +Default value: ``undef`` + +##### `limitreqbody` + +Data type: `Optional[Integer]` + +Restricts the total size of the HTTP request body sent from the client +The LimitRequestBody directive allows the user to set a limit on the allowed +size of an HTTP request message body within the context in which the +directive is given (server, per-directory, per-file or per-location). If the +client request exceeds that limit, the server will return an error response +instead of servicing the request. + +Default value: ``undef`` + +##### `$use_servername_for_filenames` + +When set to true, default log / config file names will be derived from the sanitized +value of the $servername parameter. +When set to false (default), the existing behaviour of using the $name parameter +will remain. + +##### `$use_port_for_filenames` + +When set to true and use_servername_for_filenames is also set to true, default log / +config file names will be derived from the sanitized value of both the $servername and +$port parameters. +When set to false (default), the port is not included in the file names and may lead to +duplicate declarations if two virtual hosts use the same domain. + +##### `$mdomain` + +All the names in the list are managed as one Managed Domain (MD). mod_md will request +one single certificate that is valid for all these names. + +##### `use_servername_for_filenames` + +Data type: `Optional[Boolean]` + + + +Default value: ``false`` + +##### `use_port_for_filenames` + +Data type: `Optional[Boolean]` + + + +Default value: ``false`` + +##### `proxy_requests` + +Data type: `Boolean` + + + +Default value: ``false`` + +##### `mdomain` + +Data type: `Optional[Variant[Boolean,String]]` + + + +Default value: ``undef`` + +### `apache::vhost::custom` + +The `apache::vhost::custom` defined type is a thin wrapper around the `apache::custom_config` defined type, and simply overrides some of its default settings specific to the virtual host directory in Apache. + +#### Parameters + +The following parameters are available in the `apache::vhost::custom` defined type: + +* [`content`](#content) +* [`ensure`](#ensure) +* [`priority`](#priority) +* [`verify_config`](#verify_config) + +##### `content` + +Data type: `Any` + +Sets the configuration file's content. + +##### `ensure` + +Data type: `Any` + +Specifies if the virtual host file is present or absent. + +Default value: `'present'` + +##### `priority` + +Data type: `Any` + +Sets the relative load order for Apache HTTPD VirtualHost configuration files. + +Default value: `'25'` + +##### `verify_config` + +Data type: `Any` + +Specifies whether to validate the configuration file before notifying the Apache service. + +Default value: ``true`` + +### `apache::vhost::fragment` + +Define a fragment within a vhost + +#### Examples + +##### With a vhost without priority + +```puppet +include apache +apache::vhost { 'myvhost': +} +apache::vhost::fragment { 'myfragment': + vhost => 'myvhost', + content => '# Foo', +} +``` + +##### With a vhost with priority + +```puppet +include apache +apache::vhost { 'myvhost': + priority => '42', +} +apache::vhost::fragment { 'myfragment': + vhost => 'myvhost', + priority => '42', + content => '# Foo', +} +``` + +##### With a vhost with default vhost + +```puppet +include apache +apache::vhost { 'myvhost': + default_vhost => true, +} +apache::vhost::fragment { 'myfragment': + vhost => 'myvhost', + priority => '10', # default_vhost implies priority 10 + content => '# Foo', +} +``` + +##### Adding a fragment to the built in default vhost + +```puppet +include apache +apache::vhost::fragment { 'myfragment': + vhost => 'default', + priority => '15', + content => '# Foo', +} +``` + +#### Parameters + +The following parameters are available in the `apache::vhost::fragment` defined type: + +* [`vhost`](#vhost) +* [`priority`](#priority) +* [`content`](#content) +* [`order`](#order) +* [`port`](#port) + +##### `vhost` + +Data type: `String[1]` + +The title of the vhost resource to append to + +##### `priority` + +Data type: `Any` + +Set the priority to match the one `apache::vhost` sets. This must match the +one `apache::vhost` sets or else the concat fragment won't be found. + +Default value: ``undef`` + +##### `content` + +Data type: `Optional[String]` + +The content to put in the fragment. Only when it's non-empty the actual +fragment will be created. + +Default value: ``undef`` + +##### `order` + +Data type: `Integer[0]` + +The order to insert the fragment at + +Default value: `900` + +##### `port` + +Data type: `Optional[Integer[0]]` + + + +Default value: ``undef`` + +## Resource types + +### `a2mod` + +Manage Apache 2 modules + +#### Properties + +The following properties are available in the `a2mod` type. + +##### `ensure` + +Valid values: `present`, `absent` + +The basic property that the resource should be in. + +Default value: `present` + +#### Parameters + +The following parameters are available in the `a2mod` type. + +* [`identifier`](#identifier) +* [`lib`](#lib) +* [`name`](#name) +* [`provider`](#provider) + +##### `identifier` + +Module identifier string used by LoadModule. Default: module-name_module + +##### `lib` + +The name of the .so library to be loaded + +##### `name` + +namevar + +The name of the module to be managed + +##### `provider` + +The specific backend to use for this `a2mod` resource. You will seldom need to specify this --- Puppet will usually +discover the appropriate provider for your platform. + +## Functions + +### `apache::apache_pw_hash` + +Type: Ruby 4.x API + +DEPRECATED. Use the function [`apache::pw_hash`](#apachepw_hash) instead. + +#### `apache::apache_pw_hash(Any *$args)` + +The apache::apache_pw_hash function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `apache::bool2httpd` + +Type: Ruby 4.x API + +Transform a supposed boolean to On or Off. Passes all other values through. + +#### Examples + +##### + +```puppet +$trace_enable = false +$server_signature = 'mail' + +apache::bool2httpd($trace_enable) # returns 'Off' +apache::bool2httpd($server_signature) # returns 'mail' +apache::bool2httpd(undef) # returns 'Off' +``` + +#### `apache::bool2httpd(Any $arg)` + +The apache::bool2httpd function. + +Returns: `Any` Will return either `On` or `Off` if given a boolean value. Returns a string of any +other given value. + +##### Examples + +###### + +```puppet +$trace_enable = false +$server_signature = 'mail' + +apache::bool2httpd($trace_enable) # returns 'Off' +apache::bool2httpd($server_signature) # returns 'mail' +apache::bool2httpd(undef) # returns 'Off' +``` + +##### `arg` + +Data type: `Any` + +The value to be converted into a string. + +### `apache::pw_hash` + +Type: Ruby 4.x API + +Currently uses SHA-hashes, because although this format is considered insecure, it's the +most secure format supported by the most platforms. + +#### `apache::pw_hash(String[1] $password)` + +Currently uses SHA-hashes, because although this format is considered insecure, it's the +most secure format supported by the most platforms. + +Returns: `String` Returns the hash of the input that was given. + +##### `password` + +Data type: `String[1]` + +The input that is to be hashed. + +### `apache_pw_hash` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`apache::pw_hash`](#apachepw_hash) instead. + +#### `apache_pw_hash(Any *$args)` + +The apache_pw_hash function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +### `bool2httpd` + +Type: Ruby 4.x API + +DEPRECATED. Use the namespaced function [`apache::bool2httpd`](#apachebool2httpd) instead. + +#### `bool2httpd(Any *$args)` + +The bool2httpd function. + +Returns: `Any` + +##### `*args` + +Data type: `Any` + + + +## Data types + +### `Apache::LogLevel` + +A string that conforms to the Apache `LogLevel` syntax. +Different levels can be specified for individual apache modules. + +ie. `[module:]level [module:level] ...` + +The levels are (in order of decreasing significance): +* `emerg` +* `alert` +* `crit` +* `error` +* `warn` +* `notice` +* `info` +* `debug` +* `trace1` +* `trace2` +* `trace3` +* `trace4` +* `trace5` +* `trace6` +* `trace7` +* `trace8` + +* **See also** + * https://httpd.apache.org/docs/current/mod/core.html#loglevel + +Alias of + +```puppet +Pattern[/(emerg|alert|crit|error|warn|notice|info|debug|trace[1-8])/] +``` + +### `Apache::OIDCSettings` + +https://github.com/zmartzone/mod_auth_openidc/blob/master/auth_openidc.conf + +Alias of + +```puppet +Struct[{ + Optional['RedirectURI'] => Variant[Stdlib::HTTPSUrl,Stdlib::HttpUrl,Pattern[/^\/[A-Za-z0-9\-\._%\/]*$/]], + Optional['CryptoPassphrase'] => String, + Optional['MetadataDir'] => String, + Optional['ProviderMetadataURL'] => Stdlib::HTTPSUrl, + Optional['ProviderIssuer'] => String, + Optional['ProviderAuthorizationEndpoint'] => Stdlib::HTTPSUrl, + Optional['ProviderJwksUri'] => Stdlib::HTTPSUrl, + Optional['ProviderTokenEndpoint'] => Stdlib::HTTPSUrl, + Optional['ProviderTokenEndpointAuth'] => Enum['client_secret_basic','client_secret_post','client_secret_jwt','private_key_jwt','none'], + Optional['ProviderTokenEndpointParams'] => Pattern[/^[A-Za-z0-9\-\._%]+=[A-Za-z0-9\-\._%]+(&[A-Za-z0-9\-\._%]+=[A-Za-z0-9\-\._%]+)*$/], + Optional['ProviderUserInfoEndpoint'] => Stdlib::HTTPSUrl, + Optional['ProviderCheckSessionIFrame'] => Stdlib::HTTPSUrl, + Optional['ProviderEndSessionEndpoint'] => Stdlib::HTTPSUrl, + Optional['ProviderRevocationEndpoint'] => Stdlib::HTTPSUrl, + Optional['ProviderBackChannelLogoutSupported'] => Enum['On','Off'], + Optional['ProviderRegistrationEndpointJson'] => String, + Optional['Scope'] => Pattern[/^[A-Za-z0-9\-\._\s]+$/], + Optional['AuthRequestParams'] => Pattern[/^[A-Za-z0-9\-\._%]+=[A-Za-z0-9\-\._%]+(&[A-Za-z0-9\-\._%]+=[A-Za-z0-9\-\._%]+)*$/], + Optional['SSLValidateServer'] => Enum['On','Off'], + Optional['UserInfoRefreshInterval'] => Integer, + Optional['JWKSRefreshInterval'] => Integer, + Optional['UserInfoTokenMethod'] => Enum['authz_header','post_param'], + Optional['ProviderAuthRequestMethod'] => Enum['GET','POST'], + Optional['PublicKeyFiles'] => String, + Optional['ResponseType'] => Enum['code','id_token','id_token token','code id_token','code token','code id_token token'], + Optional['ResponseMode'] => Enum['fragment','query','form_post'], + Optional['ClientID'] => String, + Optional['ClientSecret'] => String, + Optional['ClientTokenEndpointCert'] => String, + Optional['ClientTokenEndpointKey'] => String, + Optional['ClientName'] => String, + Optional['ClientContact'] => String, + Optional['PKCDMethod'] => Enum['plain','S256','referred_tb'], + Optional['TokenBindingPolicy'] => Enum['disabled','optional','required','enforced'], + Optional['ClientJwksUri'] => Stdlib::HTTPSUrl, + Optional['IDTokenSignedResponseAlg'] => Enum['RS256','RS384','RS512','PS256','PS384','PS512','HS256','HS384','HS512','ES256','ES384','ES512'], + Optional['IDTokenEncryptedResponseAlg'] => Enum['RSA1_5','A128KW','A256KW','RSA-OAEP'], + Optional['IDTokenEncryptedResponseAlg'] => Enum['A128CBC-HS256','A256CBC-HS512','A256GCM'], + Optional['UserInfoSignedResposeAlg'] => Enum['RS256','RS384','RS512','PS256','PS384','PS512','HS256','HS384','HS512','ES256','ES384','ES512'], + Optional['UserInfoEncryptedResponseAlg'] => Enum['RSA1_5','A128KW','A256KW','RSA-OAEP'], + Optional['UserInfoEncryptedResponseEnc'] => Enum['A128CBC-HS256','A256CBC-HS512','A256GCM'], + Optional['OAuthServerMetadataURL'] => Stdlib::HTTPSUrl, + Optional['AuthIntrospectionEndpoint'] => Stdlib::HTTPSUrl, + Optional['OAuthClientID'] => String, + Optional['OAuthClientSecret'] => String, + Optional['OAuthIntrospectionEndpointAuth'] => Enum['client_secret_basic','client_secret_post','client_secret_jwt','private_key_jwt','bearer_access_token','none'], + Optional['OAuthIntrospectionClientAuthBearerToken'] => String, + Optional['OAuthIntrospectionEndpointCert'] => String, + Optional['OAuthIntrospectionEndpointKey'] => String, + Optional['OAuthIntrospectionEndpointMethod'] => Enum['POST','GET'], + Optional['OAuthIntrospectionEndpointParams'] => Pattern[/^[A-Za-z0-9\-\._%]+=[A-Za-z0-9\-\._%]+(&[A-Za-z0-9\-\._%]+=[A-Za-z0-9\-\._%]+)*$/], + Optional['OAuthIntrospectionTokenParamName'] => String, + Optional['OAuthTokenExpiryClaim'] => Pattern[/^[A-Za-z0-9\-\._]+\s(absolute|relative)\s(mandatory|optional)$/], + Optional['OAuthSSLValidateServer'] => Enum['On','Off'], + Optional['OAuthVerifySharedKeys'] => String, + Optional['OAuthVerifyCertFiles'] => String, + Optional['OAuthVerifyJwksUri'] => Stdlib::HTTPSUrl, + Optional['OAuthRemoteUserClaim'] => String, + Optional['OAuthAcceptTokenAs'] => Pattern[/^((header|post|query|cookie\:[A-Za-z0-9\-\._]+|basic)\s?)+$/], + Optional['OAuthAccessTokenBindingPolicy'] => Enum['disabled','optional','required','enforced'], + Optional['Cookie'] => String, + Optional['SessionCookieChunkSize'] => Integer, + Optional['CookieHTTPOnly'] => Enum['On','Off'], + Optional['CookieSameSite'] => Enum['On','Off'], + Optional['PassCookies'] => String, + Optional['StripCookies'] => String, + Optional['StateMaxNumberOfCookies'] => Pattern[/^[0-9]+\s(false|true)$/], + Optional['SessionInactivityTimeout'] => Integer, + Optional['SessionMaxDuration'] => Integer, + Optional['SessionType'] => Pattern[/^(server-cache(:persistent)?|client-cookie(:persistent)?)$/], + Optional['SessionCacheFallbackToCookie'] => Enum['On','Off'], + Optional['CacheType'] => Enum['shm','memcache','file','redis'], + Optional['CacheEncrypt'] => Enum['On','Off'], + Optional['CacheShmMax'] => Integer, + Optional['CacheShmEntrySizeMax'] => Integer, + Optional['CacheFileCleanInterval'] => Integer, + Optional['MemCacheServers'] => String, + Optional['RedisCacheServer'] => String, + Optional['RedisCachePassword'] => String, + Optional['DiscoverURL'] => Variant[Stdlib::HTTPSUrl,Stdlib::HttpUrl], + Optional['HTMLErrorTemplate'] => String, + Optional['DefaultURL'] => Variant[Stdlib::HTTPSUrl,Stdlib::HttpUrl], + Optional['PathScope'] => Pattern[/^[A-Za-z0-9\-\._\s]+$/], + Optional['PathAuthRequestParams'] => Pattern[/^[A-Za-z0-9\-\._%]+=[A-Za-z0-9\-\._%]+(&[A-Za-z0-9\-\._%]+=[A-Za-z0-9\-\._%]+)*$/], + Optional['IDTokenIatSlack'] => Integer, + Optional['ClaimPrefix'] => String, + Optional['ClaimDelimiter'] => Pattern[/^.$/], + Optional['RemoteUserClaim'] => String, + Optional['PassIDTokenAs'] => Pattern[/^((claims|payload|serialized)\s?)+$/], + Optional['PassUserInfoAs'] => Pattern[/^((claims|json|jwt)\s?)+$/], + Optional['PassClaimsAs'] => Enum['none','headers','environment','both'], + Optional['AuthNHeader'] => String, + Optional['HTTPTimeoutLong'] => Integer, + Optional['HTTPTimeoutShort'] => Integer, + Optional['StateTimeout'] => Integer, + Optional['ScrubRequestHeaders'] => Enum['On','Off'], + Optional['OutgoingProxy'] => String, + Optional['UnAuthAction'] => Enum['auth','pass','401','410'], + Optional['UnAuthzAction'] => Enum['401','403','auth'], + Optional['PreservePost'] => Enum['On','Off'], + Optional['PassRefreshToken'] => Enum['On','Off'], + Optional['RequestObject'] => String, + Optional['ProviderMetadataRefreshInterval'] => Integer, + Optional['InfoHook'] => Pattern[/^((iat|access_token|access_token_expires|id_token|userinfo|refresh_token|session)\s?)+$/], + Optional['BlackListedClaims'] => String, + Optional['WhiteListedClaims'] => String, + Optional['RefreshAccessTokenBeforeExpiry'] => Pattern[/^[0-9]+(\slogout_on_error)?$/], + }] +``` + +## Tasks + +### `init` + +Allows you to perform apache service functions + +**Supports noop?** false + +#### Parameters + +##### `action` + +Data type: `Enum[reload]` + +Action to perform + +##### `service_name` + +Data type: `Optional[String[1]]` + +The name of the apache service + diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/Rakefile b/modules/services/unix/http/apache_stretch_compatible/apache/Rakefile deleted file mode 100644 index 3994519d9..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/Rakefile +++ /dev/null @@ -1,38 +0,0 @@ -require 'puppetlabs_spec_helper/rake_tasks' -require 'puppet-lint/tasks/puppet-lint' -require 'puppet_blacksmith/rake_tasks' if Bundler.rubygems.find_name('puppet-blacksmith').any? - -PuppetLint.configuration.fail_on_warnings = true -PuppetLint.configuration.send('relative') -PuppetLint.configuration.send('disable_only_variable_string') - -desc 'Generate pooler nodesets' -task :gen_nodeset do - require 'beaker-hostgenerator' - require 'securerandom' - require 'fileutils' - - agent_target = ENV['TEST_TARGET'] - if ! agent_target - STDERR.puts 'TEST_TARGET environment variable is not set' - STDERR.puts 'setting to default value of "redhat-64default."' - agent_target = 'redhat-64default.' - end - - master_target = ENV['MASTER_TEST_TARGET'] - if ! master_target - STDERR.puts 'MASTER_TEST_TARGET environment variable is not set' - STDERR.puts 'setting to default value of "redhat7-64mdcl"' - master_target = 'redhat7-64mdcl' - end - - targets = "#{master_target}-#{agent_target}" - cli = BeakerHostGenerator::CLI.new([targets]) - nodeset_dir = "tmp/nodesets" - nodeset = "#{nodeset_dir}/#{targets}-#{SecureRandom.uuid}.yaml" - FileUtils.mkdir_p(nodeset_dir) - File.open(nodeset, 'w') do |fh| - fh.print(cli.execute) - end - puts nodeset -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/apache.pp b/modules/services/unix/http/apache_stretch_compatible/apache/apache.pp index 88ea25494..0c63066b8 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/apache.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/apache.pp @@ -15,4 +15,15 @@ class { 'apache': mpm_module => 'prefork' -} \ No newline at end of file +} + +exec { 'apache2-systemd-reload': + command => 'systemctl daemon-reload; systemctl enable apache2', + path => [ '/usr/bin', '/bin', '/usr/sbin' ], +} +#-> +#service { 'apache2': +# ensure => running, +# provider => systemd, +# enable => true, +#} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/checksums.json b/modules/services/unix/http/apache_stretch_compatible/apache/checksums.json deleted file mode 100644 index c52d59c2a..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/checksums.json +++ /dev/null @@ -1,346 +0,0 @@ -{ - "CHANGELOG.md": "d5da65931d19f0aabf13a428dc56bc0c", - "CONTRIBUTING.md": "77d0440d7cd4206497f99065c60bed46", - "Gemfile": "bedf635025b279d7c7732adcc8ae9a29", - "LICENSE": "3b83ef96387f14655fc854ddc3c6bd57", - "MAINTAINERS.md": "6508b1d302b38186425992a66186c060", - "NOTICE": "b7760cf49f58b80b31df83244cc0fbd0", - "README.md": "b9a192cdc9ddecd060bc011a76df4b81", - "Rakefile": "a49b6653243c678ed33c8870db467d89", - "examples/apache.pp": "41e97262421ea5734fac16a338701a78", - "examples/dev.pp": "8da0d50d9d06834dd06329b8945f06d5", - "examples/init.pp": "d27415f33028c26d4031d30305eec5e0", - "examples/mod_load_params.pp": "e8d1c1b1b96d560c8288c51a76bffc87", - "examples/mods.pp": "78a25c9e226265353eabefd3ddfd4218", - "examples/mods_custom.pp": "bc9e6959c282984cf9cdd93869c89499", - "examples/php.pp": "afa0871b94040e3ae91fce9c375fb725", - "examples/vhost.pp": "27d808964b43d157de5ce8f47b441b46", - "examples/vhost_directories.pp": "95aa446a2fccf9f3561581a5d71c61a7", - "examples/vhost_filter.pp": "62c5af7868af9887b7d71769c319c1e5", - "examples/vhost_ip_based.pp": "7a4d4c1c00147c45e4534f58d2fbf4ed", - "examples/vhost_proxypass.pp": "2f0bd33b34a48554adcdf20d6d31a4c2", - "examples/vhost_ssl.pp": "ddd3c45964df56837d6c051a7d692378", - "examples/vhosts_without_listen.pp": "226afb3e87129a56fc9add21b120feb2", - "files/httpd": "295f5e924afe6f752d29327e73fe6d0a", - "lib/facter/apache_version.rb": "babb22b1d567021995b4b5fa9328047b", - "lib/puppet/parser/functions/bool2httpd.rb": "05d5deeb6e0c31acee7c55b249ec8e06", - "lib/puppet/parser/functions/validate_apache_log_level.rb": "d75bc4ef17ff5c9a1f94dd3948e733d1", - "lib/puppet/provider/a2mod/a2mod.rb": "d986d8e8373f3f31c97359381c180628", - "lib/puppet/provider/a2mod/gentoo.rb": "2492d446adbb68f678e86a75eb7ff3bd", - "lib/puppet/provider/a2mod/modfix.rb": "b689a1c83c9ccd8590399c67f3e588e5", - "lib/puppet/provider/a2mod/redhat.rb": "c39b80e75e7d0666def31c2a6cdedb0b", - "lib/puppet/provider/a2mod.rb": "03ed73d680787dd126ea37a03be0b236", - "lib/puppet/type/a2mod.rb": "9042ccc045bfeecca28bebb834114f05", - "locales/config.yaml": "ca04e502d031649d4aaa40d1803ade8b", - "locales/puppetlabs-apache.pot": "4bd09a821333cf6c272a64e944ef4e01", - "manifests/balancer.pp": "b444ff1415ba0bd6c8ec1497bcc9cfb3", - "manifests/balancermember.pp": "d74ab23d74fa198853b13ad837df925c", - "manifests/confd/no_accf.pp": "406d0ca41c3b90f83740ca218dc3f484", - "manifests/custom_config.pp": "357badc11586c8bb726f2a36364c0932", - "manifests/default_confd_files.pp": "86fdbe5773abb7c2da26db096973865c", - "manifests/default_mods/load.pp": "bc0b3b65edd1ba6178c09672352f9bce", - "manifests/default_mods.pp": "e4a7aa787443fce2e76c37e8fec99012", - "manifests/dev.pp": "8a7ead42f991e5dfdd364ba1aa1304e0", - "manifests/fastcgi/server.pp": "f177293f02a2878b43a863e8ab3015db", - "manifests/init.pp": "5d0b9eccf800e4c0b293bed68571c4ec", - "manifests/listen.pp": "6e44a9f49376cefb5694d52be5bc5a88", - "manifests/mod/actions.pp": "ec2a5d1cf54790204750f9b67938d230", - "manifests/mod/alias.pp": "1ef0d98a941bd796d428297b74acc8c4", - "manifests/mod/auth_basic.pp": "dffef6ff10145393cb78fcaa27220c53", - "manifests/mod/auth_cas.pp": "f2e61e67393a998a19f8b34506e07e0d", - "manifests/mod/auth_kerb.pp": "8759cab3dc12d6ba4cc12fcdbb699418", - "manifests/mod/auth_mellon.pp": "5bfbc604dd79923bdb65ecab02353059", - "manifests/mod/authn_core.pp": "4db773ddbc0d875230085782d4521951", - "manifests/mod/authn_dbd.pp": "8f03863a483184ca53b9bc3a45b2297f", - "manifests/mod/authn_file.pp": "eeb11513490beee901574746faaeabdf", - "manifests/mod/authnz_ldap.pp": "5fb4b52f54daf03358e08cde676ea4fc", - "manifests/mod/authnz_pam.pp": "9f99d93e289a2db42c74046c8ae1889f", - "manifests/mod/authz_default.pp": "b7c94cfa4e008155fffd241d35834064", - "manifests/mod/authz_user.pp": "d446c90c44304594206bd2a0112be625", - "manifests/mod/autoindex.pp": "3b50dc082dba420c3d564309601fd419", - "manifests/mod/cache.pp": "b56d68b9401ba3e02a1f2fe55cdfbcca", - "manifests/mod/cgi.pp": "731ed7bce75628afeb78afd3fa2fd793", - "manifests/mod/cgid.pp": "fb9ae9b5012d41e22cb85c0b50e17361", - "manifests/mod/cluster.pp": "8b67026e9a6a4bdc6a2481613896ded1", - "manifests/mod/dav.pp": "9df80d36dd609be9032a8260aa9d10c1", - "manifests/mod/dav_fs.pp": "9ad2359d64b0b6f219bd8a338917d114", - "manifests/mod/dav_svn.pp": "abc1ba954033b0b0187c079f310eb0e2", - "manifests/mod/dbd.pp": "4471dbd9fd67d0db885d4ba2a47a194a", - "manifests/mod/deflate.pp": "20231a22aba12eb905f1d7f1853e383e", - "manifests/mod/dev.pp": "42673bab60b6fc0f3aa6e2357ec0a27c", - "manifests/mod/dir.pp": "75039bc8c77b9b82fa12fc5aa1061291", - "manifests/mod/disk_cache.pp": "da18cbefced9bb32fc009e999c5b76e2", - "manifests/mod/dumpio.pp": "5492a7249450a7fdf335ecb0c3b948f4", - "manifests/mod/env.pp": "2a0321180a59161565b2b5f1b79d6b15", - "manifests/mod/event.pp": "a82a7ab979cc351eb660576bdc91d0e8", - "manifests/mod/expires.pp": "6f12edcf6863958af832db73b56e5f08", - "manifests/mod/ext_filter.pp": "287966c2c0fd450c72a1c9ef88a0e155", - "manifests/mod/fastcgi.pp": "96a3fcf0508a7eb8c9601eac329622eb", - "manifests/mod/fcgid.pp": "96e0a5f09c2d1ba21b2209a6e21b6847", - "manifests/mod/filter.pp": "b0039f3ae932b1204994ef2180dd76d2", - "manifests/mod/geoip.pp": "41762c637ab45dac05e564d1b3d03c3e", - "manifests/mod/headers.pp": "ef3de538a0a4c9406236faf43eb89710", - "manifests/mod/include.pp": "a3b66eda88e38d90825c16b834bacd8d", - "manifests/mod/info.pp": "c3e815ed9912bb9147805f7274508489", - "manifests/mod/intercept_form_submit.pp": "b3e55433272082bac1e7a5334df3b01f", - "manifests/mod/itk.pp": "f631157ebdff68b6fc2bb6dbd5b8e8c4", - "manifests/mod/ldap.pp": "319e62a24e30221e691b9cf85a6288e1", - "manifests/mod/lookup_identity.pp": "a3fd01d395ea09ec1488494fd077dd7b", - "manifests/mod/mime.pp": "24fe99c65367a3f606441605a2ff26dd", - "manifests/mod/mime_magic.pp": "d31702cee9007c2e65c8d3ccbed1fda3", - "manifests/mod/negotiation.pp": "35fb1e9fa643054271804e215bb47299", - "manifests/mod/nss.pp": "3cc69b59bba579181b0ceb1dfd2976d0", - "manifests/mod/pagespeed.pp": "1fcf4c30084bd1e4fa3006b4d3265c1a", - "manifests/mod/passenger.pp": "f1a4609f61e30fc839ad7f4b668a750b", - "manifests/mod/perl.pp": "b8180ca0e1e7f8d60030321f52c28d6d", - "manifests/mod/peruser.pp": "13761222709094653bca7bad4435fcdb", - "manifests/mod/php.pp": "b6d383242b3c52a2543f8f477ff308a0", - "manifests/mod/prefork.pp": "3deff89f43a1f55dda643ac66e3fc4dc", - "manifests/mod/proxy.pp": "a65065f0c7705b7b75b1dd6fc2222e27", - "manifests/mod/proxy_ajp.pp": "073e2406aea7822750d4c21f02d8ac80", - "manifests/mod/proxy_balancer.pp": "c717e51517043084854b26c89d7b99d9", - "manifests/mod/proxy_connect.pp": "7cd9b4b61ec6feb020f753ee74910a48", - "manifests/mod/proxy_fcgi.pp": "8c7fd559419b159e27218a17463d850d", - "manifests/mod/proxy_html.pp": "aa012e927e20d3f7734fdc026491fd20", - "manifests/mod/proxy_http.pp": "0db1b26f8b4036b0d46ba86b7eaac561", - "manifests/mod/proxy_wstunnel.pp": "88ee88d6d56a70f0000e690f80f64acb", - "manifests/mod/python.pp": "6f65b22271cf356832fe7a1949163861", - "manifests/mod/remoteip.pp": "9ad1d5712477f11ae2643f209bb08ce3", - "manifests/mod/reqtimeout.pp": "17b245b5d14f3f7b8c1d5fa07e5c159e", - "manifests/mod/rewrite.pp": "292f2d6ce2078fa9df7f686105ea7b95", - "manifests/mod/rpaf.pp": "54991f51a06e2b4171956e6ce1caf3a3", - "manifests/mod/security.pp": "b5ed320cbcce30b79557dd38941d339b", - "manifests/mod/setenvif.pp": "fa3b3e5f3a7e029f9db5b66ae499c6c8", - "manifests/mod/shib.pp": "8b75f8818fe9dc5728a478fc27962447", - "manifests/mod/socache_shmcb.pp": "c94ae23ab8cce744acad2f7e33dbfa9c", - "manifests/mod/speling.pp": "b6971e10caf22837e410b94910b66b1a", - "manifests/mod/ssl.pp": "ed4255fa17a174ce02fd8eef399c0ae1", - "manifests/mod/status.pp": "75d19ef4dde3529359d080c6607926f0", - "manifests/mod/suexec.pp": "2a8671856a0ece597e9b57867dc35e76", - "manifests/mod/suphp.pp": "5a7390ef0a0ceaa2d7e684bcb6300587", - "manifests/mod/userdir.pp": "8cce2ae6536eab6b809c63cb6ed59c55", - "manifests/mod/version.pp": "6cb31057ebffa796f95642cc95f9499d", - "manifests/mod/vhost_alias.pp": "ee1225a748daaf50aca39a6d93fb8470", - "manifests/mod/worker.pp": "41137580c48b89f2795c1295d87962c0", - "manifests/mod/wsgi.pp": "adcaac9e490512a58d0e6070904c85d2", - "manifests/mod/xsendfile.pp": "fba06f05a19c466654aca5ecaa705bf0", - "manifests/mod.pp": "405f340daea9c50913904818ca4041d7", - "manifests/mpm.pp": "d4bfe77df34110cb253557104b2e6310", - "manifests/namevirtualhost.pp": "5ad54a441ff26a55cc536069d8fad238", - "manifests/package.pp": "ebd1e1e815ef744ebd4e9d8a6c94a07a", - "manifests/params.pp": "605e33b78b4eb131ac9e9bad335ce88f", - "manifests/peruser/multiplexer.pp": "0ea75341b7a93e55bcfb431a93b1a6c9", - "manifests/peruser/processor.pp": "62f0ad5ed2ec36dadc7f40ad2a9e1bb9", - "manifests/php.pp": "9c9d07e12bf5d112b0b54f5bd69046fc", - "manifests/proxy.pp": "7c8515b88406922e148322ee15044b29", - "manifests/python.pp": "ddef4cd73850fdc2dc126d4579c30adf", - "manifests/security/rule_link.pp": "9c879ecfd7534347ccc8cf3ea77fa859", - "manifests/service.pp": "9984fd2cfd49cea0b8db61f7cc3c1c4b", - "manifests/ssl.pp": "173f3d6a7fd2b5f4100c4ff03d84e13b", - "manifests/version.pp": "3388b1978b04cba63ed7fc8e2ec3f692", - "manifests/vhost/custom.pp": "421081f6c4f33e1aca07ff789e53345e", - "manifests/vhost.pp": "707b86ad96804fed2413ef6366ac43b4", - "manifests/vhosts.pp": "d5cd9e6b701b7b2948c011546bc55497", - "metadata.json": "f9025597336b7ffb8631e1c5949985ae", - "spec/acceptance/apache_parameters_spec.rb": "d8d8f53c76a65558f189a33ef063976a", - "spec/acceptance/apache_ssl_spec.rb": "9cddf1b1b3a4ed2fe971fabe8785e9ed", - "spec/acceptance/class_spec.rb": "9d77ee23b734dd48ecea4353dee3d616", - "spec/acceptance/custom_config_spec.rb": "61e03d814d0671d194dd40e6b1ad5c9b", - "spec/acceptance/default_mods_spec.rb": "2481bfa99dd34e15f2b4c7eed194635f", - "spec/acceptance/itk_spec.rb": "812c855013c08ebb13e642dc5199b41a", - "spec/acceptance/mod_dav_svn_spec.rb": "e792a6d585026dd7bded38e62c8786f6", - "spec/acceptance/mod_deflate_spec.rb": "dd39bfb069e0233bf134caaeb1dc6fe6", - "spec/acceptance/mod_fcgid_spec.rb": "ef0e3368ea14247c05ff43217b5856ee", - "spec/acceptance/mod_mime_spec.rb": "0869792d98c1b2577f02d97c92f1765e", - "spec/acceptance/mod_negotiation_spec.rb": "017f6b0cc1496c25aa9b8a33ef8dbbb3", - "spec/acceptance/mod_pagespeed_spec.rb": "23256a41b700fc92a96edf34a16be499", - "spec/acceptance/mod_passenger_spec.rb": "a66264ef73ad6c5396a06ab9b5444c7c", - "spec/acceptance/mod_php_spec.rb": "98bc1ff97a36de86d5a1b800b2afd7a6", - "spec/acceptance/mod_proxy_html_spec.rb": "34478fc2f12a23cd5a95d424f85da150", - "spec/acceptance/mod_security_spec.rb": "c783d44cf3ccba2fa6a3c14de0e486a0", - "spec/acceptance/mod_suphp_spec.rb": "f5c1f21e4c5323b81afc354c82e7ceb9", - "spec/acceptance/nodesets/centos-7-x64.yml": "a713f3abd3657f0ae2878829badd23cd", - "spec/acceptance/nodesets/debian-8-x64.yml": "d2d2977900989f30086ad251a14a1f39", - "spec/acceptance/nodesets/default.yml": "b42da5a1ea0c964567ba7495574b8808", - "spec/acceptance/nodesets/docker/centos-7.yml": "8a3892807bdd62306ae4774f41ba11ae", - "spec/acceptance/nodesets/docker/debian-8.yml": "ac8e871d1068c96de5e85a89daaec6df", - "spec/acceptance/nodesets/docker/ubuntu-14.04.yml": "dc42ee922a96908d85b8f0f08203ce58", - "spec/acceptance/nodesets/suse.yml": "eff62186e4de2ffed45a72a375380338", - "spec/acceptance/prefork_worker_spec.rb": "1570eefe61d667a1b43824adc0b2bb78", - "spec/acceptance/service_spec.rb": "341f157cb33fa48d5166d2274ad3bc65", - "spec/acceptance/version.rb": "6a1f2db3e369f3dc2b5bd76f4921891a", - "spec/acceptance/vhost_spec.rb": "ac0e99a6dfbe8faa2837bf2356fdda7d", - "spec/acceptance/vhosts_spec.rb": "c9635037681d569a053da6eb7ae5f4f4", - "spec/classes/apache_spec.rb": "c75f9bf2fedf99c4d478536d3786223c", - "spec/classes/dev_spec.rb": "6bc9ff7cffb77aac52c5bd3acc157d2d", - "spec/classes/mod/alias_spec.rb": "e62706d9925b0dc1821db78d01986a7e", - "spec/classes/mod/auth_cas_spec.rb": "46a7ba3fe31d3fc6175b8dce5105326e", - "spec/classes/mod/auth_kerb_spec.rb": "d281ff13b8989d759bd7fcdb599a882a", - "spec/classes/mod/auth_mellon_spec.rb": "81d3ea4b7567718ca810b625fd36d231", - "spec/classes/mod/authn_dbd_spec.rb": "8c794faaa5244e16f432c76679cb12d7", - "spec/classes/mod/authnz_ldap_spec.rb": "bef6980f85489c5fd7388511cb65b644", - "spec/classes/mod/authnz_pam_spec.rb": "71759e9ab2dd8aeefeb4d79e3349e67e", - "spec/classes/mod/cluster_spec.rb": "c1d01cc4a4f9ce10d692294019791e2f", - "spec/classes/mod/dav_svn_spec.rb": "6b3c4123a067e249f6c78c5b0cbcbcc7", - "spec/classes/mod/deflate_spec.rb": "adf6e41357fefe4ff1128e8fea4d3057", - "spec/classes/mod/dev_spec.rb": "1a30ef5fb18073fd2bf6f7923ff9c57f", - "spec/classes/mod/dir_spec.rb": "9e25507c094cb3b2fe6eb1106668b484", - "spec/classes/mod/disk_cache_spec.rb": "e821fa50ace7ab3398c43b16034748e9", - "spec/classes/mod/dumpio_spec.rb": "689d167b05e669c29709fc36940e7b05", - "spec/classes/mod/event_spec.rb": "46a304c796ac3928be0a67bec1f46b4f", - "spec/classes/mod/expires_spec.rb": "0d27e3438627f2ad34abacf582fb8b0b", - "spec/classes/mod/ext_filter_spec.rb": "7af18fdf1376f17e68dc99e5627ba067", - "spec/classes/mod/fastcgi_spec.rb": "59f7ea857b0fa614e8808270c529300f", - "spec/classes/mod/fcgid_spec.rb": "bda06cc347a8da8d7c7374add2654248", - "spec/classes/mod/info_spec.rb": "d51c6a9e6ae4d944488a43c8c15b95c0", - "spec/classes/mod/intercept_form_submit_spec.rb": "2e7087360a57f6ccf88b80239ca5056e", - "spec/classes/mod/itk_spec.rb": "622f23a1346383846cbc98e38388034d", - "spec/classes/mod/ldap_spec.rb": "12863d495558fbe9f6cb7a50ab37688c", - "spec/classes/mod/lookup_identity.rb": "97997c0a2e7a1b717426b5845df604ee", - "spec/classes/mod/mime_magic_spec.rb": "259304a80e92e4ba15e7cd719fe25c17", - "spec/classes/mod/mime_spec.rb": "d946fb96659b67bf7117ad7ed4b25cce", - "spec/classes/mod/negotiation_spec.rb": "44d50f7e6ef8c6388baa4c7cfc07be43", - "spec/classes/mod/pagespeed_spec.rb": "56bd7d82920cb734ea8139c9fed97de7", - "spec/classes/mod/passenger_spec.rb": "e8daaeafddd8b8ac33800c04a93b5c03", - "spec/classes/mod/perl_spec.rb": "1daa227f563ac19ff8dcdea0d0005ec4", - "spec/classes/mod/peruser_spec.rb": "c379ce85a997789856b12c27957bf994", - "spec/classes/mod/php_spec.rb": "2cc1a1d5d097be26eef3139b4e8eafaf", - "spec/classes/mod/prefork_spec.rb": "d82f0f25691ba019b912cd000dbb845f", - "spec/classes/mod/proxy_balancer_spec.rb": "c0bd0c3ebf39d7c66120b3837551f6b1", - "spec/classes/mod/proxy_connect_spec.rb": "baef920356c839b698c2adb865e79b5f", - "spec/classes/mod/proxy_html_spec.rb": "c6fc0e6b0cbcd3d5f9e65d533366ee32", - "spec/classes/mod/proxy_wstunnel.rb": "69bcef5e88aeb115290d8428186c80ec", - "spec/classes/mod/python_spec.rb": "5ca2dd0829b7baa1022c551b66548b20", - "spec/classes/mod/remoteip_spec.rb": "f9bf0bc64fef6d570f7b798ceef0d598", - "spec/classes/mod/reqtimeout_spec.rb": "2af2919e8253100fbc2e001d30a5cd15", - "spec/classes/mod/rpaf_spec.rb": "5c4725a4bcab9339d7309765390aaed1", - "spec/classes/mod/security_spec.rb": "f2e41f16ff5e8aa8f4709cab68a7cf5e", - "spec/classes/mod/shib_spec.rb": "b4ec345e387f8d7186048f5d286bb71d", - "spec/classes/mod/speling_spec.rb": "96919b9fbd1e894fcfd649044c3dafb5", - "spec/classes/mod/ssl_spec.rb": "9c9fe05b815405d4e7fbb095e01d7d2a", - "spec/classes/mod/status_spec.rb": "1eeaf906baf6ca82bf24c4e23494c71c", - "spec/classes/mod/suphp_spec.rb": "cc7c02c42e985aa133f9d868e14d9435", - "spec/classes/mod/userdir_spec.rb": "648ab42ba4113b31712ecf8d9ec485e0", - "spec/classes/mod/worker_spec.rb": "c326e36fbcfe9f0c59dc1db389a33926", - "spec/classes/mod/wsgi_spec.rb": "902251d74d6d3c821f460b620158295b", - "spec/classes/params_spec.rb": "adbd9f0dee677ea9439b9ce0d620894f", - "spec/classes/service_spec.rb": "0709833b94c1a3fbd13b73042fa84967", - "spec/classes/vhosts_spec.rb": "9baf23eb534e944a1bd593e72dd3050e", - "spec/defines/balancer_spec.rb": "8793815eb22b5190977b154fcd97e85e", - "spec/defines/balancermember_spec.rb": "e93ded8b51cc1d73e52f453880b3576e", - "spec/defines/custom_config_spec.rb": "cd4ee6803b79a844442107ac385cc833", - "spec/defines/fastcgi_server_spec.rb": "8e167c1525cb9a7473efdde01efe0ca3", - "spec/defines/mod_spec.rb": "a10e5b2570419737c03cd0f6347cc985", - "spec/defines/modsec_link_spec.rb": "3421b21f8234637dd1c32ebcf89e44c3", - "spec/defines/vhost_custom_spec.rb": "d5596a7a0c239d4c0ed8bebbb6a124ab", - "spec/defines/vhost_spec.rb": "b338a9fe8d5bd1f2002025905c2c4a74", - "spec/fixtures/files/negotiation.conf": "9c11872e26327ec880749b5dfdea25d6", - "spec/fixtures/files/spec": "e964ecac35c35baa9b4c57dac4ff5b3e", - "spec/fixtures/site_apache/templates/fake.conf.erb": "6b0431dd0b9a0bf803eb0684300c2cff", - "spec/fixtures/templates/negotiation.conf.erb": "c838e612ce6f82a5efd12871ad562011", - "spec/spec_helper.rb": "b2db3bc02b4ac2fd5142a6621c641b07", - "spec/spec_helper_acceptance.rb": "97b5d5677a368ac97cdc3ae2ab5e204f", - "spec/spec_helper_local.rb": "1b6ccd9b2f6946b81560239881774e94", - "spec/unit/apache_version_spec.rb": "c9d7b8ab46fb21d370702f02088281a2", - "spec/unit/provider/a2mod/gentoo_spec.rb": "02f7510cbf4945c5e1094ebcb967c8e0", - "spec/unit/puppet/parser/functions/bool2httpd_spec.rb": "0c9bca53eb43b5fc888126514b2a174c", - "spec/unit/puppet/parser/functions/validate_apache_log_level.rb": "8f558fd81d1655e9ab20896152eca512", - "templates/confd/no-accf.conf.erb": "a614f28c4b54370e4fa88403dfe93eb0", - "templates/fastcgi/server.erb": "30cdd04393bdb4f68678d00e2930721b", - "templates/httpd.conf.erb": "3667dc46bedcfd2b79f82570b1063623", - "templates/listen.erb": "6286aa08f9e28caee54b1e1ee031b9d6", - "templates/mod/alias.conf.erb": "370e9d394dd462d3ebc0dd345ab68f6f", - "templates/mod/auth_cas.conf.erb": "35e1291a5fa05067d7623c02bafb0ada", - "templates/mod/auth_mellon.conf.erb": "4e17d22a8f1bc312e976e8513199c945", - "templates/mod/authn_dbd.conf.erb": "7a84f5d3b3a4b92a88fe052b13376f8e", - "templates/mod/authnz_ldap.conf.erb": "2262e6d90ae81f2b732bbf0163006c59", - "templates/mod/autoindex.conf.erb": "2421a3c6df32c7e38c2a7a22afdf5728", - "templates/mod/cgid.conf.erb": "f8ce27d60bc495bab16de2696ebb2fd0", - "templates/mod/cluster.conf.erb": "9e92178f1d45193868e41e7fe1a06976", - "templates/mod/dav_fs.conf.erb": "10c1131168e35319e22b3fbfe51aebfd", - "templates/mod/deflate.conf.erb": "e866ecf2bfe8e42ea984267f569723db", - "templates/mod/dir.conf.erb": "2485da78a2506c14bf51dde38dd03360", - "templates/mod/disk_cache.conf.erb": "48d1b54ec1dedea7f68451bc0774790e", - "templates/mod/dumpio.conf.erb": "260a03d5f5b450095a5374690fbb34b2", - "templates/mod/event.conf.erb": "5e4095242d8e5dd99fe0823cfa2f1434", - "templates/mod/expires.conf.erb": "7a77f8b1d50c53ee77a6cb798c51a2b9", - "templates/mod/ext_filter.conf.erb": "4e4e4143ab402a9f9d51301b1a192202", - "templates/mod/fastcgi.conf.erb": "2404caa7d91dea083fc4f8b6f18acd24", - "templates/mod/fcgid.conf.erb": "1780c7808bb3811deaf0007c890df4dc", - "templates/mod/geoip.conf.erb": "93b95f44ec733ee8231be82381e02782", - "templates/mod/info.conf.erb": "c8580f35594e8f76da9c961def618739", - "templates/mod/itk.conf.erb": "eff84b78e4f2f8c5c3a2e9fc4b8aad16", - "templates/mod/ldap.conf.erb": "03ef6f461e4778342e6b94b8b4f3cd3a", - "templates/mod/load.erb": "01132434e6101080c41548b0ba7e57d8", - "templates/mod/mime.conf.erb": "2fa5a10d06ff979de1d5d2544586ab45", - "templates/mod/mime_magic.conf.erb": "067c3180b4216439b039822114144e78", - "templates/mod/mpm_event.conf.erb": "80097a19d063a4f973465d9ef5c0c0bf", - "templates/mod/negotiation.conf.erb": "a2f0fb40cd038cb17bedc2b84d9f48ea", - "templates/mod/nss.conf.erb": "03a7a3721b19706e00df00e457c5df69", - "templates/mod/pagespeed.conf.erb": "d1d8dfb00e528aab10a24518c7f148a6", - "templates/mod/passenger.conf.erb": "81512838f2fb7f01bf7fd674f023d086", - "templates/mod/peruser.conf.erb": "c4f4054aee899249ea6fef5a9e5c14ff", - "templates/mod/php.conf.erb": "c535da6adea16bdcb0586260eedf8c93", - "templates/mod/prefork.conf.erb": "f9ec5a7eaea78a19b04fa69f8acd8a84", - "templates/mod/proxy.conf.erb": "33a6a57edd324ba56e879a7b077ecf08", - "templates/mod/proxy_balancer.conf.erb": "a9f8d51a2a7169e5fd0c8415a3f9c662", - "templates/mod/proxy_html.conf.erb": "1236e21e77bcc077dd71dbef98c911c7", - "templates/mod/remoteip.conf.erb": "ad58e174410e3ff46ff93d4ad1e7b8a0", - "templates/mod/reqtimeout.conf.erb": "314ef068b786ae5afded290a8b6eab15", - "templates/mod/rpaf.conf.erb": "5447539c083ae54f3a9e93c1ac8c988b", - "templates/mod/security.conf.erb": "e309716298ed8709df5496c27d47fe36", - "templates/mod/security_crs.conf.erb": "5c7bc134c0675d75b66a5c8faaf11eb6", - "templates/mod/setenvif.conf.erb": "c7ede4173da1915b7ec088201f030c28", - "templates/mod/ssl.conf.erb": "f88b0d03bbbc9b0773475434a2ef0f93", - "templates/mod/status.conf.erb": "574ecc6f74e8b75d84710a44c4260210", - "templates/mod/suphp.conf.erb": "05bb7b3ea23976b032ce405bfd4edd18", - "templates/mod/userdir.conf.erb": "5d0185dc69bc30849bc1a2f63f652b74", - "templates/mod/worker.conf.erb": "dc4c7049af7312f5e82b3e72e8fccdfd", - "templates/mod/wsgi.conf.erb": "ba2ba5a5699889626f4bc7f5604070b0", - "templates/namevirtualhost.erb": "fbfca19a639e18e6c477e191344ac8ae", - "templates/ports_header.erb": "afe35cb5747574b700ebaa0f0b3a626e", - "templates/vhost/_access_log.erb": "522414033856b19a50a7ebb1c729438a", - "templates/vhost/_action.erb": "a004dfcac2e63cef65cf8aa0e270b636", - "templates/vhost/_additional_includes.erb": "10e9c0056e962c49459839a1576b082e", - "templates/vhost/_aliases.erb": "6412f695e911feac18986da38f290dae", - "templates/vhost/_allow_encoded_slashes.erb": "37dee0b6fe9287342a10b533955dff81", - "templates/vhost/_auth_cas.erb": "96fb19c558e7e187fe9160f00f39061c", - "templates/vhost/_auth_kerb.erb": "3d0de0c3066440dffcbc75215174705b", - "templates/vhost/_block.erb": "8fa2f970222dbc0a38898b5a0ab80411", - "templates/vhost/_charsets.erb": "d152b6a7815e9edc0fe9bf9acbe2f1ec", - "templates/vhost/_custom_fragment.erb": "325ff48cefc06db035daa3491c391a88", - "templates/vhost/_directories.erb": "cb400adc888ef3632e155b700c2117aa", - "templates/vhost/_docroot.erb": "65d882a3c9d6b6bdd2f9b771f378035a", - "templates/vhost/_error_document.erb": "81d3007c1301a5c5f244c082cfee9de2", - "templates/vhost/_fallbackresource.erb": "e6c103bee7f6f76b10f244fc9fd1cd3b", - "templates/vhost/_fastcgi.erb": "e6d743e11b776e155dc4f80c602fb7e1", - "templates/vhost/_file_footer.erb": "e27b2525783e590ca1820f1e2118285d", - "templates/vhost/_file_header.erb": "7c3c04eb4ac67403604113e2628696cf", - "templates/vhost/_filters.erb": "597b9de5ae210af9182a1c95172115e7", - "templates/vhost/_header.erb": "9eb9d4075f288183d8224ddec5b2f126", - "templates/vhost/_http_protocol_options.erb": "9df9dec592fdb8fb4ab4abf7227cef9c", - "templates/vhost/_itk.erb": "8bf90b9855a9277f7a665b10f6c57fe9", - "templates/vhost/_jk_mounts.erb": "ce997ee7b5602af04062cd5f785da345", - "templates/vhost/_keepalive_options.erb": "16876858bac1e55b13545866b0428d90", - "templates/vhost/_logging.erb": "5bc4cbb1bc8a292acc0ba0420f96ca4e", - "templates/vhost/_passenger.erb": "2c720e3c849f81898be5f3822a3f67be", - "templates/vhost/_passenger_base_uris.erb": "c8d7f4da1434078e856c72671942dcd8", - "templates/vhost/_php.erb": "a16a9f3e146ce463481205e083d4bf79", - "templates/vhost/_php_admin.erb": "107a57e9e7b3f86d1abcf743f672a292", - "templates/vhost/_proxy.erb": "18b9bbb791d248179a08eb36ab895e12", - "templates/vhost/_rack.erb": "ebe187c1bdc81eec9c8e0d9026120b18", - "templates/vhost/_redirect.erb": "2d40ece74203cc00b861a058db91962c", - "templates/vhost/_requestheader.erb": "db1b0cdda069ae809b5b83b0871ef991", - "templates/vhost/_require.erb": "932106f2c9ea604bba4ace78d22bdfee", - "templates/vhost/_rewrite.erb": "b7858eac95352744196006b57d4091df", - "templates/vhost/_scriptalias.erb": "98713f33cca15b22c749bd35ea9a7b41", - "templates/vhost/_security.erb": "0ade536a9d25342e7128996add04be56", - "templates/vhost/_serveralias.erb": "95fed45853629924467aefc271d5b396", - "templates/vhost/_serversignature.erb": "9bf5a458783ab459e5043e1cdf671fa7", - "templates/vhost/_setenv.erb": "6e6a7efb1b168da9673c9e6d00eadec5", - "templates/vhost/_ssl.erb": "788b293b65736aead0007fe3bc52448b", - "templates/vhost/_sslproxy.erb": "8ab477ac3aa325e46f07b3fbf188303f", - "templates/vhost/_suexec.erb": "f2b3f9b9ff8fbac4e468e02cd824675a", - "templates/vhost/_suphp.erb": "a1c4a5e4461adbfce870df0abd158b59", - "templates/vhost/_wsgi.erb": "7939532279d7655896ce1a5942116ca7" -} \ No newline at end of file diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/data/common.yaml b/modules/services/unix/http/apache_stretch_compatible/apache/data/common.yaml new file mode 100644 index 000000000..2fbf0ffd7 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/data/common.yaml @@ -0,0 +1 @@ +--- {} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/examples/apache.pp b/modules/services/unix/http/apache_stretch_compatible/apache/examples/apache.pp index 18ec55311..0d4543564 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/examples/apache.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/examples/apache.pp @@ -1,6 +1,6 @@ -include ::apache -include ::apache::mod::php -include ::apache::mod::cgi -include ::apache::mod::userdir -include ::apache::mod::disk_cache -include ::apache::mod::proxy_http +include apache +include apache::mod::php +include apache::mod::cgi +include apache::mod::userdir +include apache::mod::disk_cache +include apache::mod::proxy_http diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/examples/dev.pp b/modules/services/unix/http/apache_stretch_compatible/apache/examples/dev.pp index 5616e32ba..6c4f95571 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/examples/dev.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/examples/dev.pp @@ -1 +1 @@ -include ::apache::mod::dev +include apache::mod::dev diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/examples/init.pp b/modules/services/unix/http/apache_stretch_compatible/apache/examples/init.pp index 33911073b..b3f9f13aa 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/examples/init.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/examples/init.pp @@ -1 +1 @@ -include ::apache +include apache diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/examples/mod_load_params.pp b/modules/services/unix/http/apache_stretch_compatible/apache/examples/mod_load_params.pp index fa43132b7..879f2cfe5 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/examples/mod_load_params.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/examples/mod_load_params.pp @@ -1,8 +1,7 @@ # Tests the path and identifier parameters for the apache::mod class # Base class for clarity: -class { '::apache': } - +class { 'apache': } # Exaple parameter usage: apache::mod { 'testmod': diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/examples/mods.pp b/modules/services/unix/http/apache_stretch_compatible/apache/examples/mods.pp index 699638248..dd64e3b23 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/examples/mods.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/examples/mods.pp @@ -3,7 +3,6 @@ # Base class. Declares default vhost on port 80 and default ssl # vhost on port 443 listening on all interfaces and serving # $apache::docroot, and declaring our default set of modules. -class { '::apache': +class { 'apache': default_mods => true, } - diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/examples/mods_custom.pp b/modules/services/unix/http/apache_stretch_compatible/apache/examples/mods_custom.pp index 4098c83aa..103e52a4f 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/examples/mods_custom.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/examples/mods_custom.pp @@ -3,7 +3,7 @@ # Base class. Declares default vhost on port 80 and default ssl # vhost on port 443 listening on all interfaces and serving # $apache::docroot, and declaring a custom set of modules. -class { '::apache': +class { 'apache': default_mods => [ 'info', 'alias', @@ -13,4 +13,3 @@ class { '::apache': 'expires', ], } - diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/examples/php.pp b/modules/services/unix/http/apache_stretch_compatible/apache/examples/php.pp index ee187717e..1d926bfb4 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/examples/php.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/examples/php.pp @@ -1,4 +1,4 @@ -class { '::apache': +class { 'apache': mpm_module => 'prefork', } -include ::apache::mod::php +include apache::mod::php diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost.pp b/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost.pp index 440a56d4b..c0813d160 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost.pp @@ -5,7 +5,7 @@ # Base class. Declares default vhost on port 80 and default ssl # vhost on port 443 listening on all interfaces and serving # $apache::docroot -class { '::apache': } +class { 'apache': } # Most basic vhost apache::vhost { 'first.example.com': @@ -141,7 +141,6 @@ apache::vhost { 'fifteenth.example.com': rack_base_uris => ['/rackapp1', '/rackapp2'], } - # Vhost to redirect non-ssl to ssl apache::vhost { 'sixteenth.example.com non-ssl': servername => 'sixteenth.example.com', @@ -229,20 +228,17 @@ apache::vhost { 'subdomain.loc': serveraliases => ['*.loc',], } -# Vhost with SSLProtocol,SSLCipherSuite, SSLHonorCipherOrder +# Vhost with SSL (SSLProtocol, SSLCipherSuite & SSLHonorCipherOrder from default) apache::vhost { 'securedomain.com': - priority => '10', - vhost_name => 'www.securedomain.com', - port => '443', - docroot => '/var/www/secure', - ssl => true, - ssl_cert => '/etc/ssl/securedomain.cert', - ssl_key => '/etc/ssl/securedomain.key', - ssl_chain => '/etc/ssl/securedomain.crt', - ssl_protocol => '-ALL +TLSv1', - ssl_cipher => 'ALL:!aNULL:!ADH:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM', - ssl_honorcipherorder => 'On', - add_listen => false, + priority => '10', + vhost_name => 'www.securedomain.com', + port => '443', + docroot => '/var/www/secure', + ssl => true, + ssl_cert => '/etc/ssl/securedomain.cert', + ssl_key => '/etc/ssl/securedomain.key', + ssl_chain => '/etc/ssl/securedomain.crt', + add_listen => false, } # Vhost with access log environment variables writing control @@ -258,4 +254,3 @@ apache::vhost { 'twentysecond.example.com': docroot => '/var/www/twentysecond', rack_base_uris => ['/passengerapp1', '/passengerapp2'], } - diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_directories.pp b/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_directories.pp index df5a2d52a..f02734d02 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_directories.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_directories.pp @@ -1,7 +1,7 @@ # Base class. Declares default vhost on port 80 and default ssl # vhost on port 443 listening on all interfaces and serving # $apache::docroot -class { '::apache': } +class { 'apache': } # Example from README adapted. apache::vhost { 'readme.example.net': @@ -41,4 +41,3 @@ apache::vhost { 'files.example.net': }, ], } - diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_filter.pp b/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_filter.pp index 1a66b856b..ef27639c9 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_filter.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_filter.pp @@ -1,5 +1,5 @@ # Base class. Declares default vhost on port 80 with filters. -class { '::apache': } +class { 'apache': } # Example from README adapted. apache::vhost { 'readme.example.net': @@ -14,4 +14,3 @@ apache::vhost { 'readme.example.net': 'FilterProtocol COMPRESS DEFLATE change=yes;byteranges=no', ], } - diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_ip_based.pp b/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_ip_based.pp index 249c4199c..dc0fa4f33 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_ip_based.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_ip_based.pp @@ -3,7 +3,7 @@ # Base class. Turn off the default vhosts; we will be declaring # all vhosts below. -class { '::apache': +class { 'apache': default_vhost => false, } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_proxypass.pp b/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_proxypass.pp index 8edd0de9c..ca9c57dff 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_proxypass.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_proxypass.pp @@ -5,7 +5,7 @@ # Base class. Declares default vhost on port 80 and default ssl # vhost on port 443 listening on all interfaces and serving # $apache::docroot -class { '::apache': } +class { 'apache': } # Most basic vhost with proxy_pass apache::vhost { 'first.example.com': @@ -30,7 +30,7 @@ apache::vhost { 'second.example.com': 'params' => { 'retry' => '0', 'timeout' => '5', - } + } }, ], } @@ -59,7 +59,7 @@ apache::vhost { 'fourth.example.com': 'params' => { 'retry' => '0', 'timeout' => '5', - }, + }, 'keywords' => ['noquery', 'interpolate'] }, ], diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_ssl.pp b/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_ssl.pp index 53989ff1b..8e7a2b279 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_ssl.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhost_ssl.pp @@ -3,7 +3,7 @@ # Base class. Turn off the default vhosts; we will be declaring # all vhosts below. -class { '::apache': +class { 'apache': default_vhost => false, } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhosts_without_listen.pp b/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhosts_without_listen.pp index 0e97a0221..d42118bc2 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhosts_without_listen.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/examples/vhosts_without_listen.pp @@ -4,11 +4,10 @@ # Base class. Turn off the default vhosts; we will be declaring # all vhosts below. -class { '::apache': +class { 'apache': default_vhost => false, } - # Add two an IP-based vhost on 10.0.0.10, ssl and non-ssl apache::vhost { 'The first IP-based vhost, non-ssl': servername => 'first.example.com', diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/hiera.yaml b/modules/services/unix/http/apache_stretch_compatible/apache/hiera.yaml new file mode 100644 index 000000000..545fff327 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/hiera.yaml @@ -0,0 +1,21 @@ +--- +version: 5 + +defaults: # Used for any hierarchy level that omits these keys. + datadir: data # This path is relative to hiera.yaml's directory. + data_hash: yaml_data # Use the built-in YAML backend. + +hierarchy: + - name: "osfamily/major release" + paths: + # Used to distinguish between Debian and Ubuntu + - "os/%{facts.os.name}/%{facts.os.release.major}.yaml" + - "os/%{facts.os.family}/%{facts.os.release.major}.yaml" + # Used for Solaris + - "os/%{facts.os.family}/%{facts.kernelrelease}.yaml" + - name: "osfamily" + paths: + - "os/%{facts.os.name}.yaml" + - "os/%{facts.os.family}.yaml" + - name: 'common' + path: 'common.yaml' diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/lib/facter/apache_version.rb b/modules/services/unix/http/apache_stretch_compatible/apache/lib/facter/apache_version.rb index 63e4e1c2b..bb16670db 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/lib/facter/apache_version.rb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/lib/facter/apache_version.rb @@ -1,13 +1,29 @@ +# frozen_string_literal: true + Facter.add(:apache_version) do + confine kernel: ['FreeBSD', 'Linux'] setcode do - if Facter::Util::Resolution.which('apachectl') + apache_version = nil + + if Facter::Util::Resolution.which('httpd') + apache_version = Facter::Util::Resolution.exec('httpd -V 2>&1') + Facter.debug "Matching httpd '#{apache_version}'" + elsif Facter::Util::Resolution.which('apache2') + apache_version = Facter::Util::Resolution.exec('apache2 -V 2>&1') + Facter.debug "Matching apache2 '#{apache_version}'" + elsif Facter::Util::Resolution.which('apachectl') apache_version = Facter::Util::Resolution.exec('apachectl -v 2>&1') Facter.debug "Matching apachectl '#{apache_version}'" - %r{^Server version: Apache\/(\d+.\d+(.\d+)?)}.match(apache_version)[1] elsif Facter::Util::Resolution.which('apache2ctl') apache_version = Facter::Util::Resolution.exec('apache2ctl -v 2>&1') Facter.debug "Matching apache2ctl '#{apache_version}'" - %r{^Server version: Apache\/(\d+.\d+(.\d+)?)}.match(apache_version)[1] + end + + unless apache_version.nil? + match = %r{^Server version: Apache\/(\d+.\d+(.\d+)?)}.match(apache_version) + unless match.nil? + match[1] + end end end end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/apache/apache_pw_hash.rb b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/apache/apache_pw_hash.rb new file mode 100644 index 000000000..4606ac731 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/apache/apache_pw_hash.rb @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +# @summary DEPRECATED. Use the function [`apache::pw_hash`](#apachepw_hash) instead. +Puppet::Functions.create_function(:'apache::apache_pw_hash') do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + call_function('deprecation', 'apache::apache_pw_hash', 'This function is deprecated, please use apache::pw_hash instead.') + call_function('apache::pw_hash', *args) + end +end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/apache/bool2httpd.rb b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/apache/bool2httpd.rb new file mode 100644 index 000000000..1fb71c590 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/apache/bool2httpd.rb @@ -0,0 +1,36 @@ +# frozen_string_literal: true + +# @summary +# Transform a supposed boolean to On or Off. Passes all other values through. +# +Puppet::Functions.create_function(:'apache::bool2httpd') do + # @param arg + # The value to be converted into a string. + # + # @return + # Will return either `On` or `Off` if given a boolean value. Returns a string of any + # other given value. + # @example + # $trace_enable = false + # $server_signature = 'mail' + # + # apache::bool2httpd($trace_enable) # returns 'Off' + # apache::bool2httpd($server_signature) # returns 'mail' + # apache::bool2httpd(undef) # returns 'Off' + # + def bool2httpd(arg) + return 'Off' if arg.nil? || arg == false || matches_string?(arg, %r{false}i) || arg == :undef + return 'On' if arg == true || matches_string?(arg, %r{true}i) + arg.to_s + end + + private + + def matches_string?(value, matcher) + if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.4.0') + value =~ matcher + else + value.is_a?(String) && value.match?(matcher) + end + end +end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/apache/pw_hash.rb b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/apache/pw_hash.rb new file mode 100644 index 000000000..c56e916b9 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/apache/pw_hash.rb @@ -0,0 +1,23 @@ +# frozen_string_literal: true + +# @summary +# Hashes a password in a format suitable for htpasswd files read by apache. +# +# Currently uses SHA-hashes, because although this format is considered insecure, it's the +# most secure format supported by the most platforms. +Puppet::Functions.create_function(:'apache::pw_hash') do + # @param password + # The input that is to be hashed. + # + # @return + # Returns the hash of the input that was given. + dispatch :apache_pw_hash do + required_param 'String[1]', :password + return_type 'String' + end + + def apache_pw_hash(password) + require 'base64' + '{SHA}' + Base64.strict_encode64(Digest::SHA1.digest(password)) + end +end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/apache_pw_hash.rb b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/apache_pw_hash.rb new file mode 100644 index 000000000..7aad4400d --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/apache_pw_hash.rb @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +# @summary DEPRECATED. Use the namespaced function [`apache::pw_hash`](#apachepw_hash) instead. +Puppet::Functions.create_function(:apache_pw_hash) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + call_function('deprecation', 'apache_pw_hash', 'This function is deprecated, please use apache::pw_hash instead.') + call_function('apache::pw_hash', *args) + end +end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/bool2httpd.rb b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/bool2httpd.rb new file mode 100644 index 000000000..62569f7bb --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/functions/bool2httpd.rb @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +# @summary DEPRECATED. Use the namespaced function [`apache::bool2httpd`](#apachebool2httpd) instead. +Puppet::Functions.create_function(:bool2httpd) do + dispatch :deprecation_gen do + repeated_param 'Any', :args + end + def deprecation_gen(*args) + call_function('deprecation', 'bool2httpd', 'This function is deprecated, please use apache::bool2httpd instead.') + call_function('apache::bool2httpd', *args) + end +end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/parser/functions/bool2httpd.rb b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/parser/functions/bool2httpd.rb deleted file mode 100644 index 5fb79f6f5..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/parser/functions/bool2httpd.rb +++ /dev/null @@ -1,30 +0,0 @@ -Puppet::Parser::Functions::newfunction(:bool2httpd, :type => :rvalue, :doc => <<-EOS -Transform a supposed boolean to On or Off. Pass all other values through. -Given a nil value (undef), bool2httpd will return 'Off' - -Example: - - $trace_enable = false - $server_signature = 'mail' - - bool2httpd($trace_enable) - # => 'Off' - bool2httpd($server_signature) - # => 'mail' - bool2httpd(undef) - # => 'Off' - -EOS -) do |args| - raise(Puppet::ParseError, "bool2httpd() wrong number of arguments. Given: #{args.size} for 1)") if args.size != 1 - - arg = args[0] - - if arg.nil? or arg == false or arg =~ /false/i or arg == :undef - return 'Off' - elsif arg == true or arg =~ /true/i - return 'On' - end - - return arg.to_s -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/parser/functions/validate_apache_log_level.rb b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/parser/functions/validate_apache_log_level.rb deleted file mode 100644 index 8a1ade0be..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/parser/functions/validate_apache_log_level.rb +++ /dev/null @@ -1,27 +0,0 @@ -module Puppet::Parser::Functions - newfunction(:validate_apache_log_level, :doc => <<-'ENDHEREDOC') do |args| - Perform simple validation of a string against the list of known log - levels as per http://httpd.apache.org/docs/current/mod/core.html#loglevel - validate_apache_loglevel('info') - - Modules maybe specified with their own levels like these: - validate_apache_loglevel('warn ssl:info') - validate_apache_loglevel('warn mod_ssl.c:info') - validate_apache_loglevel('warn ssl_module:info') - - Expected to be used from the main or vhost. - - Might be used from directory too later as apaceh supports that - - ENDHEREDOC - if (args.size != 1) then - raise Puppet::ParseError, ("validate_apache_loglevel(): wrong number of arguments (#{args.length}; must be 1)") - end - - log_level = args[0] - msg = "Log level '${log_level}' is not one of the supported Apache HTTP Server log levels." - - raise Puppet::ParseError, (msg) unless log_level =~ Regexp.compile('(emerg|alert|crit|error|warn|notice|info|debug|trace[1-8])') - - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod.rb b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod.rb index 670aca3d0..7406e01da 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod.rb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod.rb @@ -1,33 +1,42 @@ +# frozen_string_literal: true + +# a2mod.rb class Puppet::Provider::A2mod < Puppet::Provider + # Fetches the mod provider def self.prefetch(mods) instances.each do |prov| - if mod = mods[prov.name] + mod = mods[prov.name] + if mod mod.provider = prov end end end + # Clear's the property_hash def flush @property_hash.clear end + # Returns a copy of the property_hash def properties if @property_hash.empty? - @property_hash = query || {:ensure => :absent} + @property_hash = query || { ensure: :absent } @property_hash[:ensure] = :absent if @property_hash.empty? end @property_hash.dup end + # Returns the properties of the given mod if it exists. def query self.class.instances.each do |mod| - if mod.name == self.name or mod.name.downcase == self.name + if mod.name == name || mod.name.downcase == name return mod.properties end end nil end + # Return's if the ensure property is absent or not def exists? properties[:ensure] != :absent end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/a2mod.rb b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/a2mod.rb index e257a579e..3330fd5dc 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/a2mod.rb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/a2mod.rb @@ -1,35 +1,37 @@ +# frozen_string_literal: true + require 'puppet/provider/a2mod' -Puppet::Type.type(:a2mod).provide(:a2mod, :parent => Puppet::Provider::A2mod) do - desc "Manage Apache 2 modules on Debian and Ubuntu" +Puppet::Type.type(:a2mod).provide(:a2mod, parent: Puppet::Provider::A2mod) do + desc 'Manage Apache 2 modules on Debian and Ubuntu' - optional_commands :encmd => "a2enmod" - optional_commands :discmd => "a2dismod" - commands :apache2ctl => "apache2ctl" + optional_commands encmd: 'a2enmod' + optional_commands discmd: 'a2dismod' + commands apache2ctl: 'apache2ctl' - confine :osfamily => :debian - defaultfor :operatingsystem => [:debian, :ubuntu] + confine osfamily: :debian + defaultfor operatingsystem: [:debian, :ubuntu] - def self.instances - modules = apache2ctl("-M").lines.collect { |line| - m = line.match(/(\w+)_module \(shared\)$/) - m[1] if m - }.compact + def self.instances + modules = apache2ctl('-M').lines.map { |line| + m = line.match(%r{(\w+)_module \(shared\)$}) + m[1] if m + }.compact - modules.map do |mod| - new( - :name => mod, - :ensure => :present, - :provider => :a2mod - ) - end + modules.map do |mod| + new( + name: mod, + ensure: :present, + provider: :a2mod, + ) end + end - def create - encmd resource[:name] - end + def create + encmd resource[:name] + end - def destroy - discmd resource[:name] - end + def destroy + discmd resource[:name] + end end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/gentoo.rb b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/gentoo.rb index 07319dfdc..c53fbd5b6 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/gentoo.rb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/gentoo.rb @@ -1,9 +1,11 @@ -require 'puppet/util/filetype' -Puppet::Type.type(:a2mod).provide(:gentoo, :parent => Puppet::Provider) do - desc "Manage Apache 2 modules on Gentoo" +# frozen_string_literal: true - confine :operatingsystem => :gentoo - defaultfor :operatingsystem => :gentoo +require 'puppet/util/filetype' +Puppet::Type.type(:a2mod).provide(:gentoo, parent: Puppet::Provider) do + desc 'Manage Apache 2 modules on Gentoo' + + confine operatingsystem: :gentoo + defaultfor operatingsystem: :gentoo attr_accessor :property_hash @@ -12,7 +14,7 @@ Puppet::Type.type(:a2mod).provide(:gentoo, :parent => Puppet::Provider) do end def exists? - (!(@property_hash[:ensure].nil?) and @property_hash[:ensure] == :present) + (!@property_hash[:ensure].nil? && @property_hash[:ensure] == :present) end def destroy @@ -30,34 +32,32 @@ Puppet::Type.type(:a2mod).provide(:gentoo, :parent => Puppet::Provider) do def self.clear @mod_resources = [] @modules = [] - @other_args = "" + @other_args = '' end def self.initvars - @conf_file = "/etc/conf.d/apache2" + @conf_file = '/etc/conf.d/apache2' @filetype = Puppet::Util::FileType.filetype(:flat).new(conf_file) @mod_resources = [] @modules = [] - @other_args = "" + @other_args = '' end - self.initvars + initvars # Retrieve an array of all existing modules def self.modules if @modules.length <= 0 # Locate the APACHE_OPTS variable - records = filetype.read.split(/\n/) - apache2_opts = records.grep(/^\s*APACHE2_OPTS=/).first + records = filetype.read.split(%r{\n}) + apache2_opts = records.grep(%r{^\s*APACHE2_OPTS=}).first # Extract all defines - while apache2_opts.sub!(/-D\s+(\w+)/, '') - @modules << $1.downcase - end + @modules << Regexp.last_match(1).downcase while apache2_opts.sub!(%r{-D\s+(\w+)}, '') # Hang on to any remaining options. - if apache2_opts.match(/APACHE2_OPTS="(.+)"/) - @other_args = $1.strip + if apache2_opts =~ %r{APACHE2_OPTS="(.+)"} + @other_args = Regexp.last_match(1).strip end @modules.sort!.uniq! @@ -66,51 +66,51 @@ Puppet::Type.type(:a2mod).provide(:gentoo, :parent => Puppet::Provider) do @modules end - def self.prefetch(resources={}) + def self.prefetch(resources = {}) # Match resources with existing providers instances.each do |provider| - if resource = resources[provider.name] + resource = resources[provider.name] + if resource resource.provider = provider end end # Store all resources using this provider for flushing - resources.each do |name, resource| + resources.each do |_name, resource| @mod_resources << resource end end def self.instances - modules.map {|mod| new(:name => mod, :provider => :gentoo, :ensure => :present)} + modules.map { |mod| new(name: mod, provider: :gentoo, ensure: :present) } end def self.flush - mod_list = modules - mods_to_remove = @mod_resources.select {|mod| mod.should(:ensure) == :absent}.map {|mod| mod[:name]} - mods_to_add = @mod_resources.select {|mod| mod.should(:ensure) == :present}.map {|mod| mod[:name]} + mods_to_remove = @mod_resources.select { |mod| mod.should(:ensure) == :absent }.map { |mod| mod[:name] } + mods_to_add = @mod_resources.select { |mod| mod.should(:ensure) == :present }.map { |mod| mod[:name] } mod_list -= mods_to_remove mod_list += mods_to_add mod_list.sort!.uniq! - if modules != mod_list - opts = @other_args + " " - opts << mod_list.map {|mod| "-D #{mod.upcase}"}.join(" ") - opts.strip! - opts.gsub!(/\s+/, ' ') + return unless modules != mod_list - apache2_opts = %Q{APACHE2_OPTS="#{opts}"} - Puppet.debug("Writing back \"#{apache2_opts}\" to #{conf_file}") + opts = @other_args + ' ' + opts << mod_list.map { |mod| "-D #{mod.upcase}" }.join(' ') + opts.strip! + opts.gsub!(%r{\s+}, ' ') - records = filetype.read.split(/\n/) + apache2_opts = %(APACHE2_OPTS="#{opts}") + Puppet.debug("Writing back \"#{apache2_opts}\" to #{conf_file}") - opts_index = records.find_index {|i| i.match(/^\s*APACHE2_OPTS/)} - records[opts_index] = apache2_opts + records = filetype.read.split(%r{\n}) - filetype.backup - filetype.write(records.join("\n")) - @modules = mod_list - end + opts_index = records.find_index { |i| i.match(%r{^\s*APACHE2_OPTS}) } + records[opts_index] = apache2_opts + + filetype.backup + filetype.write(records.join("\n")) + @modules = mod_list end end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/modfix.rb b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/modfix.rb index 8f35b2e4a..755c927e4 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/modfix.rb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/modfix.rb @@ -1,12 +1,13 @@ +# frozen_string_literal: true + Puppet::Type.type(:a2mod).provide :modfix do - desc "Dummy provider for A2mod. + desc "Dummy provider for A2mod. + Fake nil resources when there is no crontab binary available. Allows + puppetd to run on a bootstrapped machine before a Cron package has been + installed. Workaround for: http://projects.puppetlabs.com/issues/2384 + " - Fake nil resources when there is no crontab binary available. Allows - puppetd to run on a bootstrapped machine before a Cron package has been - installed. Workaround for: http://projects.puppetlabs.com/issues/2384 - " - - def self.instances - [] - end -end \ No newline at end of file + def self.instances + [] + end +end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/redhat.rb b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/redhat.rb index ea5494cb4..149a7b909 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/redhat.rb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/provider/a2mod/redhat.rb @@ -1,12 +1,14 @@ +# frozen_string_literal: true + require 'puppet/provider/a2mod' -Puppet::Type.type(:a2mod).provide(:redhat, :parent => Puppet::Provider::A2mod) do - desc "Manage Apache 2 modules on RedHat family OSs" +Puppet::Type.type(:a2mod).provide(:redhat, parent: Puppet::Provider::A2mod) do + desc 'Manage Apache 2 modules on RedHat family OSs' - commands :apachectl => "apachectl" + commands apachectl: 'apachectl' - confine :osfamily => :redhat - defaultfor :osfamily => :redhat + confine osfamily: :redhat + defaultfor osfamily: :redhat require 'pathname' @@ -18,14 +20,14 @@ Puppet::Type.type(:a2mod).provide(:redhat, :parent => Puppet::Provider::A2mod) d class << self attr_accessor :modpath def preinit - @modpath = "/etc/httpd/mod.d" + @modpath = '/etc/httpd/mod.d' end end - self.preinit + preinit def create - File.open(modfile,'w') do |f| + File.open(modfile, 'w') do |f| f.puts "LoadModule #{resource[:identifier]} #{libfile}" end end @@ -35,26 +37,26 @@ Puppet::Type.type(:a2mod).provide(:redhat, :parent => Puppet::Provider::A2mod) d end def self.instances - modules = apachectl("-M").lines.collect { |line| - m = line.match(/(\w+)_module \(shared\)$/) + modules = apachectl('-M').lines.map { |line| + m = line.match(%r{(\w+)_module \(shared\)$}) m[1] if m }.compact modules.map do |mod| new( - :name => mod, - :ensure => :present, - :provider => :redhat + name: mod, + ensure: :present, + provider: :redhat, ) end end def modfile - modfile ||= "#{self.class.modpath}/#{resource[:name]}.load" + "#{self.class.modpath}/#{resource[:name]}.load" end # Set libfile path: If absolute path is passed, then maintain it. Else, make it default from 'modules' dir. def libfile - libfile = Pathname.new(resource[:lib]).absolute? ? resource[:lib] : "modules/#{resource[:lib]}" + Pathname.new(resource[:lib]).absolute? ? resource[:lib] : "modules/#{resource[:lib]}" end end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/type/a2mod.rb b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/type/a2mod.rb index 07a911e5e..da04d7f4d 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/type/a2mod.rb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/lib/puppet/type/a2mod.rb @@ -1,30 +1,30 @@ +# frozen_string_literal: true + Puppet::Type.newtype(:a2mod) do - @doc = "Manage Apache 2 modules" + @doc = 'Manage Apache 2 modules' - ensurable + ensurable - newparam(:name) do - Puppet.warning "The a2mod provider is deprecated, please use apache::mod instead" - desc "The name of the module to be managed" + newparam(:name) do + Puppet.warning 'The a2mod provider is deprecated, please use apache::mod instead' + desc 'The name of the module to be managed' - isnamevar + isnamevar + end - end + newparam(:lib) do + desc 'The name of the .so library to be loaded' - newparam(:lib) do - desc "The name of the .so library to be loaded" + defaultto { "mod_#{@resource[:name]}.so" } + end - defaultto { "mod_#{@resource[:name]}.so" } - end - - newparam(:identifier) do - desc "Module identifier string used by LoadModule. Default: module-name_module" + newparam(:identifier) do + desc 'Module identifier string used by LoadModule. Default: module-name_module' - # http://httpd.apache.org/docs/2.2/mod/module-dict.html#ModuleIdentifier + # http://httpd.apache.org/docs/2.2/mod/module-dict.html#ModuleIdentifier - defaultto { "#{resource[:name]}_module" } - end - - autorequire(:package) { catalog.resource(:package, 'httpd')} + defaultto { "#{resource[:name]}_module" } + end + autorequire(:package) { catalog.resource(:package, 'httpd') } end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/locales/config.yaml b/modules/services/unix/http/apache_stretch_compatible/apache/locales/config.yaml deleted file mode 100644 index 0ec10ba97..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/locales/config.yaml +++ /dev/null @@ -1,25 +0,0 @@ ---- -# This is the project-specific configuration file for setting up -# fast_gettext for your project. -gettext: - # This is used for the name of the .pot and .po files; they will be - # called .pot? - project_name: puppetlabs-apache - # This is used in comments in the .pot and .po files to indicate what - # project the files belong to and should bea little more desctiptive than - # - package_name: puppetlabs-apache - # The locale that the default messages in the .pot file are in - default_locale: en - # The email used for sending bug reports. - bugs_address: docs@puppet.com - # The holder of the copyright. - copyright_holder: Puppet, Inc. - # This determines which comments in code should be eligible for translation. - # Any comments that start with this string will be externalized. (Leave - # empty to include all.) - comments_tag: TRANSLATOR - # Patterns for +Dir.glob+ used to find all files that might contain - # translatable content, relative to the project root directory - source_files: - diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/locales/puppetlabs-apache.pot b/modules/services/unix/http/apache_stretch_compatible/apache/locales/puppetlabs-apache.pot deleted file mode 100644 index 7602dd885..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/locales/puppetlabs-apache.pot +++ /dev/null @@ -1,25 +0,0 @@ -#, fuzzy -msgid "" -msgstr "" -"Project-Id-Version: PACKAGE VERSION\n" -"Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2017-03-21 14:19+0100\n" -"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" -"Last-Translator: FULL NAME \n" -"Language-Team: LANGUAGE \n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=UTF-8\n" -"Content-Transfer-Encoding: 8bit\n" -"X-Generator: Translate Toolkit 2.0.0\n" - -#. metadata.json -#: .summary -msgid "" -"Installs, configures, and manages Apache virtual hosts, web services, and " -"modules." -msgstr "" - -#. metadata.json -#: .description -msgid "Module for Apache configuration" -msgstr "" diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/balancer.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/balancer.pp index 41db8a8dc..6740a73c2 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/balancer.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/balancer.pp @@ -1,80 +1,89 @@ -# == Define Resource Type: apache::balancer +# @summary +# This type will create an apache balancer cluster file inside the conf.d +# directory. # -# This type will create an apache balancer cluster file inside the conf.d -# directory. Each balancer cluster needs one or more balancer members (that can +# Each balancer cluster needs one or more balancer members (that can # be declared with the apache::balancermember defined resource type). Using # storeconfigs, you can export the apache::balancermember resources on all # balancer members, and then collect them on a single apache load balancer # server. # -# === Requirement/Dependencies: +# @note +# Currently requires the puppetlabs/concat module on the Puppet Forge and uses +# storeconfigs on the Puppet Server to export/collect resources from all +# balancer members. # -# Currently requires the puppetlabs/concat module on the Puppet Forge and uses -# storeconfigs on the Puppet Master to export/collect resources from all -# balancer members. +# @param name +# The namevar of the defined resource type is the balancer clusters name.
+# This name is also used in the name of the conf.d file # -# === Parameters +# @param proxy_set +# Configures key-value pairs to be used as a ProxySet lines in the configuration. # -# [*name*] -# The namevar of the defined resource type is the balancer clusters name. -# This name is also used in the name of the conf.d file +# @param target +# The path to the file the balancer definition will be written in. # -# [*proxy_set*] -# Hash, default empty. If given, each key-value pair will be used as a ProxySet -# line in the configuration. +# @param collect_exported +# Determines whether to use exported resources.
+# If you statically declare all of your backend servers, set this parameter to false to rely +# on existing, declared balancer member resources. Also, use apache::balancermember with array +# arguments.
+# To dynamically declare backend servers via exported resources collected on a central node, +# set this parameter to true to collect the balancer member resources exported by the balancer +# member nodes.
+# If you don't use exported resources, a single Puppet run configures all balancer members. If +# you use exported resources, Puppet has to run on the balanced nodes first, then run on the +# balancer. # -# [*target*] -# String, default undef. If given, path to the file the balancer definition will -# be written. +# @param options +# Specifies an array of [options](https://httpd.apache.org/docs/current/mod/mod_proxy.html#balancermember) +# after the balancer URL, and accepts any key-value pairs available to `ProxyPass`. # -# [*collect_exported*] -# Boolean, default 'true'. True means 'collect exported @@balancermember -# resources' (for the case when every balancermember node exports itself), -# false means 'rely on the existing declared balancermember resources' (for the -# case when you know the full set of balancermembers in advance and use -# apache::balancermember with array arguments, which allows you to deploy -# everything in 1 run) -# -# -# === Examples -# -# Exporting the resource for a balancer member: -# -# apache::balancer { 'puppet00': } +# @example +# apache::balancer { 'puppet00': } # define apache::balancer ( $proxy_set = {}, $collect_exported = true, $target = undef, + $options = [], ) { - include ::apache::mod::proxy_balancer + include apache::mod::proxy_balancer if versioncmp($apache::mod::proxy_balancer::apache_version, '2.4') >= 0 { $lbmethod = $proxy_set['lbmethod'] ? { undef => 'byrequests', default => $proxy_set['lbmethod'], } - ensure_resource('apache::mod', "lbmethod_${lbmethod}") + ensure_resource('apache::mod', "lbmethod_${lbmethod}", { + 'loadfile_name' => "proxy_balancer_lbmethod_${lbmethod}.load" + }) } if $target { $_target = $target } else { - $_target = "${::apache::confd_dir}/balancer_${name}.conf" + $_target = "${apache::confd_dir}/balancer_${name}.conf" + } + + if !empty($options) { + $_options = " ${join($options, ' ')}" + } else { + $_options = '' } concat { "apache_balancer_${name}": owner => '0', group => '0', path => $_target, - mode => $::apache::file_mode, + mode => $apache::file_mode, notify => Class['Apache::Service'], } concat::fragment { "00-${name}-header": target => "apache_balancer_${name}", order => '01', - content => "\n", + content => "\n", } if $collect_exported { diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/balancermember.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/balancermember.pp index 6e8b29f13..3fa54960d 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/balancermember.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/balancermember.pp @@ -1,50 +1,48 @@ -# == Define Resource Type: apache::balancermember -# +# @summary +# Defines members of `mod_proxy_balancer` +# +# Sets up a balancer member inside a listening service configuration block in +# the load balancer's `apache.cfg`. +# # This type will setup a balancer member inside a listening service # configuration block in /etc/apache/apache.cfg on the load balancer. -# currently it only has the ability to specify the instance name, url and an +# Currently it only has the ability to specify the instance name, url and an # array of options. More features can be added as needed. The best way to # implement this is to export this resource for all apache balancer member # servers, and then collect them on the main apache load balancer. # -# === Requirement/Dependencies: +# @note +# Currently requires the puppetlabs/concat module on the Puppet Forge and +# uses storeconfigs on the Puppet Server to export/collect resources +# from all balancer members. # -# Currently requires the puppetlabs/concat module on the Puppet Forge and -# uses storeconfigs on the Puppet Master to export/collect resources -# from all balancer members. +# @param name +# The title of the resource is arbitrary and only utilized in the concat +# fragment name. # -# === Parameters +# @param balancer_cluster +# The apache service's instance name (or, the title of the apache::balancer +# resource). This must match up with a declared apache::balancer resource. # -# [*name*] -# The title of the resource is arbitrary and only utilized in the concat -# fragment name. +# @param url +# The url used to contact the balancer member server. # -# [*balancer_cluster*] -# The apache service's instance name (or, the title of the apache::balancer -# resource). This must match up with a declared apache::balancer resource. +# @param options +# Specifies an array of [options](https://httpd.apache.org/docs/current/mod/mod_proxy.html#balancermember) +# after the URL, and accepts any key-value pairs available to `ProxyPass`. # -# [*url*] -# The url used to contact the balancer member server. +# @example +# @@apache::balancermember { 'apache': +# balancer_cluster => 'puppet00', +# url => "ajp://${::fqdn}:8009" +# options => ['ping=5', 'disablereuse=on', 'retry=5', 'ttl=120'], +# } # -# [*options*] -# An array of options to be specified after the url. -# -# === Examples -# -# Exporting the resource for a balancer member: -# -# @@apache::balancermember { 'apache': -# balancer_cluster => 'puppet00', -# url => "ajp://${::fqdn}:8009" -# options => ['ping=5', 'disablereuse=on', 'retry=5', 'ttl=120'], -# } -# -define apache::balancermember( +define apache::balancermember ( $balancer_cluster, $url = "http://${::fqdn}/", $options = [], ) { - concat::fragment { "BalancerMember ${name}": target => "apache_balancer_${balancer_cluster}", content => inline_template(" BalancerMember ${url} <%= @options.join ' ' %>\n"), diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/confd/no_accf.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/confd/no_accf.pp index f35c0c8b9..024a088a9 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/confd/no_accf.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/confd/no_accf.pp @@ -1,10 +1,14 @@ +# @summary +# Manages the `no-accf.conf` file. +# +# @api private class apache::confd::no_accf { # Template uses no variables file { 'no-accf.conf': ensure => 'file', - path => "${::apache::confd_dir}/no-accf.conf", + path => "${apache::confd_dir}/no-accf.conf", content => template('apache/confd/no-accf.conf.erb'), - require => Exec["mkdir ${::apache::confd_dir}"], - before => File[$::apache::confd_dir], + require => Exec["mkdir ${apache::confd_dir}"], + before => File[$apache::confd_dir], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/custom_config.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/custom_config.pp index 6bffa05c7..52b94b489 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/custom_config.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/custom_config.pp @@ -1,15 +1,67 @@ -# See README.md for usage information +# @summary +# Adds a custom configuration file to the Apache server's `conf.d` directory. +# +# If the file is invalid and this defined type's `verify_config` parameter's value is +# `true`, Puppet throws an error during a Puppet run. +# +# @param ensure +# Specifies whether the configuration file should be present. +# +# @param confdir +# Sets the directory in which Puppet places configuration files. +# +# @param content +# Sets the configuration file's content. The `content` and `source` parameters are exclusive +# of each other. +# +# @param filename +# Sets the name of the file under `confdir` in which Puppet stores the configuration. +# +# @param priority +# Sets the configuration file's priority by prefixing its filename with this parameter's +# numeric value, as Apache processes configuration files in alphanumeric order.
+# To omit the priority prefix in the configuration file's name, set this parameter to `false`. +# +# @param source +# Points to the configuration file's source. The `content` and `source` parameters are +# exclusive of each other. +# +# @param verify_command +# Specifies the command Puppet uses to verify the configuration file. Use a fully qualified +# command.
+# This parameter is used only if the `verify_config` parameter's value is `true`. If the +# `verify_command` fails, the Puppet run deletes the configuration file and raises an error, +# but does not notify the Apache service. +# +# @param verify_config +# Specifies whether to validate the configuration file before notifying the Apache service. +# +# @param owner +# File owner of configuration file +# +# @param group +# File group of configuration file +# +# @param file_mode +# File mode of configuration file +# +# @param show_diff +# show_diff property for configuration file resource +# define apache::custom_config ( Enum['absent', 'present'] $ensure = 'present', - $confdir = $::apache::confd_dir, + $confdir = $apache::confd_dir, $content = undef, $priority = '25', $source = undef, - $verify_command = $::apache::params::verify_command, + $verify_command = $apache::params::verify_command, Boolean $verify_config = true, $filename = undef, + $owner = undef, + $group = undef, + $file_mode = undef, + Boolean $show_diff = true, ) { - if $content and $source { fail('Only one of $content and $source can be specified.') } @@ -38,13 +90,19 @@ define apache::custom_config ( $notifies = undef } + $_file_mode = pick($file_mode, $apache::file_mode) + file { "apache_${name}": - ensure => $ensure, - path => "${confdir}/${_filename}", - content => $content, - source => $source, - require => Package['httpd'], - notify => $notifies, + ensure => $ensure, + path => "${confdir}/${_filename}", + owner => $owner, + group => $group, + mode => $_file_mode, + content => $content, + source => $source, + show_diff => $show_diff, + require => Package['httpd'], + notify => $notifies, } if $ensure == 'present' and $verify_config { diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/default_confd_files.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/default_confd_files.pp index c06b30c83..ecf543eed 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/default_confd_files.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/default_confd_files.pp @@ -1,3 +1,7 @@ +# @summary +# Helper for setting up default conf.d files. +# +# @api private class apache::default_confd_files ( $all = true, ) { @@ -5,7 +9,7 @@ class apache::default_confd_files ( if $all { case $::osfamily { 'freebsd': { - include ::apache::confd::no_accf + include apache::confd::no_accf } default: { # do nothing diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/default_mods.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/default_mods.pp index 879df595c..255c9239f 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/default_mods.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/default_mods.pp @@ -1,8 +1,12 @@ +# @summary +# Installs and congfigures default mods for Apache +# +# @api private class apache::default_mods ( $all = true, $mods = undef, - $apache_version = $::apache::apache_version, - $use_systemd = $::apache::use_systemd, + $apache_version = $apache::apache_version, + $use_systemd = $apache::use_systemd, ) { # These are modules required to run the default configuration. # They are not configurable at this time, so we just include @@ -13,11 +17,14 @@ class apache::default_mods ( if versioncmp($apache_version, '2.4') >= 0 { # Lets fork it # Do not try to load mod_systemd on RHEL/CentOS 6 SCL. - if ( !($::osfamily == 'redhat' and versioncmp($::operatingsystemrelease, '7.0') == -1) and !($::operatingsystem == 'Amazon') ) { + if ( !($::osfamily == 'redhat' and versioncmp($::operatingsystemmajrelease, '7') == -1) and !($::operatingsystem == 'Amazon') ) { if ($use_systemd) { ::apache::mod { 'systemd': } } } + if ($::operatingsystem == 'Amazon' and $::operatingsystemrelease == '2') { + ::apache::mod { 'systemd': } + } ::apache::mod { 'unixd': } } } @@ -40,24 +47,24 @@ class apache::default_mods ( if $all { case $::osfamily { 'debian': { - include ::apache::mod::authn_core - include ::apache::mod::reqtimeout + include apache::mod::authn_core + include apache::mod::reqtimeout if versioncmp($apache_version, '2.4') < 0 { ::apache::mod { 'authn_alias': } } } 'redhat': { - include ::apache::mod::actions - include ::apache::mod::authn_core - include ::apache::mod::cache - include ::apache::mod::ext_filter - include ::apache::mod::mime - include ::apache::mod::mime_magic - include ::apache::mod::rewrite - include ::apache::mod::speling - include ::apache::mod::suexec - include ::apache::mod::version - include ::apache::mod::vhost_alias + include apache::mod::actions + include apache::mod::authn_core + include apache::mod::cache + include apache::mod::ext_filter + include apache::mod::mime + include apache::mod::mime_magic + include apache::mod::rewrite + include apache::mod::speling + include apache::mod::suexec + include apache::mod::version + include apache::mod::vhost_alias ::apache::mod { 'auth_digest': } ::apache::mod { 'authn_anon': } ::apache::mod { 'authn_dbm': } @@ -75,20 +82,20 @@ class apache::default_mods ( } } 'freebsd': { - include ::apache::mod::actions - include ::apache::mod::authn_core - include ::apache::mod::cache - include ::apache::mod::disk_cache - include ::apache::mod::headers - include ::apache::mod::info - include ::apache::mod::mime_magic - include ::apache::mod::reqtimeout - include ::apache::mod::rewrite - include ::apache::mod::userdir - include ::apache::mod::version - include ::apache::mod::vhost_alias - include ::apache::mod::speling - include ::apache::mod::filter + include apache::mod::actions + include apache::mod::authn_core + include apache::mod::cache + include apache::mod::disk_cache + include apache::mod::headers + include apache::mod::info + include apache::mod::mime_magic + include apache::mod::reqtimeout + include apache::mod::rewrite + include apache::mod::userdir + include apache::mod::version + include apache::mod::vhost_alias + include apache::mod::speling + include apache::mod::filter ::apache::mod { 'asis': } ::apache::mod { 'auth_digest': } @@ -102,7 +109,7 @@ class apache::default_mods ( ::apache::mod { 'dumpio': } ::apache::mod { 'expires': } ::apache::mod { 'file_cache': } - ::apache::mod { 'imagemap':} + ::apache::mod { 'imagemap': } ::apache::mod { 'include': } ::apache::mod { 'logio': } ::apache::mod { 'request': } @@ -111,32 +118,32 @@ class apache::default_mods ( } default: {} } - case $::apache::mpm_module { + case $apache::mpm_module { 'prefork': { - include ::apache::mod::cgi + include apache::mod::cgi } 'worker': { - include ::apache::mod::cgid + include apache::mod::cgid } default: { # do nothing } } - include ::apache::mod::alias - include ::apache::mod::authn_file - include ::apache::mod::autoindex - include ::apache::mod::dav - include ::apache::mod::dav_fs - include ::apache::mod::deflate - include ::apache::mod::dir - include ::apache::mod::mime - include ::apache::mod::negotiation - include ::apache::mod::setenvif + include apache::mod::alias + include apache::mod::authn_file + include apache::mod::autoindex + include apache::mod::dav + include apache::mod::dav_fs + include apache::mod::deflate + include apache::mod::dir + include apache::mod::mime + include apache::mod::negotiation + include apache::mod::setenvif ::apache::mod { 'auth_basic': } if versioncmp($apache_version, '2.4') >= 0 { # filter is needed by mod_deflate - include ::apache::mod::filter + include apache::mod::filter # authz_core is needed for 'Require' directive ::apache::mod { 'authz_core': @@ -146,13 +153,13 @@ class apache::default_mods ( # lots of stuff seems to break without access_compat ::apache::mod { 'access_compat': } } else { - include ::apache::mod::authz_default + include apache::mod::authz_default } - include ::apache::mod::authz_user + include apache::mod::authz_user ::apache::mod { 'authz_groupfile': } - include ::apache::mod::env + include apache::mod::env } elsif $mods { ::apache::default_mods::load { $mods: } @@ -163,7 +170,7 @@ class apache::default_mods ( } # filter is needed by mod_deflate - include ::apache::mod::filter + include apache::mod::filter } } else { if versioncmp($apache_version, '2.4') >= 0 { @@ -173,7 +180,7 @@ class apache::default_mods ( } # filter is needed by mod_deflate - include ::apache::mod::filter + include apache::mod::filter } } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/default_mods/load.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/default_mods/load.pp index 356e9fa00..fc44ebcb3 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/default_mods/load.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/default_mods/load.pp @@ -1,4 +1,7 @@ -# private define +# @summary +# Helper used by `apache::default_mods` +# +# @api private define apache::default_mods::load ($module = $title) { if defined("apache::mod::${module}") { include "::apache::mod::${module}" diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/dev.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/dev.pp index d4a25a7e4..106541032 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/dev.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/dev.pp @@ -1,10 +1,18 @@ +# @summary +# Installs Apache development libraries. +# +# The libraries installed depends on the `dev_packages` parameter of the `apache::params` +# class, based on your operating system: +# - **Debian** : `libaprutil1-dev`, `libapr1-dev`; `apache2-dev` +# - **FreeBSD**: `undef`; on FreeBSD, you must declare the `apache::package` or `apache` classes before declaring `apache::dev`. +# - **Gentoo**: `undef`. +# - **Red Hat**: `httpd-devel`. class apache::dev { - if ! defined(Class['apache']) { fail('You must include the apache base class before using any apache defined resources') } - $packages = $::apache::dev_packages + $packages = $apache::dev_packages if $packages { # FreeBSD doesn't have dev packages to install package { $packages: ensure => present, diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/fastcgi/server.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/fastcgi/server.pp index 78363062b..2e372b1a1 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/fastcgi/server.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/fastcgi/server.pp @@ -1,3 +1,33 @@ +# @summary +# Defines one or more external FastCGI servers to handle specific file types. Use this +# defined type with `mod_fastcgi`. +# +# @param host +# Determines the FastCGI's hostname or IP address and TCP port number (1-65535). +# +# @param timeout +# Sets the number of seconds a [FastCGI](http://www.fastcgi.com/) application can be inactive before aborting the +# request and logging the event at the error LogLevel. The inactivity timer applies only as +# long as a connection is pending with the FastCGI application. If a request is queued to an +# application, but the application doesn't respond by writing and flushing within this period, +# the request is aborted. If communication is complete with the application but incomplete with +# the client (the response is buffered), the timeout does not apply. +# +# @param flush +# Forces `mod_fastcgi` to write to the client as data is received from the +# application. By default, `mod_fastcgi` buffers data in order to free the application +# as quickly as possible. +# +# @param faux_path +# Apache has FastCGI handle URIs that resolve to this filename. The path set in this +# parameter does not have to exist in the local filesystem. +# +# @param fcgi_alias +# Internally links actions with the FastCGI server. This alias must be unique. +# +# @param file_type +# Sets the MIME `content-type` of the file to be processed by the FastCGI server. +# define apache::fastcgi::server ( $host = '127.0.0.1:9000', $timeout = 15, @@ -7,23 +37,23 @@ define apache::fastcgi::server ( $file_type = 'application/x-httpd-php', $pass_header = undef, ) { - include ::apache::mod::fastcgi + include apache::mod::fastcgi Apache::Mod['fastcgi'] -> Apache::Fastcgi::Server[$title] - if is_absolute_path($host) { + if $host =~ Stdlib::Absolutepath { $socket = $host } file { "fastcgi-pool-${name}.conf": - ensure => present, - path => "${::apache::confd_dir}/fastcgi-pool-${name}.conf", + ensure => file, + path => "${apache::confd_dir}/fastcgi-pool-${name}.conf", owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, + group => $apache::params::root_group, + mode => $apache::file_mode, content => template('apache/fastcgi/server.erb'), - require => Exec["mkdir ${::apache::confd_dir}"], - before => File[$::apache::confd_dir], + require => Exec["mkdir ${apache::confd_dir}"], + before => File[$apache::confd_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/init.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/init.pp index 1a6e6665d..26ded53a7 100755 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/init.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/init.pp @@ -1,116 +1,573 @@ -# Class: apache +# @summary +# Guides the basic setup and installation of Apache on your system. # -# This class installs Apache +# When this class is declared with the default options, Puppet: +# - Installs the appropriate Apache software package and [required Apache modules](#default_mods) for your operating system. +# - Places the required configuration files in a directory, with the [default location](#conf_dir) determined by your operating system. +# - Configures the server with a default virtual host and standard port (`80`) and address (`\*`) bindings. +# - Creates a document root directory determined by your operating system, typically `/var/www`. +# - Starts the Apache service. # -# Parameters: +# @example +# class { 'apache': } # -# Actions: -# - Install Apache -# - Manage Apache service +# @param allow_encoded_slashes +# Sets the server default for the `AllowEncodedSlashes` declaration, which modifies the +# responses to URLs containing '\' and '/' characters. If not specified, this parameter omits +# the declaration from the server's configuration and uses Apache's default setting of 'off'. # -# Requires: +# @param apache_version +# Configures module template behavior, package names, and default Apache modules by defining +# the version of Apache to use. We do not recommend manually configuring this parameter +# without reason. # -# Sample Usage: +# @param conf_dir +# Sets the directory where the Apache server's main configuration file is located. # +# @param conf_template +# Defines the template used for the main Apache configuration file. Modifying this +# parameter is potentially risky, as the apache module is designed to use a minimal +# configuration file customized by `conf.d` entries. +# +# @param confd_dir +# Sets the location of the Apache server's custom configuration directory. +# +# @param default_charset +# Used as the `AddDefaultCharset` directive in the main configuration file. +# +# @param default_confd_files +# Determines whether Puppet generates a default set of includable Apache configuration files +# in the directory defined by the `confd_dir` parameter. These configuration files +# correspond to what is typically installed with the Apache package on the server's +# operating system. +# +# @param default_mods +# Determines whether to configure and enable a set of default Apache modules depending on +# your operating system.
+# If `false`, Puppet includes only the Apache modules required to make the HTTP daemon work +# on your operating system, and you can declare any other modules separately using the +# `apache::mod::` class or `apache::mod` defined type.
+# If `true`, Puppet installs additional modules, depending on the operating system and +# the values of `apache_version` and `mpm_module` parameters. Because these lists of +# modules can change frequently, consult the Puppet module's code for up-to-date lists.
+# If this parameter contains an array, Puppet instead enables all passed Apache modules. +# +# @param default_ssl_ca +# Sets the default certificate authority for the Apache server.
+# Although the default value results in a functioning Apache server, you **must** update +# this parameter with your certificate authority information before deploying this server in +# a production environment. +# +# @param default_ssl_cert +# Sets the SSL encryption certificate location.
+# Although the default value results in a functioning Apache server, you **must** update this +# parameter with your certificate location before deploying this server in a production environment. +# +# @param default_ssl_chain +# Sets the default SSL chain location.
+# Although this default value results in a functioning Apache server, you **must** update +# this parameter with your SSL chain before deploying this server in a production environment. +# +# @param default_ssl_crl +# Sets the path of the default certificate revocation list (CRL) file to use.
+# Although this default value results in a functioning Apache server, you **must** update +# this parameter with the CRL file path before deploying this server in a production +# environment. You can use this parameter with or in place of the `default_ssl_crl_path`. +# +# @param default_ssl_crl_path +# Sets the server's certificate revocation list path, which contains your CRLs.
+# Although this default value results in a functioning Apache server, you **must** update +# this parameter with the CRL file path before deploying this server in a production environment. +# +# @param default_ssl_crl_check +# Sets the default certificate revocation check level via the `SSLCARevocationCheck` directive. +# This parameter applies only to Apache 2.4 or higher and is ignored on older versions.
+# Although this default value results in a functioning Apache server, you **must** specify +# this parameter when using certificate revocation lists in a production environment. +# +# @param default_ssl_key +# Sets the SSL certificate key file location. +# Although the default values result in a functioning Apache server, you **must** update +# this parameter with your SSL key's location before deploying this server in a production +# environment. +# +# @param default_ssl_reload_on_change +# Enable reloading of apache if the content of ssl files have changed. +# +# @param default_ssl_vhost +# Configures a default SSL virtual host. +# If `true`, Puppet automatically configures the following virtual host using the +# `apache::vhost` defined type: +# ```puppet +# apache::vhost { 'default-ssl': +# port => 443, +# ssl => true, +# docroot => $docroot, +# scriptalias => $scriptalias, +# serveradmin => $serveradmin, +# access_log_file => "ssl_${access_log_file}", +# } +# ``` +# **Note**: SSL virtual hosts only respond to HTTPS queries. +# +# @param default_type +# _Apache 2.2 only_. Sets the MIME `content-type` sent if the server cannot otherwise +# determine an appropriate `content-type`. This directive is deprecated in Apache 2.4 and +# newer, and is only for backwards compatibility in configuration files. +# +# @param default_vhost +# Configures a default virtual host when the class is declared.
+# To configure customized virtual hosts, set this parameter's +# value to `false`.
+# > **Note**: Apache will not start without at least one virtual host. If you set this +# to `false` you must configure a virtual host elsewhere. +# +# @param dev_packages +# Configures a specific dev package to use.
+# For example, using httpd 2.4 from the IUS yum repo:
+# ``` puppet +# include ::apache::dev +# class { 'apache': +# apache_name => 'httpd24u', +# dev_packages => 'httpd24u-devel', +# } +# ``` +# +# @param docroot +# Sets the default `DocumentRoot` location. +# +# @param error_documents +# Determines whether to enable [custom error documents](https://httpd.apache.org/docs/current/custom-error.html) on the Apache server. +# +# @param group +# Sets the group ID that owns any Apache processes spawned to answer requests.
+# By default, Puppet attempts to manage this group as a resource under the `apache` +# class, determining the group based on the operating system as detected by the +# `apache::params` class. To prevent the group resource from being created and use a group +# created by another Puppet module, set the `manage_group` parameter's value to `false`.
+# > **Note**: Modifying this parameter only changes the group ID that Apache uses to spawn +# child processes to access resources. It does not change the user that owns the parent server +# process. +# +# @param httpd_dir +# Sets the Apache server's base configuration directory. This is useful for specially +# repackaged Apache server builds but might have unintended consequences when combined +# with the default distribution packages. +# +# @param http_protocol_options +# Specifies the strictness of HTTP protocol checks.
+# Valid options: any sequence of the following alternative values: `Strict` or `Unsafe`, +# `RegisteredMethods` or `LenientMethods`, and `Allow0.9` or `Require1.0`. +# +# @param keepalive +# Determines whether to enable persistent HTTP connections with the `KeepAlive` directive. +# If you set this to `On`, use the `keepalive_timeout` and `max_keepalive_requests` parameters +# to set relevant options.
+# +# @param keepalive_timeout +# Sets the `KeepAliveTimeout` directive, which determines the amount of time the Apache +# server waits for subsequent requests on a persistent HTTP connection. This parameter is +# only relevant if the `keepalive` parameter is enabled. +# +# @param max_keepalive_requests +# Limits the number of requests allowed per connection when the `keepalive` parameter is enabled. +# +# @param hostname_lookups +# This directive enables DNS lookups so that host names can be logged and passed to +# CGIs/SSIs in REMOTE_HOST.
+# > **Note**: If enabled, it impacts performance significantly. +# +# @param ldap_trusted_mode +# The following modes are supported: +# +# NONE - no encryption +# SSL - ldaps:// encryption on default port 636 +# TLS - STARTTLS encryption on default port 389 +# Not all LDAP toolkits support all the above modes. An error message will be logged at +# runtime if a mode is not supported, and the connection to the LDAP server will fail. +# +#If an ldaps:// URL is specified, the mode becomes SSL and the setting of LDAPTrustedMode is ignored. +# +# @param ldap_verify_server_cert +# Specifies whether to force the verification of a server certificate when establishing an SSL +# connection to the LDAP server. +# On|Off +# +# @param lib_path +# Specifies the location whereApache module files are stored.
+# > **Note**: Do not configure this parameter manually without special reason. +# +# @param log_level +# Configures the apache [LogLevel](https://httpd.apache.org/docs/current/mod/core.html#loglevel) directive +# which adjusts the verbosity of the messages recorded in the error logs. +# +# @param log_formats +# Define additional `LogFormat` directives. Values: A hash, such as: +# ``` puppet +# $log_formats = { vhost_common => '%v %h %l %u %t \"%r\" %>s %b' } +# ``` +# There are a number of predefined `LogFormats` in the `httpd.conf` that Puppet creates: +# ``` httpd +# LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined +# LogFormat "%h %l %u %t \"%r\" %>s %b" common +# LogFormat "%{Referer}i -> %U" referer +# LogFormat "%{User-agent}i" agent +# LogFormat "%{X-Forwarded-For}i %l %u %t \"%r\" %s %b \"%{Referer}i\" \"%{User-agent}i\"" forwarded +# ``` +# If your `log_formats` parameter contains one of those, it will be overwritten with **your** definition. +# +# @param logroot +# Changes the directory of Apache log files for the virtual host. +# +# @param logroot_mode +# Overrides the default `logroot` directory's mode.
+# > **Note**: Do _not_ grant write access to the directory where the logs are stored +# without being aware of the consequences. See the [Apache documentation](https://httpd.apache.org/docs/current/logs.html#security) +# for details. +# +# @param manage_group +# When `false`, stops Puppet from creating the group resource.
+# If you have a group created from another Puppet module that you want to use to run Apache, +# set this to `false`. Without this parameter, attempting to use a previously established +# group results in a duplicate resource error. +# +# @param supplementary_groups +# A list of groups to which the user belongs. These groups are in addition to the primary group.
+# Notice: This option only has an effect when `manage_user` is set to true. +# +# @param manage_user +# When `false`, stops Puppet from creating the user resource.
+# This is for instances when you have a user, created from another Puppet module, you want +# to use to run Apache. Without this parameter, attempting to use a previously established +# user would result in a duplicate resource error. +# +# @param mod_dir +# Sets where Puppet places configuration files for your Apache modules. +# +# @param mod_libs +# Allows the user to override default module library names. +# ```puppet +# include apache::params +# class { 'apache': +# mod_libs => merge($::apache::params::mod_libs, { +# 'wsgi' => 'mod_wsgi_python3.so', +# }) +# } +# ``` +# +# @param mod_packages +# Allows the user to override default module package names. +# ```puppet +# include apache::params +# class { 'apache': +# mod_packages => merge($::apache::params::mod_packages, { +# 'auth_kerb' => 'httpd24-mod_auth_kerb', +# }) +# } +# ``` +# +# @param mpm_module +# Determines which [multi-processing module](https://httpd.apache.org/docs/current/mpm.html) (MPM) is loaded and configured for the +# HTTPD process. Valid values are: `event`, `itk`, `peruser`, `prefork`, `worker` or `false`.
+# You must set this to `false` to explicitly declare the following classes with custom parameters: +# - `apache::mod::event` +# - `apache::mod::itk` +# - `apache::mod::peruser` +# - `apache::mod::prefork` +# - `apache::mod::worker` +# +# @param package_ensure +# Controls the `package` resource's `ensure` attribute. Valid values are: `absent`, `installed` +# (or equivalent `present`), or a version string. +# +# @param pidfile +# Allows settting a custom location for the pid file. Useful if using a custom-built Apache rpm. +# +# @param ports_file +# Sets the path to the file containing Apache ports configuration. +# +# @param protocols +# Sets the [Protocols](https://httpd.apache.org/docs/current/en/mod/core.html#protocols) +# directive, which lists available protocols for the server. +# +# @param protocols_honor_order +# Sets the [ProtocolsHonorOrder](https://httpd.apache.org/docs/current/en/mod/core.html#protocolshonororder) +# directive which determines whether the order of Protocols sets precedence during negotiation. +# +# @param purge_configs +# Removes all other Apache configs and virtual hosts.
+# Setting this to `false` is a stopgap measure to allow the apache module to coexist with +# existing or unmanaged configurations. We recommend moving your configuration to resources +# within this module. For virtual host configurations, see `purge_vhost_dir`. +# +# @param purge_vhost_dir +# If the `vhost_dir` parameter's value differs from the `confd_dir` parameter's, this parameter +# determines whether Puppet removes any configurations inside `vhost_dir` that are _not_ managed +# by Puppet.
+# Setting `purge_vhost_dir` to `false` is a stopgap measure to allow the apache module to +# coexist with existing or otherwise unmanaged configurations within `vhost_dir`. +# +# @param rewrite_lock +# Allows setting a custom location for a rewrite lock - considered best practice if using +# a RewriteMap of type prg in the `rewrites` parameter of your virtual host. This parameter +# only applies to Apache version 2.2 or lower and is ignored on newer versions. +# +# @param sendfile +# Forces Apache to use the Linux kernel's `sendfile` support to serve static files, via the +# `EnableSendfile` directive. +# +# @param serveradmin +# Sets the Apache server administrator's contact information via Apache's `ServerAdmin` directive. +# +# @param servername +# Sets the Apache server name via Apache's `ServerName` directive. +# Setting to `false` will not set ServerName at all. +# +# @param server_root +# Sets the Apache server's root directory via Apache's `ServerRoot` directive. +# +# @param server_signature +# Configures a trailing footer line to display at the bottom of server-generated documents, +# such as error documents and output of certain Apache modules, via Apache's `ServerSignature` +# directive. Valid values are: `On` or `Off`. +# +# @param server_tokens +# Controls how much information Apache sends to the browser about itself and the operating +# system, via Apache's `ServerTokens` directive. +# +# @param service_enable +# Determines whether Puppet enables the Apache HTTPD service when the system is booted. +# +# @param service_ensure +# Determines whether Puppet should make sure the service is running. +# Valid values are: `true` (or `running`) or `false` (or `stopped`).
+# The `false` or `stopped` values set the 'httpd' service resource's `ensure` parameter +# to `false`, which is useful when you want to let the service be managed by another +# application, such as Pacemaker.
+# +# @param service_name +# Sets the name of the Apache service. +# +# @param service_manage +# Determines whether Puppet manages the HTTPD service's state. +# +# @param service_restart +# Determines whether Puppet should use a specific command to restart the HTTPD service. +# Values: a command to restart the Apache service. +# +# @param timeout +# Sets Apache's `TimeOut` directive, which defines the number of seconds Apache waits for +# certain events before failing a request. +# +# @param trace_enable +# Controls how Apache handles `TRACE` requests (per RFC 2616) via the `TraceEnable` directive. +# +# @param use_canonical_name +# Controls Apache's `UseCanonicalName` directive which controls how Apache handles +# self-referential URLs. If not specified, this parameter omits the declaration from the +# server's configuration and uses Apache's default setting of 'off'. +# +# @param use_systemd +# Controls whether the systemd module should be installed on Centos 7 servers, this is +# especially useful if using custom-built RPMs. +# +# @param file_mode +# Sets the desired permissions mode for config files. +# Valid values are: a string, with permissions mode in symbolic or numeric notation. +# +# @param root_directory_options +# Array of the desired options for the `/` directory in httpd.conf. +# +# @param root_directory_secured +# Sets the default access policy for the `/` directory in httpd.conf. A value of `false` +# allows access to all resources that are missing a more specific access policy. A value of +# `true` denies access to all resources by default. If `true`, more specific rules must be +# used to allow access to these resources (for example, in a directory block using the +# `directories` parameter). +# +# @param vhost_dir +# Changes your virtual host configuration files' location. +# +# @param vhost_include_pattern +# Defines the pattern for files included from the `vhost_dir`. +# If set to a value like `[^.#]\*.conf[^~]` to make sure that files accidentally created in +# this directory (such as files created by version control systems or editor backups) are +# *not* included in your server configuration.
+# Some operating systems use a value of `*.conf`. By default, this module creates configuration +# files ending in `.conf`. +# +# @param user +# Changes the user that Apache uses to answer requests. Apache's parent process continues +# to run as root, but child processes access resources as the user defined by this parameter. +# To prevent Puppet from managing the user, set the `manage_user` parameter to `false`. +# +# @param apache_name +# The name of the Apache package to install. If you are using a non-standard Apache package +# you might need to override the default setting.
+# For CentOS/RHEL Software Collections (SCL), you can also use `apache::version::scl_httpd_version`. +# +# @param error_log +# The name of the error log file for the main server instance. If the string starts with +# `/`, `|`, or `syslog`: the full path is set. Otherwise, the filename is prefixed with +# `$logroot`. +# +# @param scriptalias +# Directory to use for global script alias +# +# @param access_log_file +# The name of the access log file for the main server instance. +# +# @param limitreqfields +# The `limitreqfields` parameter sets the maximum number of request header fields in +# an HTTP request. This directive gives the server administrator greater control over +# abnormal client request behavior, which may be useful for avoiding some forms of +# denial-of-service attacks. The value should be increased if normal clients see an error +# response from the server that indicates too many fields were sent in the request. +# +# @param limitreqfieldsize +# The `limitreqfieldsize` parameter sets the maximum ammount of _bytes_ that will +# be allowed within a request header. +# +# @param ip +# Specifies the ip address +# +# @param purge_vdir +# Removes all other Apache configs and virtual hosts.
+# > **Note**: This parameter is deprecated in favor of the `purge_config` parameter.
+# +# @param conf_enabled +# Whether the additional config files in `/etc/apache2/conf-enabled` should be managed. +# +# @param vhost_enable_dir +# Set's whether the vhost definitions will be stored in sites-availible and if +# they will be symlinked to and from sites-enabled. +# +# @param mod_enable_dir +# Set's whether the mods-enabled directory should be managed. +# +# @param ssl_file +# This parameter allows you to set an ssl.conf file to be managed in order to implement +# an SSL Certificate. +# +# @param file_e_tag +# Sets the server default for the `FileETag` declaration, which modifies the response header +# field for static files. +# +# @param use_optional_includes +# Specifies whether Apache uses the `IncludeOptional` directive instead of `Include` for +# `additional_includes` in Apache 2.4 or newer. +# +# @param mime_types_additional +# Specifies any idditional Internet media (mime) types that you wish to be configured. +# class apache ( - $apache_name = $::apache::params::apache_name, - $service_name = $::apache::params::service_name, - $default_mods = true, - Boolean $default_vhost = true, - $default_charset = undef, - Boolean $default_confd_files = true, - Boolean $default_ssl_vhost = false, - $default_ssl_cert = $::apache::params::default_ssl_cert, - $default_ssl_key = $::apache::params::default_ssl_key, - $default_ssl_chain = undef, - $default_ssl_ca = undef, - $default_ssl_crl_path = undef, - $default_ssl_crl = undef, - $default_ssl_crl_check = undef, - $default_type = 'none', - $dev_packages = $::apache::params::dev_packages, - $ip = undef, - Boolean $service_enable = true, - Boolean $service_manage = true, - $service_ensure = 'running', - $service_restart = undef, - $purge_configs = false, - $purge_vhost_dir = undef, - $purge_vdir = false, - $serveradmin = 'root@localhost', - $sendfile = 'On', - $error_documents = false, - $timeout = '120', - $httpd_dir = $::apache::params::httpd_dir, - $server_root = $::apache::params::server_root, - $conf_dir = $::apache::params::conf_dir, - $confd_dir = $::apache::params::confd_dir, - $vhost_dir = $::apache::params::vhost_dir, - $vhost_enable_dir = $::apache::params::vhost_enable_dir, - $mod_packages = $::apache::params::mod_packages, - $vhost_include_pattern = $::apache::params::vhost_include_pattern, - $mod_dir = $::apache::params::mod_dir, - $mod_enable_dir = $::apache::params::mod_enable_dir, - $mpm_module = $::apache::params::mpm_module, - $lib_path = $::apache::params::lib_path, - $conf_template = $::apache::params::conf_template, - $servername = $::apache::params::servername, - $pidfile = $::apache::params::pidfile, - Optional[Stdlib::Absolutepath] $rewrite_lock = undef, - Boolean $manage_user = true, - Boolean $manage_group = true, - $user = $::apache::params::user, - $group = $::apache::params::group, - $http_protocol_options = $::apache::params::http_protocol_options, - $supplementary_groups = [], - $keepalive = $::apache::params::keepalive, - $keepalive_timeout = $::apache::params::keepalive_timeout, - $max_keepalive_requests = $::apache::params::max_keepalive_requests, - $limitreqfieldsize = '8190', - $logroot = $::apache::params::logroot, - $logroot_mode = $::apache::params::logroot_mode, - $log_level = $::apache::params::log_level, - $log_formats = {}, - $ssl_file = undef, - $ports_file = $::apache::params::ports_file, - $docroot = $::apache::params::docroot, - $apache_version = $::apache::version::default, - $server_tokens = 'OS', - $server_signature = 'On', - $trace_enable = 'On', - Optional[Enum['on', 'off', 'nodecode']] $allow_encoded_slashes = undef, - $file_e_tag = undef, + $apache_name = $apache::params::apache_name, + $service_name = $apache::params::service_name, + $default_mods = true, + Boolean $default_vhost = true, + $default_charset = undef, + Boolean $default_confd_files = true, + Boolean $default_ssl_vhost = false, + $default_ssl_cert = $apache::params::default_ssl_cert, + $default_ssl_key = $apache::params::default_ssl_key, + $default_ssl_chain = undef, + $default_ssl_ca = undef, + $default_ssl_crl_path = undef, + $default_ssl_crl = undef, + $default_ssl_crl_check = undef, + Boolean $default_ssl_reload_on_change = false, + $default_type = 'none', + $dev_packages = $apache::params::dev_packages, + $ip = undef, + Boolean $service_enable = true, + Boolean $service_manage = true, + $service_ensure = 'running', + $service_restart = undef, + $purge_configs = true, + $purge_vhost_dir = undef, + $purge_vdir = false, + $serveradmin = 'root@localhost', + Enum['On', 'Off', 'on', 'off'] $sendfile = 'On', + $ldap_verify_server_cert = undef, + $ldap_trusted_mode = undef, + $error_documents = false, + $timeout = '60', + $httpd_dir = $apache::params::httpd_dir, + $server_root = $apache::params::server_root, + $conf_dir = $apache::params::conf_dir, + $confd_dir = $apache::params::confd_dir, + Enum['Off', 'On', 'Double', 'off', 'on', 'double'] $hostname_lookups = $apache::params::hostname_lookups, + $conf_enabled = $apache::params::conf_enabled, + $vhost_dir = $apache::params::vhost_dir, + $vhost_enable_dir = $apache::params::vhost_enable_dir, + $mod_libs = $apache::params::mod_libs, + $mod_packages = $apache::params::mod_packages, + $vhost_include_pattern = $apache::params::vhost_include_pattern, + $mod_dir = $apache::params::mod_dir, + $mod_enable_dir = $apache::params::mod_enable_dir, + $mpm_module = $apache::params::mpm_module, + $lib_path = $apache::params::lib_path, + $conf_template = $apache::params::conf_template, + $servername = $apache::params::servername, + $pidfile = $apache::params::pidfile, + Optional[Stdlib::Absolutepath] $rewrite_lock = undef, + Boolean $manage_user = true, + Boolean $manage_group = true, + $user = $apache::params::user, + $group = $apache::params::group, + $http_protocol_options = $apache::params::http_protocol_options, + $supplementary_groups = [], + $keepalive = $apache::params::keepalive, + $keepalive_timeout = $apache::params::keepalive_timeout, + $max_keepalive_requests = $apache::params::max_keepalive_requests, + $limitreqfieldsize = '8190', + $limitreqfields = '100', + $logroot = $apache::params::logroot, + $logroot_mode = $apache::params::logroot_mode, + Apache::LogLevel $log_level = $apache::params::log_level, + $log_formats = {}, + $ssl_file = undef, + $ports_file = $apache::params::ports_file, + $docroot = $apache::params::docroot, + $apache_version = $apache::version::default, + $server_tokens = 'Prod', + $server_signature = 'On', + $trace_enable = 'On', + Optional[Enum['on', 'off', 'nodecode']] $allow_encoded_slashes = undef, + $file_e_tag = undef, + Optional[Enum['On', 'on', 'Off', 'off', 'DNS', 'dns']] + $use_canonical_name = undef, $package_ensure = 'installed', - Boolean $use_optional_includes = $::apache::params::use_optional_includes, - $use_systemd = $::apache::params::use_systemd, - $mime_types_additional = $::apache::params::mime_types_additional, - $file_mode = $::apache::params::file_mode, - $root_directory_options = $::apache::params::root_directory_options, + Boolean $use_optional_includes = $apache::params::use_optional_includes, + $use_systemd = $apache::params::use_systemd, + $mime_types_additional = $apache::params::mime_types_additional, + $file_mode = $apache::params::file_mode, + $root_directory_options = $apache::params::root_directory_options, Boolean $root_directory_secured = false, - $error_log = $::apache::params::error_log, - $scriptalias = $::apache::params::scriptalias, - $access_log_file = $::apache::params::access_log_file, - $overwrite_ports = true, # TODO: Implement this as in wheezy apache + $error_log = $apache::params::error_log, + $scriptalias = $apache::params::scriptalias, + $access_log_file = $apache::params::access_log_file, + Array[Enum['h2', 'h2c', 'http/1.1']] $protocols = [], + Optional[Boolean] $protocols_honor_order = undef, ) inherits ::apache::params { - $valid_mpms_re = $apache_version ? { '2.4' => '(event|itk|peruser|prefork|worker)', default => '(event|itk|prefork|worker)' } - if $::osfamily == 'RedHat' and $::apache::version::distrelease == '7' { + if $::osfamily == 'RedHat' and $facts['operatingsystemmajrelease'] == '7' { # On redhat 7 the ssl.conf lives in /etc/httpd/conf.d (the confd_dir) # when all other module configs live in /etc/httpd/conf.modules.d (the # mod_dir). On all other platforms and versions, ssl.conf lives in the # mod_dir. This should maintain the expected location of ssl.conf $_ssl_file = $ssl_file ? { undef => "${apache::confd_dir}/ssl.conf", - default => $ssl_file + default => $ssl_file } } else { $_ssl_file = $ssl_file ? { undef => "${apache::mod_dir}/ssl.conf", - default => $ssl_file + default => $ssl_file } } @@ -130,7 +587,6 @@ class apache ( notify => Class['Apache::Service'], } } - validate_re($sendfile, [ '^[oO]n$' , '^[oO]ff$' ]) # declare the web server user and group # Note: requiring the package means the package ought to create them and not puppet @@ -149,9 +605,7 @@ class apache ( } } - validate_apache_log_level($log_level) - - class { '::apache::service': + class { 'apache::service': service_name => $service_name, service_enable => $service_enable, service_manage => $service_manage, @@ -191,6 +645,17 @@ class apache ( require => Package['httpd'], } + if $conf_enabled and ! defined(File[$conf_enabled]) { + file { $conf_enabled: + ensure => directory, + recurse => true, + purge => $purge_confd, + force => $purge_confd, + notify => Class['Apache::Service'], + require => Package['httpd'], + } + } + if ! defined(File[$mod_dir]) { exec { "mkdir ${mod_dir}": creates => $mod_dir, @@ -256,29 +721,27 @@ class apache ( $vhost_load_dir = $vhost_dir } - if $overwrite_ports { - concat { $ports_file: - ensure => present, - owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, - notify => Class['Apache::Service'], - require => Package['httpd'], - } - concat::fragment { 'Apache ports header': - target => $ports_file, - content => template('apache/ports_header.erb'), - } + concat { $ports_file: + ensure => present, + owner => 'root', + group => $apache::params::root_group, + mode => $apache::file_mode, + notify => Class['Apache::Service'], + require => Package['httpd'], + } + concat::fragment { 'Apache ports header': + target => $ports_file, + content => template('apache/ports_header.erb'), } - if $::apache::conf_dir and $::apache::params::conf_file { + if $apache::conf_dir and $apache::params::conf_file { if $::osfamily == 'gentoo' { $error_documents_path = '/usr/share/apache2/error' - if is_array($default_mods) { + if $default_mods =~ Array { if versioncmp($apache_version, '2.4') >= 0 { if defined('apache::mod::ssl') { ::portage::makeconf { 'apache2_modules': - content => concat($default_mods, [ 'authz_core', 'socache_shmcb' ]), + content => concat($default_mods, ['authz_core', 'socache_shmcb']), } } else { ::portage::makeconf { 'apache2_modules': @@ -293,11 +756,11 @@ class apache ( } file { [ - '/etc/apache2/modules.d/.keep_www-servers_apache-2', - '/etc/apache2/vhosts.d/.keep_www-servers_apache-2', - ]: - ensure => absent, - require => Package['httpd'], + '/etc/apache2/modules.d/.keep_www-servers_apache-2', + '/etc/apache2/vhosts.d/.keep_www-servers_apache-2', + ]: + ensure => absent, + require => Package['httpd'], } } @@ -330,26 +793,27 @@ class apache ( # - $trace_enable # - $rewrite_lock # - $root_directory_secured - file { "${::apache::conf_dir}/${::apache::params::conf_file}": + file { "${apache::conf_dir}/${apache::params::conf_file}": ensure => file, + mode => $apache::file_mode, content => template($conf_template), notify => Class['Apache::Service'], - require => [Package['httpd']], + require => [Package['httpd'], Concat[$ports_file]], } # preserve back-wards compatibility to the times when default_mods was # only a boolean value. Now it can be an array (too) - if is_array($default_mods) { - class { '::apache::default_mods': + if $default_mods =~ Array { + class { 'apache::default_mods': all => false, mods => $default_mods, } } else { - class { '::apache::default_mods': + class { 'apache::default_mods': all => $default_mods, } } - class { '::apache::default_confd_files': + class { 'apache::default_confd_files': all => $default_confd_files, } if $mpm_module and $mpm_module != 'false' { # lint:ignore:quoted_booleans @@ -366,33 +830,37 @@ class apache ( } ::apache::vhost { 'default': - ensure => $default_vhost_ensure, - port => '80', - docroot => $docroot, - scriptalias => $scriptalias, - serveradmin => $serveradmin, - access_log_file => $access_log_file, - priority => '15', - ip => $ip, - logroot_mode => $logroot_mode, - manage_docroot => $default_vhost, + ensure => $default_vhost_ensure, + port => '80', + docroot => $docroot, + scriptalias => $scriptalias, + serveradmin => $serveradmin, + access_log_file => $access_log_file, + priority => '15', + ip => $ip, + logroot_mode => $logroot_mode, + manage_docroot => $default_vhost, + use_servername_for_filenames => true, + use_port_for_filenames => true, } $ssl_access_log_file = $::osfamily ? { 'freebsd' => $access_log_file, default => "ssl_${access_log_file}", } ::apache::vhost { 'default-ssl': - ensure => $default_ssl_vhost_ensure, - port => '443', - ssl => true, - docroot => $docroot, - scriptalias => $scriptalias, - serveradmin => $serveradmin, - access_log_file => $ssl_access_log_file, - priority => '15', - ip => $ip, - logroot_mode => $logroot_mode, - manage_docroot => $default_ssl_vhost, + ensure => $default_ssl_vhost_ensure, + port => '443', + ssl => true, + docroot => $docroot, + scriptalias => $scriptalias, + serveradmin => $serveradmin, + access_log_file => $ssl_access_log_file, + priority => '15', + ip => $ip, + logroot_mode => $logroot_mode, + manage_docroot => $default_ssl_vhost, + use_servername_for_filenames => true, + use_port_for_filenames => true, } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/listen.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/listen.pp index 9730d3c75..3eb60baad 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/listen.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/listen.pp @@ -1,25 +1,15 @@ -define apache::listen ($port='') { +# @summary +# Adds `Listen` directives to `ports.conf` that define the +# Apache server's or a virtual host's listening address and port. +# +# The `apache::vhost` class uses this defined type, and titles take the form +# ``, `:`, or `:`. +define apache::listen { $listen_addr_port = $name - if defined(Concat[$::apache::ports_file]){ - # Template uses: $listen_addr_port - concat::fragment { "Listen ${listen_addr_port}": - target => $::apache::ports_file, - content => template('apache/listen.erb'), - } - } elsif $port != '80' { - # Create a temporary file - # join with cat $tmp_file >> $file - # remove tmp files - $ports_file = $::apache::ports_file - $tmp_file = "$ports_file-tmp_listen" - file { $tmp_file: - ensure => file, - content => template('apache/listen.erb'), - } - - exec { "apache::listen: cat $tmp_file with ports.conf": - command => "/bin/cat $tmp_file >> $ports_file;/bin/rm $tmp_file" - } + # Template uses: $listen_addr_port + concat::fragment { "Listen ${listen_addr_port}": + target => $apache::ports_file, + content => template('apache/listen.erb'), } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod.pp index ddef130c8..0f7105d63 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod.pp @@ -1,8 +1,42 @@ +# @summary +# Installs packages for an Apache module that doesn't have a corresponding +# `apache::mod::` class. +# +# Checks for or places the module's default configuration files in the Apache server's +# `module` and `enable` directories. The default locations depend on your operating system. +# +# @param package +# **Required**.
+# Names the package Puppet uses to install the Apache module. +# +# @param package_ensure +# Determines whether Puppet ensures the Apache module should be installed. +# +# @param lib +# Defines the module's shared object name. Do not configure manually without special reason. +# +# @param lib_path +# Specifies a path to the module's libraries. Do not manually set this parameter +# without special reason. The `path` parameter overrides this value. +# +# @param loadfile_name +# Sets the filename for the module's `LoadFile` directive, which can also set +# the module load order as Apache processes them in alphanumeric order. +# +# @param id +# Specifies the package id +# +# @param loadfiles +# Specifies an array of `LoadFile` directives. +# +# @param path +# Specifies a path to the module. Do not manually set this parameter without a special reason. +# define apache::mod ( $package = undef, $package_ensure = 'present', $lib = undef, - $lib_path = $::apache::lib_path, + $lib_path = $apache::lib_path, $id = undef, $path = undef, $loadfile_name = undef, @@ -14,10 +48,10 @@ define apache::mod ( $mod = $name #include apache #This creates duplicate resources in rspec-puppet - $mod_dir = $::apache::mod_dir + $mod_dir = $apache::mod_dir # Determine if we have special lib - $mod_libs = $::apache::params::mod_libs + $mod_libs = $apache::mod_libs if $lib { $_lib = $lib } elsif has_key($mod_libs, $mod) { # 2.6 compatibility hack @@ -46,11 +80,11 @@ define apache::mod ( } # Determine if we have a package - $mod_packages = $::apache::mod_packages + $mod_packages = $apache::mod_packages if $package { $_package = $package } elsif has_key($mod_packages, $mod) { # 2.6 compatibility hack - if ($::apache::apache_version == '2.4' and $::operatingsystem =~ /^[Aa]mazon$/) { + if ($apache::apache_version == '2.4' and $::operatingsystem =~ /^[Aa]mazon$/ and $::operatingsystemmajrelease != '2') { # On amazon linux we need to prefix our package name with mod24 instead of mod to support apache 2.4 $_package = regsubst($mod_packages[$mod],'^(mod_)?(.*)','mod24_\2') } else { @@ -67,11 +101,11 @@ define apache::mod ( $package_before = $::osfamily ? { 'freebsd' => [ File[$_loadfile_name], - File["${::apache::conf_dir}/${::apache::params::conf_file}"] + File["${apache::conf_dir}/${apache::params::conf_file}"] ], default => [ File[$_loadfile_name], - File[$::apache::confd_dir], + File[$apache::confd_dir], ], } # if there are any packages, they should be installed before the associated conf file @@ -89,8 +123,8 @@ define apache::mod ( ensure => file, path => "${mod_dir}/${_loadfile_name}", owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, + group => $apache::params::root_group, + mode => $apache::file_mode, content => template('apache/mod/load.erb'), require => [ Package['httpd'], @@ -101,14 +135,14 @@ define apache::mod ( } if $::osfamily == 'Debian' { - $enable_dir = $::apache::mod_enable_dir - file{ "${_loadfile_name} symlink": + $enable_dir = $apache::mod_enable_dir + file { "${_loadfile_name} symlink": ensure => link, path => "${enable_dir}/${_loadfile_name}", target => "${mod_dir}/${_loadfile_name}", owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, + group => $apache::params::root_group, + mode => $apache::file_mode, require => [ File[$_loadfile_name], Exec["mkdir ${enable_dir}"], @@ -120,13 +154,13 @@ define apache::mod ( # defined in the class apache::mod::module # Some modules do not require this file. if defined(File["${mod}.conf"]) { - file{ "${mod}.conf symlink": + file { "${mod}.conf symlink": ensure => link, path => "${enable_dir}/${mod}.conf", target => "${mod_dir}/${mod}.conf", owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, + group => $apache::params::root_group, + mode => $apache::file_mode, require => [ File["${mod}.conf"], Exec["mkdir ${enable_dir}"], @@ -136,14 +170,14 @@ define apache::mod ( } } } elsif $::osfamily == 'Suse' { - $enable_dir = $::apache::mod_enable_dir - file{ "${_loadfile_name} symlink": + $enable_dir = $apache::mod_enable_dir + file { "${_loadfile_name} symlink": ensure => link, path => "${enable_dir}/${_loadfile_name}", target => "${mod_dir}/${_loadfile_name}", owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, + group => $apache::params::root_group, + mode => $apache::file_mode, require => [ File[$_loadfile_name], Exec["mkdir ${enable_dir}"], @@ -155,13 +189,13 @@ define apache::mod ( # defined in the class apache::mod::module # Some modules do not require this file. if defined(File["${mod}.conf"]) { - file{ "${mod}.conf symlink": + file { "${mod}.conf symlink": ensure => link, path => "${enable_dir}/${mod}.conf", target => "${mod_dir}/${mod}.conf", owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, + group => $apache::params::root_group, + mode => $apache::file_mode, require => [ File["${mod}.conf"], Exec["mkdir ${enable_dir}"], diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/actions.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/actions.pp index 3b60f297f..c9b7d15d6 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/actions.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/actions.pp @@ -1,3 +1,8 @@ +# @summary +# Installs Apache mod_actions +# +# @see https://httpd.apache.org/docs/current/mod/mod_actions.html for additional documentation. +# class apache::mod::actions { apache::mod { 'actions': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/alias.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/alias.pp index 4eb42ac97..58ab0bdf8 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/alias.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/alias.pp @@ -1,10 +1,33 @@ -class apache::mod::alias( +# @summary +# Installs and configures `mod_alias`. +# +# @param apache_version +# The version of Apache, if not set will be retrieved from the init class. +# +# @param icons_options +# Disables directory listings for the icons directory, via Apache [Options](https://httpd.apache.org/docs/current/mod/core.html#options) +# directive. +# +# @param icons_path +# Sets the local path for an /icons/ Alias. Default depends on operating system: +# - Debian: /usr/share/apache2/icons +# - FreeBSD: /usr/local/www/apache24/icons +# - Gentoo: /var/www/icons +# - Red Hat: /var/www/icons, except on Apache 2.4, where it's /usr/share/httpd/icons +# +# @param icons_path +# Change the alias for /icons/. +# +# @see https://httpd.apache.org/docs/current/mod/mod_alias.html for additional documentation. +# +class apache::mod::alias ( $apache_version = undef, $icons_options = 'Indexes MultiViews', # set icons_path to false to disable the alias - $icons_path = $::apache::params::alias_icons_path, + $icons_path = $apache::params::alias_icons_path, + $icons_prefix = $apache::params::icons_prefix ) inherits ::apache::params { - include ::apache + include apache $_apache_version = pick($apache_version, $apache::apache_version) apache::mod { 'alias': } @@ -12,11 +35,11 @@ class apache::mod::alias( if $icons_path { file { 'alias.conf': ensure => file, - path => "${::apache::mod_dir}/alias.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/alias.conf", + mode => $apache::file_mode, content => template('apache/mod/alias.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/apreq2.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/apreq2.pp new file mode 100644 index 000000000..51f1a9f98 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/apreq2.pp @@ -0,0 +1,11 @@ +# @summary +# Installs `mod_apreq2`. +# +# @see http://httpd.apache.org/apreq/docs/libapreq2/group__mod__apreq2.html for additional documentation. +# +# @note Unsupported platforms: CentOS: all; Debian: 8; OracleLinux: all; RedHat: all; Scientific: all; SLES: all; Ubuntu: all +class apache::mod::apreq2 { + ::apache::mod { 'apreq2': + id => 'apreq_module', + } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_basic.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_basic.pp index cacfafa4d..cb2d1313c 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_basic.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_basic.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_auth_basic` +# +# @see https://httpd.apache.org/docs/current/mod/mod_auth_basic.html for additional documentation. +# class apache::mod::auth_basic { ::apache::mod { 'auth_basic': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_cas.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_cas.pp index 00de62242..51e7d2c08 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_cas.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_cas.pp @@ -1,7 +1,90 @@ +# @summary +# Installs and configures `mod_auth_cas`. +# +# @param cas_login_url +# Sets the URL to which the module redirects users when they attempt to access a +# CAS-protected resource and don't have an active session. +# +# @param cas_validate_url +# Sets the URL to use when validating a client-presented ticket in an HTTP query string. +# +# @param cas_cookie_path +# Sets the location where information on the current session should be stored. This should +# be writable by the web server only. +# +# @param cas_cookie_path_mode +# The mode of cas_cookie_path. +# +# @param cas_version +# The version of the CAS protocol to adhere to. +# +# @param cas_debug +# Whether to enable or disable debug mode. +# +# @param cas_validate_server +# Whether to validate the presented certificate. This has been deprecated and +# removed from Version 1.1-RC1 onward. +# +# @param cas_validatedepth +# The maximum depth for chained certificate validation. +# +# @param cas_proxy_validate_url +# The URL to use when performing a proxy validation. +# +# @param cas_root_proxied_as +# Sets the URL end users see when access to this Apache server is proxied per vhost. +# This URL should not include a trailing slash. +# +# @param cas_cookie_entropy +# When creating a local session, this many random bytes are used to create a unique +# session identifier. +# +# @param cas_timeout +# The hard limit, in seconds, for a mod_auth_cas session. +# +# @param cas_idle_timeout +# The limit, in seconds, of how long a mod_auth_cas session can be idle. +# +# @param cas_cache_clean_interval +# The minimum amount of time that must pass inbetween cache cleanings. +# +# @param cas_cookie_domain +# The value for the 'Domain=' parameter in the Set-Cookie header. +# +# @param cas_cookie_http_only +# Setting this flag prevents the mod_auth_cas cookies from being accessed by +# client side Javascript. +# +# @param cas_authoritative +# Determines whether an optional authorization directive is authoritative and thus binding. +# +# @param cas_validate_saml +# Parse response from CAS server for SAML. +# +# @param cas_sso_enabled +# Enables experimental support for single sign out (may mangle POST data). +# +# @param cas_attribute_prefix +# Adds a header with the value of this header being the attribute values when SAML +# validation is enabled. +# +# @param cas_attribute_delimiter +# Sets the delimiter between attribute values in the header created by `cas_attribute_prefix`. +# +# @param cas_scrub_request_headers +# Remove inbound request headers that may have special meaning within mod_auth_cas. +# +# @param suppress_warning +# Suppress warning about being on RedHat (mod_auth_cas package is now available in epel-testing repo). +# +# @note The auth_cas module isn't available on RH/CentOS without providing dependency packages provided by EPEL. +# +# @see https://github.com/apereo/mod_auth_cas for additional documentation. +# class apache::mod::auth_cas ( String $cas_login_url, String $cas_validate_url, - String $cas_cookie_path = $::apache::params::cas_cookie_path, + String $cas_cookie_path = $apache::params::cas_cookie_path, $cas_cookie_path_mode = '0750', $cas_version = 2, $cas_debug = 'Off', @@ -24,12 +107,11 @@ class apache::mod::auth_cas ( $cas_scrub_request_headers = undef, $suppress_warning = false, ) inherits ::apache::params { - if $::osfamily == 'RedHat' and ! $suppress_warning { warning('RedHat distributions do not have Apache mod_auth_cas in their default package repositories.') } - include ::apache + include apache ::apache::mod { 'auth_cas': } file { $cas_cookie_path: @@ -44,12 +126,11 @@ class apache::mod::auth_cas ( # - All variables beginning with cas_ file { 'auth_cas.conf': ensure => file, - path => "${::apache::mod_dir}/auth_cas.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/auth_cas.conf", + mode => $apache::file_mode, content => template('apache/mod/auth_cas.conf.erb'), - require => [ Exec["mkdir ${::apache::mod_dir}"], ], - before => File[$::apache::mod_dir], + require => [Exec["mkdir ${apache::mod_dir}"],], + before => File[$apache::mod_dir], notify => Class['Apache::Service'], } - } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_gssapi.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_gssapi.pp new file mode 100644 index 000000000..226e6061c --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_gssapi.pp @@ -0,0 +1,10 @@ +# @summary +# Installs `mod_auth_gsappi`. +# +# @see https://github.com/modauthgssapi/mod_auth_gssapi for additional documentation. +# +class apache::mod::auth_gssapi { + include apache + include apache::mod::authn_core + apache::mod { 'auth_gssapi': } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_kerb.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_kerb.pp index 4b4887fe8..093c26d22 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_kerb.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_kerb.pp @@ -1,7 +1,9 @@ +# @summary +# Installs `mod_auth_kerb` +# +# @see http://modauthkerb.sourceforge.net for additional documentation. class apache::mod::auth_kerb { - include ::apache - include ::apache::mod::authn_core + include apache + include apache::mod::authn_core ::apache::mod { 'auth_kerb': } } - - diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_mellon.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_mellon.pp index 5dbb6b577..d585aed64 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_mellon.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_mellon.pp @@ -1,26 +1,50 @@ +# @summary +# Installs and configures `mod_auth_mellon`. +# +# @param mellon_cache_size +# Maximum number of sessions which can be active at once. +# +# @param mellon_lock_file +# Full path to a file used for synchronizing access to the session data. +# +# @param mellon_post_directory +# Full path of a directory where POST requests are saved during authentication. +# +# @param mellon_cache_entry_size +# Maximum size for a single session entry in bytes. +# +# @param mellon_post_ttl +# Delay in seconds before a saved POST request can be flushed. +# +# @param mellon_post_size +# Maximum size for saved POST requests. +# +# @param mellon_post_count +# Maximum amount of saved POST requests. +# +# @see https://github.com/Uninett/mod_auth_mellon for additional documentation. +# class apache::mod::auth_mellon ( - $mellon_cache_size = $::apache::params::mellon_cache_size, - $mellon_lock_file = $::apache::params::mellon_lock_file, - $mellon_post_directory = $::apache::params::mellon_post_directory, + $mellon_cache_size = $apache::params::mellon_cache_size, + $mellon_lock_file = $apache::params::mellon_lock_file, + $mellon_post_directory = $apache::params::mellon_post_directory, $mellon_cache_entry_size = undef, $mellon_post_ttl = undef, $mellon_post_size = undef, $mellon_post_count = undef ) inherits ::apache::params { - - include ::apache + include apache ::apache::mod { 'auth_mellon': } # Template uses # - All variables beginning with mellon_ file { 'auth_mellon.conf': ensure => file, - path => "${::apache::mod_dir}/auth_mellon.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/auth_mellon.conf", + mode => $apache::file_mode, content => template('apache/mod/auth_mellon.conf.erb'), - require => [ Exec["mkdir ${::apache::mod_dir}"], ], - before => File[$::apache::mod_dir], + require => [Exec["mkdir ${apache::mod_dir}"],], + before => File[$apache::mod_dir], notify => Class['Apache::Service'], } - } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_openidc.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_openidc.pp new file mode 100644 index 000000000..ad0024fc4 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/auth_openidc.pp @@ -0,0 +1,11 @@ +# @summary +# Installs and configures `mod_auth_openidc`. +# +# @see https://github.com/zmartzone/mod_auth_openidc for additional documentation. +# +class apache::mod::auth_openidc ( +) inherits ::apache::params { + include apache + include apache::mod::authz_user + apache::mod { 'auth_openidc': } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authn_core.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authn_core.pp index c5ce5b107..f145982e2 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authn_core.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authn_core.pp @@ -1,5 +1,13 @@ -class apache::mod::authn_core( - $apache_version = $::apache::apache_version +# @summary +# Installs `mod_authn_core`. +# +# @param apache_version +# The version of apache being run. +# +# @see https://httpd.apache.org/docs/current/mod/mod_authn_core.html for additional documentation. +# +class apache::mod::authn_core ( + $apache_version = $apache::apache_version ) { if versioncmp($apache_version, '2.4') >= 0 { ::apache::mod { 'authn_core': } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authn_dbd.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authn_dbd.pp index be6ff3e55..b5e8d2c91 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authn_dbd.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authn_dbd.pp @@ -1,3 +1,32 @@ +# @summary +# Installs `mod_authn_dbd`. +# +# @param authn_dbd_params +# The params needed for the mod to function. +# +# @param authn_dbd_dbdriver +# Selects an apr_dbd driver by name. +# +# @param authn_dbd_query +# +# @param authn_dbd_min +# Set the minimum number of connections per process. +# +# @param authn_dbd_max +# Set the maximum number of connections per process. +# +# @param authn_dbd_keep +# Set the maximum number of connections per process to be sustained. +# +# @param authn_dbd_exptime +# Set the time to keep idle connections alive when the number of +# connections specified in DBDKeep has been exceeded. +# +# @param authn_dbd_alias +# Sets an alias for `AuthnProvider. +# +# @see https://httpd.apache.org/docs/current/mod/mod_authn_dbd.html for additional documentation. +# class apache::mod::authn_dbd ( $authn_dbd_params, $authn_dbd_dbdriver = 'mysql', @@ -8,23 +37,23 @@ class apache::mod::authn_dbd ( $authn_dbd_exptime = '300', $authn_dbd_alias = undef, ) inherits ::apache::params { - include ::apache - include ::apache::mod::dbd + include apache + include apache::mod::dbd ::apache::mod { 'authn_dbd': } if $authn_dbd_alias { - include ::apache::mod::authn_core + include apache::mod::authn_core } # Template uses # - All variables beginning with authn_dbd file { 'authn_dbd.conf': ensure => file, - path => "${::apache::mod_dir}/authn_dbd.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/authn_dbd.conf", + mode => $apache::file_mode, content => template('apache/mod/authn_dbd.conf.erb'), - require => [ Exec["mkdir ${::apache::mod_dir}"], ], - before => File[$::apache::mod_dir], + require => [Exec["mkdir ${apache::mod_dir}"],], + before => File[$apache::mod_dir], notify => Class['Apache::Service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authn_file.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authn_file.pp index bc787244a..141804507 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authn_file.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authn_file.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_authn_file`. +# +# @see https://httpd.apache.org/docs/2.4/mod/mod_authn_file.html for additional documentation. +# class apache::mod::authn_file { ::apache::mod { 'authn_file': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authnz_ldap.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authnz_ldap.pp index cc9ab67f0..3f194d736 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authnz_ldap.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authnz_ldap.pp @@ -1,11 +1,20 @@ -# lint:ignore:variable_is_lowercase required for compatibility +# @summary +# Installs `mod_authnz_ldap`. +# +# @param verify_server_cert +# Whether to force te verification of a server cert or not. +# +# @param package_name +# The name of the ldap package. +# +# @see https://httpd.apache.org/docs/current/mod/mod_authnz_ldap.html for additional documentation. +# @note Unsupported platforms: RedHat: 6, 8; CentOS: 6, 8; OracleLinux: 6, 8; Ubuntu: all; Debian: all; SLES: all class apache::mod::authnz_ldap ( Boolean $verify_server_cert = true, $package_name = undef, ) { - - include ::apache - include '::apache::mod::ldap' + include apache + include 'apache::mod::ldap' ::apache::mod { 'authnz_ldap': package => $package_name, } @@ -14,12 +23,11 @@ class apache::mod::authnz_ldap ( # - $verify_server_cert file { 'authnz_ldap.conf': ensure => file, - path => "${::apache::mod_dir}/authnz_ldap.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/authnz_ldap.conf", + mode => $apache::file_mode, content => template('apache/mod/authnz_ldap.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } -# lint:endignore diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authnz_pam.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authnz_pam.pp index c2672126d..35ddb779e 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authnz_pam.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authnz_pam.pp @@ -1,4 +1,9 @@ +# @summary +# Installs `mod_authnz_pam`. +# +# @see https://www.adelton.com/apache/mod_authnz_pam for additional documentation. +# class apache::mod::authnz_pam { - include ::apache + include apache ::apache::mod { 'authnz_pam': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authz_default.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authz_default.pp index e457774ae..540d086ab 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authz_default.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authz_default.pp @@ -1,5 +1,13 @@ -class apache::mod::authz_default( - $apache_version = $::apache::apache_version +# @summary +# Installs and configures `mod_authz_default`. +# +# @param apache_version +# Version of Apache to install module on. +# +# @see https://httpd.apache.org/docs/current/mod/mod_authz_default.html for additional documentation. +# +class apache::mod::authz_default ( + $apache_version = $apache::apache_version ) { if versioncmp($apache_version, '2.4') >= 0 { warning('apache::mod::authz_default has been removed in Apache 2.4') diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authz_user.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authz_user.pp index 948a3e2c9..81bdf5f31 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authz_user.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/authz_user.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_authz_user` +# +# @see https://httpd.apache.org/docs/current/mod/mod_authz_user.html for additional documentation. +# class apache::mod::authz_user { ::apache::mod { 'authz_user': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/autoindex.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/autoindex.pp index 67c7580e3..e3215540a 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/autoindex.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/autoindex.pp @@ -1,14 +1,31 @@ -class apache::mod::autoindex { - include ::apache +# @summary +# Installs `mod_autoindex` +# +# @see https://httpd.apache.org/docs/current/mod/mod_autoindex.html for additional documentation. +# +class apache::mod::autoindex ( + $icons_prefix = $apache::params::icons_prefix +) inherits ::apache::params { + include apache ::apache::mod { 'autoindex': } - # Template uses no variables + + # Determine icon filename suffix for autoindex.conf.erb + case $::operatingsystem { + 'Debian', 'Ubuntu': { + $icon_suffix = '-20x22' + } + default: { + $icon_suffix = '' + } + } + file { 'autoindex.conf': ensure => file, - path => "${::apache::mod_dir}/autoindex.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/autoindex.conf", + mode => $apache::file_mode, content => template('apache/mod/autoindex.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cache.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cache.pp index 4ab9f44ba..a822ae9aa 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cache.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cache.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_cache` +# +# @see https://httpd.apache.org/docs/current/mod/mod_cache.html for additional documentation. +# class apache::mod::cache { ::apache::mod { 'cache': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cgi.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cgi.pp index 272f0ccd0..c11ea7fc9 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cgi.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cgi.pp @@ -1,9 +1,19 @@ +# @summary +# Installs `mod_cgi`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_cgi.html for additional documentation. +# class apache::mod::cgi { + include apache case $::osfamily { 'FreeBSD': {} default: { - if $::apache::mpm_module =~ /^(itk|peruser|prefork)$/ { - Class["::apache::mod::${::apache::mpm_module}"] -> Class['::apache::mod::cgi'] + if defined(Class['::apache::mod::itk']) { + Class['::apache::mod::itk'] -> Class['::apache::mod::cgi'] + } elsif defined(Class['::apache::mod::peruser']) { + Class['::apache::mod::peruser'] -> Class['::apache::mod::cgi'] + } else { + Class['::apache::mod::prefork'] -> Class['::apache::mod::cgi'] } } } @@ -15,5 +25,4 @@ class apache::mod::cgi { } else { ::apache::mod { 'cgi': } } - } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cgid.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cgid.pp index b2cb01655..e40af45b4 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cgid.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cgid.pp @@ -1,5 +1,10 @@ +# @summary +# Installs `mod_cgid`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_cgid.html +# class apache::mod::cgid { - include ::apache + include apache case $::osfamily { 'FreeBSD': {} default: { @@ -31,11 +36,11 @@ class apache::mod::cgid { # Template uses $cgisock_path file { 'cgid.conf': ensure => file, - path => "${::apache::mod_dir}/cgid.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/cgid.conf", + mode => $apache::file_mode, content => template('apache/mod/cgid.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cluster.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cluster.pp index 442b58352..9b827f763 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cluster.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/cluster.pp @@ -1,3 +1,53 @@ +# @summary +# Installs `mod_cluster`. +# +# @param allowed_network +# Balanced members network. +# +# @param balancer_name +# Name of balancer. +# +# @param ip +# Specifies the IP address to listen to. +# +# @param version +# Specifies the mod_cluster version. Version 1.3.0 or greater is required for httpd 2.4. +# +# @param enable_mcpm_receive +# Whether MCPM should be enabled. +# +# @param port +# mod_cluster listen port. +# +# @param keep_alive_timeout +# Specifies how long Apache should wait for a request, in seconds. +# +# @param manager_allowed_network +# Whether to allow the network to access the mod_cluster_manager. +# +# @param max_keep_alive_requests +# Maximum number of requests kept alive. +# +# @param server_advertise +# Whether the server should advertise. +# +# @param advertise_frequency +# Sets the interval between advertise messages in seconds. +# +# @example +# class { '::apache::mod::cluster': +# ip => '172.17.0.1', +# allowed_network => '172.17.0.', +# balancer_name => 'mycluster', +# version => '1.3.1' +# } +# +# @note +# There is no official package available for mod_cluster, so you must make it available outside of the apache module. +# Binaries can be found [here](https://modcluster.io/). +# +# @see https://modcluster.io/ for additional documentation. +# class apache::mod::cluster ( $allowed_network, $balancer_name, @@ -11,8 +61,7 @@ class apache::mod::cluster ( $server_advertise = true, $advertise_frequency = undef, ) { - - include ::apache + include apache ::apache::mod { 'proxy': } ::apache::mod { 'proxy_ajp': } @@ -26,14 +75,13 @@ class apache::mod::cluster ( ::apache::mod { 'slotmem': } } - file {'cluster.conf': + file { 'cluster.conf': ensure => file, - path => "${::apache::mod_dir}/cluster.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/cluster.conf", + mode => $apache::file_mode, content => template('apache/mod/cluster.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } - } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/data.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/data.pp new file mode 100644 index 000000000..43bc2d0c9 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/data.pp @@ -0,0 +1,18 @@ +# @summary +# Installs and configures `mod_data`. +# +# @param apache_version +# Version of Apache to install module on. +# +# @see https://httpd.apache.org/docs/current/mod/mod_data.html for additional documentation. +# +class apache::mod::data ( + $apache_version = undef, +) { + include apache + $_apache_version = pick($apache_version, $apache::apache_version) + if versioncmp($_apache_version, '2.3') < 0 { + fail('mod_data is only available in Apache 2.3 and later') + } + ::apache::mod { 'data': } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dav.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dav.pp index ade9c0809..616492705 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dav.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dav.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_dav`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_dav.html for additional documentation. +# class apache::mod::dav { ::apache::mod { 'dav': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dav_fs.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dav_fs.pp index 60127e3f6..20fd5c015 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dav_fs.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dav_fs.pp @@ -1,5 +1,10 @@ +# @summary +# Installs `mod_dav_fs`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_dav_fs.html for additional documentation. +# class apache::mod::dav_fs { - include ::apache + include apache $dav_lock = $::osfamily ? { 'debian' => "\${APACHE_LOCK_DIR}/DAVLock", 'freebsd' => '/usr/local/var/DavLock', @@ -12,11 +17,11 @@ class apache::mod::dav_fs { # Template uses: $dav_lock file { 'dav_fs.conf': ensure => file, - path => "${::apache::mod_dir}/dav_fs.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/dav_fs.conf", + mode => $apache::file_mode, content => template('apache/mod/dav_fs.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dav_svn.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dav_svn.pp index 35d5417b5..4c04d1b35 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dav_svn.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dav_svn.pp @@ -1,10 +1,18 @@ +# @summary +# Installs and configures `mod_dav_svn`. +# +# @param authz_svn_enabled +# Specifies whether to install Apache mod_authz_svn +# +# @see https://httpd.apache.org/docs/current/mod/mod_dav_svn.html for additional documentation. +# class apache::mod::dav_svn ( $authz_svn_enabled = false, ) { Class['::apache::mod::dav'] -> Class['::apache::mod::dav_svn'] - include ::apache - include ::apache::mod::dav - if($::operatingsystem == 'SLES' and $::operatingsystemmajrelease < '12'){ + include apache + include apache::mod::dav + if($::operatingsystem == 'SLES' and versioncmp($::operatingsystemmajrelease, '12') < 0) { package { 'subversion-server': ensure => 'installed', provider => 'zypper', @@ -13,15 +21,11 @@ class apache::mod::dav_svn ( ::apache::mod { 'dav_svn': } - if $::osfamily == 'Debian' and ($::operatingsystemmajrelease != '6' and $::operatingsystemmajrelease != '10.04' and $::operatingsystemrelease != '10.04' and $::operatingsystemmajrelease != '16.04') { - $loadfile_name = undef - } else { - $loadfile_name = 'dav_svn_authz_svn.load' - } - if $authz_svn_enabled { ::apache::mod { 'authz_svn': - loadfile_name => $loadfile_name, + # authz_svn depends on symbols from the dav_svn module, + # therefore, make sure authz_svn is loaded after dav_svn. + loadfile_name => 'dav_svn_authz_svn.load', require => Apache::Mod['dav_svn'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dbd.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dbd.pp index 547acc77d..cdc9cdf6f 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dbd.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dbd.pp @@ -1,3 +1,11 @@ +# @summary +# Installs `mod_dbd`. +# +# @param apache_version +# Used to verify that the Apache version you have requested is compatible with the module. +# +# @see https://httpd.apache.org/docs/current/mod/mod_dbd.html for additional documentation. +# class apache::mod::dbd { ::apache::mod { 'dbd': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/deflate.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/deflate.pp index 70ac5be12..777c2f888 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/deflate.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/deflate.pp @@ -1,3 +1,14 @@ +# @summary +# Installs and configures `mod_deflate`. +# +# @param types +# An array of MIME types to be deflated. See https://www.iana.org/assignments/media-types/media-types.xhtml. +# +# @param notes +# A Hash where the key represents the type and the value represents the note name. +# +# @see https://httpd.apache.org/docs/current/mod/mod_deflate.html for additional documentation. +# class apache::mod::deflate ( $types = [ 'text/html text/plain text/xml', @@ -12,16 +23,16 @@ class apache::mod::deflate ( 'Ratio' => 'ratio', } ) { - include ::apache + include apache ::apache::mod { 'deflate': } file { 'deflate.conf': ensure => file, - path => "${::apache::mod_dir}/deflate.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/deflate.conf", + mode => $apache::file_mode, content => template('apache/mod/deflate.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dev.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dev.pp index 5abdedd36..4039ff1fd 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dev.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dev.pp @@ -1,5 +1,11 @@ +# @summary +# Installs `mod_dev`. +# +# @note +# This module is deprecated. Please use `apache::dev`. +# class apache::mod::dev { # Development packages are not apache modules warning('apache::mod::dev is deprecated; please use apache::dev') - include ::apache::dev + include apache::dev } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dir.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dir.pp index 3c994d3e1..86f97a070 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dir.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dir.pp @@ -1,23 +1,34 @@ -# Note: this sets the global DirectoryIndex directive, it may be necessary to consider being able to modify the apache::vhost to declare DirectoryIndex statements in a vhost configuration -# Parameters: -# - $indexes provides a string for the DirectoryIndex directive http://httpd.apache.org/docs/current/mod/mod_dir.html#directoryindex +# @summary +# Installs and configures `mod_dir`. +# +# @param types +# Specifies the text-based content types to compress. +# +# @param indexes +# Provides a string for the DirectoryIndex directive +# +# @todo +# This sets the global DirectoryIndex directive, so it may be necessary to consider being able to modify the apache::vhost to declare +# DirectoryIndex statements in a vhost configuration +# +# @see https://httpd.apache.org/docs/current/mod/mod_dir.html for additional documentation. +# class apache::mod::dir ( $dir = 'public_html', Array[String] $indexes = ['index.html','index.html.var','index.cgi','index.pl','index.php','index.xhtml'], ) { - - include ::apache + include apache ::apache::mod { 'dir': } # Template uses # - $indexes file { 'dir.conf': ensure => file, - path => "${::apache::mod_dir}/dir.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/dir.conf", + mode => $apache::file_mode, content => template('apache/mod/dir.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/disk_cache.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/disk_cache.pp index 7cd72701e..cb82b7b6b 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/disk_cache.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/disk_cache.pp @@ -1,11 +1,37 @@ +# @summary +# Installs and configures `mod_disk_cache`. +# +# @param cache_root +# Defines the name of the directory on the disk to contain cache files. +# Default depends on the Apache version and operating system: +# - Debian: /var/cache/apache2/mod_cache_disk +# - FreeBSD: /var/cache/mod_cache_disk +# - Red Hat, Apache 2.4: /var/cache/httpd/proxy +# - Red Hat, Apache 2.2: /var/cache/mod_proxy +# +# @param cache_ignore_headers +# Specifies HTTP header(s) that should not be stored in the cache. +# +# @param default_cache_enable +# Default value is true, which enables "CacheEnable disk /" in disk_cache.conf for the webserver. This would cache +# every request to apache by default for every vhost. If set to false the default cache all behaviour is supressed. +# You can then control this behaviour in individual vhosts by explicitly defining CacheEnable. +# +# @note +# Apache 2.2, mod_disk_cache installed. On Apache 2.4, mod_cache_disk installed. +# +# @see https://httpd.apache.org/docs/2.2/mod/mod_disk_cache.html for additional documentation. +# class apache::mod::disk_cache ( - $cache_root = undef, + $cache_root = undef, + $cache_ignore_headers = undef, + Boolean $default_cache_enable = true, ) { - include ::apache + include apache if $cache_root { $_cache_root = $cache_root } - elsif versioncmp($::apache::apache_version, '2.4') >= 0 { + elsif versioncmp($apache::apache_version, '2.4') >= 0 { $_cache_root = $::osfamily ? { 'debian' => '/var/cache/apache2/mod_cache_disk', 'redhat' => '/var/cache/httpd/proxy', @@ -20,7 +46,7 @@ class apache::mod::disk_cache ( } } - if versioncmp($::apache::apache_version, '2.4') >= 0 { + if versioncmp($apache::apache_version, '2.4') >= 0 { apache::mod { 'cache_disk': } } else { @@ -32,11 +58,11 @@ class apache::mod::disk_cache ( # Template uses $_cache_root file { 'disk_cache.conf': ensure => file, - path => "${::apache::mod_dir}/disk_cache.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/disk_cache.conf", + mode => $apache::file_mode, content => template('apache/mod/disk_cache.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dumpio.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dumpio.pp index c79f6da38..df892a919 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dumpio.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/dumpio.pp @@ -1,18 +1,38 @@ -class apache::mod::dumpio( +# @summary +# Installs and configures `mod_dumpio`. +# +# @param dump_io_input +# Dump all input data to the error log +# +# @param dump_io_output +# Dump all output data to the error log +# +# @example +# class{'apache': +# default_mods => false, +# log_level => 'dumpio:trace7', +# } +# class{'apache::mod::dumpio': +# dump_io_input => 'On', +# dump_io_output => 'Off', +# } +# +# @see https://httpd.apache.org/docs/current/mod/mod_dumpio.html for additional documentation. +# +class apache::mod::dumpio ( Enum['Off', 'On', 'off', 'on'] $dump_io_input = 'Off', Enum['Off', 'On', 'off', 'on'] $dump_io_output = 'Off', ) { - include ::apache + include apache ::apache::mod { 'dumpio': } - file{'dumpio.conf': + file { 'dumpio.conf': ensure => file, - path => "${::apache::mod_dir}/dumpio.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/dumpio.conf", + mode => $apache::file_mode, content => template('apache/mod/dumpio.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } - } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/env.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/env.pp index b973005f4..2ca17a5e7 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/env.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/env.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_env`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_env.html for additional documentation. +# class apache::mod::env { ::apache::mod { 'env': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/event.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/event.pp index a87395916..402a8530e 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/event.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/event.pp @@ -1,3 +1,51 @@ +# @summary +# Installs and configures `mod_event`. +# +# @param startservers +# Sets the number of child server processes created at startup, via the module's `StartServers` directive. Setting this to `false` +# removes the parameter. +# +# @param maxclients +# Apache 2.3.12 or older alias for the `MaxRequestWorkers` directive. +# +# @param maxrequestworkers +# Sets the maximum number of connections Apache can simultaneously process, via the module's `MaxRequestWorkers` directive. Setting +# these to `false` removes the parameters. +# +# @param minsparethreads +# Sets the minimum number of idle threads, via the `MinSpareThreads` directive. Setting this to `false` removes the parameters. +# +# @param maxsparethreads +# Sets the maximum number of idle threads, via the `MaxSpareThreads` directive. Setting this to `false` removes the parameters. +# +# @param threadsperchild +# Number of threads created by each child process. +# +# @param maxrequestsperchild +# Apache 2.3.8 or older alias for the `MaxConnectionsPerChild` directive. +# +# @param maxconnectionsperchild +# Limit on the number of connections that an individual child server will handle during its life. +# +# @param serverlimit +# Limits the configurable number of processes via the `ServerLimit` directive. Setting this to `false` removes the parameter. +# +# @param apache_version +# Version of Apache to install module on. +# +# @param threadlimit +# Limits the number of event threads via the module's `ThreadLimit` directive. Setting this to `false` removes the parameter. +# +# @param listenbacklog +# Sets the maximum length of the pending connections queue via the module's `ListenBackLog` directive. Setting this to `false` removes +# the parameter. +# +# @note +# You cannot include apache::mod::event with apache::mod::itk, apache::mod::peruser, apache::mod::prefork, or +# apache::mod::worker on the same server. +# +# @see https://httpd.apache.org/docs/current/mod/event.html for additional documentation. +# @note Unsupported platforms: SLES: all class apache::mod::event ( $startservers = '2', $maxclients = '150', @@ -12,7 +60,7 @@ class apache::mod::event ( $threadlimit = '64', $listenbacklog = '511', ) { - include ::apache + include apache $_apache_version = pick($apache_version, $apache::apache_version) @@ -30,8 +78,8 @@ class apache::mod::event ( } File { owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, + group => $apache::params::root_group, + mode => $apache::file_mode, } # Template uses: @@ -42,25 +90,25 @@ class apache::mod::event ( # - $threadsperchild # - $maxrequestsperchild # - $serverlimit - file { "${::apache::mod_dir}/event.conf": + file { "${apache::mod_dir}/event.conf": ensure => file, - mode => $::apache::file_mode, + mode => $apache::file_mode, content => template('apache/mod/event.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } case $::osfamily { 'redhat': { if versioncmp($_apache_version, '2.4') >= 0 { - apache::mpm{ 'event': + apache::mpm { 'event': apache_version => $_apache_version, } } } 'debian','freebsd' : { - apache::mpm{ 'event': + apache::mpm { 'event': apache_version => $_apache_version, } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/expires.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/expires.pp index 07ec82e27..7a5bfddea 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/expires.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/expires.pp @@ -1,9 +1,25 @@ +# @summary +# Installs and configures `mod_expires`. +# +# @param expires_active +# Enables generation of Expires headers. +# +# @param expires_default +# Specifies the default algorithm for calculating expiration time using ExpiresByType syntax or interval syntax. +# +# @param expires_by_type +# Describes a set of [MIME content-types](https://www.iana.org/assignments/media-types/media-types.xhtml) and their expiration +# times. This should be used as an array of Hashes, with each Hash's key a valid MIME content-type (i.e. 'text/json') and its +# value following valid interval syntax. +# +# @see https://httpd.apache.org/docs/current/mod/mod_expires.html for additional documentation. +# class apache::mod::expires ( $expires_active = true, $expires_default = undef, $expires_by_type = undef, ) { - include ::apache + include apache ::apache::mod { 'expires': } # Template uses @@ -12,11 +28,11 @@ class apache::mod::expires ( # $expires_by_type file { 'expires.conf': ensure => file, - path => "${::apache::mod_dir}/expires.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/expires.conf", + mode => $apache::file_mode, content => template('apache/mod/expires.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ext_filter.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ext_filter.pp index 11550320c..d2a3d635e 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ext_filter.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ext_filter.pp @@ -1,7 +1,23 @@ -class apache::mod::ext_filter( +# @summary +# Installs and configures `mod_ext_filter`. +# +# @param ext_filter_define +# Hash of filter names and their parameters. +# +# @example +# class { 'apache::mod::ext_filter': +# ext_filter_define => { +# 'slowdown' => 'mode=output cmd=/bin/cat preservescontentlength', +# 'puppetdb-strip' => 'mode=output outtype=application/json cmd="pdb-resource-filter"', +# }, +# } +# +# @see https://httpd.apache.org/docs/current/mod/mod_ext_filter.html for additional documentation. +# +class apache::mod::ext_filter ( Optional[Hash] $ext_filter_define = undef ) { - include ::apache + include apache ::apache::mod { 'ext_filter': } @@ -11,11 +27,11 @@ class apache::mod::ext_filter( if $ext_filter_define { file { 'ext_filter.conf': ensure => file, - path => "${::apache::mod_dir}/ext_filter.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/ext_filter.conf", + mode => $apache::file_mode, content => template('apache/mod/ext_filter.conf.erb'), - require => [ Exec["mkdir ${::apache::mod_dir}"], ], - before => File[$::apache::mod_dir], + require => [Exec["mkdir ${apache::mod_dir}"],], + before => File[$apache::mod_dir], notify => Class['Apache::Service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/fastcgi.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/fastcgi.pp index 543a32233..a3445c917 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/fastcgi.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/fastcgi.pp @@ -1,9 +1,19 @@ +# @summary +# Installs `mod_fastcgi`. +# +# @see https://github.com/FastCGI-Archives/mod_fastcgi for additional documentation. +# class apache::mod::fastcgi { - include ::apache - + include apache + if ($::osfamily == 'Redhat' and versioncmp($::operatingsystemmajrelease, '7') >= 0) { + fail('mod_fastcgi is no longer supported on el7 and above.') + } + if ($facts['os']['name'] == 'Ubuntu' and versioncmp($facts['os']['release']['major'], '18.04') >= 0) { + fail('mod_fastcgi is no longer supported on Ubuntu 18.04 and above. Please use mod_proxy_fcgi') + } # Debian specifies it's fastcgi lib path, but RedHat uses the default value # with no config file - $fastcgi_lib_path = $::apache::params::fastcgi_lib_path + $fastcgi_lib_path = $apache::params::fastcgi_lib_path ::apache::mod { 'fastcgi': } @@ -14,13 +24,12 @@ class apache::mod::fastcgi { # - $fastcgi_dir file { 'fastcgi.conf': ensure => file, - path => "${::apache::mod_dir}/fastcgi.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/fastcgi.conf", + mode => $apache::file_mode, content => template('apache/mod/fastcgi.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } - } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/fcgid.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/fcgid.pp index 0e99a9b79..14aa141d9 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/fcgid.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/fcgid.pp @@ -1,8 +1,45 @@ -class apache::mod::fcgid( +# @summary +# Installs and configures `mod_fcgid`. +# +# @param expires_active +# Enables generation of Expires headers. +# +# @param expires_default +# Default algorithm for calculating expiration time. +# +# @param expires_by_type +# Value of the Expires header configured by MIME type. +# +# @example The class does not individually parameterize all available options. Instead, configure mod_fcgid using the options hash. +# class { 'apache::mod::fcgid': +# options => { +# 'FcgidIPCDir' => '/var/run/fcgidsock', +# 'SharememPath' => '/var/run/fcgid_shm', +# 'AddHandler' => 'fcgid-script .fcgi', +# }, +# } +# +# @example If you include apache::mod::fcgid, you can set the [FcgidWrapper][] per directory, per virtual host. The module must be +# loaded first; Puppet will not automatically enable it if you set the fcgiwrapper parameter in apache::vhost. +# include apache::mod::fcgid +# +# apache::vhost { 'example.org': +# docroot => '/var/www/html', +# directories => { +# path => '/var/www/html', +# fcgiwrapper => { +# command => '/usr/local/bin/fcgiwrapper', +# } +# }, +# } +# +# @see https://httpd.apache.org/docs/current/mod/mod_fcgid.html for additional documentation. +# +class apache::mod::fcgid ( $options = {}, ) { - include ::apache - if ($::osfamily == 'RedHat' and $::operatingsystemmajrelease == '7') or $::osfamily == 'FreeBSD' { + include apache + if ($::osfamily == 'RedHat' and $::operatingsystemmajrelease >= '7') or $::osfamily == 'FreeBSD' { $loadfile_name = 'unixd_fcgid.load' $conf_name = 'unixd_fcgid.conf' } else { @@ -18,11 +55,11 @@ class apache::mod::fcgid( # - $options file { $conf_name: ensure => file, - path => "${::apache::mod_dir}/${conf_name}", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/${conf_name}", + mode => $apache::file_mode, content => template('apache/mod/fcgid.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/filter.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/filter.pp index 26dc488b3..5cee27718 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/filter.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/filter.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_filter`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_filter.html for additional documentation. +# class apache::mod::filter { ::apache::mod { 'filter': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/geoip.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/geoip.pp index 66ae887de..b77ea05c6 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/geoip.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/geoip.pp @@ -1,3 +1,32 @@ +# @summary +# Installs and configures `mod_geoip`. +# +# @param enable +# Toggles whether to enable geoip. +# +# @param db_file +# Path to database for GeoIP to use. +# +# @param flag +# Caching directive to use. Values: 'CheckCache', 'IndexCache', 'MemoryCache', 'Standard'. +# +# @param output +# Output variable locations. Values: 'All', 'Env', 'Request', 'Notes'. +# +# @param enable_utf8 +# Changes the output from ISO88591 (Latin1) to UTF8. +# +# @param scan_proxy_headers +# Enables the GeoIPScanProxyHeaders option. +# +# @param scan_proxy_headers_field +# Specifies the header mod_geoip uses to determine the client's IP address. +# +# @param use_last_xforwarededfor_ip +# Determines whether to use the first or last IP address for the client's IP in a comma-separated list of IP addresses is found. +# +# @see https://dev.maxmind.com/geoip/legacy/mod_geoip2 for additional documentation. +# class apache::mod::geoip ( $enable = false, $db_file = '/usr/share/GeoIP/GeoIP.dat', @@ -8,7 +37,7 @@ class apache::mod::geoip ( $scan_proxy_header_field = undef, $use_last_xforwarededfor_ip = undef, ) { - include ::apache + include apache ::apache::mod { 'geoip': } # Template uses: @@ -22,12 +51,11 @@ class apache::mod::geoip ( # - use_last_xforwarededfor_ip file { 'geoip.conf': ensure => file, - path => "${::apache::mod_dir}/geoip.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/geoip.conf", + mode => $apache::file_mode, content => template('apache/mod/geoip.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } - } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/headers.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/headers.pp index d18c5e279..a86dbf76a 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/headers.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/headers.pp @@ -1,3 +1,11 @@ +# @summary +# Installs and configures `mod_headers`. +# +# @param apache_version +# Version of Apache to install module on. +# +# @see https://httpd.apache.org/docs/current/mod/mod_headers.html for additional documentation. +# class apache::mod::headers { ::apache::mod { 'headers': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/http2.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/http2.pp new file mode 100644 index 000000000..0637aee4d --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/http2.pp @@ -0,0 +1,105 @@ +# @summary +# Installs and configures `mod_http2`. +# +# @param h2_copy_files +# Determine file handling in responses. +# +# @param h2_direct +# H2 Direct Protocol Switch. +# +# @param h2_early_hints +# Determine sending of 103 status codes. +# +# @param h2_max_session_streams +# Sets maximum number of active streams per HTTP/2 session. +# +# @param h2_max_worker_idle_seconds +# Sets maximum number of seconds h2 workers remain idle until shut down. +# +# @param h2_max_workers +# Sets maximum number of worker threads to use per child process. +# +# @param h2_min_workers +# Sets minimal number of worker threads to use per child process. +# +# @param h2_modern_tls_only +# Toggles the security checks on HTTP/2 connections in TLS mode +# +# @param h2_push +# Toggles the usage of the HTTP/2 server push protocol feature. +# +# @param h2_push_diary_size +# Sets maximum number of HTTP/2 server pushes that are remembered per HTTP/2 connection. +# +# @param h2_priority +# Require HTTP/2 connections to be "modern TLS" only +# +# @param h2_push_resource +# When added to a directory/location, HTTP/2 PUSHes will be attempted for all paths added +# via this directive +# +# @param h2_serialize_headers +# Toggles if HTTP/2 requests shall be serialized in HTTP/1.1 format for processing by httpd +# core or if received binary data shall be passed into the request_recs directly. +# +# @param h2_stream_max_mem_size +# Sets the maximum number of outgoing data bytes buffered in memory for an active streams. +# +# @param h2_tls_cool_down_secs +# Sets the number of seconds of idle time on a TLS connection before the TLS write size falls +# back to small (~1300 bytes) length. +# +# @param h2_tls_warm_up_size +# Sets the number of bytes to be sent in small TLS records (~1300 bytes) until doing maximum +# sized writes (16k) on https: HTTP/2 connections. +# +# @param h2_upgrade +# Toggles the usage of the HTTP/1.1 Upgrade method for switching to HTTP/2. +# +# @param h2_window_size +# Sets the size of the window that is used for flow control from client to server and limits +# the amount of data the server has to buffer. +# +# @param apache_version +# Version of Apache to install module on. +# +# @see https://httpd.apache.org/docs/current/mod/mod_http2.html for additional documentation. +# +class apache::mod::http2 ( + Optional[Boolean] $h2_copy_files = undef, + Optional[Boolean] $h2_direct = undef, + Optional[Boolean] $h2_early_hints = undef, + Optional[Integer] $h2_max_session_streams = undef, + Optional[Integer] $h2_max_worker_idle_seconds = undef, + Optional[Integer] $h2_max_workers = undef, + Optional[Integer] $h2_min_workers = undef, + Optional[Boolean] $h2_modern_tls_only = undef, + Optional[Boolean] $h2_push = undef, + Optional[Integer] $h2_push_diary_size = undef, + Array[String] $h2_push_priority = [], + Array[String] $h2_push_resource = [], + Optional[Boolean] $h2_serialize_headers = undef, + Optional[Integer] $h2_stream_max_mem_size = undef, + Optional[Integer] $h2_tls_cool_down_secs = undef, + Optional[Integer] $h2_tls_warm_up_size = undef, + Optional[Boolean] $h2_upgrade = undef, + Optional[Integer] $h2_window_size = undef, + Optional[String] $apache_version = undef, +) { + include apache + apache::mod { 'http2': } + + $_apache_version = pick($apache_version, $apache::apache_version) + + file { 'http2.conf': + ensure => file, + content => template('apache/mod/http2.conf.erb'), + mode => $apache::file_mode, + path => "${apache::mod_dir}/http2.conf", + owner => $apache::params::user, + group => $apache::params::group, + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], + notify => Class['apache::service'], + } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/include.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/include.pp index edbe81f32..af9675a95 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/include.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/include.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_include`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_include.html for additional documentation. +# class apache::mod::include { ::apache::mod { 'include': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/info.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/info.pp index c6f1355e5..baf20cb32 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/info.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/info.pp @@ -1,14 +1,32 @@ +# @summary +# Installs and configures `mod_info`. +# +# @param allow_from +# Allowlist of IPv4 or IPv6 addresses or ranges that can access the info path. +# +# @param apache_version +# Version of Apache to install module on. +# +# @param restrict_access +# Toggles whether to restrict access to info path. If `false`, the `allow_from` allowlist is ignored and any IP address can +# access the info path. +# +# @param info_path +# Path on server to file containing server configuration information. +# +# @see https://httpd.apache.org/docs/current/mod/mod_info.html for additional documentation. +# class apache::mod::info ( $allow_from = ['127.0.0.1','::1'], $apache_version = undef, $restrict_access = true, $info_path = '/server-info', -){ - include ::apache +) { + include apache $_apache_version = pick($apache_version, $apache::apache_version) if $::osfamily == 'Suse' { - if defined(Class['::apache::mod::worker']){ + if defined(Class['::apache::mod::worker']) { $suse_path = '/usr/lib64/apache2-worker' } else { $suse_path = '/usr/lib64/apache2-prefork' @@ -23,11 +41,11 @@ class apache::mod::info ( # Template uses $allow_from, $_apache_version file { 'info.conf': ensure => file, - path => "${::apache::mod_dir}/info.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/info.conf", + mode => $apache::file_mode, content => template('apache/mod/info.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/intercept_form_submit.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/intercept_form_submit.pp index 39f1f5e07..f6ccf653b 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/intercept_form_submit.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/intercept_form_submit.pp @@ -1,4 +1,9 @@ +# @summary +# Installs `mod_intercept_form_submit`. +# +# @see https://www.adelton.com/apache/mod_intercept_form_submit for additional documentation. +# class apache::mod::intercept_form_submit { - include ::apache + include apache ::apache::mod { 'intercept_form_submit': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/itk.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/itk.pp index 8ceb56d2b..2f44b01a8 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/itk.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/itk.pp @@ -1,3 +1,34 @@ +# @summary +# Installs MPM `mod_itk`. +# +# @param startservers +# Number of child server processes created on startup. +# +# @param minspareservers +# Minimum number of idle child server processes. +# +# @param maxspareservers +# Maximum number of idle child server processes. +# +# @param serverlimit +# Maximum configured value for `MaxRequestWorkers` for the lifetime of the Apache httpd process. +# +# @param maxclients +# Limit on the number of simultaneous requests that will be served. +# +# @param maxrequestsperchild +# Limit on the number of connections that an individual child server process will handle. +# +# @param enablecapabilities +# Drop most root capabilities in the parent process, and instead run as the user given by the User/Group directives with some extra +# capabilities (in particular setuid). Somewhat more secure, but can cause problems when serving from filesystems that do not honor +# capabilities, such as NFS. +# +# @param apache_version +# Used to verify that the Apache version you have requested is compatible with the module. +# +# @see http://mpm-itk.sesse.net for additional documentation. +# @note Unsupported platforms: CentOS: 8; RedHat: 8; SLES: all class apache::mod::itk ( $startservers = '8', $minspareservers = '5', @@ -5,9 +36,10 @@ class apache::mod::itk ( $serverlimit = '256', $maxclients = '256', $maxrequestsperchild = '4000', + $enablecapabilities = undef, $apache_version = undef, ) { - include ::apache + include apache $_apache_version = pick($apache_version, $apache::apache_version) @@ -29,7 +61,7 @@ class apache::mod::itk ( } } else { if ! defined(Class['apache::mod::prefork']) { - include ::apache::mod::prefork + include apache::mod::prefork } } } @@ -38,8 +70,8 @@ class apache::mod::itk ( } File { owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, + group => $apache::params::root_group, + mode => $apache::file_mode, } # Template uses: @@ -49,12 +81,12 @@ class apache::mod::itk ( # - $serverlimit # - $maxclients # - $maxrequestsperchild - file { "${::apache::mod_dir}/itk.conf": + file { "${apache::mod_dir}/itk.conf": ensure => file, - mode => $::apache::file_mode, + mode => $apache::file_mode, content => template('apache/mod/itk.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } @@ -64,7 +96,7 @@ class apache::mod::itk ( ensure => present, } if versioncmp($_apache_version, '2.4') >= 0 { - ::apache::mpm{ 'itk': + ::apache::mpm { 'itk': apache_version => $_apache_version, } } @@ -80,7 +112,7 @@ class apache::mod::itk ( } } 'debian', 'freebsd': { - apache::mpm{ 'itk': + apache::mpm { 'itk': apache_version => $_apache_version, } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/jk.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/jk.pp new file mode 100644 index 000000000..d13ddd55a --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/jk.pp @@ -0,0 +1,378 @@ +# @summary +# Installs `mod_jk`. +# +# @param ip +# IP for binding to mod_jk. Useful when the binding address is not the primary network interface IP. +# +# @param port +# Port for binding to mod_jk. Useful when something else, like a reverse proxy or cache, is receiving requests at port 80, then +# needs to forward them to Apache at a different port. +# +# @param add_listen +# Defines if a Listen directive according to parameters ip and port (see below), so that Apache listens to the IP/port combination +# and redirect to mod_jk. Useful when another Listen directive, like Listen *: or Listen , can conflict with the one +# necessary for mod_jk binding. +# +# @param workers_file +# The name of a worker file for the Tomcat servlet containers. +# +# @param worker_property +# Enables setting worker properties inside Apache configuration file. +# +# @param logroot +# The base directory for shm_file and log_file is determined by the logroot parameter. If unspecified, defaults to +# apache::params::logroot. The default logroot is sane enough therefore it is not recommended to override it. +# +# @param shm_file +# Shared memory file name. +# +# @param shm_size +# Size of the shared memory file name. +# +# @param mount_file +# File containing multiple mappings from a context to a Tomcat worker. +# +# @param mount_file_reload +# This directive configures the reload check interval in seconds. +# +# @param mount +# A mount point from a context to a Tomcat worker. +# +# @param un_mount +# An exclusion mount point from a context to a Tomcat worker. +# +# @param auto_alias +# Automatically Alias webapp context directories into the Apache document space +# +# @param mount_copy +# If this directive is set to "On" in some virtual server, the mounts from the global server will be copied +# to this virtual server, more precisely all mounts defined by JkMount or JkUnMount. +# +# @param worker_indicator +# Name of the Apache environment variable that can be used to set worker names in combination with SetHandler +# jakarta-servlet. +# +# @param watchdog_interval +# This directive configures the watchdog thread interval in seconds. +# +# @param log_file +# Full or server relative path to the mod_jk log file. +# +# @param log_level +# The mod_jk log level, can be debug, info, warn error or trace. +# +# @param log_stamp_format +# The mod_jk date log format, using an extended strftime syntax. +# +# @param request_log_format +# Request log format string. +# +# @param extract_ssl +# Turns on SSL processing and information gathering by mod_jk. +# +# @param https_indicator +# Name of the Apache environment variable that contains SSL indication. +# +# @param sslprotocol_indicator +# Name of the Apache environment variable that contains the SSL protocol name. +# +# @param certs_indicator +# Name of the Apache environment variable that contains SSL client certificates. +# +# @param cipher_indicator +# Name of the Apache environment variable that contains SSL client cipher. +# +# @param certchain_prefix +# Name of the Apache environment (prefix) that contains SSL client chain certificates. +# +# @param session_indicator +# Name of the Apache environment variable that contains SSL session. +# +# @param keysize_indicator +# Name of the Apache environment variable that contains SSL key size in use. +# +# @param local_name_indicator +# Name of the Apache environment variable which can be used to overwrite the forwarded local name. +# +# @param ignore_cl_indicator +# Name of the Apache environment variable which forces to ignore an existing Content-Length request header. +# +# @param local_addr_indicator +# Name of the Apache environment variable which can be used to overwrite the forwarded local IP address. +# +# @param local_port_indicator +# Name of the Apache environment variable which can be used to overwrite the forwarded local port. +# +# @param remote_host_indicator +# Name of the Apache environment variable which can be used to overwrite the forwarded remote (client) host name. +# +# @param remote_addr_indicator +# Name of the Apache environment variable which can be used to overwrite the forwarded remote (client) IP address. +# +# @param remote_port_indicator +# Name of the Apache environment variable which can be used to overwrite the forwarded remote (client) IP address. +# +# @param remote_user_indicator +# Name of the Apache environment variable which can be used to overwrite the forwarded user name. +# +# @param auth_type_indicator +# Name of the Apache environment variable which can be used to overwrite the forwarded authentication type. +# +# @param options +# Set one of more options to configure the mod_jk module. +# +# @param env_var +# Adds a name and an optional default value of environment variable that should be sent to servlet-engine as a request attribute. +# +# @param strip_session +# If this directive is set to On in some virtual server, the session IDs ;jsessionid=... will be removed for URLs which are not +# forwarded but instead are handled by the local server. +# +# @param workers_file_content +# Each directive has the format worker..=. This maps as a hash of hashes, where the outer hash specifies +# workers, and each inner hash specifies each worker properties and values. Plus, there are two global directives, 'worker.list' and +# 'worker.maintain' For example, the workers file below should be parameterized as follows: +# +# Worker file: +# ``` +# worker.list = status +# worker.list = some_name,other_name +# +# worker.maintain = 60 +# +# # Optional comment +# worker.some_name.type=ajp13 +# worker.some_name.socket_keepalive=true +# +# # I just like comments +# worker.other_name.type=ajp12 (why would you?) +# worker.other_name.socket_keepalive=false +# ``` +# +# Puppet file: +# ``` +# $workers_file_content = { +# worker_lists => ['status', 'some_name,other_name'], +# worker_maintain => '60', +# some_name => { +# comment => 'Optional comment', +# type => 'ajp13', +# socket_keepalive => 'true', +# }, +# other_name => { +# comment => 'I just like comments', +# type => 'ajp12', +# socket_keepalive => 'false', +# }, +# } +# ``` +# +# @param mount_file_content +# Each directive has the format = . This maps as a hash of hashes, where the outer hash specifies workers, and +# each inner hash contains two items: +# - uri_list-an array with URIs to be mapped to the worker +# - comment-an optional string with a comment for the worker. For example, the mount file below should be parameterized as Figure 2: +# +# Worker file: +# ``` +# # Worker 1 +# /context_1/ = worker_1 +# /context_1/* = worker_1 +# +# # Worker 2 +# / = worker_2 +# /context_2/ = worker_2 +# /context_2/* = worker_2 +# ``` +# +# Puppet file: +# ``` +# $mount_file_content = { +# worker_1 => { +# uri_list => ['/context_1/', '/context_1/*'], +# comment => 'Worker 1', +# }, +# worker_2 => { +# uri_list => ['/context_2/', '/context_2/*'], +# comment => 'Worker 2', +# }, +# }, +# ``` +# +# @example +# class { '::apache::mod::jk': +# ip => '192.168.2.15', +# workers_file => 'conf/workers.properties', +# mount_file => 'conf/uriworkermap.properties', +# shm_file => 'run/jk.shm', +# shm_size => '50M', +# workers_file_content => { +# +# }, +# } +# +# @note +# shm_file and log_file +# Depending on how these files are specified, the class creates their final path differently: +# +# Relative path: prepends supplied path with logroot (see below) +# Absolute path or pipe: uses supplied path as-is +# +# ``` +# shm_file => 'shm_file' +# # Ends up in +# $shm_path = '/var/log/httpd/shm_file' +# +# shm_file => '/run/shm_file' +# # Ends up in +# $shm_path = '/run/shm_file' +# +# shm_file => '"|rotatelogs /var/log/httpd/mod_jk.log.%Y%m%d 86400 -180"' +# # Ends up in +# $shm_path = '"|rotatelogs /var/log/httpd/mod_jk.log.%Y%m%d 86400 -180"' +# ``` +# +# @note +# All parameters are optional. When undefined, some receive default values, while others cause an optional +# directive to be absent +# +# Additionally, There is no official package available for mod_jk and thus it must be made available by means outside of the control of the +# apache module. Binaries can be found at Apache Tomcat Connectors download page +# +# @see https://tomcat.apache.org/connectors-doc/reference/apache.html for additional documentation. +# +class apache::mod::jk ( + # Binding to mod_jk + Optional[String] $ip = undef, + Integer $port = 80, + Boolean $add_listen = true, + # Conf file content + $workers_file = undef, + $worker_property = {}, + $logroot = undef, + $shm_file = 'jk-runtime-status', + $shm_size = undef, + $mount_file = undef, + $mount_file_reload = undef, + $mount = {}, + $un_mount = {}, + $auto_alias = undef, + $mount_copy = undef, + $worker_indicator = undef, + $watchdog_interval = undef, + $log_file = 'mod_jk.log', + $log_level = undef, + $log_stamp_format = undef, + $request_log_format = undef, + $extract_ssl = undef, + $https_indicator = undef, + $sslprotocol_indicator = undef, + $certs_indicator = undef, + $cipher_indicator = undef, + $certchain_prefix = undef, + $session_indicator = undef, + $keysize_indicator = undef, + $local_name_indicator = undef, + $ignore_cl_indicator = undef, + $local_addr_indicator = undef, + $local_port_indicator = undef, + $remote_host_indicator = undef, + $remote_addr_indicator = undef, + $remote_port_indicator = undef, + $remote_user_indicator = undef, + $auth_type_indicator = undef, + $options = [], + $env_var = {}, + $strip_session = undef, + # Location list + # See comments in template mod/jk.conf.erb + $location_list = [], + # Workers file content + # See comments in template mod/jk/workers.properties.erb + $workers_file_content = {}, + # Mount file content + # See comments in template mod/jk/uriworkermap.properties.erb + $mount_file_content = {}, +) { + # Provides important variables + include apache + # Manages basic module config + ::apache::mod { 'jk': } + + # Ensure that we are not using variables with the typo fixed by MODULES-6225 + # anymore: + if !empty($workers_file_content) and has_key($workers_file_content, 'worker_mantain') { + fail('Please replace $workers_file_content[\'worker_mantain\'] by $workers_file_content[\'worker_maintain\']. See MODULES-6225 for details.') + } + + # Binding to mod_jk + if $add_listen { + $_ip = $ip ? { + undef => $facts['ipaddress'], + default => $ip, + } + ensure_resource('apache::listen', "${_ip}:${port}", {}) + } + + # File resource common parameters + File { + ensure => file, + mode => $apache::file_mode, + notify => Class['apache::service'], + } + + # Shared memory and log paths + # If logroot unspecified, use default + $log_dir = $logroot ? { + undef => $apache::logroot, + default => $logroot, + } + # If absolute path or pipe, use as-is + # If relative path, prepend with log directory + # If unspecified, use default + $shm_path = $shm_file ? { + undef => "${log_dir}/jk-runtime-status", + /^\"?[|\/]/ => $shm_file, + default => "${log_dir}/${shm_file}", + } + $log_path = $log_file ? { + undef => "${log_dir}/mod_jk.log", + /^\"?[|\/]/ => $log_file, + default => "${log_dir}/${log_file}", + } + + # Main config file + $mod_dir = $apache::mod_dir + file { 'jk.conf': + path => "${mod_dir}/jk.conf", + content => template('apache/mod/jk.conf.erb'), + require => [ + Exec["mkdir ${mod_dir}"], + File[$mod_dir], + ], + } + + # Workers file + if $workers_file != undef { + $workers_path = $workers_file ? { + /^\// => $workers_file, + default => "${apache::httpd_dir}/${workers_file}", + } + file { $workers_path: + content => template('apache/mod/jk/workers.properties.erb'), + require => Package['httpd'], + } + } + + # Mount file + if $mount_file != undef { + $mount_path = $mount_file ? { + /^\// => $mount_file, + default => "${apache::httpd_dir}/${mount_file}", + } + file { $mount_path: + content => template('apache/mod/jk/uriworkermap.properties.erb'), + require => Package['httpd'], + } + } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ldap.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ldap.pp index 3e5159222..9c37b09e6 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ldap.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ldap.pp @@ -1,3 +1,53 @@ +# @summary +# Installs and configures `mod_ldap`. +# +# @param apache_version +# Used to verify that the Apache version you have requested is compatible with the module. +# +# @param package_name +# Specifies the custom package name. +# +# @param ldap_trusted_global_cert_file +# Sets the file or database containing global trusted Certificate Authority or global client certificates. +# +# @param ldap_trusted_global_cert_type +# Sets the certificate parameter of the global trusted Certificate Authority or global client certificates. +# +# @param ldap_shared_cache_size +# Size in bytes of the shared-memory cache +# +# @param ldap_cache_entries +# Maximum number of entries in the primary LDAP cache +# +# @param ldap_cache_ttl +# Time that cached items remain valid (in seconds). +# +# @param ldap_opcache_entries +# Number of entries used to cache LDAP compare operations +# +# @param ldap_opcache_ttl +# Time that entries in the operation cache remain valid (in seconds). +# +# @param ldap_trusted_mode +# Specifies the SSL/TLS mode to be used when connecting to an LDAP server. +# +# @param ldap_path +# The server location of the ldap status page. +# +# @example +# class { 'apache::mod::ldap': +# ldap_trusted_global_cert_file => '/etc/pki/tls/certs/ldap-trust.crt', +# ldap_trusted_global_cert_type => 'CA_DER', +# ldap_trusted_mode => 'TLS', +# ldap_shared_cache_size => '500000', +# ldap_cache_entries => '1024', +# ldap_cache_ttl => '600', +# ldap_opcache_entries => '1024', +# ldap_opcache_ttl => '600', +# } +# +# @see https://httpd.apache.org/docs/current/mod/mod_ldap.html for additional documentation. +# @note Unsupported platforms: CentOS: 8; RedHat: 8 class apache::mod::ldap ( $apache_version = undef, $package_name = undef, @@ -8,9 +58,10 @@ class apache::mod::ldap ( $ldap_cache_ttl = undef, $ldap_opcache_entries = undef, $ldap_opcache_ttl = undef, -){ - - include ::apache + $ldap_trusted_mode = undef, + String $ldap_path = '/ldap-status', +) { + include apache $_apache_version = pick($apache_version, $apache::apache_version) ::apache::mod { 'ldap': package => $package_name, @@ -18,11 +69,11 @@ class apache::mod::ldap ( # Template uses $_apache_version file { 'ldap.conf': ensure => file, - path => "${::apache::mod_dir}/ldap.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/ldap.conf", + mode => $apache::file_mode, content => template('apache/mod/ldap.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/lookup_identity.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/lookup_identity.pp index 445c60ef2..3161ec329 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/lookup_identity.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/lookup_identity.pp @@ -1,4 +1,9 @@ +# @summary +# Installs `mod_lookup_identity` +# +# @see https://www.adelton.com/apache/mod_lookup_identity for additional documentation. +# class apache::mod::lookup_identity { - include ::apache + include apache ::apache::mod { 'lookup_identity': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/macro.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/macro.pp new file mode 100644 index 000000000..c4d2af003 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/macro.pp @@ -0,0 +1,9 @@ +# @summary +# Installs `mod_macro`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_macro.html for additional documentation. +# +class apache::mod::macro { + include apache + ::apache::mod { 'macro': } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/md.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/md.pp new file mode 100644 index 000000000..d8847ed67 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/md.pp @@ -0,0 +1,140 @@ +# @summary +# Installs and configures `mod_md`. +# +# @param md_activation_delay +# - +# +# @param md_base_server +# Control if base server may be managed or only virtual hosts. +# +# @param md_ca_challenges +# Type of ACME challenge used to prove domain ownership. +# +# @param md_certificate_agreement +# You confirm that you accepted the Terms of Service of the Certificate +# Authority. +# +# @param md_certificate_authority +# The URL of the ACME Certificate Authority service. +# +# @param md_certificate_check +# - +# +# @param md_certificate_monitor +# The URL of a certificate log monitor. +# +# @param md_certificate_protocol +# The protocol to use with the Certificate Authority. +# +# @param md_certificate_status +# Exposes public certificate information in JSON. +# +# @param md_challenge_dns01 +# Define a program to be called when the `dns-01` challenge needs to be +# setup/torn down. +# +# @param md_contact_email +# The ACME protocol requires you to give a contact url when you sign up. +# +# @param md_http_proxy +# Define a proxy for outgoing connections. +# +# @param md_members +# Control if the alias domain names are automatically added. +# +# @param md_message_cmd +# Handle events for Manage Domains. +# +# @param md_must_staple +# Control if new certificates carry the OCSP Must Staple flag. +# +# @param md_notify_cmd +# Run a program when a Managed Domain is ready. +# +# @param md_port_map +# Map external to internal ports for domain ownership verification. +# +# @param md_private_keys +# Set type and size of the private keys generated. +# +# @param md_renew_mode +# Controls if certificates shall be renewed. +# +# @param md_renew_window +# Control when a certificate will be renewed. +# +# @param md_require_https +# Redirects http: traffic to https: for Managed Domains. +# An http: Virtual Host must nevertheless be setup for that domain. +# +# @param md_server_status +# Control if Managed Domain information is added to server-status. +# +# @param md_staple_others +# Enable stapling for certificates not managed by mod_md. +# +# @param md_stapling +# Enable stapling for all or a particular MDomain. +# +# @param md_stapling_keep_response +# Controls when old responses should be removed. +# +# @param md_stapling_renew_window +# Control when the stapling responses will be renewed. +# +# @param md_store_dir +# Path on the local file system to store the Managed Domains data. +# +# @param md_warn_window +# Define the time window when you want to be warned about an expiring +# certificate. +# +# @see https://httpd.apache.org/docs/current/mod/mod_md.html for additional documentation. +# +# @note Unsupported platforms: CentOS: 6, 7; Debian: 8, 9; OracleLinux: all; RedHat: 6, 7; Scientific: all; SLES: all; Ubuntu: 14, 16, 18 +class apache::mod::md ( + Optional[String] $md_activation_delay = undef, + Optional[Enum['on', 'off']] $md_base_server = undef, + Optional[Array[Enum['dns-01', 'http-01', 'tls-alpn-01']]] $md_ca_challenges = undef, + Optional[Enum['accepted']] $md_certificate_agreement = undef, + Optional[Stdlib::HTTPUrl] $md_certificate_authority = undef, + Optional[String] $md_certificate_check = undef, # undocumented + Optional[String] $md_certificate_monitor = undef, + Optional[Enum['ACME']] $md_certificate_protocol = undef, + Optional[Enum['on', 'off']] $md_certificate_status = undef, + Optional[Stdlib::Absolutepath] $md_challenge_dns01 = undef, + Optional[String] $md_contact_email = undef, + Optional[Stdlib::HTTPUrl] $md_http_proxy = undef, + Optional[Enum['auto', 'manual']] $md_members = undef, + Optional[Stdlib::Absolutepath] $md_message_cmd = undef, + Optional[Enum['on', 'off']] $md_must_staple = undef, + Optional[Stdlib::Absolutepath] $md_notify_cmd = undef, + Optional[String] $md_port_map = undef, + Optional[String] $md_private_keys = undef, + Optional[Enum['always', 'auto', 'manual']] $md_renew_mode = undef, + Optional[String] $md_renew_window = undef, + Optional[Enum['off', 'permanent', 'temporary']] $md_require_https = undef, + Optional[Enum['on', 'off']] $md_server_status = undef, + Optional[Enum['on', 'off']] $md_staple_others = undef, + Optional[Enum['on', 'off']] $md_stapling = undef, + Optional[String] $md_stapling_keep_response = undef, + Optional[String] $md_stapling_renew_window = undef, + Optional[Stdlib::Absolutepath] $md_store_dir = undef, + Optional[String] $md_warn_window = undef, +) { + include apache + include apache::mod::watchdog + + apache::mod { 'md': + } + + file { 'md.conf': + ensure => file, + path => "${apache::mod_dir}/md.conf", + mode => $apache::file_mode, + content => epp('apache/mod/md.conf.epp'), + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], + notify => Class['apache::service'], + } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/mime.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/mime.pp index f68693093..9243ae1e1 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/mime.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/mime.pp @@ -1,19 +1,33 @@ +# @summary +# Installs and configures `mod_mime`. +# +# @param mime_support_package +# Name of the MIME package to be installed. +# +# @param mime_types_config +# The location of the mime.types file. +# +# @param mime_types_additional +# List of additional MIME types to include. +# +# @see https://httpd.apache.org/docs/current/mod/mod_mime.html for additional documentation. +# class apache::mod::mime ( - $mime_support_package = $::apache::params::mime_support_package, - $mime_types_config = $::apache::params::mime_types_config, + $mime_support_package = $apache::params::mime_support_package, + $mime_types_config = $apache::params::mime_types_config, $mime_types_additional = undef, ) inherits ::apache::params { - include ::apache + include apache $_mime_types_additional = pick($mime_types_additional, $apache::mime_types_additional) apache::mod { 'mime': } # Template uses $_mime_types_config file { 'mime.conf': ensure => file, - path => "${::apache::mod_dir}/mime.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/mime.conf", + mode => $apache::file_mode, content => template('apache/mod/mime.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } if $mime_support_package { diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/mime_magic.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/mime_magic.pp index ecc74cfdd..99a1ec4bb 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/mime_magic.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/mime_magic.pp @@ -1,17 +1,25 @@ +# @summary +# Installs and configures `mod_mime_magic`. +# +# @param magic_file +# Enable MIME-type determination based on file contents using the specified magic file. +# +# @see https://httpd.apache.org/docs/current/mod/mod_mime_magic.html for additional documentation. +# class apache::mod::mime_magic ( $magic_file = undef, ) { - include ::apache - $_magic_file = pick($magic_file, "${::apache::conf_dir}/magic") + include apache + $_magic_file = pick($magic_file, "${apache::conf_dir}/magic") apache::mod { 'mime_magic': } # Template uses $magic_file file { 'mime_magic.conf': ensure => file, - path => "${::apache::mod_dir}/mime_magic.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/mime_magic.conf", + mode => $apache::file_mode, content => template('apache/mod/mime_magic.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/negotiation.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/negotiation.pp index c7c34b81f..bc018001a 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/negotiation.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/negotiation.pp @@ -1,27 +1,32 @@ +# @summary +# Installs and configures `mod_negotiation`. +# +# @param force_language_priority +# Action to take if a single acceptable document is not found. +# +# @param language_priority +# The precedence of language variants for cases where the client does not express a preference. +# +# @see [https://httpd.apache.org/docs/current/mod/mod_negotiation.html for additional documentation. +# class apache::mod::negotiation ( - $force_language_priority = 'Prefer Fallback', - $language_priority = [ 'en', 'ca', 'cs', 'da', 'de', 'el', 'eo', 'es', 'et', - 'fr', 'he', 'hr', 'it', 'ja', 'ko', 'ltz', 'nl', 'nn', - 'no', 'pl', 'pt', 'pt-BR', 'ru', 'sv', 'zh-CN', - 'zh-TW' ], + Variant[Array[String], String] $force_language_priority = 'Prefer Fallback', + Variant[Array[String], String] $language_priority = ['en', 'ca', 'cs', 'da', 'de', 'el', 'eo', 'es', 'et', + 'fr', 'he', 'hr', 'it', 'ja', 'ko', 'ltz', 'nl', 'nn', + 'no', 'pl', 'pt', 'pt-BR', 'ru', 'sv', 'zh-CN', + 'zh-TW'], ) { - include ::apache - if !is_array($force_language_priority) and !is_string($force_language_priority) { - fail('force_languague_priority must be a string or array of strings') - } - if !is_array($language_priority) and !is_string($language_priority) { - fail('force_languague_priority must be a string or array of strings') - } + include apache ::apache::mod { 'negotiation': } # Template uses no variables file { 'negotiation.conf': ensure => file, - mode => $::apache::file_mode, - path => "${::apache::mod_dir}/negotiation.conf", + mode => $apache::file_mode, + path => "${apache::mod_dir}/negotiation.conf", content => template('apache/mod/negotiation.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/nss.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/nss.pp index 8814c9366..4c986ff81 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/nss.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/nss.pp @@ -1,15 +1,32 @@ +# @summary +# Installs and configures `mod_nss`. +# +# @param transfer_log +# Path to `access.log`. +# +# @param error_Log +# Path to `error.log` +# +# @param passwd_file +# Path to file containing token passwords used for NSSPassPhraseDialog. +# +# @param port +# Sets the SSL port that should be used by mod_nss. +# +# @see https://pagure.io/mod_nss for additional documentation. +# class apache::mod::nss ( - $transfer_log = "${::apache::params::logroot}/access.log", - $error_log = "${::apache::params::logroot}/error.log", + $transfer_log = "${apache::params::logroot}/access.log", + $error_log = "${apache::params::logroot}/error.log", $passwd_file = undef, $port = 8443, ) { - include ::apache - include ::apache::mod::mime + include apache + include apache::mod::mime apache::mod { 'nss': } - $httpd_dir = $::apache::httpd_dir + $httpd_dir = $apache::httpd_dir # Template uses: # $transfer_log @@ -18,11 +35,11 @@ class apache::mod::nss ( # passwd_file file { 'nss.conf': ensure => file, - path => "${::apache::mod_dir}/nss.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/nss.conf", + mode => $apache::file_mode, content => template('apache/mod/nss.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/pagespeed.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/pagespeed.pp index 052dad0b1..54181545a 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/pagespeed.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/pagespeed.pp @@ -1,3 +1,18 @@ +# @summary +# Installs and configures `mod_pagespeed`. +# +# @todo +# Add docs +# +# @note +# Verify that your system is compatible with the latest Google Pagespeed requirements. +# +# Although this apache module requires the mod-pagespeed-stable package, Puppet does not manage the software repositories required to +# automatically install the package. If you declare this class when the package is either not installed or not available to your +# package manager, your Puppet run will fail. +# +# @see https://developers.google.com/speed/pagespeed/module/ for additional documentation. +# class apache::mod::pagespeed ( $inherit_vhost_config = 'on', $filter_xhtml = false, @@ -34,8 +49,8 @@ class apache::mod::pagespeed ( $additional_configuration = {}, $apache_version = undef, $package_ensure = undef, -){ - include ::apache +) { + include apache $_apache_version = pick($apache_version, $apache::apache_version) $_lib = $_apache_version ? { '2.4' => 'mod_pagespeed_ap24.so', @@ -50,11 +65,11 @@ class apache::mod::pagespeed ( # Template uses $_apache_version file { 'pagespeed.conf': ensure => file, - path => "${::apache::mod_dir}/pagespeed.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/pagespeed.conf", + mode => $apache::file_mode, content => template('apache/mod/pagespeed.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/passenger.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/passenger.pp index 3b17d3db3..9019c33e4 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/passenger.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/passenger.pp @@ -1,40 +1,824 @@ +# @summary +# Installs `mod_pasenger`. +# +# @param manage_repo +# Toggle whether to manage yum repo if on a RedHat node. +# +# @param mod_id +# Specifies the package id. +# +# @param mod_lib +# Defines the module's shared object name. Do not configure manually without special reason. +# +# @param mod_lib_path +# Specifies a path to the module's libraries. Do not manually set this parameter without special reason. The `path` parameter overrides +# this value. +# +# @param mod_package +# Name of the module package to install. +# +# @param mod_package_ensure +# Determines whether Puppet ensures the module should be installed. +# +# @param mod_path +# Specifies a path to the module. Do not manually set this parameter without a special reason. +# +# @param passenger_allow_encoded_slashes +# Toggle whether URLs with encoded slashes (%2f) can be used (by default Apache does not support this). +# +# @param passenger_app_env +# This option sets, for the current application, the value of the following environment variables: +# - RAILS_ENV +# - RACK_ENV +# - WSGI_ENV +# - NODE_ENV +# - PASSENGER_APP_ENV +# +# @param passenger_app_group_name +# Sets the name of the application group that the current application should belong to. +# +# @param passenger_app_root +# Path to the application root which allows access independent from the DocumentRoot. +# +# @param passenger_app_type +# Specifies the type of the application. If you set this option, then you must also set PassengerAppRoot, otherwise Passenger will +# not properly recognize your application. +# +# @param passenger_base_uri +# Used to specify that the given URI is an distinct application that should be served by Passenger. +# +# @param passenger_buffer_response +# Toggle whether application-generated responses are buffered by Apache. Buffering will happen in memory. +# +# @param passenger_buffer_upload +# Toggle whether HTTP client request bodies are buffered before they are sent to the application. +# +# @param passenger_concurrency_model +# Specifies the I/O concurrency model that should be used for Ruby application processes. +# +# @param passenger_conf_file +# +# +# @param passenger_conf_package_file +# +# +# @param passenger_data_buffer_dir +# Specifies the directory in which to store data buffers. +# +# @param passenger_debug_log_file +# +# +# @param passenger_debugger +# Turns support for Ruby application debugging on or off. +# +# @param passenger_default_group +# Allows you to specify the group that applications must run as, if user switching fails or is disabled. +# +# @param passenger_default_ruby +# File path to desired ruby interpreter to use by default. +# +# @param passenger_default_user +# Allows you to specify the user that applications must run as, if user switching fails or is disabled. +# +# @param passenger_disable_security_update_check +# Allows disabling the Passenger security update check, a daily check with https://securitycheck.phusionpassenger.com for important +# security updates that might be available. +# +# @param passenger_enabled +# Toggles whether Passenger should be enabled for that particular context. +# +# @param passenger_error_override +# Toggles whether Apache will intercept and handle responses with HTTP status codes of 400 and higher. +# +# @param passenger_file_descriptor_log_file +# Log file descriptor debug tracing messages to the given file. +# +# @param passenger_fly_with +# Enables the Flying Passenger mode, and configures Apache to connect to the Flying Passenger daemon that's listening on the +# given socket filename. +# +# @param passenger_force_max_concurrent_requests_per_process +# Use this option to tell Passenger how many concurrent requests the application can handle per process. +# +# @param passenger_friendly_error_pages +# Toggles whether Passenger should display friendly error pages whenever an application fails to start. +# +# @param passenger_group +# Allows you to override that behavior and explicitly set a group to run the web application as, regardless of the ownership of the +# startup file. +# +# @param passenger_high_performance +# Toggles whether to enable PassengerHighPerformance which will make Passenger will be a little faster, in return for reduced +# compatibility with other Apache modules. +# +# @param passenger_installed_version +# +# +# @param passenger_instance_registry_dir +# Specifies the directory that Passenger should use for registering its current instance. +# +# @param passenger_load_shell_envvars +# Enables or disables the loading of shell environment variables before spawning the application. +# +# @param passenger_log_file +# File path to log file. By default Passenger log messages are written to the Apache global error log. +# +# @param passenger_log_level +# Specifies how much information Passenger should log to its log file. A higher log level value means that more +# information will be logged. +# +# @param passenger_lve_min_uid +# When using Passenger on a LVE-enabled kernel, a security check (enter) is run for spawning application processes. This options +# tells the check to only allow processes with UIDs equal to, or higher than, the specified value. +# +# @param passenger_max_instances +# The maximum number of application processes that may simultaneously exist for an application. +# +# @param passenger_max_instances_per_app +# The maximum number of application processes that may simultaneously exist for a single application. +# +# @param passenger_max_pool_size +# The maximum number of application processes that may simultaneously exist. +# +# @param passenger_max_preloader_idle_time +# Set the preloader's idle timeout, in seconds. A value of 0 means that it should never idle timeout. +# +# @param passenger_max_request_queue_size +# Specifies the maximum size for the queue of all incoming requests. +# +# @param passenger_max_request_time +# The maximum amount of time, in seconds, that an application process may take to process a request. +# +# @param passenger_max_requests +# The maximum number of requests an application process will process. +# +# @param passenger_memory_limit +# The maximum amount of memory that an application process may use, in megabytes. +# +# @param passenger_meteor_app_settings +# When using a Meteor application in non-bundled mode, use this option to specify a JSON file with settings for the application. +# +# @param passenger_min_instances +# Specifies the minimum number of application processes that should exist for a given application. +# +# @param passenger_nodejs +# Specifies the Node.js command to use for serving Node.js web applications. +# +# @param passenger_pool_idle_time +# The maximum number of seconds that an application process may be idle. +# +# @param passenger_pre_start +# URL of the web application you want to pre-start. +# +# @param passenger_python +# Specifies the Python interpreter to use for serving Python web applications. +# +# @param passenger_resist_deployment_errors +# Enables or disables resistance against deployment errors. +# +# @param passenger_resolve_symlinks_in_document_root +# This option is no longer available in version 5.2.0. Switch to PassengerAppRoot if you are setting the application root via a +# document root containing symlinks. +# +# @param passenger_response_buffer_high_watermark +# Configures the maximum size of the real-time disk-backed response buffering system. +# +# @param passenger_restart_dir +# Path to directory containing restart.txt file. Can be either absolute or relative. +# +# @param passenger_rolling_restarts +# Enables or disables support for zero-downtime application restarts through restart.txt. +# +# @param passenger_root +# Refers to the location to the Passenger root directory, or to a location configuration file. +# +# @param passenger_ruby +# Specifies the Ruby interpreter to use for serving Ruby web applications. +# +# @param passenger_security_update_check_proxy +# Allows use of an intermediate proxy for the Passenger security update check. +# +# @param passenger_show_version_in_header +# Toggle whether Passenger will output its version number in the X-Powered-By header in all Passenger-served requests: +# +# @param passenger_socket_backlog +# This option can be raised if Apache manages to overflow the backlog queue. +# +# @param passenger_spawn_method +# Controls whether Passenger spawns applications directly, or using a prefork copy-on-write mechanism. +# +# @param passenger_start_timeout +# Specifies a timeout for the startup of application processes. +# +# @param passenger_startup_file +# Specifies the startup file that Passenger should use when loading the application. +# +# @param passenger_stat_throttle_rate +# Setting this option to a value of x means that certain filesystem checks will be performed at most once every x seconds. +# +# @param passenger_sticky_sessions +# Toggles whether all requests that a client sends will be routed to the same originating application process, whenever possible. +# +# @param passenger_sticky_sessions_cookie_name +# Sets the name of the sticky sessions cookie. +# +# @param passenger_thread_count +# Specifies the number of threads that Passenger should spawn per Ruby application process. +# +# @param passenger_use_global_queue +# N/A. +# +# @param passenger_user +# Allows you to override that behavior and explicitly set a user to run the web application as, regardless of the ownership of the +# startup file. +# +# @param passenger_user_switching +# Toggles whether to attempt to enable user account sandboxing, also known as user switching. +# +# @param rack_auto_detect +# This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. +# +# @param rack_autodetect +# This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. +# +# @param rack_base_uri +# Deprecated in 3.0.0 in favor of PassengerBaseURI. +# +# @param rack_env +# Alias for PassengerAppEnv. +# +# @param rails_allow_mod_rewrite +# This option doesn't do anything anymore since version 4.0.0. +# +# @param rails_app_spawner_idle_time +# This option has been removed in version 4.0.0, and replaced with PassengerMaxPreloaderIdleTime. +# +# @param rails_auto_detect +# This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. +# +# @param rails_autodetect +# This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. +# +# @param rails_base_uri +# Deprecated in 3.0.0 in favor of PassengerBaseURI. +# +# @param rails_default_user +# Deprecated in 3.0.0 in favor of PassengerDefaultUser +# +# @param rails_env +# Alias for PassengerAppEnv. +# +# @param rails_framework_spawner_idle_time +# This option is no longer available in version 4.0.0. There is no alternative because framework spawning has been removed +# altogether. You should use smart spawning instead. +# +# @param rails_ruby +# Deprecated in 3.0.0 in favor of PassengerRuby. +# +# @param rails_spawn_method +# Deprecated in 3.0.0 in favor of PassengerSpawnMethod. +# +# @param rails_user_switching +# Deprecated in 3.0.0 in favor of PassengerUserSwitching. +# +# @param wsgi_auto_detect +# This option has been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead. +# +# @note +# In Passenger source code you can strip out what are all the available options by looking in +# - src/apache2_module/Configuration.cpp +# - src/apache2_module/ConfigurationCommands.cpp +# There are also several undocumented settings. +# +# @note +# For Red Hat based systems, ensure that you meet the minimum requirements described in the passenger docs. +# +# The current set of server configurations settings were taken directly from the Passenger Reference. To enable deprecation warnings +# and removal failure messages, set the passenger_installed_version to the version number installed on the server. +# +# Change Log: +# - As of 08/13/2017 there are 84 available/deprecated/removed settings. +# - Around 08/20/2017 UnionStation was discontinued options were removed. +# - As of 08/20/2017 there are 77 available/deprecated/removed settings. +# +# @see https://www.phusionpassenger.com/docs/references/config_reference/apache/ for additional documentation. +# class apache::mod::passenger ( - $passenger_conf_file = $::apache::params::passenger_conf_file, - $passenger_conf_package_file = $::apache::params::passenger_conf_package_file, - $passenger_high_performance = undef, - $passenger_pool_idle_time = undef, - $passenger_max_request_queue_size = undef, - $passenger_max_requests = undef, - Optional[Enum['smart', 'direct', 'smart-lv2', 'conservative']] $passenger_spawn_method = undef, - $passenger_stat_throttle_rate = undef, - $rack_autodetect = undef, - $rails_autodetect = undef, - $passenger_root = $::apache::params::passenger_root, - $passenger_ruby = $::apache::params::passenger_ruby, - $passenger_default_ruby = $::apache::params::passenger_default_ruby, - $passenger_max_pool_size = undef, - $passenger_min_instances = undef, - $passenger_max_instances_per_app = undef, - $passenger_use_global_queue = undef, - $passenger_app_env = undef, - Optional[Stdlib::Absolutepath] $passenger_log_file = undef, - $passenger_log_level = undef, - $passenger_data_buffer_dir = undef, - $manage_repo = true, - $mod_package = undef, - $mod_package_ensure = undef, - $mod_lib = undef, - $mod_lib_path = undef, - $mod_id = undef, - $mod_path = undef, + $manage_repo = true, + $mod_id = undef, + $mod_lib = undef, + $mod_lib_path = undef, + $mod_package = undef, + $mod_package_ensure = undef, + $mod_path = undef, + $passenger_allow_encoded_slashes = undef, + Optional[String] $passenger_anonymous_telemetry_proxy = undef, + $passenger_app_env = undef, + $passenger_app_group_name = undef, + $passenger_app_root = undef, + $passenger_app_type = undef, + $passenger_base_uri = undef, + $passenger_buffer_response = undef, + $passenger_buffer_upload = undef, + $passenger_concurrency_model = undef, + $passenger_conf_file = $apache::params::passenger_conf_file, + $passenger_conf_package_file = $apache::params::passenger_conf_package_file, + $passenger_data_buffer_dir = undef, + $passenger_debug_log_file = undef, + $passenger_debugger = undef, + $passenger_default_group = undef, + $passenger_default_ruby = $apache::params::passenger_default_ruby, + $passenger_default_user = undef, + Optional[Boolean] $passenger_disable_anonymous_telemetry = undef, + Optional[Boolean] $passenger_disable_log_prefix = undef, + $passenger_disable_security_update_check = undef, + $passenger_enabled = undef, + $passenger_error_override = undef, + $passenger_file_descriptor_log_file = undef, + $passenger_fly_with = undef, + $passenger_force_max_concurrent_requests_per_process = undef, + $passenger_friendly_error_pages = undef, + $passenger_group = undef, + $passenger_high_performance = undef, + $passenger_installed_version = undef, + $passenger_instance_registry_dir = undef, + $passenger_load_shell_envvars = undef, + Optional[Stdlib::Absolutepath] $passenger_log_file = undef, + $passenger_log_level = undef, + $passenger_lve_min_uid = undef, + $passenger_max_instances = undef, + $passenger_max_instances_per_app = undef, + $passenger_max_pool_size = undef, + $passenger_max_preloader_idle_time = undef, + $passenger_max_request_queue_size = undef, + $passenger_max_request_time = undef, + $passenger_max_requests = undef, + $passenger_memory_limit = undef, + $passenger_meteor_app_settings = undef, + $passenger_min_instances = undef, + $passenger_nodejs = undef, + $passenger_pool_idle_time = undef, + Optional[Variant[String,Array[String]]] $passenger_pre_start = undef, + $passenger_python = undef, + $passenger_resist_deployment_errors = undef, + $passenger_resolve_symlinks_in_document_root = undef, + $passenger_response_buffer_high_watermark = undef, + $passenger_restart_dir = undef, + $passenger_rolling_restarts = undef, + $passenger_root = $apache::params::passenger_root, + $passenger_ruby = $apache::params::passenger_ruby, + $passenger_security_update_check_proxy = undef, + $passenger_show_version_in_header = undef, + $passenger_socket_backlog = undef, + Optional[String] $passenger_spawn_dir = undef, + Optional[Enum['smart', 'direct', 'smart-lv2', 'conservative']] $passenger_spawn_method = undef, + $passenger_start_timeout = undef, + $passenger_startup_file = undef, + $passenger_stat_throttle_rate = undef, + $passenger_sticky_sessions = undef, + $passenger_sticky_sessions_cookie_name = undef, + Optional[String] $passenger_sticky_sessions_cookie_attributes = undef, + $passenger_thread_count = undef, + $passenger_use_global_queue = undef, + $passenger_user = undef, + $passenger_user_switching = undef, + $rack_auto_detect = undef, + $rack_autodetect = undef, + $rack_base_uri = undef, + $rack_env = undef, + $rails_allow_mod_rewrite = undef, + $rails_app_spawner_idle_time = undef, + $rails_auto_detect = undef, + $rails_autodetect = undef, + $rails_base_uri = undef, + $rails_default_user = undef, + $rails_env = undef, + $rails_framework_spawner_idle_time = undef, + $rails_ruby = undef, + $rails_spawn_method = undef, + $rails_user_switching = undef, + $wsgi_auto_detect = undef, ) inherits ::apache::params { - - include ::apache - + include apache + if $passenger_installed_version { + if $passenger_allow_encoded_slashes { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_allow_encoded_slashes is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_anonymous_telemetry_proxy { + if (versioncmp($passenger_installed_version, '6.0.0') < 0) { + fail("Passenger config option :: passenger_anonymous_telemetry_proxy is not introduced until version 6.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_app_env { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_app_env is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_app_group_name { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_app_group_name is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_app_root { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_app_root is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_app_type { + if (versioncmp($passenger_installed_version, '4.0.25') < 0) { + fail("Passenger config option :: passenger_app_type is not introduced until version 4.0.25 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_base_uri { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_base_uri is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_buffer_response { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_buffer_response is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_buffer_upload { + if (versioncmp($passenger_installed_version, '4.0.26') < 0) { + fail("Passenger config option :: passenger_buffer_upload is not introduced until version 4.0.26 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_concurrency_model { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_concurrency_model is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_data_buffer_dir { + if (versioncmp($passenger_installed_version, '5.0.0') < 0) { + fail("Passenger config option :: passenger_data_buffer_dir is not introduced until version 5.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_debug_log_file { + if (versioncmp($passenger_installed_version, '5.0.5') > 0) { + warning('DEPRECATED PASSENGER OPTION :: passenger_debug_log_file :: This option has been renamed in version 5.0.5 to PassengerLogFile.') + } + } + if $passenger_debugger { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_debugger is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_default_group { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_default_group is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_default_ruby { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_default_ruby is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_default_user { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_default_user is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_disable_anonymous_telemetry { + if (versioncmp($passenger_installed_version, '6.0.0') < 0) { + fail("Passenger config option :: passenger_disable_anonymous_telemetry is not introduced until version 6.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_disable_log_prefix { + if (versioncmp($passenger_installed_version, '6.0.2') < 0) { + fail("Passenger config option :: passenger_disable_log_prefix is not introduced until version 6.0.2 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_disable_security_update_check { + if (versioncmp($passenger_installed_version, '5.1.0') < 0) { + fail("Passenger config option :: passenger_disable_security_update_check is not introduced until version 5.1.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_enabled { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_enabled is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_error_override { + if (versioncmp($passenger_installed_version, '4.0.24') < 0) { + fail("Passenger config option :: passenger_error_override is not introduced until version 4.0.24 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_file_descriptor_log_file { + if (versioncmp($passenger_installed_version, '5.0.5') < 0) { + fail("Passenger config option :: passenger_file_descriptor_log_file is not introduced until version 5.0.5 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_fly_with { + if (versioncmp($passenger_installed_version, '4.0.45') < 0) { + fail("Passenger config option :: passenger_fly_with is not introduced until version 4.0.45 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_force_max_concurrent_requests_per_process { + if (versioncmp($passenger_installed_version, '5.0.22') < 0) { + fail("Passenger config option :: passenger_force_max_concurrent_requests_per_process is not introduced until version 5.0.22 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_friendly_error_pages { + if (versioncmp($passenger_installed_version, '4.0.42') < 0) { + fail("Passenger config option :: passenger_friendly_error_pages is not introduced until version 4.0.42 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_group { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_group is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_high_performance { + if (versioncmp($passenger_installed_version, '2.0.0') < 0) { + fail("Passenger config option :: passenger_high_performance is not introduced until version 2.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_instance_registry_dir { + if (versioncmp($passenger_installed_version, '5.0.0') < 0) { + fail("Passenger config option :: passenger_instance_registry_dir is not introduced until version 5.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_load_shell_envvars { + if (versioncmp($passenger_installed_version, '4.0.20') < 0) { + fail("Passenger config option :: passenger_load_shell_envvars is not introduced until version 4.0.20 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_log_file { + if (versioncmp($passenger_installed_version, '5.0.5') < 0) { + fail("Passenger config option :: passenger_log_file is not introduced until version 5.0.5 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_log_level { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_log_level is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_lve_min_uid { + if (versioncmp($passenger_installed_version, '5.0.28') < 0) { + fail("Passenger config option :: passenger_lve_min_uid is not introduced until version 5.0.28 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_max_instances { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_max_instances is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_max_instances_per_app { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_max_instances_per_app is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_max_pool_size { + if (versioncmp($passenger_installed_version, '1.0.0') < 0) { + fail("Passenger config option :: passenger_max_pool_size is not introduced until version 1.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_max_preloader_idle_time { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_max_preloader_idle_time is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_max_request_queue_size { + if (versioncmp($passenger_installed_version, '4.0.15') < 0) { + fail("Passenger config option :: passenger_max_request_queue_size is not introduced until version 4.0.15 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_max_request_time { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_max_request_time is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_max_requests { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_max_requests is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_memory_limit { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_memory_limit is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_meteor_app_settings { + if (versioncmp($passenger_installed_version, '5.0.7') < 0) { + fail("Passenger config option :: passenger_meteor_app_settings is not introduced until version 5.0.7 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_min_instances { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_min_instances is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_nodejs { + if (versioncmp($passenger_installed_version, '4.0.24') < 0) { + fail("Passenger config option :: passenger_nodejs is not introduced until version 4.0.24 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_pool_idle_time { + if (versioncmp($passenger_installed_version, '1.0.0') < 0) { + fail("Passenger config option :: passenger_pool_idle_time is not introduced until version 1.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_pre_start { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_pre_start is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_python { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_python is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_resist_deployment_errors { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_resist_deployment_errors is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_resolve_symlinks_in_document_root { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_resolve_symlinks_in_document_root is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_response_buffer_high_watermark { + if (versioncmp($passenger_installed_version, '5.0.0') < 0) { + fail("Passenger config option :: passenger_response_buffer_high_watermark is not introduced until version 5.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_restart_dir { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_restart_dir is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_rolling_restarts { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_rolling_restarts is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_root { + if (versioncmp($passenger_installed_version, '1.0.0') < 0) { + fail("Passenger config option :: passenger_root is not introduced until version 1.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_ruby { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_ruby is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_security_update_check_proxy { + if (versioncmp($passenger_installed_version, '5.1.0') < 0) { + fail("Passenger config option :: passenger_security_update_check_proxy is not introduced until version 5.1.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_show_version_in_header { + if (versioncmp($passenger_installed_version, '5.1.0') < 0) { + fail("Passenger config option :: passenger_show_version_in_header is not introduced until version 5.1.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_socket_backlog { + if (versioncmp($passenger_installed_version, '5.0.24') < 0) { + fail("Passenger config option :: passenger_socket_backlog is not introduced until version 5.0.24 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_spawn_dir { + if (versioncmp($passenger_installed_version, '6.0.3') < 0) { + fail("Passenger config option :: passenger_spawn_dir is not introduced until version 6.0.3 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_spawn_method { + if (versioncmp($passenger_installed_version, '2.0.0') < 0) { + fail("Passenger config option :: passenger_spawn_method is not introduced until version 2.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_start_timeout { + if (versioncmp($passenger_installed_version, '4.0.15') < 0) { + fail("Passenger config option :: passenger_start_timeout is not introduced until version 4.0.15 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_startup_file { + if (versioncmp($passenger_installed_version, '4.0.25') < 0) { + fail("Passenger config option :: passenger_startup_file is not introduced until version 4.0.25 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_stat_throttle_rate { + if (versioncmp($passenger_installed_version, '2.2.0') < 0) { + fail("Passenger config option :: passenger_stat_throttle_rate is not introduced until version 2.2.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_sticky_sessions { + if (versioncmp($passenger_installed_version, '4.0.45') < 0) { + fail("Passenger config option :: passenger_sticky_sessions is not introduced until version 4.0.45 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_sticky_sessions_cookie_name { + if (versioncmp($passenger_installed_version, '4.0.45') < 0) { + fail("Passenger config option :: passenger_sticky_sessions_cookie_name is not introduced until version 4.0.45 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_sticky_sessions_cookie_attributes { + if (versioncmp($passenger_installed_version, '6.0.5') < 0) { + fail("Passenger config option :: passenger_sticky_sessions_cookie_attributes is not introduced until version 6.0.5 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_thread_count { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_thread_count is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_use_global_queue { + if (versioncmp($passenger_installed_version, '4.0.0') > 0) { + fail('REMOVED PASSENGER OPTION :: passenger_use_global_queue :: -- no message on the current passenger reference webpage -- ') + } + if (versioncmp($passenger_installed_version, '2.0.4') < 0) { + fail("Passenger config option :: passenger_use_global_queue is not introduced until version 2.0.4 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_user { + if (versioncmp($passenger_installed_version, '4.0.0') < 0) { + fail("Passenger config option :: passenger_user is not introduced until version 4.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $passenger_user_switching { + if (versioncmp($passenger_installed_version, '3.0.0') < 0) { + fail("Passenger config option :: passenger_user_switching is not introduced until version 3.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if ($rack_auto_detect or $rack_autodetect) { + if (versioncmp($passenger_installed_version, '4.0.0') > 0) { + fail('REMOVED PASSENGER OPTION :: rack_auto_detect :: These options have been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead.') + } + } + if $rack_base_uri { + if (versioncmp($passenger_installed_version, '3.0.0') > 0) { + warning('DEPRECATED PASSENGER OPTION :: rack_base_uri :: Deprecated in 3.0.0 in favor of PassengerBaseURI.') + } + } + if $rack_env { + if (versioncmp($passenger_installed_version, '2.0.0') < 0) { + fail("Passenger config option :: rack_env is not introduced until version 2.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $rails_allow_mod_rewrite { + if (versioncmp($passenger_installed_version, '4.0.0') > 0) { + warning("DEPRECATED PASSENGER OPTION :: rails_allow_mod_rewrite :: This option doesn't do anything anymore in since version 4.0.0.") + } + } + if $rails_app_spawner_idle_time { + if (versioncmp($passenger_installed_version, '4.0.0') > 0) { + fail('REMOVED PASSENGER OPTION :: rails_app_spawner_idle_time :: This option has been removed in version 4.0.0, and replaced with PassengerMaxPreloaderIdleTime.') + } + } + if ($rails_auto_detect or $rails_autodetect) { + if (versioncmp($passenger_installed_version, '4.0.0') > 0) { + fail('REMOVED PASSENGER OPTION :: rails_auto_detect :: These options have been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead.') + } + } + if $rails_base_uri { + if (versioncmp($passenger_installed_version, '3.0.0') > 0) { + warning('DEPRECATED PASSENGER OPTION :: rails_base_uri :: Deprecated in 3.0.0 in favor of PassengerBaseURI.') + } + } + if $rails_default_user { + if (versioncmp($passenger_installed_version, '3.0.0') > 0) { + warning('DEPRECATED PASSENGER OPTION :: rails_default_user :: Deprecated in 3.0.0 in favor of PassengerDefaultUser.') + } + } + if $rails_env { + if (versioncmp($passenger_installed_version, '2.0.0') < 0) { + fail("Passenger config option :: rails_env is not introduced until version 2.0.0 :: ${passenger_installed_version} is the version reported") + } + } + if $rails_framework_spawner_idle_time { + if (versioncmp($passenger_installed_version, '4.0.0') > 0) { + fail('REMOVED PASSENGER OPTION :: rails_framework_spawner_idle_time :: This option is no longer available in version 4.0.0. There is no alternative because framework spawning has been removed altogether. You should use smart spawning instead.') + } + } + if $rails_ruby { + if (versioncmp($passenger_installed_version, '3.0.0') > 0) { + warning('DEPRECATED PASSENGER OPTION :: rails_ruby :: Deprecated in 3.0.0 in favor of PassengerRuby.') + } + } + if $rails_spawn_method { + if (versioncmp($passenger_installed_version, '3.0.0') > 0) { + warning('DEPRECATED PASSENGER OPTION :: rails_spawn_method :: Deprecated in 3.0.0 in favor of PassengerSpawnMethod.') + } + } + if $rails_user_switching { + if (versioncmp($passenger_installed_version, '3.0.0') > 0) { + warning('DEPRECATED PASSENGER OPTION :: rails_user_switching :: Deprecated in 3.0.0 in favor of PassengerUserSwitching.') + } + } + if $wsgi_auto_detect { + if (versioncmp($passenger_installed_version, '4.0.0') > 0) { + fail('REMOVED PASSENGER OPTION :: wsgi_auto_detect :: These options have been removed in version 4.0.0 as part of an optimization. You should use PassengerEnabled instead.') + } + } + } # Managed by the package, but declare it to avoid purging if $passenger_conf_package_file { file { 'passenger_package.conf': - path => "${::apache::confd_dir}/${passenger_conf_package_file}", + path => "${apache::confd_dir}/${passenger_conf_package_file}", } } @@ -53,7 +837,11 @@ class apache::mod::passenger ( if $::osfamily == 'RedHat' and $manage_repo { if $::operatingsystem == 'Amazon' { - $baseurl = 'https://oss-binaries.phusionpassenger.com/yum/passenger/el/6Server/$basearch' + if $::operatingsystemmajrelease == '2' { + $baseurl = 'https://oss-binaries.phusionpassenger.com/yum/passenger/el/7/$basearch' + } else { + $baseurl = 'https://oss-binaries.phusionpassenger.com/yum/passenger/el/6/$basearch' + } } else { $baseurl = 'https://oss-binaries.phusionpassenger.com/yum/passenger/el/$releasever/$basearch' } @@ -64,7 +852,7 @@ class apache::mod::passenger ( descr => 'passenger', enabled => '1', gpgcheck => '0', - gpgkey => 'https://packagecloud.io/gpg.key', + gpgkey => 'https://oss-binaries.phusionpassenger.com/auto-software-signing-gpg-key.txt', repo_gpgcheck => '1', sslcacert => '/etc/pki/tls/certs/ca-bundle.crt', sslverify => '1', @@ -87,29 +875,91 @@ class apache::mod::passenger ( } # Template uses: - # - $passenger_root - # - $passenger_ruby - # - $passenger_default_ruby - # - $passenger_max_pool_size - # - $passenger_min_instances - # - $passenger_max_instances_per_app - # - $passenger_high_performance - # - $passenger_max_requests - # - $passenger_spawn_method - # - $passenger_stat_throttle_rate - # - $passenger_use_global_queue - # - $passenger_log_file - # - $passenger_log_level - # - $passenger_app_env - # - $passenger_data_buffer_dir - # - $rack_autodetect - # - $rails_autodetect + # - $passenger_allow_encoded_slashes : since 4.0.0. + # - $passenger_app_env : since 4.0.0. + # - $passenger_app_group_name : since 4.0.0. + # - $passenger_app_root : since 4.0.0. + # - $passenger_app_type : since 4.0.25. + # - $passenger_base_uri : since 4.0.0. + # - $passenger_buffer_response : since 4.0.0. + # - $passenger_buffer_upload : since 4.0.26. + # - $passenger_concurrency_model : since 4.0.0. + # - $passenger_data_buffer_dir : since 5.0.0. + # - $passenger_debug_log_file : since unkown. Deprecated in 5.0.5. + # - $passenger_debugger : since 3.0.0. + # - $passenger_default_group : since 3.0.0. + # - $passenger_default_ruby : since 4.0.0. + # - $passenger_default_user : since 3.0.0. + # - $passenger_disable_security_update_check : since 5.1.0. + # - $passenger_enabled : since 4.0.0. + # - $passenger_error_override : since 4.0.24. + # - $passenger_file_descriptor_log_file : since 5.0.5. + # - $passenger_fly_with : since 4.0.45. + # - $passenger_force_max_concurrent_requests_per_process : since 5.0.22. + # - $passenger_friendly_error_pages : since 4.0.42. + # - $passenger_group : since 4.0.0. + # - $passenger_high_performance : since 2.0.0. + # - $passenger_instance_registry_dir : since 5.0.0. + # - $passenger_load_shell_envvars : since 4.0.20. + # - $passenger_log_file : since 5.0.5. + # - $passenger_log_level : since 3.0.0. + # - $passenger_lve_min_uid : since 5.0.28. + # - $passenger_max_instances : since 3.0.0. + # - $passenger_max_instances_per_app : since 3.0.0. + # - $passenger_max_pool_size : since 1.0.0. + # - $passenger_max_preloader_idle_time : since 4.0.0. + # - $passenger_max_request_queue_size : since 4.0.15. + # - $passenger_max_request_time : since 3.0.0. + # - $passenger_max_requests : since 3.0.0. + # - $passenger_memory_limit : since 3.0.0. + # - $passenger_meteor_app_settings : since 5.0.7. + # - $passenger_min_instances : since 3.0.0. + # - $passenger_nodejs : since 4.0.24. + # - $passenger_pool_idle_time : since 1.0.0. + # - $passenger_pre_start : since 3.0.0. + # - $passenger_python : since 4.0.0. + # - $passenger_resist_deployment_errors : since 3.0.0. + # - $passenger_resolve_symlinks_in_document_root : since 3.0.0. + # - $passenger_response_buffer_high_watermark : since 5.0.0. + # - $passenger_restart_dir : since 3.0.0. + # - $passenger_rolling_restarts : since 3.0.0. + # - $passenger_root : since 1.0.0. + # - $passenger_ruby : since 4.0.0. + # - $passenger_security_update_check_proxy : since 5.1.0. + # - $passenger_show_version_in_header : since 5.1.0. + # - $passenger_socket_backlog : since 5.0.24. + # - $passenger_spawn_method : since 2.0.0. + # - $passenger_start_timeout : since 4.0.15. + # - $passenger_startup_file : since 4.0.25. + # - $passenger_stat_throttle_rate : since 2.2.0. + # - $passenger_sticky_sessions : since 4.0.45. + # - $passenger_sticky_sessions_cookie_name : since 4.0.45. + # - $passenger_thread_count : since 4.0.0. + # - $passenger_use_global_queue : since 2.0.4.Deprecated in 4.0.0. + # - $passenger_user : since 4.0.0. + # - $passenger_user_switching : since 3.0.0. + # - $rack_auto_detect : since unkown. Deprecated in 4.0.0. + # - $rack_base_uri : since unkown. Deprecated in 3.0.0. + # - $rack_env : since 2.0.0. + # - $rails_allow_mod_rewrite : since unkown. Deprecated in 4.0.0. + # - $rails_app_spawner_idle_time : since unkown. Deprecated in 4.0.0. + # - $rails_auto_detect : since unkown. Deprecated in 4.0.0. + # - $rails_base_uri : since unkown. Deprecated in 3.0.0. + # - $rails_default_user : since unkown. Deprecated in 3.0.0. + # - $rails_env : since 2.0.0. + # - $rails_framework_spawner_idle_time : since unkown. Deprecated in 4.0.0. + # - $rails_ruby : since unkown. Deprecated in 3.0.0. + # - $rails_spawn_method : since unkown. Deprecated in 3.0.0. + # - $rails_user_switching : since unkown. Deprecated in 3.0.0. + # - $wsgi_auto_detect : since unkown. Deprecated in 4.0.0. + # - $rails_autodetect : this options is only for backward compatiblity with older versions of this class + # - $rack_autodetect : this options is only for backward compatiblity with older versions of this class file { 'passenger.conf': ensure => file, - path => "${::apache::mod_dir}/${passenger_conf_file}", + path => "${apache::mod_dir}/${passenger_conf_file}", content => template('apache/mod/passenger.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/perl.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/perl.pp index 3bfeac977..f883305ea 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/perl.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/perl.pp @@ -1,4 +1,9 @@ +# @summary +# Installs `mod_perl`. +# +# @see https://perl.apache.org for additional documentation. +# class apache::mod::perl { - include ::apache + include apache ::apache::mod { 'perl': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/peruser.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/peruser.pp index 5683dd66c..4fec2c04c 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/peruser.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/peruser.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_peruser`. +# +# @todo +# Add docs class apache::mod::peruser ( $minspareprocessors = '2', $minprocessors = '2', @@ -8,7 +13,7 @@ class apache::mod::peruser ( $expiretimeout = '120', $keepalive = 'Off', ) { - include ::apache + include apache case $::osfamily { 'freebsd' : { fail("Unsupported osfamily ${::osfamily}") @@ -34,11 +39,11 @@ class apache::mod::peruser ( } File { owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, + group => $apache::params::root_group, + mode => $apache::file_mode, } - $mod_dir = $::apache::mod_dir + $mod_dir = $apache::mod_dir # Template uses: # - $minspareprocessors @@ -50,25 +55,25 @@ class apache::mod::peruser ( # - $expiretimeout # - $keepalive # - $mod_dir - file { "${::apache::mod_dir}/peruser.conf": + file { "${apache::mod_dir}/peruser.conf": ensure => file, - mode => $::apache::file_mode, + mode => $apache::file_mode, content => template('apache/mod/peruser.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } - file { "${::apache::mod_dir}/peruser": + file { "${apache::mod_dir}/peruser": ensure => directory, - require => File[$::apache::mod_dir], + require => File[$apache::mod_dir], } - file { "${::apache::mod_dir}/peruser/multiplexers": + file { "${apache::mod_dir}/peruser/multiplexers": ensure => directory, - require => File["${::apache::mod_dir}/peruser"], + require => File["${apache::mod_dir}/peruser"], } - file { "${::apache::mod_dir}/peruser/processors": + file { "${apache::mod_dir}/peruser/processors": ensure => directory, - require => File["${::apache::mod_dir}/peruser"], + require => File["${apache::mod_dir}/peruser"], } ::apache::peruser::multiplexer { '01-default': } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/php.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/php.pp index c7c004888..02c51be64 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/php.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/php.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_php`. +# +# @todo +# Add docs class apache::mod::php ( $package_name = undef, $package_ensure = 'present', @@ -6,13 +11,20 @@ class apache::mod::php ( $content = undef, $template = 'apache/mod/php.conf.erb', $source = undef, - $root_group = $::apache::params::root_group, - $php_version = $::apache::params::php_version, + $root_group = $apache::params::root_group, + $php_version = $apache::params::php_version, + $libphp_prefix = 'libphp' ) inherits apache::params { + include apache + if (versioncmp($php_version, '8') < 0) { + $mod = "php${php_version}" + } else { + $mod = 'php' + } - include ::apache - $mod = "php${php_version}" - + if $apache::version::scl_httpd_version == undef and $apache::version::scl_php_version != undef { + fail('If you define apache::version::scl_php_version, you also need to specify apache::version::scl_httpd_version') + } if defined(Class['::apache::mod::prefork']) { Class['::apache::mod::prefork']->File["${mod}.conf"] } @@ -38,7 +50,7 @@ class apache::mod::php ( } # Determine if we have a package - $mod_packages = $::apache::mod_packages + $mod_packages = $apache::mod_packages if $package_name { $_package_name = $package_name } elsif has_key($mod_packages, $mod) { # 2.6 compatibility hack @@ -49,46 +61,58 @@ class apache::mod::php ( $_package_name = undef } - $_lib = "libphp${php_version}.so" $_php_major = regsubst($php_version, '^(\d+)\..*$', '\1') + $_php_version_no_dot = regsubst($php_version, '\.', '') + if $apache::version::scl_httpd_version { + $_lib = "librh-php${_php_version_no_dot}-php${_php_major}.so" + } else { + # Controls php version and libphp prefix + $_lib = $_php_major ? { + '8' => "${libphp_prefix}.so", + default => "${libphp_prefix}${php_version}.so", + } + } + $_module_id = $_php_major ? { + '5' => 'php5_module', + '7' => 'php7_module', + default => 'php_module', + } if $::operatingsystem == 'SLES' { - ::apache::mod { $mod: - package => $_package_name, - package_ensure => $package_ensure, - lib => 'mod_php5.so', - id => "php${_php_major}_module", - path => "${::apache::lib_path}/mod_php5.so", - } - } else { - ::apache::mod { $mod: - package => $_package_name, - package_ensure => $package_ensure, - lib => $_lib, - id => "php${_php_major}_module", - path => $path, - } - + ::apache::mod { $mod: + package => $_package_name, + package_ensure => $package_ensure, + lib => "mod_${mod}.so", + id => $_module_id, + path => "${apache::lib_path}/mod_${mod}.so", } + } else { + ::apache::mod { $mod: + package => $_package_name, + package_ensure => $package_ensure, + lib => $_lib, + id => $_module_id, + path => $path, + } + } - - include ::apache::mod::mime - include ::apache::mod::dir + include apache::mod::mime + include apache::mod::dir Class['::apache::mod::mime'] -> Class['::apache::mod::dir'] -> Class['::apache::mod::php'] # Template uses $extensions file { "${mod}.conf": ensure => file, - path => "${::apache::mod_dir}/${mod}.conf", + path => "${apache::mod_dir}/${mod}.conf", owner => 'root', group => $root_group, - mode => $::apache::file_mode, + mode => $apache::file_mode, content => $manage_content, source => $source, require => [ - Exec["mkdir ${::apache::mod_dir}"], + Exec["mkdir ${apache::mod_dir}"], ], - before => File[$::apache::mod_dir], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/prefork.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/prefork.pp index f35551ce6..f6c6315ae 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/prefork.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/prefork.pp @@ -1,13 +1,51 @@ +# @summary +# Installs and configures MPM `prefork`. +# +# @param startservers +# Number of child server processes created at startup. +# +# @param minspareservers +# Minimum number of idle child server processes. +# +# @param maxspareservers +# Maximum number of idle child server processes. +# +# @param serverlimit +# Upper limit on configurable number of processes. +# +# @param maxclients +# Old alias for MaxRequestWorkers. +# +# @param maxrequestworkers +# Maximum number of connections that will be processed simultaneously. +# +# @param maxrequestsperchild +# Old alias for MaxConnectionsPerChild. +# +# @param maxconnectionsperchild +# Limit on the number of connections that an individual child server will handle during its life. +# +# @param apache_version +# Used to verify that the Apache version you have requested is compatible with the module. +# +# @param listenbacklog +# Maximum length of the queue of pending connections. +# +# @see https://httpd.apache.org/docs/current/mod/prefork.html for additional documentation. +# class apache::mod::prefork ( - $startservers = '8', - $minspareservers = '5', - $maxspareservers = '20', - $serverlimit = '256', - $maxclients = '256', - $maxrequestsperchild = '4000', - $apache_version = undef, + $startservers = '8', + $minspareservers = '5', + $maxspareservers = '20', + $serverlimit = '256', + $maxclients = '256', + $maxrequestworkers = undef, + $maxrequestsperchild = '4000', + $maxconnectionsperchild = undef, + $apache_version = undef, + $listenbacklog = '511' ) { - include ::apache + include apache $_apache_version = pick($apache_version, $apache::apache_version) if defined(Class['apache::mod::event']) { fail('May not include both apache::mod::prefork and apache::mod::event on the same node') @@ -23,10 +61,19 @@ class apache::mod::prefork ( if defined(Class['apache::mod::worker']) { fail('May not include both apache::mod::prefork and apache::mod::worker on the same node') } + + if versioncmp($_apache_version, '2.3.13') < 0 { + if $maxrequestworkers == undef { + warning("For newer versions of Apache, \$maxclients is deprecated, please use \$maxrequestworkers.") + } elsif $maxconnectionsperchild == undef { + warning("For newer versions of Apache, \$maxrequestsperchild is deprecated, please use \$maxconnectionsperchild.") + } + } + File { owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, + group => $apache::params::root_group, + mode => $apache::file_mode, } # Template uses: @@ -35,19 +82,21 @@ class apache::mod::prefork ( # - $maxspareservers # - $serverlimit # - $maxclients + # - $maxrequestworkers # - $maxrequestsperchild - file { "${::apache::mod_dir}/prefork.conf": + # - $maxconnectionsperchild + file { "${apache::mod_dir}/prefork.conf": ensure => file, content => template('apache/mod/prefork.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } case $::osfamily { 'redhat': { if versioncmp($_apache_version, '2.4') >= 0 { - ::apache::mpm{ 'prefork': + ::apache::mpm { 'prefork': apache_version => $_apache_version, } } @@ -63,12 +112,12 @@ class apache::mod::prefork ( } } 'debian', 'freebsd': { - ::apache::mpm{ 'prefork': + ::apache::mpm { 'prefork': apache_version => $_apache_version, } } 'Suse': { - ::apache::mpm{ 'prefork': + ::apache::mpm { 'prefork': apache_version => $apache_version, lib_path => '/usr/lib64/apache2-prefork', } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy.pp index ce82cb3a8..2a9eb7149 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy.pp @@ -1,11 +1,40 @@ +# @summary +# Installs and configures `mod_proxy`. +# +# @param proxy_requests +# Enables forward (standard) proxy requests. +# +# @param allow_from +# List of IPs allowed to access proxy. +# +# @param apache_version +# Used to verify that the Apache version you have requested is compatible with the module. +# +# @param package_name +# Name of the proxy package to install. +# +# @param proxy_via +# Set local IP address for outgoing proxy connections. +# +# @param proxy_timeout +# Network timeout for proxied requests. +# +# @param proxy_iobuffersize +# Set the size of internal data throughput buffer +# +# @see https://httpd.apache.org/docs/current/mod/mod_proxy.html for additional documentation. +# class apache::mod::proxy ( - $proxy_requests = 'Off', - $allow_from = undef, - $apache_version = undef, - $package_name = undef, - $proxy_via = 'On', + $proxy_requests = 'Off', + $allow_from = undef, + $apache_version = undef, + $package_name = undef, + $proxy_via = 'On', + $proxy_timeout = undef, + $proxy_iobuffersize = undef, ) { - include ::apache + include apache + $_proxy_timeout = $apache::timeout $_apache_version = pick($apache_version, $apache::apache_version) ::apache::mod { 'proxy': package => $package_name, @@ -13,11 +42,11 @@ class apache::mod::proxy ( # Template uses $proxy_requests, $_apache_version file { 'proxy.conf': ensure => file, - path => "${::apache::mod_dir}/proxy.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/proxy.conf", + mode => $apache::file_mode, content => template('apache/mod/proxy.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_ajp.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_ajp.pp index a011a1789..36bea00c8 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_ajp.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_ajp.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_proxy_ajp`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_proxy_ajp.html for additional documentation. +# class apache::mod::proxy_ajp { Class['::apache::mod::proxy'] -> Class['::apache::mod::proxy_ajp'] ::apache::mod { 'proxy_ajp': } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_balancer.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_balancer.pp index dbc86df42..43bd0af65 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_balancer.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_balancer.pp @@ -1,12 +1,28 @@ -class apache::mod::proxy_balancer( +# @summary +# Installs and configures `mod_proxy_balancer`. +# +# @param manager +# Toggle whether to enable balancer manager support. +# +# @param maanger_path +# Server relative path to balancer manager. +# +# @param allow_from +# List of IPs from which the balancer manager can be accessed. +# +# @param apache_version +# Version of Apache to install module on. +# +# @see https://httpd.apache.org/docs/current/mod/mod_proxy_balancer.html for additional documentation. +# +class apache::mod::proxy_balancer ( Boolean $manager = false, Stdlib::Absolutepath $manager_path = '/balancer-manager', Array $allow_from = ['127.0.0.1','::1'], - $apache_version = $::apache::apache_version, + $apache_version = $apache::apache_version, ) { - - include ::apache::mod::proxy - include ::apache::mod::proxy_http + include apache::mod::proxy + include apache::mod::proxy_http if versioncmp($apache_version, '2.4') >= 0 { ::apache::mod { 'slotmem_shm': } } @@ -15,14 +31,14 @@ class apache::mod::proxy_balancer( Class['::apache::mod::proxy_http'] -> Class['::apache::mod::proxy_balancer'] ::apache::mod { 'proxy_balancer': } if $manager { - include ::apache::mod::status + include apache::mod::status file { 'proxy_balancer.conf': ensure => file, - path => "${::apache::mod_dir}/proxy_balancer.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/proxy_balancer.conf", + mode => $apache::file_mode, content => template('apache/mod/proxy_balancer.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_connect.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_connect.pp index cda5b89dc..e09cab079 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_connect.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_connect.pp @@ -1,7 +1,15 @@ +# @summary +# Installs `mod_proxy_connect`. +# +# @param apache_version +# Used to verify that the Apache version you have requested is compatible with the module. +# +# @see https://httpd.apache.org/docs/current/mod/mod_proxy_connect.html for additional documentation. +# class apache::mod::proxy_connect ( $apache_version = undef, ) { - include ::apache + include apache $_apache_version = pick($apache_version, $apache::apache_version) if versioncmp($_apache_version, '2.2') >= 0 { Class['::apache::mod::proxy'] -> Class['::apache::mod::proxy_connect'] diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_fcgi.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_fcgi.pp index 21473eb76..84bc3d178 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_fcgi.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_fcgi.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_proxy_fcgi`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_proxy_fcgi.html for additional documentation. +# class apache::mod::proxy_fcgi { Class['::apache::mod::proxy'] -> Class['::apache::mod::proxy_fcgi'] ::apache::mod { 'proxy_fcgi': } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_html.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_html.pp index 94259bd77..0205af848 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_html.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_html.pp @@ -1,5 +1,10 @@ +# @summary +# Installs `mod_proxy_html`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_proxy_html.html for additional documentation. +# class apache::mod::proxy_html { - include ::apache + include apache Class['::apache::mod::proxy'] -> Class['::apache::mod::proxy_html'] Class['::apache::mod::proxy_http'] -> Class['::apache::mod::proxy_html'] @@ -14,15 +19,28 @@ class apache::mod::proxy_html { 'i686' => 'i386', default => $::hardwaremodel, } - $loadfiles = $::apache::params::distrelease ? { - '6' => ['/usr/lib/libxml2.so.2'], - '10' => ['/usr/lib/libxml2.so.2'], - default => ["/usr/lib/${gnu_path}-linux-gnu/libxml2.so.2"], + case $::operatingsystem { + 'Ubuntu': { + $loadfiles = $facts['operatingsystemmajrelease'] ? { + '10' => ['/usr/lib/libxml2.so.2'], + default => ["/usr/lib/${gnu_path}-linux-gnu/libxml2.so.2"], + } + } + 'Debian': { + $loadfiles = $facts['operatingsystemmajrelease'] ? { + '6' => ['/usr/lib/libxml2.so.2'], + default => ["/usr/lib/${gnu_path}-linux-gnu/libxml2.so.2"], + } + } + default: { + $loadfiles = ["/usr/lib/${gnu_path}-linux-gnu/libxml2.so.2"] + } } - if versioncmp($::apache::apache_version, '2.4') >= 0 { + if versioncmp($apache::apache_version, '2.4') >= 0 { ::apache::mod { 'xml2enc': } } } + default: {} } ::apache::mod { 'proxy_html': @@ -32,11 +50,11 @@ class apache::mod::proxy_html { # Template uses $icons_path file { 'proxy_html.conf': ensure => file, - path => "${::apache::mod_dir}/proxy_html.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/proxy_html.conf", + mode => $apache::file_mode, content => template('apache/mod/proxy_html.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_http.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_http.pp index 1579e68ee..b80857c20 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_http.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_http.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_proxy_http`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_proxy_http.html for additional documentation. +# class apache::mod::proxy_http { Class['::apache::mod::proxy'] -> Class['::apache::mod::proxy_http'] ::apache::mod { 'proxy_http': } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_wstunnel.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_wstunnel.pp index 290954b74..a7dc00f0f 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_wstunnel.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/proxy_wstunnel.pp @@ -1,5 +1,10 @@ +# @summary +# Installs `mod_proxy_wstunnel`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_proxy_wstunnel.html for additional documentation. +# class apache::mod::proxy_wstunnel { - include ::apache, ::apache::mod::proxy + include apache, apache::mod::proxy Class['::apache::mod::proxy'] -> Class['::apache::mod::proxy_wstunnel'] ::apache::mod { 'proxy_wstunnel': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/python.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/python.pp index 75af35011..91f1d3818 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/python.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/python.pp @@ -1,6 +1,16 @@ -class apache::mod::python { - include ::apache - ::apache::mod { 'python': } +# @summary +# Installs and configures `mod_python`. +# +# @param loadfile_name +# Sets the name of the configuration file that is used to load the python module. +# +# @see https://github.com/grisha/mod_python for additional documentation. +# +class apache::mod::python ( + Optional[String] $loadfile_name = undef, +) { + include apache + ::apache::mod { 'python': + loadfile_name => $loadfile_name, + } } - - diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/remoteip.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/remoteip.pp index 92010cf96..addc966fa 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/remoteip.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/remoteip.pp @@ -1,30 +1,114 @@ +# @summary +# Installs and configures `mod_remoteip`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_remoteip.html +# +# @param header +# The header field in which `mod_remoteip` will look for the useragent IP. +# +# @param internal_proxy +# A list of IP addresses, IP blocks or hostname that are trusted to set a +# valid value inside specified header. Unlike the `$trusted_proxy_ips` +# parameter, any IP address (including private addresses) presented by these +# proxies will trusted by `mod_remoteip`. +# +# @param proxy_ips +# *Deprecated*: use `$internal_proxy` instead. +# +# @param internal_proxy_list +# The path to a file containing a list of IP addresses, IP blocks or hostname +# that are trusted to set a valid value inside the specified header. See +# `$internal_proxy` for details. +# +# @param proxies_header +# A header into which `mod_remoteip` will collect a list of all of the +# intermediate client IP addresses trusted to resolve the useragent IP of the +# request (e.g. `X-Forwarded-By`). +# +# @param proxy_protocol +# Wether or not to enable the PROXY protocol header handling. If enabled +# upstream clients must set the header every time they open a connection. +# +# @param proxy_protocol_exceptions +# A list of IP address or IP blocks that are not required to use the PROXY +# protocol. +# +# @param trusted_proxy +# A list of IP addresses, IP blocks or hostname that are trusted to set a +# valid value inside the specified header. Unlike the `$proxy_ips` parameter, +# any private IP presented by these proxies will be disgarded by +# `mod_remoteip`. +# +# @param trusted_proxy_ips +# *Deprecated*: use `$trusted_proxy` instead. +# +# @param trusted_proxy_list +# The path to a file containing a list of IP addresses, IP blocks or hostname +# that are trusted to set a valid value inside the specified header. See +# `$trusted_proxy` for details. +# +# @param apache_version +# A version string used to validate that your apache version supports +# `mod_remoteip`. If not specified, `$::apache::apache_version` is used. +# +# @see https://httpd.apache.org/docs/current/mod/mod_remoteip.html for additional documentation. +# class apache::mod::remoteip ( - $header = 'X-Forwarded-For', - $proxy_ips = [ '127.0.0.1' ], - $proxies_header = undef, - $trusted_proxy_ips = undef, - $apache_version = undef, + String $header = 'X-Forwarded-For', + Optional[Array[Variant[Stdlib::Host,Stdlib::IP::Address]]] $internal_proxy = undef, + Optional[Array[Variant[Stdlib::Host,Stdlib::IP::Address]]] $proxy_ips = undef, + Optional[Stdlib::Absolutepath] $internal_proxy_list = undef, + Optional[String] $proxies_header = undef, + Boolean $proxy_protocol = false, + Optional[Array[Variant[Stdlib::Host,Stdlib::IP::Address]]] $proxy_protocol_exceptions = undef, + Optional[Array[Stdlib::Host]] $trusted_proxy = undef, + Optional[Array[Stdlib::Host]] $trusted_proxy_ips = undef, + Optional[Stdlib::Absolutepath] $trusted_proxy_list = undef, + Optional[String] $apache_version = undef, ) { - include ::apache + include apache + $_apache_version = pick($apache_version, $apache::apache_version) if versioncmp($_apache_version, '2.4') < 0 { fail('mod_remoteip is only available in Apache 2.4') } + if $proxy_ips { + deprecation('apache::mod::remoteip::proxy_ips', 'This parameter is deprecated, please use `internal_proxy`.') + $_internal_proxy = $proxy_ips + } elsif $internal_proxy { + $_internal_proxy = $internal_proxy + } else { + $_internal_proxy = ['127.0.0.1'] + } + + if $trusted_proxy_ips { + deprecation('apache::mod::remoteip::trusted_proxy_ips', 'This parameter is deprecated, please use `trusted_proxy`.') + $_trusted_proxy = $trusted_proxy_ips + } else { + $_trusted_proxy = $trusted_proxy + } + ::apache::mod { 'remoteip': } - # Template uses: - # - $header - # - $proxy_ips - # - $proxies_header - # - $trusted_proxy_ips + $template_parameters = { + header => $header, + internal_proxy => $_internal_proxy, + internal_proxy_list => $internal_proxy_list, + proxies_header => $proxies_header, + proxy_protocol => $proxy_protocol, + proxy_protocol_exceptions => $proxy_protocol_exceptions, + trusted_proxy => $_trusted_proxy, + trusted_proxy_list => $trusted_proxy_list, + } + file { 'remoteip.conf': ensure => file, - path => "${::apache::mod_dir}/remoteip.conf", - mode => $::apache::file_mode, - content => template('apache/mod/remoteip.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], - notify => Service['httpd'], + path => "${apache::mod_dir}/remoteip.conf", + mode => $apache::file_mode, + content => epp('apache/mod/remoteip.conf.epp', $template_parameters), + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], + notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/reqtimeout.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/reqtimeout.pp index f166f6d6f..a971e045d 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/reqtimeout.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/reqtimeout.pp @@ -1,15 +1,24 @@ +# @summary +# Installs and configures `mod_reqtimeout`. +# +# @param timeouts +# List of timeouts and data rates for receiving requests. +# +# @see https://httpd.apache.org/docs/current/mod/mod_reqtimeout.html for additional documentation. +# class apache::mod::reqtimeout ( $timeouts = ['header=20-40,minrate=500', 'body=10,minrate=500'] -){ - include ::apache +) { + include apache ::apache::mod { 'reqtimeout': } # Template uses no variables file { 'reqtimeout.conf': ensure => file, - path => "${::apache::mod_dir}/reqtimeout.conf", + path => "${apache::mod_dir}/reqtimeout.conf", + mode => $apache::file_mode, content => template('apache/mod/reqtimeout.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/rewrite.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/rewrite.pp index 694f0b6f5..06986d1e8 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/rewrite.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/rewrite.pp @@ -1,4 +1,9 @@ +# @summary +# Installs `mod_rewrite`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_rewrite.html for additional documentation. +# class apache::mod::rewrite { - include ::apache::params + include apache::params ::apache::mod { 'rewrite': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/rpaf.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/rpaf.pp index b9afa149f..7e4bab23e 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/rpaf.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/rpaf.pp @@ -1,10 +1,27 @@ +# @summary +# Installs and configures `mod_rpaf`. +# +# @param sethostname +# Toggles whether to update vhost name so ServerName and ServerAlias work. +# +# @param proxy_ips +# List of IPs & bitmasked subnets to adjust requests for +# +# @param header +# Header to use for the real IP address. +# +# @param template +# Path to template to use for configuring mod_rpaf. +# +# @see https://github.com/gnif/mod_rpaf for additional documentation. +# class apache::mod::rpaf ( $sethostname = true, - $proxy_ips = [ '127.0.0.1' ], + $proxy_ips = ['127.0.0.1'], $header = 'X-Forwarded-For', $template = 'apache/mod/rpaf.conf.erb' ) { - include ::apache + include apache ::apache::mod { 'rpaf': } # Template uses: @@ -13,11 +30,11 @@ class apache::mod::rpaf ( # - $header file { 'rpaf.conf': ensure => file, - path => "${::apache::mod_dir}/rpaf.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/rpaf.conf", + mode => $apache::file_mode, content => template($template), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/security.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/security.pp index 95c58a033..4234f4088 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/security.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/security.pp @@ -1,13 +1,112 @@ +# @summary +# Installs and configures `mod_security`. +# +# @param version +# Manage mod_security or mod_security2 +# +# @param logroot +# Configures the location of audit and debug logs. +# +# @param crs_package +# Name of package that installs CRS rules. +# +# @param activated_rules +# An array of rules from the modsec_crs_path or absolute to activate via symlinks. +# +# @param modsec_dir +# Defines the path where Puppet installs the modsec configuration and activated rules links. +# +# @param modsec_secruleengine +# Configures the rules engine. +# +# @param audit_log_relevant_status +# Configures which response status code is to be considered relevant for the purpose of audit logging. +# +# @param audit_log_parts +# Defines which parts of each transaction are going to be recorded in the audit log. Each part is assigned a single letter; when a +# letter appears in the list then the equivalent part will be recorded. +# +# @param audit_log_type +# Defines the type of audit logging mechanism to be used. +# +# @param audit_log_storage_dir +# Defines the directory where concurrent audit log entries are to be stored. This directive is only needed when concurrent audit logging is used. +# +# @param secpcrematchlimit +# Sets the match limit in the PCRE library. +# +# @param secpcrematchlimitrecursion +# Sets the match limit recursion in the PCRE library. +# +# @param allowed_methods +# A space-separated list of allowed HTTP methods. +# +# @param content_types +# A list of one or more allowed MIME types. +# +# @param restricted_extensions +# A space-sparated list of prohibited file extensions. +# +# @param restricted_headers +# A list of restricted headers separated by slashes and spaces. +# +# @param secdefaultaction +# Defines the default list of actions, which will be inherited by the rules in the same configuration context. +# +# @param anomaly_score_blocking +# Activates or deactivates the Collaborative Detection Blocking of the OWASP ModSecurity Core Rule Set. +# +# @param inbound_anomaly_threshold +# Sets the scoring threshold level of the inbound blocking rules for the Collaborative Detection Mode in the OWASP ModSecurity Core Rule Set. +# +# @param outbound_anomaly_threshold +# Sets the scoring threshold level of the outbound blocking rules for the Collaborative Detection Mode in the OWASP ModSecurity Core Rule Set. +# +# @param critical_anomaly_score +# Sets the Anomaly Score for rules assigned with a critical severity. +# +# @param error_anomaly_score +# Sets the Anomaly Score for rules assigned with a error severity. +# +# @param warning_anomaly_score +# Sets the Anomaly Score for rules assigned with a warning severity. +# +# @param notice_anomaly_score +# Sets the Anomaly Score for rules assigned with a notice severity. +# +# @param secrequestmaxnumargs +# Sets the maximum number of arguments in the request. +# +# @param secrequestbodylimit +# Sets the maximum request body size ModSecurity will accept for buffering. +# +# @param secrequestbodynofileslimit +# Configures the maximum request body size ModSecurity will accept for buffering, excluding the size of any files being transported +# in the request. +# +# @param secrequestbodyinmemorylimit +# Configures the maximum request body size that ModSecurity will store in memory. +# +# @param manage_security_crs +# Toggles whether to manage ModSecurity Core Rule Set +# +# @see https://github.com/SpiderLabs/ModSecurity/wiki for additional documentation. +# class apache::mod::security ( - $logroot = $::apache::params::logroot, - $crs_package = $::apache::params::modsec_crs_package, - $activated_rules = $::apache::params::modsec_default_rules, - $modsec_dir = $::apache::params::modsec_dir, - $modsec_secruleengine = $::apache::params::modsec_secruleengine, + $logroot = $apache::params::logroot, + $version = $apache::params::modsec_version, + $crs_package = $apache::params::modsec_crs_package, + $activated_rules = $apache::params::modsec_default_rules, + $custom_rules = $apache::params::modsec_custom_rules, + $custom_rules_set = $apache::params::modsec_custom_rules_set, + $modsec_dir = $apache::params::modsec_dir, + $modsec_secruleengine = $apache::params::modsec_secruleengine, $audit_log_relevant_status = '^(?:5|4(?!04))', - $audit_log_parts = $::apache::params::modsec_audit_log_parts, - $secpcrematchlimit = $::apache::params::secpcrematchlimit, - $secpcrematchlimitrecursion = $::apache::params::secpcrematchlimitrecursion, + $audit_log_parts = $apache::params::modsec_audit_log_parts, + $audit_log_type = $apache::params::modsec_audit_log_type, + $audit_log_storage_dir = undef, + $secpcrematchlimit = $apache::params::secpcrematchlimit, + $secpcrematchlimitrecursion = $apache::params::secpcrematchlimitrecursion, $allowed_methods = 'GET HEAD POST OPTIONS', $content_types = 'application/x-www-form-urlencoded|multipart/form-data|text/xml|application/xml|application/x-amf', $restricted_extensions = '.asa/ .asax/ .ascx/ .axd/ .backup/ .bak/ .bat/ .cdx/ .cer/ .cfg/ .cmd/ .com/ .config/ .conf/ .cs/ .csproj/ .csr/ .dat/ .db/ .dbf/ .dll/ .dos/ .htr/ .htw/ .ida/ .idc/ .idq/ .inc/ .ini/ .key/ .licx/ .lnk/ .log/ .mdb/ .old/ .pass/ .pdb/ .pol/ .printer/ .pwd/ .resources/ .resx/ .sql/ .sys/ .vb/ .vbs/ .vbproj/ .vsdisco/ .webinfo/ .xsd/ .xsx/', @@ -26,7 +125,7 @@ class apache::mod::security ( $secrequestbodyinmemorylimit = '131072', $manage_security_crs = true, ) inherits ::apache::params { - include ::apache + include apache $_secdefaultaction = $secdefaultaction ? { /log/ => $secdefaultaction, # it has log or nolog,auditlog or log,noauditlog @@ -37,26 +136,38 @@ class apache::mod::security ( fail('FreeBSD is not currently supported') } - if ($::osfamily == 'Suse' and $::operatingsystemrelease < '11') { + if ($::osfamily == 'Suse' and versioncmp($::operatingsystemrelease, '11') < 0) { fail('SLES 10 is not currently supported.') } - ::apache::mod { 'security': + case $version { + 1: { + $mod_name = 'security' + $mod_conf_name = 'security.conf' + } + 2: { + $mod_name = 'security2' + $mod_conf_name = 'security2.conf' + } + default: { + fail('Unsuported version for mod security') + } + } + ::apache::mod { $mod_name: id => 'security2_module', lib => 'mod_security2.so', } - ::apache::mod { 'unique_id_module': id => 'unique_id_module', lib => 'mod_unique_id.so', } - if $crs_package { + if $crs_package { package { $crs_package: ensure => 'installed', before => [ - File[$::apache::confd_dir], + File[$apache::confd_dir], File[$modsec_dir], ], } @@ -66,6 +177,8 @@ class apache::mod::security ( # - logroot # - $modsec_dir # - $audit_log_parts + # - $audit_log_type + # - $audit_log_storage_dir # - secpcrematchlimit # - secpcrematchlimitrecursion # - secrequestbodylimit @@ -74,12 +187,12 @@ class apache::mod::security ( file { 'security.conf': ensure => file, content => template('apache/mod/security.conf.erb'), - mode => $::apache::file_mode, - path => "${::apache::mod_dir}/security.conf", - owner => $::apache::params::user, - group => $::apache::params::group, - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + mode => $apache::file_mode, + path => "${apache::mod_dir}/${mod_conf_name}", + owner => $apache::params::user, + group => $apache::params::group, + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } @@ -96,8 +209,8 @@ class apache::mod::security ( file { "${modsec_dir}/activated_rules": ensure => directory, - owner => $::apache::params::user, - group => $::apache::params::group, + owner => $apache::params::user, + group => $apache::params::group, mode => '0555', purge => true, force => true, @@ -105,6 +218,27 @@ class apache::mod::security ( notify => Class['apache::service'], } + if $custom_rules { + # Template to add custom rule and included in security configuration + file {"${modsec_dir}/custom_rules": + ensure => directory, + owner => $apache::params::user, + group => $apache::params::group, + mode => $apache::file_mode, + require => File[$modsec_dir], + } + + file { "${modsec_dir}/custom_rules/custom_01_rules.conf": + ensure => file, + owner => $apache::params::user, + group => $apache::params::group, + mode => $apache::file_mode, + content => template('apache/mod/security_custom.conf.erb'), + require => File["${modsec_dir}/custom_rules"], + notify => Class['apache::service'], + } + } + if $manage_security_crs { # Template uses: # - $_secdefaultaction @@ -126,8 +260,10 @@ class apache::mod::security ( require => File[$modsec_dir], notify => Class['apache::service'], } + + # Debian 9 has a different rule setup + unless $::operatingsystem == 'SLES' or ($::operatingsystem == 'Debian' and versioncmp($::operatingsystemrelease, '9') >= 0) or ($::operatingsystem == 'Ubuntu' and versioncmp($::operatingsystemrelease, '18.04') >= 0) { + apache::security::rule_link { $activated_rules: } + } } - - unless $::operatingsystem == 'SLES' { apache::security::rule_link { $activated_rules: } } - } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/setenvif.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/setenvif.pp index d7baf582e..6b3586a7a 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/setenvif.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/setenvif.pp @@ -1,14 +1,19 @@ +# @summary +# Installs `mod_setenvif`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_setenvif.html for additional documentation. +# class apache::mod::setenvif { - include ::apache + include apache ::apache::mod { 'setenvif': } # Template uses no variables file { 'setenvif.conf': ensure => file, - path => "${::apache::mod_dir}/setenvif.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/setenvif.conf", + mode => $apache::file_mode, content => template('apache/mod/setenvif.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/shib.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/shib.pp index 318a3a340..85946a10b 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/shib.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/shib.pp @@ -1,17 +1,42 @@ +# @summary +# Installs and configures `mod_shib`. +# +# @param suppress_warning +# Toggles whether to trigger warning on RedHat nodes. +# +# @param mod_full_path +# Specifies a path to the module. Do not manually set this parameter without a special reason. +# +# @param package_name +# Name of the Shibboleth package to be installed. +# +# @param mod_lib +# Specifies a path to the module's libraries. Do not manually set this parameter without special reason. The `path` parameter +# overrides this value. +# +# This class installs and configures only the Apache components of a web application that consumes Shibboleth SSO identities. You +# can manage the Shibboleth configuration manually, with Puppet, or using a [Shibboleth Puppet Module](https://github.com/aethylred/puppet-shibboleth). +# +# @note +# The Shibboleth module isn't available on RH/CentOS without providing dependency packages provided by Shibboleth's repositories. +# See the [Shibboleth Service Provider Installation Guide](http://wiki.aaf.edu.au/tech-info/sp-install-guide). +# +# @see https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPApacheConfig for additional documentation. +# @note Unsupported platforms: RedHat: all; CentOS: all; Scientific: all; SLES: all; Debian: 7, 8; Ubuntu: all; OracleLinux: all class apache::mod::shib ( $suppress_warning = false, $mod_full_path = undef, $package_name = undef, $mod_lib = undef, ) { - include ::apache + include apache if $::osfamily == 'RedHat' and ! $suppress_warning { warning('RedHat distributions do not have Apache mod_shib in their default package repositories.') } $mod_shib = 'shib2' - apache::mod {$mod_shib: + apache::mod { $mod_shib: id => 'mod_shib', path => $mod_full_path, package => $package_name, diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/socache_shmcb.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/socache_shmcb.pp index 7bfb4c6b5..e9be75dce 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/socache_shmcb.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/socache_shmcb.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_socache_shmcb`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_socache_shmcb.html for additional documentation. +# class apache::mod::socache_shmcb { - ::apache::mod { 'socache_shmcb': } -} \ No newline at end of file + ::apache::mod { 'socache_shmcb': } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/speling.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/speling.pp index fbd19d373..538e8ffa6 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/speling.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/speling.pp @@ -1,4 +1,9 @@ +# @summary +# Installs `mod_spelling`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_speling.html for additional documentation. +# class apache::mod::speling { - include ::apache + include apache ::apache::mod { 'speling': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ssl.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ssl.pp index d27b6b8ee..20acb814e 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ssl.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ssl.pp @@ -1,26 +1,111 @@ +# @summary +# Installs `mod_ssl`. +# +# @param ssl_compression +# Enable compression on the SSL level. +# +# @param ssl_cryptodevice +# Enable use of a cryptographic hardware accelerator. +# +# @param ssl_options +# Configure various SSL engine run-time options. +# +# @param ssl_openssl_conf_cmd +# Configure OpenSSL parameters through its SSL_CONF API. +# +# @param ssl_cert +# Path to server PEM-encoded X.509 certificate data file. +# +# @param ssl_key +# Path to server PEM-encoded private key file +# +# @param ssl_ca +# File of concatenated PEM-encoded CA Certificates for Client Auth. +# +# @param ssl_cipher +# Cipher Suite available for negotiation in SSL handshake. +# +# @param ssl_honorcipherorder +# Option to prefer the server's cipher preference order. +# +# @param ssl_protocol +# Configure usable SSL/TLS protocol versions. +# Default based on the OS: +# - RedHat 8: [ 'all' ]. +# - Other Platforms: [ 'all', '-SSLv2', '-SSLv3' ]. +# +# @param ssl_proxy_protocol +# Configure usable SSL protocol flavors for proxy usage. +# +# @param ssl_pass_phrase_dialog +# Type of pass phrase dialog for encrypted private keys. +# +# @param ssl_random_seed_bytes +# Pseudo Random Number Generator (PRNG) seeding source. +# +# @param ssl_sessioncache +# Configures the storage type of the global/inter-process SSL Session Cache +# +# @param ssl_sessioncachetimeout +# Number of seconds before an SSL session expires in the Session Cache. +# +# @param ssl_stapling +# Enable stapling of OCSP responses in the TLS handshake. +# +# @param ssl_stapling_return_errors +# Pass stapling related OCSP errors on to client. +# +# @param ssl_mutex +# Configures mutex mechanism and lock file directory for all or specified mutexes. +# Default based on the OS and/or Apache version: +# - RedHat/FreeBSD/Suse/Gentoo: 'default'. +# - Debian/Ubuntu + Apache >= 2.4: 'default'. +# - Debian/Ubuntu + Apache < 2.4: 'file:${APACHE_RUN_DIR}/ssl_mutex'. +# +# @param ssl_reload_on_change +# Enable reloading of apache if the content of ssl files have changed. It only affects ssl files configured here and not vhost ones. +# +# @param apache_version +# Used to verify that the Apache version you have requested is compatible with the module. +# +# @param package_name +# Name of ssl package to install. +# +# On most operating systems, the ssl.conf is placed in the module configuration directory. On Red Hat based operating systems, this +# file is placed in /etc/httpd/conf.d, the same location in which the RPM stores the configuration. +# +# To use SSL with a virtual host, you must either set the default_ssl_vhost parameter in ::apache to true or the ssl parameter in +# apache::vhost to true. +# +# @see https://httpd.apache.org/docs/current/mod/mod_ssl.html for additional documentation. +# class apache::mod::ssl ( Boolean $ssl_compression = false, + Optional[Boolean] $ssl_sessiontickets = undef, $ssl_cryptodevice = 'builtin', - $ssl_options = [ 'StdEnvVars' ], + $ssl_options = ['StdEnvVars'], $ssl_openssl_conf_cmd = undef, + Optional[String] $ssl_cert = undef, + Optional[String] $ssl_key = undef, $ssl_ca = undef, $ssl_cipher = 'HIGH:MEDIUM:!aNULL:!MD5:!RC4:!3DES', Variant[Boolean, Enum['on', 'off']] $ssl_honorcipherorder = true, - $ssl_protocol = [ 'all', '-SSLv2', '-SSLv3' ], + $ssl_protocol = $apache::params::ssl_protocol, Array $ssl_proxy_protocol = [], $ssl_pass_phrase_dialog = 'builtin', $ssl_random_seed_bytes = '512', - String $ssl_sessioncache = $::apache::params::ssl_sessioncache, + String $ssl_sessioncache = $apache::params::ssl_sessioncache, $ssl_sessioncachetimeout = '300', Boolean $ssl_stapling = false, + Optional[String] $stapling_cache = undef, Optional[Boolean] $ssl_stapling_return_errors = undef, $ssl_mutex = undef, + Boolean $ssl_reload_on_change = false, $apache_version = undef, $package_name = undef, ) inherits ::apache::params { - - include ::apache - include ::apache::mod::mime + include apache + include apache::mod::mime $_apache_version = pick($apache_version, $apache::apache_version) if $ssl_mutex { $_ssl_mutex = $ssl_mutex @@ -29,8 +114,6 @@ class apache::mod::ssl ( 'debian': { if versioncmp($_apache_version, '2.4') >= 0 { $_ssl_mutex = 'default' - } elsif $::operatingsystem == 'Ubuntu' and $::operatingsystemrelease == '10.04' { - $_ssl_mutex = 'file:/var/run/apache2/ssl_mutex' } else { $_ssl_mutex = "file:\${APACHE_RUN_DIR}/ssl_mutex" } @@ -53,7 +136,7 @@ class apache::mod::ssl ( } } - if is_bool($ssl_honorcipherorder) { + if $ssl_honorcipherorder =~ Boolean { $_ssl_honorcipherorder = $ssl_honorcipherorder } else { $_ssl_honorcipherorder = $ssl_honorcipherorder ? { @@ -63,19 +146,23 @@ class apache::mod::ssl ( } } - $stapling_cache = $::osfamily ? { - 'debian' => "\${APACHE_RUN_DIR}/ocsp(32768)", - 'redhat' => '/run/httpd/ssl_stapling(32768)', - 'freebsd' => '/var/run/ssl_stapling(32768)', - 'gentoo' => '/var/run/ssl_stapling(32768)', - 'Suse' => '/var/lib/apache2/ssl_stapling(32768)', + if $stapling_cache =~ Undef { + $_stapling_cache = $::osfamily ? { + 'debian' => "\${APACHE_RUN_DIR}/ocsp(32768)", + 'redhat' => '/run/httpd/ssl_stapling(32768)', + 'freebsd' => '/var/run/ssl_stapling(32768)', + 'gentoo' => '/var/run/ssl_stapling(32768)', + 'Suse' => '/var/lib/apache2/ssl_stapling(32768)', + } + } else { + $_stapling_cache = $stapling_cache } if $::osfamily == 'Suse' { - if defined(Class['::apache::mod::worker']){ + if defined(Class['::apache::mod::worker']) { $suse_path = '/usr/lib64/apache2-worker' } else { - $suse_path = '/usr/lib64/apache2-worker' + $suse_path = '/usr/lib64/apache2-prefork' } ::apache::mod { 'ssl': package => $package_name, @@ -88,12 +175,31 @@ class apache::mod::ssl ( } if versioncmp($_apache_version, '2.4') >= 0 { - include ::apache::mod::socache_shmcb + include apache::mod::socache_shmcb + } + + if $ssl_reload_on_change { + [$ssl_cert, $ssl_key, $ssl_ca].each |$ssl_file| { + if $ssl_file { + include apache::mod::ssl::reload + $_ssl_file_copy = regsubst($ssl_file, '/', '_', 'G') + file { $_ssl_file_copy: + path => "${apache::params::puppet_ssl_dir}/${_ssl_file_copy}", + source => "file://${ssl_file}", + owner => 'root', + group => $apache::params::root_group, + mode => '0640', + seltype => 'cert_t', + notify => Class['apache::service'], + } + } + } } # Template uses # # $ssl_compression + # $ssl_sessiontickets # $ssl_cryptodevice # $ssl_ca # $ssl_cipher @@ -101,18 +207,18 @@ class apache::mod::ssl ( # $ssl_options # $ssl_openssl_conf_cmd # $ssl_sessioncache - # $stapling_cache + # $_stapling_cache # $ssl_mutex # $ssl_random_seed_bytes # $ssl_sessioncachetimeout # $_apache_version file { 'ssl.conf': ensure => file, - path => $::apache::_ssl_file, - mode => $::apache::file_mode, + path => $apache::_ssl_file, + mode => $apache::file_mode, content => template('apache/mod/ssl.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ssl/reload.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ssl/reload.pp new file mode 100644 index 000000000..723c6cb8d --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/ssl/reload.pp @@ -0,0 +1,17 @@ +# @summary +# Manages the puppet_ssl folder for ssl file copies, which is needed to track changes for reloading service on changes +# +# @api private +class apache::mod::ssl::reload () inherits ::apache::params { + file { $apache::params::puppet_ssl_dir: + ensure => directory, + purge => true, + recurse => true, + require => Package['httpd'], + } + file { 'README.txt': + path => "${apache::params::puppet_ssl_dir}/README.txt", + content => 'This directory contains puppet managed copies of ssl files, so it can track changes and reload apache on changes.', + seltype => 'etc_t', + } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/status.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/status.pp index 54d0d8887..ddd969049 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/status.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/status.pp @@ -1,48 +1,66 @@ -# Class: apache::mod::status +# @summary +# Installs and configures `mod_status`. # -# This class enables and configures Apache mod_status -# See: http://httpd.apache.org/docs/current/mod/mod_status.html +# @param allow_from +# Array of hosts, ip addresses, partial network numbers or networks, in CIDR notation specifying what hosts can view the special +# /server-status URL. Defaults to ['127.0.0.1', '::1']. +# > Creates Apache < 2.4 directive "Allow from". # -# Parameters: -# - $allow_from is an array of hosts, ip addresses, partial network numbers -# or networks in CIDR notation specifying what hosts can view the special -# /server-status URL. Defaults to ['127.0.0.1', '::1']. -# - $extended_status track and display extended status information. Valid -# values are 'On' or 'Off'. Defaults to 'On'. -# - $status_path is the path assigned to the Location directive which -# defines the URL to access the server status. Defaults to '/server-status'. +# @param requires +# A Variant type that can be: +# - String with: +# - '' or 'unmanaged' - Host auth control done elsewhere +# - 'ip ' - Allowed IPs/ranges +# - 'host ' - Allowed names/domains +# - 'all [granted|denied]' +# - Array of strings with ip or host as above +# - Hash with following keys: +# - 'requires' - Value => Array as above +# - 'enforce' - Value => String 'Any', 'All' or 'None' +# This encloses "Require" directives in "" block +# Optional - If unspecified, "Require" directives follow current flow +# > Creates Apache >= 2.4 directives "Require" # -# Actions: -# - Enable and configure Apache mod_status +# @param extended_status +# Determines whether to track extended status information for each request, via the ExtendedStatus directive. # -# Requires: -# - The apache class +# @param status_path +# Path assigned to the Location directive which defines the URL to access the server status. # -# Sample Usage: +# @param apache_version +# Used to verify that the Apache version you have requested is compatible with the module. # -# # Simple usage allowing access from localhost and a private subnet -# class { 'apache::mod::status': -# $allow_from => ['127.0.0.1', '10.10.10.10/24'], -# } +# @example +# # Simple usage allowing access from localhost and a private subnet +# class { 'apache::mod::status': +# $allow_from => ['127.0.0.1', '10.10.10.10/24'], +# } +# +# @see http://httpd.apache.org/docs/current/mod/mod_status.html for additional documentation. # class apache::mod::status ( - Array $allow_from = ['127.0.0.1','::1'], - Enum['On', 'Off', 'on', 'off'] $extended_status = 'On', - $apache_version = undef, - $status_path = '/server-status', + Optional[Array] $allow_from = undef, + Optional[Variant[String, Array, Hash]] $requires = undef, + Enum['On', 'Off', 'on', 'off'] $extended_status = 'On', + $apache_version = undef, + $status_path = '/server-status', ) inherits ::apache::params { - - include ::apache + include apache $_apache_version = pick($apache_version, $apache::apache_version) ::apache::mod { 'status': } + + # Defaults for "Allow from" or "Require" directives + $allow_defaults = ['127.0.0.1','::1'] + $requires_defaults = 'ip 127.0.0.1 ::1' + # Template uses $allow_from, $extended_status, $_apache_version, $status_path file { 'status.conf': ensure => file, - path => "${::apache::mod_dir}/status.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/status.conf", + mode => $apache::file_mode, content => template('apache/mod/status.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/suexec.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/suexec.pp index ded013d49..b6a28b1f1 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/suexec.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/suexec.pp @@ -1,3 +1,8 @@ +# @summary +# Installs `mod_suexec`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_suexec.html for additional documentation. +# class apache::mod::suexec { ::apache::mod { 'suexec': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/suphp.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/suphp.pp index 955bba302..ae8841321 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/suphp.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/suphp.pp @@ -1,16 +1,23 @@ +# @summary +# Installs `mod_suphp`. +# +# @see https://www.suphp.org/DocumentationView.html?file=apache/INSTALL for additional documentation. +# class apache::mod::suphp ( -){ - include ::apache +) { + if $facts['os']['family'] == 'Debian' { + fail("suphp was declared EOL by it's creators as of 2013 and so is no longer supported on Ubuntu 15.10/Debian 8 and above. Please use php-fpm") + } + include apache ::apache::mod { 'suphp': } - file {'suphp.conf': + file { 'suphp.conf': ensure => file, - path => "${::apache::mod_dir}/suphp.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/suphp.conf", + mode => $apache::file_mode, content => template('apache/mod/suphp.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } - diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/userdir.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/userdir.pp index 203b93dd1..67d7717dd 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/userdir.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/userdir.pp @@ -1,23 +1,61 @@ +# @summary +# Installs and configures `mod_userdir`. +# +# @param home +# *Deprecated* Path to system home directory. +# +# @param dir +# *Deprecated* Path from user's home directory to public directory. +# +# @param userdir +# Path or directory name to be used as the UserDir. +# +# @param disable_root +# Toggles whether to allow use of root directory. +# +# @param apache_version +# Used to verify that the Apache version you have requested is compatible with the module. +# +# @param path +# Path to directory or pattern from which to find user-specific directories. +# +# @param overrides +# Array of directives that are allowed in .htaccess files. +# +# @param options +# Configures what features are available in a particular directory. +# +# @param unmanaged_path +# Toggles whether to manage path in userdir.conf +# +# @param custom_fragment +# Custom configuration to be added to userdir.conf +# +# @see https://httpd.apache.org/docs/current/mod/mod_userdir.html for additional documentation. +# class apache::mod::userdir ( $home = undef, $dir = undef, + Optional[String[1]] $userdir = undef, $disable_root = true, $apache_version = undef, $path = '/home/*/public_html', - $overrides = [ 'FileInfo', 'AuthConfig', 'Limit', 'Indexes' ], - $options = [ 'MultiViews', 'Indexes', 'SymLinksIfOwnerMatch', 'IncludesNoExec' ], + $overrides = ['FileInfo', 'AuthConfig', 'Limit', 'Indexes'], + $options = ['MultiViews', 'Indexes', 'SymLinksIfOwnerMatch', 'IncludesNoExec'], + $unmanaged_path = false, + $custom_fragment = undef, ) { - include ::apache + include apache $_apache_version = pick($apache_version, $apache::apache_version) if $home or $dir { $_home = $home ? { undef => '/home', - default => $home, + default => $home, } $_dir = $dir ? { undef => 'public_html', - default => $dir, + default => $dir, } warning('home and dir are deprecated; use path instead') $_path = "${_home}/*/${_dir}" @@ -25,16 +63,18 @@ class apache::mod::userdir ( $_path = $path } + $_userdir = pick($userdir, $_path) + ::apache::mod { 'userdir': } # Template uses $home, $dir, $disable_root, $_apache_version file { 'userdir.conf': ensure => file, - path => "${::apache::mod_dir}/userdir.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/userdir.conf", + mode => $apache::file_mode, content => template('apache/mod/userdir.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/version.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/version.pp index 1cc4412e1..7dd89adce 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/version.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/version.pp @@ -1,7 +1,14 @@ -class apache::mod::version( - $apache_version = $::apache::apache_version +# @summary +# Installs `mod_version`. +# +# @param apache_version +# Used to verify that the Apache version you have requested is compatible with the module. +# +# @see https://httpd.apache.org/docs/current/mod/mod_version.html for additional documentation. +# +class apache::mod::version ( + $apache_version = $apache::apache_version ) { - if ($::osfamily == 'debian' and versioncmp($apache_version, '2.4') >= 0) { warning("${module_name}: module version_module is built-in and can't be loaded") } else { diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/vhost_alias.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/vhost_alias.pp index 30ae122e1..3ff6fd1aa 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/vhost_alias.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/vhost_alias.pp @@ -1,3 +1,8 @@ +# @summary +# Installs Apache `mod_vhost_alias`. +# +# @see https://httpd.apache.org/docs/current/mod/mod_vhost_alias.html for additional documentation. +# class apache::mod::vhost_alias { ::apache::mod { 'vhost_alias': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/watchdog.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/watchdog.pp new file mode 100644 index 000000000..ff17a1cdd --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/watchdog.pp @@ -0,0 +1,31 @@ +# @summary +# Installs and configures `mod_watchdog`. +# +# @param watchdog_interval +# Sets the interval at which the watchdog_step hook runs. +# +# @see https://httpd.apache.org/docs/current/mod/mod_watchdog.html for additional documentation. +class apache::mod::watchdog ( + Optional[Integer] $watchdog_interval = undef, +) { + include apache + + $module_builtin = $facts['os']['family'] in ['Debian'] + + unless $module_builtin { + apache::mod { 'watchdog': + } + } + + if $watchdog_interval { + file { 'watchdog.conf': + ensure => file, + path => "${apache::mod_dir}/watchdog.conf", + mode => $apache::file_mode, + content => "WatchdogInterval ${watchdog_interval}\n", + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], + notify => Class['apache::service'], + } + } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/worker.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/worker.pp index 00a9439b3..d6b57b89b 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/worker.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/worker.pp @@ -1,56 +1,46 @@ -# == Class: apache::mod::worker +# @summary +# Installs and manages the MPM `worker`. # +# @param startservers +# The number of child server processes created on startup # -# === Parameters -# -# [*startservers*] -# (optional) The number of child server processes created on startup -# Defaults is '2' -# -# [*maxclients*] -# (optional) The max number of simultaneous requests that will be served. +# @param maxclients +# The max number of simultaneous requests that will be served. # This is the old name and is still supported. The new name is # MaxRequestWorkers as of 2.3.13. -# Default is '150' # -# [*minsparethreads*] -# (optional) Minimum number of idle threads to handle request spikes. -# Default is '25' +# @param minsparethreads +# Minimum number of idle threads to handle request spikes. # -# [*maxsparethreads*] -# (optional) Maximum number of idle threads. -# Default is '75' +# @param maxsparethreads +# Maximum number of idle threads. # -# [*threadsperchild*] -# (optional) The number of threads created by each child process. -# Default is '25' +# @param threadsperchild +# The number of threads created by each child process. # -# [*maxrequestsperchild*] -# (optional) Limit on the number of connectiojns an individual child server +# @param maxrequestsperchild +# Limit on the number of connectiojns an individual child server # process will handle. This is the old name and is still supported. The new # name is MaxConnectionsPerChild as of 2.3.9+. -# Default is '0' # -# [*serverlimit*] -# (optional) With worker, use this directive only if your MaxRequestWorkers +# @param serverlimit +# With worker, use this directive only if your MaxRequestWorkers # and ThreadsPerChild settings require more than 16 server processes # (default). Do not set the value of this directive any higher than the # number of server processes required by what you may want for # MaxRequestWorkers and ThreadsPerChild. -# Default is '25' # -# [*threadlimit*] -# (optional) This directive sets the maximum configured value for +# @param threadlimit +# This directive sets the maximum configured value for # ThreadsPerChild for the lifetime of the Apache httpd process. -# Default is '64' # -# [*listenbacklog*] -# (optional) Maximum length of the queue of pending connections. -# Defaults is '511' +# @param listenbacklog +# Maximum length of the queue of pending connections. # -# [*apache_version*] -# (optional) -# Default is $::apache::apache_version +# @param apache_version +# Used to verify that the Apache version you have requested is compatible with the module. +# +# @see https://httpd.apache.org/docs/current/mod/worker.html for additional documentation. # class apache::mod::worker ( $startservers = '2', @@ -64,7 +54,7 @@ class apache::mod::worker ( $listenbacklog = '511', $apache_version = undef, ) { - include ::apache + include apache $_apache_version = pick($apache_version, $apache::apache_version) if defined(Class['apache::mod::event']) { @@ -81,8 +71,8 @@ class apache::mod::worker ( } File { owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, + group => $apache::params::root_group, + mode => $apache::file_mode, } # Template uses: @@ -95,19 +85,18 @@ class apache::mod::worker ( # - $serverlimit # - $threadLimit # - $listenbacklog - file { "${::apache::mod_dir}/worker.conf": + file { "${apache::mod_dir}/worker.conf": ensure => file, content => template('apache/mod/worker.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } case $::osfamily { 'redhat': { - if versioncmp($_apache_version, '2.4') >= 0 { - ::apache::mpm{ 'worker': + ::apache::mpm { 'worker': apache_version => $_apache_version, } } @@ -124,7 +113,7 @@ class apache::mod::worker ( } 'debian', 'freebsd': { - ::apache::mpm{ 'worker': + ::apache::mpm { 'worker': apache_version => $_apache_version, } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/wsgi.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/wsgi.pp index 6f9d4379a..0d326a4d5 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/wsgi.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/wsgi.pp @@ -1,12 +1,43 @@ +# @summary +# Installs and configures `mod_wsgi`. +# +# @param wsgi_restrict_embedded +# Enable restrictions on use of embedded mode. +# +# @param wsgi_socket_prefix +# Configure directory to use for daemon sockets. +# +# @param wsgi_python_path +# Additional directories to search for Python modules. +# +# @param wsgi_python_home +# Absolute path to Python prefix/exec_prefix directories. +# +# @param wsgi_python_optimize +# Enables basic Python optimisation features. +# +# @param wsgi_application_group +# Sets which application group WSGI application belongs to. +# +# @param package_name +# Names of package that installs mod_wsgi. +# +# @param mod_path +# Defines the path to the mod_wsgi shared object (.so) file. +# +# @see https://github.com/GrahamDumpleton/mod_wsgi for additional documentation. +# @note Unsupported platforms: SLES: all; RedHat: all; CentOS: all; OracleLinux: all; Scientific: all class apache::mod::wsgi ( $wsgi_restrict_embedded = undef, - $wsgi_socket_prefix = $::apache::params::wsgi_socket_prefix, + $wsgi_socket_prefix = $apache::params::wsgi_socket_prefix, $wsgi_python_path = undef, $wsgi_python_home = undef, + $wsgi_python_optimize = undef, + $wsgi_application_group = undef, $package_name = undef, $mod_path = undef, ) inherits ::apache::params { - include ::apache + include apache if ($package_name != undef and $mod_path == undef) or ($package_name == undef and $mod_path != undef) { fail('apache::mod::wsgi - both package_name and mod_path must be specified!') } @@ -15,7 +46,7 @@ class apache::mod::wsgi ( if $mod_path =~ /\// { $_mod_path = $mod_path } else { - $_mod_path = "${::apache::lib_path}/${mod_path}" + $_mod_path = "${apache::lib_path}/${mod_path}" } ::apache::mod { 'wsgi': package => $package_name, @@ -31,14 +62,13 @@ class apache::mod::wsgi ( # - $wsgi_socket_prefix # - $wsgi_python_path # - $wsgi_python_home - file {'wsgi.conf': + file { 'wsgi.conf': ensure => file, - path => "${::apache::mod_dir}/wsgi.conf", - mode => $::apache::file_mode, + path => "${apache::mod_dir}/wsgi.conf", + mode => $apache::file_mode, content => template('apache/mod/wsgi.conf.erb'), - require => Exec["mkdir ${::apache::mod_dir}"], - before => File[$::apache::mod_dir], + require => Exec["mkdir ${apache::mod_dir}"], + before => File[$apache::mod_dir], notify => Class['apache::service'], } } - diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/xsendfile.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/xsendfile.pp index 7c5e88437..955488461 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/xsendfile.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mod/xsendfile.pp @@ -1,4 +1,9 @@ +# @summary +# Installs `mod_xsendfile`. +# +# @see https://tn123.org/mod_xsendfile/ for additional documentation. +# class apache::mod::xsendfile { - include ::apache::params + include apache::params ::apache::mod { 'xsendfile': } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mpm.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mpm.pp index ca342f3f0..b76772eaf 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mpm.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mpm.pp @@ -1,13 +1,16 @@ +# @summary Enables the use of Apache MPMs. +# +# @api private define apache::mpm ( - $lib_path = $::apache::lib_path, - $apache_version = $::apache::apache_version, + $lib_path = $apache::lib_path, + $apache_version = $apache::apache_version, ) { if ! defined(Class['apache']) { fail('You must include the apache base class before using any apache defined resources') } $mpm = $name - $mod_dir = $::apache::mod_dir + $mod_dir = $apache::mod_dir $_lib = "mod_mpm_${mpm}.so" $_path = "${lib_path}/${_lib}" @@ -46,20 +49,20 @@ define apache::mpm ( case $::osfamily { 'debian': { - file { "${::apache::mod_enable_dir}/${mpm}.conf": + file { "${apache::mod_enable_dir}/${mpm}.conf": ensure => link, - target => "${::apache::mod_dir}/${mpm}.conf", - require => Exec["mkdir ${::apache::mod_enable_dir}"], - before => File[$::apache::mod_enable_dir], + target => "${apache::mod_dir}/${mpm}.conf", + require => Exec["mkdir ${apache::mod_enable_dir}"], + before => File[$apache::mod_enable_dir], notify => Class['apache::service'], } if versioncmp($apache_version, '2.4') >= 0 { - file { "${::apache::mod_enable_dir}/${mpm}.load": + file { "${apache::mod_enable_dir}/${mpm}.load": ensure => link, - target => "${::apache::mod_dir}/${mpm}.load", - require => Exec["mkdir ${::apache::mod_enable_dir}"], - before => File[$::apache::mod_enable_dir], + target => "${apache::mod_dir}/${mpm}.load", + require => Exec["mkdir ${apache::mod_enable_dir}"], + before => File[$apache::mod_enable_dir], notify => Class['apache::service'], } @@ -71,42 +74,46 @@ define apache::mpm ( before => Class['apache::service'], } } - } - - if $mpm == 'itk' and ( ( $::operatingsystem == 'Ubuntu' and $::operatingsystemrelease == '16.04' ) or ( $::operatingsystem == 'Debian' and versioncmp($::operatingsystemrelease, '9.0.0') >= 0 ) ) { - $packagename = 'libapache2-mpm-itk' } else { - $packagename = "apache2-mpm-${mpm}" - } - - $mod_enabled_dir = $::apache::mod_enable_dir - - if $mpm == 'prefork' and ( $::operatingsystem == 'Debian' and versioncmp($::operatingsystemrelease, '9.0.0') >= 0 ) { - exec { '/usr/sbin/a2dismod mpm_event': - onlyif => "/usr/bin/test -e ${mod_enabled_dir}/mpm_event.load", - } - } - - if $mpm == 'itk' and ( ( $::operatingsystem == 'Ubuntu' and $::operatingsystemrelease == '14.04' ) or ($::operatingsystem == 'Debian' and versioncmp($::operatingsystemrelease, '9.0.0') >= 0 ) ) { - # workaround https://bugs.launchpad.net/ubuntu/+source/mpm-itk/+bug/1286882 - exec { '/usr/sbin/a2dismod mpm_event': - onlyif => "/usr/bin/test -e ${mod_enabled_dir}/mpm_event.load", - } - } - - if versioncmp($apache_version, '2.4') < 0 or $mpm == 'itk' { - package { $packagename: + package { "apache2-mpm-${mpm}": ensure => present, + before => [ + Class['apache::service'], + File[$apache::mod_enable_dir], + ], } - if $::apache::mod_enable_dir { - Package[$packagename] { - before => File[$::apache::mod_enable_dir], - } + } + + if $mpm == 'itk' { + include apache::mpm::disable_mpm_event + include apache::mpm::disable_mpm_worker + + package { 'libapache2-mpm-itk': + ensure => present, + before => [ + Class['apache::service'], + File[$apache::mod_enable_dir], + ], + } + } + + if $mpm == 'prefork' { + if ( ( $::operatingsystem == 'Ubuntu' and versioncmp($::operatingsystemrelease,'18.04') >= 0 ) or $::operatingsystem == 'Debian' ) { + include apache::mpm::disable_mpm_event + include apache::mpm::disable_mpm_worker + } + } + + if $mpm == 'worker' { + if ( ( $::operatingsystem == 'Ubuntu' and versioncmp($::operatingsystemrelease,'18.04') >= 0 ) or $::operatingsystem == 'Debian' ) { + include apache::mpm::disable_mpm_event + include apache::mpm::disable_mpm_prefork } } } + 'freebsd': { - class { '::apache::package': + class { 'apache::package': mpm_module => $mpm, } } @@ -117,20 +124,20 @@ define apache::mpm ( # so we don't fail } 'Suse': { - file { "${::apache::mod_enable_dir}/${mpm}.conf": + file { "${apache::mod_enable_dir}/${mpm}.conf": ensure => link, - target => "${::apache::mod_dir}/${mpm}.conf", - require => Exec["mkdir ${::apache::mod_enable_dir}"], - before => File[$::apache::mod_enable_dir], + target => "${apache::mod_dir}/${mpm}.conf", + require => Exec["mkdir ${apache::mod_enable_dir}"], + before => File[$apache::mod_enable_dir], notify => Class['apache::service'], } if versioncmp($apache_version, '2.4') >= 0 { - file { "${::apache::mod_enable_dir}/${mpm}.load": + file { "${apache::mod_enable_dir}/${mpm}.load": ensure => link, - target => "${::apache::mod_dir}/${mpm}.load", - require => Exec["mkdir ${::apache::mod_enable_dir}"], - before => File[$::apache::mod_enable_dir], + target => "${apache::mod_dir}/${mpm}.load", + require => Exec["mkdir ${apache::mod_enable_dir}"], + before => File[$apache::mod_enable_dir], notify => Class['apache::service'], } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mpm/disable_mpm_event.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mpm/disable_mpm_event.pp new file mode 100644 index 000000000..8c47576a7 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mpm/disable_mpm_event.pp @@ -0,0 +1,19 @@ +class apache::mpm::disable_mpm_event { + exec { '/usr/sbin/a2dismod event': + onlyif => "/usr/bin/test -e ${apache::mod_enable_dir}/event.load", + require => Package['httpd'], + before => Class['apache::service'], + } + exec { 'remove distribution event load file': + command => "/bin/rm ${apache::mod_enable_dir}/mpm_event.load", + onlyif => "/usr/bin/test -e ${apache::mod_enable_dir}/mpm_event.load", + require => Package['httpd'], + before => Class['apache::service'], + } + exec { 'remove distribution event conf file': + command => "/bin/rm ${apache::mod_enable_dir}/mpm_event.conf", + onlyif => "/usr/bin/test -e ${apache::mod_enable_dir}/mpm_event.conf", + require => Package['httpd'], + before => Class['apache::service'], + } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mpm/disable_mpm_prefork.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mpm/disable_mpm_prefork.pp new file mode 100644 index 000000000..ea67edbdb --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mpm/disable_mpm_prefork.pp @@ -0,0 +1,7 @@ +class apache::mpm::disable_mpm_prefork { + exec { '/usr/sbin/a2dismod prefork': + onlyif => "/usr/bin/test -e ${apache::mod_enable_dir}/prefork.load", + require => Package['httpd'], + before => Class['apache::service'], + } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mpm/disable_mpm_worker.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mpm/disable_mpm_worker.pp new file mode 100644 index 000000000..4156d8438 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/mpm/disable_mpm_worker.pp @@ -0,0 +1,7 @@ +class apache::mpm::disable_mpm_worker { + exec { '/usr/sbin/a2dismod worker': + onlyif => "/usr/bin/test -e ${apache::mod_enable_dir}/worker.load", + require => Package['httpd'], + before => Class['apache::service'], + } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/namevirtualhost.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/namevirtualhost.pp index d89cb0c5b..246df53dd 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/namevirtualhost.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/namevirtualhost.pp @@ -1,31 +1,15 @@ -define apache::namevirtualhost ($port=''){ +# @summary +# Enables name-based virtual hosts +# +# Adds all related directives to the `ports.conf` file in the Apache HTTPD configuration +# directory. Titles can take the forms `\*`, `\*:\`, `\_default\_:\`, +# `\`, or `\:\`. +define apache::namevirtualhost { $addr_port = $name - if defined(Concat[$::apache::ports_file]){ - # Template uses: $addr_port - concat::fragment { "NameVirtualHost ${addr_port}": - target => $::apache::ports_file, - content => template('apache/namevirtualhost.erb'), - } - } elsif $port != '80' { # if a second vhost is declared off port 80 - # Create a temporary file - # join with cat $tmp_file >> $file - # remove tmp files - $ports_file = $::apache::ports_file - $tmp_file = "$ports_file-tmp_nvh" - file { $tmp_file: - ensure => file, - content => template('apache/namevirtualhost.erb'), - } - - exec { "apache::listen: cat $tmp_file with ports.conf": - command => "/bin/cat $tmp_file >> $ports_file;/bin/rm $tmp_file", - require => File[$tmp_file] - } - - } else { # if a second vhost is declared on port 80 - tidy { 'remove apache default site': - path =>'/etc/apache2/sites-enabled/000-default', - } + # Template uses: $addr_port + concat::fragment { "NameVirtualHost ${addr_port}": + target => $apache::ports_file, + content => template('apache/namevirtualhost.erb'), } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/package.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/package.pp index 7c95f9980..684995ea3 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/package.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/package.pp @@ -1,8 +1,11 @@ +# @summary +# Installs an Apache MPM. +# +# @api private class apache::package ( $ensure = 'present', - $mpm_module = $::apache::params::mpm_module, + $mpm_module = $apache::params::mpm_module, ) inherits ::apache::params { - # The base class must be included first because it is used by parameter defaults if ! defined(Class['apache']) { fail('You must include the apache base class before using any apache defined resources') @@ -31,7 +34,7 @@ class apache::package ( package { 'httpd': ensure => $ensure, - name => $::apache::apache_name, + name => $apache::apache_name, notify => Class['Apache::Service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/params.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/params.pp index 0cf8eb9c6..79313de8b 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/params.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/params.pp @@ -1,23 +1,7 @@ -# Class: apache::params -# -# This class manages Apache parameters -# -# Parameters: -# - The $user that Apache runs as -# - The $group that Apache runs as -# - The $apache_name is the name of the package and service on the relevant -# distribution -# - The $php_package is the name of the package that provided PHP -# - The $ssl_package is the name of the Apache SSL package -# - The $apache_dev is the name of the Apache development libraries package -# - The $conf_contents is the contents of the Apache configuration file -# -# Actions: -# -# Requires: -# -# Sample Usage: +# @summary +# This class manages Apache parameters # +# @api private class apache::params inherits ::apache::version { if($::fqdn) { $servername = $::fqdn @@ -42,21 +26,141 @@ class apache::params inherits ::apache::version { # Default mode for files $file_mode = '0644' + # The default value for host hame lookup + $hostname_lookups = 'Off' + # Default options for / directory $root_directory_options = ['FollowSymLinks'] $vhost_include_pattern = '*' $modsec_audit_log_parts = 'ABIJDEFHZ' + $modsec_audit_log_type = 'Serial' + $modsec_custom_rules = false + $modsec_custom_rules_set = undef - if ($::operatingsystem == 'Ubuntu' and $::lsbdistrelease == '10.04') or ($::operatingsystem == 'SLES') { - $verify_command = '/usr/sbin/apache2ctl -t' - } elsif $::operatingsystem == 'FreeBSD' { - $verify_command = '/usr/local/sbin/apachectl -t' - } else { - $verify_command = '/usr/sbin/apachectl -t' + # no client certs should be trusted for auth by default. + $ssl_certs_dir = undef + + # Allow overriding the autoindex alias location + $icons_prefix = 'icons' + + if ($apache::version::scl_httpd_version) { + if $apache::version::scl_php_version == undef { + fail('If you define apache::version::scl_httpd_version, you also need to specify apache::version::scl_php_version') + } + $_scl_httpd_version_nodot = regsubst($apache::version::scl_httpd_version, '\.', '') + $_scl_httpd_name = "httpd${_scl_httpd_version_nodot}" + + $_scl_php_version_no_dot = regsubst($apache::version::scl_php_version, '\.', '') + $user = 'apache' + $group = 'apache' + $root_group = 'root' + $apache_name = "${_scl_httpd_name}-httpd" + $service_name = "${_scl_httpd_name}-httpd" + $httpd_root = "/opt/rh/${_scl_httpd_name}/root" + $httpd_dir = "${httpd_root}/etc/httpd" + $server_root = "${httpd_root}/etc/httpd" + $conf_dir = "${httpd_dir}/conf" + $confd_dir = "${httpd_dir}/conf.d" + $puppet_ssl_dir = "${httpd_dir}/puppet_ssl" + $mod_dir = $facts['operatingsystemmajrelease'] ? { + '7' => "${httpd_dir}/conf.modules.d", + default => "${httpd_dir}/conf.d", + } + $mod_enable_dir = undef + $vhost_dir = "${httpd_dir}/conf.d" + $vhost_enable_dir = undef + $conf_file = 'httpd.conf' + $conf_enabled = undef + $ports_file = "${conf_dir}/ports.conf" + $pidfile = 'run/httpd.pid' + $logroot = "/var/log/${_scl_httpd_name}" + $logroot_mode = undef + $lib_path = 'modules' + $mpm_module = 'prefork' + $dev_packages = "${_scl_httpd_name}-httpd-devel" + $default_ssl_cert = '/etc/pki/tls/certs/localhost.crt' + $default_ssl_key = '/etc/pki/tls/private/localhost.key' + $ssl_sessioncache = '/var/cache/mod_ssl/scache(512000)' + $passenger_conf_file = 'passenger_extra.conf' + $passenger_conf_package_file = 'passenger.conf' + $passenger_root = undef + $passenger_ruby = undef + $passenger_default_ruby = undef + $suphp_addhandler = 'php5-script' + $suphp_engine = 'off' + $suphp_configpath = undef + $php_version = $apache::version::scl_php_version + $mod_packages = { + 'authnz_ldap' => "${_scl_httpd_name}-mod_ldap", + 'ldap' => "${_scl_httpd_name}-mod_ldap", + "php${apache::version::scl_php_version}" => "rh-php${_scl_php_version_no_dot}-php", + 'ssl' => "${_scl_httpd_name}-mod_ssl", + } + $mod_libs = { + 'nss' => 'libmodnss.so', + } + $conf_template = 'apache/httpd.conf.erb' + $http_protocol_options = undef + $keepalive = 'On' + $keepalive_timeout = 15 + $max_keepalive_requests = 100 + $fastcgi_lib_path = undef + $mime_support_package = 'mailcap' + $mime_types_config = '/etc/mime.types' + $docroot = "${httpd_root}/var/www/html" + $alias_icons_path = $facts['operatingsystemmajrelease'] ? { + '7' => "${httpd_root}/usr/share/httpd/icons", + default => '/var/www/icons', + } + $error_documents_path = $facts['operatingsystemmajrelease'] ? { + '7' => "${httpd_root}/usr/share/httpd/error", + default => '/var/www/error' + } + if $::osfamily == 'RedHat' { + $wsgi_socket_prefix = '/var/run/wsgi' + } else { + $wsgi_socket_prefix = undef + } + $cas_cookie_path = '/var/cache/mod_auth_cas/' + $mellon_lock_file = '/run/mod_auth_mellon/lock' + $mellon_cache_size = 100 + $mellon_post_directory = undef + $modsec_version = 1 + $modsec_crs_package = 'mod_security_crs' + $modsec_crs_path = '/usr/lib/modsecurity.d' + $modsec_dir = '/etc/httpd/modsecurity.d' + $secpcrematchlimit = 1500 + $secpcrematchlimitrecursion = 1500 + $modsec_secruleengine = 'On' + $modsec_default_rules = [ + 'base_rules/modsecurity_35_bad_robots.data', + 'base_rules/modsecurity_35_scanners.data', + 'base_rules/modsecurity_40_generic_attacks.data', + 'base_rules/modsecurity_50_outbound.data', + 'base_rules/modsecurity_50_outbound_malware.data', + 'base_rules/modsecurity_crs_20_protocol_violations.conf', + 'base_rules/modsecurity_crs_21_protocol_anomalies.conf', + 'base_rules/modsecurity_crs_23_request_limits.conf', + 'base_rules/modsecurity_crs_30_http_policy.conf', + 'base_rules/modsecurity_crs_35_bad_robots.conf', + 'base_rules/modsecurity_crs_40_generic_attacks.conf', + 'base_rules/modsecurity_crs_41_sql_injection_attacks.conf', + 'base_rules/modsecurity_crs_41_xss_attacks.conf', + 'base_rules/modsecurity_crs_42_tight_security.conf', + 'base_rules/modsecurity_crs_45_trojans.conf', + 'base_rules/modsecurity_crs_47_common_exceptions.conf', + 'base_rules/modsecurity_crs_49_inbound_blocking.conf', + 'base_rules/modsecurity_crs_50_outbound.conf', + 'base_rules/modsecurity_crs_59_outbound_blocking.conf', + 'base_rules/modsecurity_crs_60_correlation.conf', + ] + $error_log = 'error_log' + $scriptalias = "${httpd_root}/var/www/cgi-bin" + $access_log_file = 'access_log' } - if $::osfamily == 'RedHat' or $::operatingsystem =~ /^[Aa]mazon$/ { + elsif $::osfamily == 'RedHat' or $::operatingsystem =~ /^[Aa]mazon$/ { $user = 'apache' $group = 'apache' $root_group = 'root' @@ -66,9 +170,16 @@ class apache::params inherits ::apache::version { $server_root = '/etc/httpd' $conf_dir = "${httpd_dir}/conf" $confd_dir = "${httpd_dir}/conf.d" - $mod_dir = $::apache::version::distrelease ? { - '7' => "${httpd_dir}/conf.modules.d", - default => "${httpd_dir}/conf.d", + $puppet_ssl_dir = "${httpd_dir}/puppet_ssl" + $conf_enabled = undef + if $::operatingsystem =~ /^[Aa]mazon$/ and $::operatingsystemmajrelease == '2' { + # Amazon Linux 2 uses the /conf.modules.d/ dir + $mod_dir = "${httpd_dir}/conf.modules.d" + } else { + $mod_dir = $facts['operatingsystemmajrelease'] ? { + '6' => "${httpd_dir}/conf.d", + default => "${httpd_dir}/conf.modules.d", + } } $mod_enable_dir = undef $vhost_dir = "${httpd_dir}/conf.d" @@ -83,7 +194,6 @@ class apache::params inherits ::apache::version { $dev_packages = 'httpd-devel' $default_ssl_cert = '/etc/pki/tls/certs/localhost.crt' $default_ssl_key = '/etc/pki/tls/private/localhost.key' - $ssl_certs_dir = '/etc/pki/tls/certs' $ssl_sessioncache = '/var/cache/mod_ssl/scache(512000)' $passenger_conf_file = 'passenger_extra.conf' $passenger_conf_package_file = 'passenger.conf' @@ -93,26 +203,37 @@ class apache::params inherits ::apache::version { $suphp_addhandler = 'php5-script' $suphp_engine = 'off' $suphp_configpath = undef - $php_version = '5' + $php_version = $facts['operatingsystemmajrelease'] ? { + '8' => '7', # RedHat8 + default => '5', # RedHat5, RedHat6, RedHat7 + } $mod_packages = { # NOTE: The auth_cas module isn't available on RH/CentOS without providing dependency packages provided by EPEL. 'auth_cas' => 'mod_auth_cas', 'auth_kerb' => 'mod_auth_kerb', + 'auth_gssapi' => 'mod_auth_gssapi', 'auth_mellon' => 'mod_auth_mellon', - 'authnz_ldap' => $::apache::version::distrelease ? { - '7' => 'mod_ldap', - default => 'mod_authz_ldap', + 'auth_openidc' => 'mod_auth_openidc', + 'authnz_ldap' => $facts['operatingsystemmajrelease'] ? { + '6' => 'mod_authz_ldap', + default => 'mod_ldap', }, 'authnz_pam' => 'mod_authnz_pam', - 'fastcgi' => 'mod_fastcgi', + 'fastcgi' => $facts['operatingsystemmajrelease'] ? { + '5' => 'mod_fastcgi', + '6' => 'mod_fastcgi', + default => undef, + }, 'fcgid' => 'mod_fcgid', 'geoip' => 'mod_geoip', 'intercept_form_submit' => 'mod_intercept_form_submit', - 'ldap' => $::apache::version::distrelease ? { - '7' => 'mod_ldap', - default => undef, + 'ldap' => $facts['operatingsystemmajrelease'] ? { + '5' => undef, + '6' => undef, + default => 'mod_ldap', }, 'lookup_identity' => 'mod_lookup_identity', + 'md' => 'mod_md', 'pagespeed' => 'mod-pagespeed-stable', # NOTE: The passenger module isn't available on RH/CentOS without # providing dependency packages provided by EPEL and passenger @@ -120,7 +241,7 @@ class apache::params inherits ::apache::version { # https://www.phusionpassenger.com/library/install/apache/install/oss/el7/ 'passenger' => 'mod_passenger', 'perl' => 'mod_perl', - 'php5' => $::apache::version::distrelease ? { + 'php5' => $facts['operatingsystemmajrelease'] ? { '5' => 'php53', default => 'php', }, @@ -133,7 +254,11 @@ class apache::params inherits ::apache::version { # See http://wiki.aaf.edu.au/tech-info/sp-install-guide 'shibboleth' => 'shibboleth', 'ssl' => 'mod_ssl', - 'wsgi' => 'mod_wsgi', + 'wsgi' => $facts['operatingsystemmajrelease'] ? { + '6' => 'mod_wsgi', # RedHat6 + '7' => 'mod_wsgi', # RedHat7 + default => 'python3-mod_wsgi', # RedHat8+ + }, 'dav_svn' => 'mod_dav_svn', 'suphp' => 'mod_suphp', 'xsendfile' => 'mod_xsendfile', @@ -142,6 +267,11 @@ class apache::params inherits ::apache::version { } $mod_libs = { 'nss' => 'libmodnss.so', + 'wsgi' => $facts['operatingsystemmajrelease'] ? { + '6' => 'mod_wsgi.so', + '7' => 'mod_wsgi.so', + default => 'mod_wsgi_python3.so', + }, } $conf_template = 'apache/httpd.conf.erb' $http_protocol_options = undef @@ -152,13 +282,13 @@ class apache::params inherits ::apache::version { $mime_support_package = 'mailcap' $mime_types_config = '/etc/mime.types' $docroot = '/var/www/html' - $alias_icons_path = $::apache::version::distrelease ? { - '7' => '/usr/share/httpd/icons', - default => '/var/www/icons', + $alias_icons_path = $facts['operatingsystemmajrelease'] ? { + '6' => '/var/www/icons', + default => '/usr/share/httpd/icons', } - $error_documents_path = $::apache::version::distrelease ? { - '7' => '/usr/share/httpd/error', - default => '/var/www/error' + $error_documents_path = $facts['operatingsystemmajrelease'] ? { + '6' => '/var/www/error', + default => '/usr/share/httpd/error', } if $::osfamily == 'RedHat' { $wsgi_socket_prefix = '/var/run/wsgi' @@ -169,6 +299,7 @@ class apache::params inherits ::apache::version { $mellon_lock_file = '/run/mod_auth_mellon/lock' $mellon_cache_size = 100 $mellon_post_directory = undef + $modsec_version = 1 $modsec_crs_package = 'mod_security_crs' $modsec_crs_path = '/usr/lib/modsecurity.d' $modsec_dir = '/etc/httpd/modsecurity.d' @@ -210,6 +341,9 @@ class apache::params inherits ::apache::version { $server_root = '/etc/apache2' $conf_dir = $httpd_dir $confd_dir = "${httpd_dir}/conf.d" + # Overwrite conf_enabled causes errors with Shibboleth when enabled on Ubuntu 18.04 + $conf_enabled = undef #"${httpd_dir}/conf-enabled.d" + $puppet_ssl_dir = "${httpd_dir}/puppet_ssl" $mod_dir = "${httpd_dir}/mods-available" $mod_enable_dir = "${httpd_dir}/mods-enabled" $vhost_dir = "${httpd_dir}/sites-available" @@ -220,55 +354,66 @@ class apache::params inherits ::apache::version { $logroot = '/var/log/apache2' $logroot_mode = undef $lib_path = '/usr/lib/apache2/modules' - $mpm_module = 'prefork' + $mpm_module = 'worker' $default_ssl_cert = '/etc/ssl/certs/ssl-cert-snakeoil.pem' $default_ssl_key = '/etc/ssl/private/ssl-cert-snakeoil.key' - $ssl_certs_dir = '/etc/ssl/certs' $ssl_sessioncache = "\${APACHE_RUN_DIR}/ssl_scache(512000)" $suphp_addhandler = 'x-httpd-php' $suphp_engine = 'off' $suphp_configpath = '/etc/php5/apache2' - if ($::operatingsystem == 'Ubuntu' and versioncmp($::operatingsystemrelease, '16.04') < 0) or ($::operatingsystem == 'Debian' and versioncmp($::operatingsystemrelease, '9') < 0) { - # Only the major version is used here - $php_version = '5' + if ($::operatingsystem == 'Ubuntu') or ($::operatingsystem == 'Debian' and versioncmp($::operatingsystemmajrelease, '11') < 0) { + $php_version = $facts['operatingsystemmajrelease'] ? { + '9' => '7.0', # Debian Stretch + '16.04' => '7.0', # Ubuntu Xenial + '10' => '7.3', # Debian Buster + '20.04' => '7.4', # Ubuntu Foccal Fossal + default => '7.2', # Ubuntu Bionic, Cosmic and Disco + } $mod_packages = { + 'apreq2' => 'libapache2-mod-apreq2', 'auth_cas' => 'libapache2-mod-auth-cas', 'auth_kerb' => 'libapache2-mod-auth-kerb', + 'auth_openidc' => 'libapache2-mod-auth-openidc', + 'auth_gssapi' => 'libapache2-mod-auth-gssapi', 'auth_mellon' => 'libapache2-mod-auth-mellon', 'authnz_pam' => 'libapache2-mod-authnz-pam', - 'dav_svn' => 'libapache2-svn', + 'dav_svn' => 'libapache2-mod-svn', 'fastcgi' => 'libapache2-mod-fastcgi', 'fcgid' => 'libapache2-mod-fcgid', 'geoip' => 'libapache2-mod-geoip', 'intercept_form_submit' => 'libapache2-mod-intercept-form-submit', + 'jk' => 'libapache2-mod-jk', 'lookup_identity' => 'libapache2-mod-lookup-identity', 'nss' => 'libapache2-mod-nss', 'pagespeed' => 'mod-pagespeed-stable', 'passenger' => 'libapache2-mod-passenger', 'perl' => 'libapache2-mod-perl2', 'phpXXX' => 'libapache2-mod-phpXXX', - 'proxy_html' => 'libapache2-mod-proxy-html', 'python' => 'libapache2-mod-python', 'rpaf' => 'libapache2-mod-rpaf', - 'security' => 'libapache2-modsecurity', + 'security' => 'libapache2-mod-security2', 'shib2' => 'libapache2-mod-shib2', - 'suphp' => 'libapache2-mod-suphp', 'wsgi' => 'libapache2-mod-wsgi', 'xsendfile' => 'libapache2-mod-xsendfile', } } else { - # major.minor version used since Debian stretch and Ubuntu Xenial - $php_version = '7.0' + $php_version = $facts['operatingsystemmajrelease'] ? { + default => '7.4', # Debian Bullseye + } $mod_packages = { + 'apreq2' => 'libapache2-mod-apreq2', 'auth_cas' => 'libapache2-mod-auth-cas', 'auth_kerb' => 'libapache2-mod-auth-kerb', + 'auth_openidc' => 'libapache2-mod-auth-openidc', + 'auth_gssapi' => 'libapache2-mod-auth-gssapi', 'auth_mellon' => 'libapache2-mod-auth-mellon', 'authnz_pam' => 'libapache2-mod-authnz-pam', - 'dav_svn' => 'libapache2-svn', + 'dav_svn' => 'libapache2-mod-svn', 'fastcgi' => 'libapache2-mod-fastcgi', 'fcgid' => 'libapache2-mod-fcgid', 'geoip' => 'libapache2-mod-geoip', 'intercept_form_submit' => 'libapache2-mod-intercept-form-submit', + 'jk' => 'libapache2-mod-jk', 'lookup_identity' => 'libapache2-mod-lookup-identity', 'nss' => 'libapache2-mod-nss', 'pagespeed' => 'mod-pagespeed-stable', @@ -277,76 +422,93 @@ class apache::params inherits ::apache::version { 'phpXXX' => 'libapache2-mod-phpXXX', 'python' => 'libapache2-mod-python', 'rpaf' => 'libapache2-mod-rpaf', - 'security' => 'libapache2-modsecurity', - 'shib2' => 'libapache2-mod-shib2', - 'suphp' => 'libapache2-mod-suphp', - 'wsgi' => 'libapache2-mod-wsgi', + 'security' => 'libapache2-mod-security2', + 'shib2' => 'libapache2-mod-shib', + 'wsgi' => 'libapache2-mod-wsgi-py3', 'xsendfile' => 'libapache2-mod-xsendfile', } } + $error_log = 'error.log' $scriptalias = '/usr/lib/cgi-bin' $access_log_file = 'access.log' - if $::osfamily == 'Debian' and versioncmp($::operatingsystemrelease, '8') < 0 { - $shib2_lib = 'mod_shib_22.so' - } else { + if ($::operatingsystem == 'Ubuntu' and versioncmp($::operatingsystemrelease, '19.04') < 0) or ($::operatingsystem == 'Debian' and versioncmp($::operatingsystemrelease, '10') < 0) { $shib2_lib = 'mod_shib2.so' + } else { + $shib2_lib = 'mod_shib.so' } $mod_libs = { 'shib2' => $shib2_lib, } $conf_template = 'apache/httpd.conf.erb' $http_protocol_options = undef - $keepalive = 'Off' + $keepalive = 'On' $keepalive_timeout = 15 $max_keepalive_requests = 100 $fastcgi_lib_path = '/var/lib/apache2/fastcgi' $mime_support_package = 'mime-support' $mime_types_config = '/etc/mime.types' - if ($::operatingsystem == 'Ubuntu' and versioncmp($::operatingsystemrelease, '13.10') >= 0) or ($::operatingsystem == 'Debian' and versioncmp($::operatingsystemrelease, '8') >= 0) { - $docroot = '/var/www/html' - } else { - $docroot = '/var/www' - } + $docroot = '/var/www/html' $cas_cookie_path = '/var/cache/apache2/mod_auth_cas/' $mellon_lock_file = undef $mellon_cache_size = undef $mellon_post_directory = '/var/cache/apache2/mod_auth_mellon/' + $modsec_version = 1 $modsec_crs_package = 'modsecurity-crs' $modsec_crs_path = '/usr/share/modsecurity-crs' $modsec_dir = '/etc/modsecurity' $secpcrematchlimit = 1500 $secpcrematchlimitrecursion = 1500 $modsec_secruleengine = 'On' - $modsec_default_rules = [ - 'base_rules/modsecurity_35_bad_robots.data', - 'base_rules/modsecurity_35_scanners.data', - 'base_rules/modsecurity_40_generic_attacks.data', - 'base_rules/modsecurity_50_outbound.data', - 'base_rules/modsecurity_50_outbound_malware.data', - 'base_rules/modsecurity_crs_20_protocol_violations.conf', - 'base_rules/modsecurity_crs_21_protocol_anomalies.conf', - 'base_rules/modsecurity_crs_23_request_limits.conf', - 'base_rules/modsecurity_crs_30_http_policy.conf', - 'base_rules/modsecurity_crs_35_bad_robots.conf', - 'base_rules/modsecurity_crs_40_generic_attacks.conf', - 'base_rules/modsecurity_crs_41_sql_injection_attacks.conf', - 'base_rules/modsecurity_crs_41_xss_attacks.conf', - 'base_rules/modsecurity_crs_42_tight_security.conf', - 'base_rules/modsecurity_crs_45_trojans.conf', - 'base_rules/modsecurity_crs_47_common_exceptions.conf', - 'base_rules/modsecurity_crs_49_inbound_blocking.conf', - 'base_rules/modsecurity_crs_50_outbound.conf', - 'base_rules/modsecurity_crs_59_outbound_blocking.conf', - 'base_rules/modsecurity_crs_60_correlation.conf', - ] + if ($::operatingsystem == 'Debian' and versioncmp($::operatingsystemrelease, '9') >= 0) or ($::operatingsystem == 'Ubuntu' and versioncmp($::operatingsystemrelease, '18.04') >= 0) { + $modsec_default_rules = [ + 'crawlers-user-agents.data', + 'iis-errors.data', + 'java-code-leakages.data', + 'java-errors.data', + 'lfi-os-files.data', + 'php-config-directives.data', + 'php-errors.data', + 'php-function-names-933150.data', + 'php-function-names-933151.data', + 'php-variables.data', + 'restricted-files.data', + 'scanners-headers.data', + 'scanners-urls.data', + 'scanners-user-agents.data', + 'scripting-user-agents.data', + 'sql-errors.data', + 'sql-function-names.data', + 'unix-shell.data', + 'windows-powershell-commands.data', + ] + } else { + $modsec_default_rules = [ + 'base_rules/modsecurity_35_bad_robots.data', + 'base_rules/modsecurity_35_scanners.data', + 'base_rules/modsecurity_40_generic_attacks.data', + 'base_rules/modsecurity_50_outbound.data', + 'base_rules/modsecurity_50_outbound_malware.data', + 'base_rules/modsecurity_crs_20_protocol_violations.conf', + 'base_rules/modsecurity_crs_21_protocol_anomalies.conf', + 'base_rules/modsecurity_crs_23_request_limits.conf', + 'base_rules/modsecurity_crs_30_http_policy.conf', + 'base_rules/modsecurity_crs_35_bad_robots.conf', + 'base_rules/modsecurity_crs_40_generic_attacks.conf', + 'base_rules/modsecurity_crs_41_sql_injection_attacks.conf', + 'base_rules/modsecurity_crs_41_xss_attacks.conf', + 'base_rules/modsecurity_crs_42_tight_security.conf', + 'base_rules/modsecurity_crs_45_trojans.conf', + 'base_rules/modsecurity_crs_47_common_exceptions.conf', + 'base_rules/modsecurity_crs_49_inbound_blocking.conf', + 'base_rules/modsecurity_crs_50_outbound.conf', + 'base_rules/modsecurity_crs_59_outbound_blocking.conf', + 'base_rules/modsecurity_crs_60_correlation.conf', + ] + } $alias_icons_path = '/usr/share/apache2/icons' $error_documents_path = '/usr/share/apache2/error' - if ($::operatingsystem == 'Ubuntu' and versioncmp($::operatingsystemrelease, '13.10') >= 0) or ($::operatingsystem == 'Debian' and versioncmp($::operatingsystemrelease, '8') >= 0) { - $dev_packages = ['libaprutil1-dev', 'libapr1-dev', 'apache2-dev'] - } else { - $dev_packages = ['libaprutil1-dev', 'libapr1-dev', 'apache2-prefork-dev'] - } + $dev_packages = ['libaprutil1-dev', 'libapr1-dev', 'apache2-dev'] # # Passenger-specific settings @@ -354,16 +516,9 @@ class apache::params inherits ::apache::version { $passenger_conf_file = 'passenger.conf' $passenger_conf_package_file = undef - - if ($::operatingsystem == 'Ubuntu' and versioncmp($::operatingsystemrelease, '14.04') < 0) or ($::operatingsystem == 'Debian' and versioncmp($::operatingsystemrelease, '8') < 0) { - $passenger_root = '/usr' - $passenger_ruby = '/usr/bin/ruby' - $passenger_default_ruby = undef - } else { - $passenger_root = '/usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini' - $passenger_ruby = undef - $passenger_default_ruby = '/usr/bin/ruby' - } + $passenger_root = '/usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini' + $passenger_ruby = undef + $passenger_default_ruby = '/usr/bin/ruby' $wsgi_socket_prefix = undef } elsif $::osfamily == 'FreeBSD' { $user = 'www' @@ -375,6 +530,8 @@ class apache::params inherits ::apache::version { $server_root = '/usr/local' $conf_dir = $httpd_dir $confd_dir = "${httpd_dir}/Includes" + $conf_enabled = undef + $puppet_ssl_dir = "${httpd_dir}/puppet_ssl" $mod_dir = "${httpd_dir}/Modules" $mod_enable_dir = undef $vhost_dir = "${httpd_dir}/Vhosts" @@ -389,7 +546,6 @@ class apache::params inherits ::apache::version { $dev_packages = undef $default_ssl_cert = '/usr/local/etc/apache24/server.crt' $default_ssl_key = '/usr/local/etc/apache24/server.key' - $ssl_certs_dir = undef $ssl_sessioncache = '/var/run/ssl_scache(512000)' $passenger_conf_file = 'passenger.conf' $passenger_conf_package_file = undef @@ -406,24 +562,26 @@ class apache::params inherits ::apache::version { # NOTE: 'php' needs to enable APACHE option in make config # NOTE: 'dav_svn' needs to enable MOD_DAV_SVN make config # NOTE: not sure where the shibboleth should come from - 'auth_kerb' => 'www/mod_auth_kerb2', - 'fcgid' => 'www/mod_fcgid', - 'passenger' => 'www/rubygem-passenger', - 'perl' => 'www/mod_perl2', - 'phpXXX' => 'www/mod_phpXXX', - 'proxy_html' => 'www/mod_proxy_html', - 'python' => 'www/mod_python3', - 'wsgi' => 'www/mod_wsgi', - 'dav_svn' => 'devel/subversion', - 'xsendfile' => 'www/mod_xsendfile', - 'rpaf' => 'www/mod_rpaf2', - 'shib2' => 'security/shibboleth2-sp', + 'auth_kerb' => 'www/mod_auth_kerb2', + 'auth_gssapi' => 'www/mod_auth_gssapi', + 'auth_openidc'=> 'www/mod_auth_openidc', + 'fcgid' => 'www/mod_fcgid', + 'passenger' => 'www/rubygem-passenger', + 'perl' => 'www/mod_perl2', + 'phpXXX' => 'www/mod_phpXXX', + 'proxy_html' => 'www/mod_proxy_html', + 'python' => 'www/mod_python3', + 'wsgi' => 'www/mod_wsgi', + 'dav_svn' => 'devel/subversion', + 'xsendfile' => 'www/mod_xsendfile', + 'rpaf' => 'www/mod_rpaf2', + 'shib2' => 'security/shibboleth2-sp', } $mod_libs = { } $conf_template = 'apache/httpd.conf.erb' $http_protocol_options = undef - $keepalive = 'Off' + $keepalive = 'On' $keepalive_timeout = 15 $max_keepalive_requests = 100 $fastcgi_lib_path = undef # TODO: revisit @@ -446,6 +604,8 @@ class apache::params inherits ::apache::version { $server_root = '/var/www' $conf_dir = $httpd_dir $confd_dir = "${httpd_dir}/conf.d" + $conf_enabled = undef + $puppet_ssl_dir = "${httpd_dir}/puppet_ssl" $mod_dir = "${httpd_dir}/modules.d" $mod_enable_dir = undef $vhost_dir = "${httpd_dir}/vhosts.d" @@ -459,7 +619,6 @@ class apache::params inherits ::apache::version { $dev_packages = undef $default_ssl_cert = '/etc/ssl/apache2/server.crt' $default_ssl_key = '/etc/ssl/apache2/server.key' - $ssl_certs_dir = '/etc/ssl/apache2' $ssl_sessioncache = '/var/run/ssl_scache(512000)' $passenger_root = '/usr' $passenger_ruby = '/usr/bin/ruby' @@ -473,6 +632,7 @@ class apache::params inherits ::apache::version { $mod_packages = { # NOTE: I list here only modules that are not included in www-servers/apache 'auth_kerb' => 'www-apache/mod_auth_kerb', + 'auth_gssapi' => 'www-apache/mod_auth_gssapi', 'authnz_external' => 'www-apache/mod_authnz_external', 'fcgid' => 'www-apache/mod_fcgid', 'passenger' => 'www-apache/passenger', @@ -491,7 +651,7 @@ class apache::params inherits ::apache::version { } $conf_template = 'apache/httpd.conf.erb' $http_protocol_options = undef - $keepalive = 'Off' + $keepalive = 'On' $keepalive_timeout = 15 $max_keepalive_requests = 100 $fastcgi_lib_path = undef # TODO: revisit @@ -515,6 +675,8 @@ class apache::params inherits ::apache::version { $server_root = '/etc/apache2' $conf_dir = $httpd_dir $confd_dir = "${httpd_dir}/conf.d" + $conf_enabled = undef + $puppet_ssl_dir = "${httpd_dir}/puppet_ssl" $mod_dir = "${httpd_dir}/mods-available" $mod_enable_dir = "${httpd_dir}/mods-enabled" $vhost_dir = "${httpd_dir}/sites-available" @@ -526,26 +688,36 @@ class apache::params inherits ::apache::version { $logroot_mode = undef $lib_path = '/usr/lib64/apache2' #changes for some modules based on mpm $mpm_module = 'prefork' - $default_ssl_cert = '/etc/apache2/ssl.crt/server.crt' - $default_ssl_key = '/etc/apache2/ssl.key/server.key' - $ssl_certs_dir = '/etc/ssl/certs' + if versioncmp($::operatingsystemrelease, '15') < 0 { + $default_ssl_cert = '/etc/apache2/ssl.crt/server.crt' + $default_ssl_key = '/etc/apache2/ssl.key/server.key' + $php_version = '5' + } else { + $default_ssl_cert = '/etc/apache2/ssl.crt/default-server.crt' + $default_ssl_key = '/etc/apache2/ssl.key/default-server.key' + $php_version = '7' + } + $suphp_configpath = "/etc/php${php_version}/apache2" $ssl_sessioncache = '/var/lib/apache2/ssl_scache(512000)' $suphp_addhandler = 'x-httpd-php' $suphp_engine = 'off' - $suphp_configpath = '/etc/php5/apache2' - $php_version = '5' - if $::operatingsystemrelease < '11' or $::operatingsystemrelease >= '12' { - $mod_packages = { + if versioncmp($::operatingsystemrelease, '11') < 0 or versioncmp($::operatingsystemrelease, '12') >= 0 { + $mod_packages = { 'auth_kerb' => 'apache2-mod_auth_kerb', + 'auth_gssapi' => 'apache2-mod_auth_gssapi', + 'dav_svn' => 'subversion-server', 'perl' => 'apache2-mod_perl', 'php5' => 'apache2-mod_php5', + 'php7' => 'apache2-mod_php7', 'python' => 'apache2-mod_python', 'security' => 'apache2-mod_security2', 'worker' => 'apache2-worker', - } + } } else { $mod_packages = { 'auth_kerb' => 'apache2-mod_auth_kerb', + 'auth_gssapi' => 'apache2-mod_auth_gssapi', + 'dav_svn' => 'subversion-server', 'perl' => 'apache2-mod_perl', 'php5' => 'apache2-mod_php53', 'python' => 'apache2-mod_python', @@ -558,7 +730,7 @@ class apache::params inherits ::apache::version { } $conf_template = 'apache/httpd.conf.erb' $http_protocol_options = undef - $keepalive = 'Off' + $keepalive = 'On' $keepalive_timeout = 15 $max_keepalive_requests = 100 $fastcgi_lib_path = '/var/lib/apache2/fastcgi' @@ -572,6 +744,7 @@ class apache::params inherits ::apache::version { $alias_icons_path = '/usr/share/apache2/icons' $error_documents_path = '/usr/share/apache2/error' $dev_packages = ['libapr-util1-devel', 'libapr1-devel', 'libcurl-devel'] + $modsec_version = 1 $modsec_crs_package = undef $modsec_crs_path = undef $modsec_default_rules = undef @@ -594,8 +767,23 @@ class apache::params inherits ::apache::version { $passenger_ruby = '/usr/bin/ruby' $passenger_default_ruby = '/usr/bin/ruby' $wsgi_socket_prefix = undef - } else { fail("Class['apache::params']: Unsupported osfamily: ${::osfamily}") } + + if $::operatingsystem == 'SLES' { + $verify_command = '/usr/sbin/apache2ctl -t' + } elsif $::operatingsystem == 'FreeBSD' { + $verify_command = '/usr/local/sbin/apachectl -t' + } elsif ($apache::version::scl_httpd_version) { + $verify_command = "/opt/rh/${_scl_httpd_name}/root/usr/sbin/apachectl -t" + } else { + $verify_command = '/usr/sbin/apachectl -t' + } + + if $::osfamily == 'RedHat' and versioncmp($facts['operatingsystemmajrelease'], '8') >= 0 { + $ssl_protocol = ['all'] # Implementations of the SSLv2 and SSLv3 protocol versions have been removed from OpenSSL (and hence mod_ssl) because these are no longer considered secure. For additional documentation https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/deploying_different_types_of_servers/setting-apache-web-server_deploying-different-types-of-servers + } else { + $ssl_protocol = ['all', '-SSLv2', '-SSLv3'] + } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/peruser/multiplexer.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/peruser/multiplexer.pp index 97143a1d4..5001090c4 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/peruser/multiplexer.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/peruser/multiplexer.pp @@ -1,6 +1,12 @@ +# @summary +# Checks if an Apache module has a class. +# +# If Apache has a class, it includes that class. If it does not, it passes the module name to the `apache::mod` defined type. +# +# @api private define apache::peruser::multiplexer ( - $user = $::apache::user, - $group = $::apache::group, + $user = $apache::user, + $group = $apache::group, $file = undef, ) { if ! $file { @@ -8,10 +14,10 @@ define apache::peruser::multiplexer ( } else { $filename = $file } - file { "${::apache::mod_dir}/peruser/multiplexers/${filename}": + file { "${apache::mod_dir}/peruser/multiplexers/${filename}": ensure => file, content => "Multiplexer ${user} ${group}\n", - require => File["${::apache::mod_dir}/peruser/multiplexers"], + require => File["${apache::mod_dir}/peruser/multiplexers"], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/peruser/processor.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/peruser/processor.pp index 30de61d7c..57c26fa9f 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/peruser/processor.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/peruser/processor.pp @@ -1,3 +1,7 @@ +# @summary +# Enables the `Peruser` module for FreeBSD only. +# +# @api private define apache::peruser::processor ( $user, $group, @@ -8,10 +12,10 @@ define apache::peruser::processor ( } else { $filename = $file } - file { "${::apache::mod_dir}/peruser/processors/${filename}": + file { "${apache::mod_dir}/peruser/processors/${filename}": ensure => file, content => "Processor ${user} ${group}\n", - require => File["${::apache::mod_dir}/peruser/processors"], + require => File["${apache::mod_dir}/peruser/processors"], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/php.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/php.pp index 9fa9c682e..32999a929 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/php.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/php.pp @@ -1,18 +1,11 @@ -# Class: apache::php +# @summary +# This class installs PHP for Apache. # -# This class installs PHP for Apache -# -# Parameters: -# - $php_package -# -# Actions: -# - Install Apache PHP package -# -# Requires: -# -# Sample Usage: +# @note +# This class is deprecated. # +# @api private class apache::php { warning('apache::php is deprecated; please use apache::mod::php') - include ::apache::mod::php + include apache::mod::php } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/proxy.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/proxy.pp index 050f36c27..9df41958c 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/proxy.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/proxy.pp @@ -1,15 +1,11 @@ -# Class: apache::proxy +# @summary +# This class enabled the proxy module for Apache. # -# This class enabled the proxy module for Apache -# -# Actions: -# - Enables Apache Proxy module -# -# Requires: -# -# Sample Usage: +# @note +# This class is deprecated. # +# @api private class apache::proxy { warning('apache::proxy is deprecated; please use apache::mod::proxy') - include ::apache::mod::proxy + include apache::mod::proxy } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/python.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/python.pp index 723a753f8..586ed9e81 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/python.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/python.pp @@ -1,6 +1,5 @@ -# Class: apache::python -# -# This class installs Python for Apache +# @summary +# This class installs Python for Apache # # Parameters: # - $php_package @@ -12,7 +11,8 @@ # # Sample Usage: # +# @api private class apache::python { warning('apache::python is deprecated; please use apache::mod::python') - include ::apache::mod::python + include apache::mod::python } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/security/rule_link.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/security/rule_link.pp index 7edb1f442..a3f70b109 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/security/rule_link.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/security/rule_link.pp @@ -1,18 +1,21 @@ +# @summary +# Links the activated_rules from `apache::mod::security` to the respective CRS rules on disk. +# +# @api private define apache::security::rule_link () { - $parts = split($title, '/') $filename = $parts[-1] $target = $title ? { /^\// => $title, - default => "${::apache::params::modsec_crs_path}/${title}", + default => "${apache::params::modsec_crs_path}/${title}", } file { $filename: ensure => 'link', - path => "${::apache::mod::security::modsec_dir}/activated_rules/${filename}", + path => "${apache::mod::security::modsec_dir}/activated_rules/${filename}", target => $target , - require => File["${::apache::mod::security::modsec_dir}/activated_rules"], + require => File["${apache::mod::security::modsec_dir}/activated_rules"], notify => Class['apache::service'], } } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/service.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/service.pp index ff082dccb..7366e5fd3 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/service.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/service.pp @@ -1,29 +1,14 @@ -# Class: apache::service -# -# Manages the Apache daemon -# -# Parameters: -# -# Actions: -# - Manage Apache service -# -# Requires: -# -# Sample Usage: -# -# sometype { 'foo': -# notify => Class['apache::service'], -# } -# +# @summary +# Installs and configures Apache service. # +# @api private class apache::service ( - $service_name = $::apache::params::service_name, + $service_name = $apache::params::service_name, Boolean $service_enable = true, $service_ensure = 'running', Boolean $service_manage = true, $service_restart = undef ) { - # The base class must be included first because parameter defaults depend on it if ! defined(Class['apache::params']) { fail('You must include the apache::params class before using any apache defined resources') diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/ssl.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/ssl.pp index d0b36593d..a241a98a2 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/ssl.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/ssl.pp @@ -1,18 +1,11 @@ -# Class: apache::ssl +# @summary +# This class installs Apache SSL capabilities # -# This class installs Apache SSL capabilities -# -# Parameters: -# - The $ssl_package name from the apache::params class -# -# Actions: -# - Install Apache SSL capabilities -# -# Requires: -# -# Sample Usage: +# @note +# This class is deprecated. # +# @api private class apache::ssl { warning('apache::ssl is deprecated; please use apache::mod::ssl') - include ::apache::mod::ssl + include apache::mod::ssl } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/version.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/version.pp index 2d33a5f4f..f799db73b 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/version.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/version.pp @@ -1,33 +1,26 @@ -# Class: apache::version +# @summary +# Try to automatically detect the version by OS # -# Try to automatically detect the version by OS -# -class apache::version { - # This will be 5 or 6 on RedHat, 6 or wheezy on Debian, 12 or quantal on Ubuntu, etc. - $osr_array = split($::operatingsystemrelease,'[\/\.]') - $distrelease = $osr_array[0] - if ! $distrelease { - fail("Class['apache::version']: Unparsable \$::operatingsystemrelease: ${::operatingsystemrelease}") - } - +# @api private +class apache::version ( + Optional[String] $scl_httpd_version = undef, + Optional[String] $scl_php_version = undef, +) { case $::osfamily { 'RedHat': { - if ($::operatingsystem == 'Amazon') { - $default = '2.2' - } elsif ($::operatingsystem == 'Fedora' and versioncmp($distrelease, '18') >= 0) or ($::operatingsystem != 'Fedora' and versioncmp($distrelease, '7') >= 0) { + if $scl_httpd_version { + $default = $scl_httpd_version + } + elsif ($::operatingsystem == 'Amazon' and $::operatingsystemmajrelease == '2') { + $default = '2.4' + } elsif ($::operatingsystem == 'Fedora' and versioncmp($facts['operatingsystemmajrelease'], '18') >= 0) or ($::operatingsystem != 'Fedora' and versioncmp($facts['operatingsystemmajrelease'], '7') >= 0) { $default = '2.4' } else { $default = '2.2' } } 'Debian': { - if $::operatingsystem == 'Ubuntu' and versioncmp($::operatingsystemrelease, '13.10') >= 0 { - $default = '2.4' - } elsif $::operatingsystem == 'Debian' and versioncmp($distrelease, '8') >= 0 { - $default = '2.4' - } else { - $default = '2.2' - } + $default = '2.4' } 'FreeBSD': { $default = '2.4' @@ -36,7 +29,7 @@ class apache::version { $default = '2.4' } 'Suse': { - if $::operatingsystem == 'SLES' and $::operatingsystemrelease >= '12' { + if ($::operatingsystem == 'SLES' and versioncmp($facts['operatingsystemmajrelease'], '12') >= 0) or ($::operatingsystem == 'OpenSuSE' and versioncmp($facts['operatingsystemmajrelease'], '42') >= 0) { $default = '2.4' } else { $default = '2.2' diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhost.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhost.pp index 90912e92b..b5604dd26 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhost.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhost.pp @@ -1,37 +1,1802 @@ -# See README.md for usage information -define apache::vhost( +# @summary +# Allows specialised configurations for virtual hosts that possess requirements +# outside of the defaults. +# +# The apache module allows a lot of flexibility in the setup and configuration of virtual hosts. +# This flexibility is due, in part, to `vhost` being a defined resource type, which allows Apache +# to evaluate it multiple times with different parameters.
+# The `apache::vhost` defined type allows you to have specialized configurations for virtual hosts +# that have requirements outside the defaults. You can set up a default virtual host within +# the base `::apache` class, as well as set a customized virtual host as the default. +# Customized virtual hosts have a lower numeric `priority` than the base class's, causing +# Apache to process the customized virtual host first.
+# The `apache::vhost` defined type uses `concat::fragment` to build the configuration file. To +# inject custom fragments for pieces of the configuration that the defined type doesn't +# inherently support, add a custom fragment.
+# For the custom fragment's `order` parameter, the `apache::vhost` defined type uses multiples +# of 10, so any `order` that isn't a multiple of 10 should work.
+# > **Note:** When creating an `apache::vhost`, it cannot be named `default` or `default-ssl`, +# because vhosts with these titles are always managed by the module. This means that you cannot +# override `Apache::Vhost['default']` or `Apache::Vhost['default-ssl]` resources. An optional +# workaround is to create a vhost named something else, such as `my default`, and ensure that the +# `default` and `default_ssl` vhosts are set to `false`: +# +# @example +# class { 'apache': +# default_vhost => false, +# default_ssl_vhost => false, +# } +# +# @param apache_version +# Apache's version number as a string, such as '2.2' or '2.4'. +# +# @param access_log +# Determines whether to configure `*_access.log` directives (`*_file`,`*_pipe`, or `*_syslog`). +# +# @param access_log_env_var +# Specifies that only requests with particular environment variables be logged. +# +# @param access_log_file +# Sets the filename of the `*_access.log` placed in `logroot`. Given a virtual host ---for +# instance, example.com--- it defaults to 'example.com_ssl.log' for +# [SSL-encrypted](https://httpd.apache.org/docs/current/ssl/index.html) virtual hosts and +# `example.com_access.log` for unencrypted virtual hosts. +# +# @param access_log_format +# Specifies the use of either a `LogFormat` nickname or a custom-formatted string for the +# access log. +# +# @param access_log_pipe +# Specifies a pipe where Apache sends access log messages. +# +# @param access_log_syslog +# Sends all access log messages to syslog. +# +# @param access_logs +# Allows you to give a hash that specifies the state of each of the `access_log_*` +# directives shown above, i.e. `access_log_pipe` and `access_log_syslog`. +# +# @param add_default_charset +# Sets a default media charset value for the `AddDefaultCharset` directive, which is +# added to `text/plain` and `text/html` responses. +# +# @param add_listen +# Determines whether the virtual host creates a `Listen` statement.
+# Setting `add_listen` to `false` prevents the virtual host from creating a `Listen` +# statement. This is important when combining virtual hosts that aren't passed an `ip` +# parameter with those that are. +# +# @param use_optional_includes +# Specifies whether Apache uses the `IncludeOptional` directive instead of `Include` for +# `additional_includes` in Apache 2.4 or newer. +# +# @param additional_includes +# Specifies paths to additional static, virtual host-specific Apache configuration files. +# You can use this parameter to implement a unique, custom configuration not supported by +# this module. +# +# @param aliases +# Passes a list of [hashes][hash] to the virtual host to create `Alias`, `AliasMatch`, +# `ScriptAlias` or `ScriptAliasMatch` directives as per the `mod_alias` documentation.
+# For example: +# ``` puppet +# aliases => [ +# { aliasmatch => '^/image/(.*)\.jpg$', +# path => '/files/jpg.images/$1.jpg', +# }, +# { alias => '/image', +# path => '/ftp/pub/image', +# }, +# { scriptaliasmatch => '^/cgi-bin(.*)', +# path => '/usr/local/share/cgi-bin$1', +# }, +# { scriptalias => '/nagios/cgi-bin/', +# path => '/usr/lib/nagios/cgi-bin/', +# }, +# { alias => '/nagios', +# path => '/usr/share/nagios/html', +# }, +# ], +# ``` +# For the `alias`, `aliasmatch`, `scriptalias` and `scriptaliasmatch` keys to work, each needs +# a corresponding context, such as `` or +# ``. Puppet creates the directives in the order specified in +# the `aliases` parameter. As described in the `mod_alias` documentation, add more specific +# `alias`, `aliasmatch`, `scriptalias` or `scriptaliasmatch` parameters before the more +# general ones to avoid shadowing.
+# > **Note**: Use the `aliases` parameter instead of the `scriptaliases` parameter because +# you can precisely control the order of various alias directives. Defining `ScriptAliases` +# using the `scriptaliases` parameter means *all* `ScriptAlias` directives will come after +# *all* `Alias` directives, which can lead to `Alias` directives shadowing `ScriptAlias` +# directives. This often causes problems; for example, this could cause problems with Nagios.
+# If `apache::mod::passenger` is loaded and `PassengerHighPerformance` is `true`, the `Alias` +# directive might not be able to honor the `PassengerEnabled => off` statement. See +# [this article](http://www.conandalton.net/2010/06/passengerenabled-off-not-working.html) for details. +# +# @param allow_encoded_slashes +# Sets the `AllowEncodedSlashes` declaration for the virtual host, overriding the server +# default. This modifies the virtual host responses to URLs with `\` and `/` characters. The +# default setting omits the declaration from the server configuration and selects the +# Apache default setting of `Off`. +# +# @param block +# Specifies the list of things to which Apache blocks access. Valid options are: `scm` (which +# blocks web access to `.svn`), `.git`, and `.bzr` directories. +# +# @param cas_attribute_prefix +# Adds a header with the value of this header being the attribute values when SAML +# validation is enabled. +# +# @param cas_attribute_delimiter +# Sets the delimiter between attribute values in the header created by `cas_attribute_prefix`. +# +# @param cas_login_url +# Sets the URL to which the module redirects users when they attempt to access a +# CAS-protected resource and don't have an active session. +# +# @param cas_root_proxied_as +# Sets the URL end users see when access to this Apache server is proxied per vhost. +# This URL should not include a trailing slash. +# +# @param cas_scrub_request_headers +# Remove inbound request headers that may have special meaning within mod_auth_cas. +# +# @param cas_sso_enabled +# Enables experimental support for single sign out (may mangle POST data). +# +# @param cas_validate_saml +# Parse response from CAS server for SAML. +# +# @param cas_validate_url +# Sets the URL to use when validating a client-presented ticket in an HTTP query string. +# +# @param cas_cookie_path +# Sets the location where information on the current session should be stored. This should +# be writable by the web server only. +# +# @param comment +# Adds comments to the header of the configuration file. Pass as string or an array of strings. +# For example: +# ``` puppet +# comment => "Account number: 123B", +# ``` +# Or: +# ``` puppet +# comment => [ +# "Customer: X", +# "Frontend domain: x.example.org", +# ] +# ``` +# +# @param custom_fragment +# Passes a string of custom configuration directives to place at the end of the virtual +# host configuration. +# +# @param default_vhost +# Sets a given `apache::vhost` defined type as the default to serve requests that do not +# match any other `apache::vhost` defined types. +# +# @param directoryindex +# Sets the list of resources to look for when a client requests an index of the directory +# by specifying a '/' at the end of the directory name. See the `DirectoryIndex` directive +# documentation for details. +# +# @param docroot +# **Required**.
+# Sets the `DocumentRoot` location, from which Apache serves files.
+# If `docroot` and `manage_docroot` are both set to `false`, no `DocumentRoot` will be set +# and the accompanying `` block will not be created. +# +# @param docroot_group +# Sets group access to the `docroot` directory. +# +# @param docroot_owner +# Sets individual user access to the `docroot` directory. +# +# @param docroot_mode +# Sets access permissions for the `docroot` directory, in numeric notation. +# +# @param manage_docroot +# Determines whether Puppet manages the `docroot` directory. +# +# @param error_log +# Specifies whether `*_error.log` directives should be configured. +# +# @param error_log_file +# Points the virtual host's error logs to a `*_error.log` file. If this parameter is +# undefined, Puppet checks for values in `error_log_pipe`, then `error_log_syslog`.
+# If none of these parameters is set, given a virtual host `example.com`, Puppet defaults +# to `$logroot/example.com_error_ssl.log` for SSL virtual hosts and +# `$logroot/example.com_error.log` for non-SSL virtual hosts. +# +# @param error_log_pipe +# Specifies a pipe to send error log messages to.
+# This parameter has no effect if the `error_log_file` parameter has a value. If neither +# this parameter nor `error_log_file` has a value, Puppet then checks `error_log_syslog`. +# +# @param error_log_syslog +# Determines whether to send all error log messages to syslog. +# This parameter has no effect if either of the `error_log_file` or `error_log_pipe` +# parameters has a value. If none of these parameters has a value, given a virtual host +# `example.com`, Puppet defaults to `$logroot/example.com_error_ssl.log` for SSL virtual +# hosts and `$logroot/example.com_error.log` for non-SSL virtual hosts. +# +# @param error_log_format +# Sets the [ErrorLogFormat](https://httpd.apache.org/docs/current/mod/core.html#errorlogformat) +# format specification for error log entries inside virtual host +# For example: +# ``` puppet +# apache::vhost { 'site.name.fdqn': +# ... +# error_log_format => [ +# '[%{uc}t] [%-m:%-l] [R:%L] [C:%{C}L] %7F: %E: %M', +# { '[%{uc}t] [R:%L] Request %k on C:%{c}L pid:%P tid:%T' => 'request' }, +# { "[%{uc}t] [R:%L] UA:'%+{User-Agent}i'" => 'request' }, +# { "[%{uc}t] [R:%L] Referer:'%+{Referer}i'" => 'request' }, +# { '[%{uc}t] [C:%{c}L] local\ %a remote\ %A' => 'connection' }, +# ], +# } +# ``` +# +# @param error_documents +# A list of hashes which can be used to override the +# [ErrorDocument](https://httpd.apache.org/docs/current/mod/core.html#errordocument) +# settings for this virtual host.
+# For example: +# ``` puppet +# apache::vhost { 'sample.example.net': +# error_documents => [ +# { 'error_code' => '503', 'document' => '/service-unavail' }, +# { 'error_code' => '407', 'document' => 'https://example.com/proxy/login' }, +# ], +# } +# ``` +# +# @param ensure +# Specifies if the virtual host is present or absent.
+# +# @param fallbackresource +# Sets the [FallbackResource](https://httpd.apache.org/docs/current/mod/mod_dir.html#fallbackresource) +# directive, which specifies an action to take for any URL that doesn't map to anything in +# your filesystem and would otherwise return 'HTTP 404 (Not Found)'. Values must either begin +# with a `/` or be `disabled`. +# +# @param fastcgi_server +# Specify an external FastCGI server to manage a connection to. +# +# @param fastcgi_socket +# Specify the socket that will be used to communicate with an external FastCGI server. +# +# @param fastcgi_idle_timeout +# If using fastcgi, this option sets the timeout for the server to respond. +# +# @param fastcgi_dir +# Specify an internal FastCGI directory that is to be managed. +# +# @param filters +# [Filters](https://httpd.apache.org/docs/current/mod/mod_filter.html) enable smart, +# context-sensitive configuration of output content filters. +# ``` puppet +# apache::vhost { "$::fqdn": +# filters => [ +# 'FilterDeclare COMPRESS', +# 'FilterProvider COMPRESS DEFLATE resp=Content-Type $text/html', +# 'FilterChain COMPRESS', +# 'FilterProtocol COMPRESS DEFLATE change=yes;byteranges=no', +# ], +# } +# ``` +# +# @param h2_copy_files +# Sets the [H2CopyFiles](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2copyfiles) +# directive which influences how the requestion process pass files to the main connection. +# +# @param h2_direct +# Sets the [H2Direct](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2direct) +# directive which toggles the usage of the HTTP/2 Direct Mode. +# +# @param h2_early_hints +# Sets the [H2EarlyHints](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2earlyhints) +# directive which controls if HTTP status 103 interim responses are forwarded to +# the client or not. +# +# @param h2_max_session_streams +# Sets the [H2MaxSessionStreams](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2maxsessionstreams) +# directive which sets the maximum number of active streams per HTTP/2 session +# that the server allows. +# +# @param h2_modern_tls_only +# Sets the [H2ModernTLSOnly](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2moderntlsonly) +# directive which toggles the security checks on HTTP/2 connections in TLS mode. +# +# @param h2_push +# Sets the [H2Push](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2push) +# directive which toggles the usage of the HTTP/2 server push protocol feature. +# +# @param h2_push_diary_size +# Sets the [H2PushDiarySize](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2pushdiarysize) +# directive which toggles the maximum number of HTTP/2 server pushes that are +# remembered per HTTP/2 connection. +# +# @param h2_push_priority +# Sets the [H2PushPriority](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2pushpriority) +# directive which defines the priority handling of pushed responses based on the +# content-type of the response. +# +# @param h2_push_resource +# Sets the [H2PushResource](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2pushresource) +# directive which declares resources for early pushing to the client. +# +# @param h2_serialize_headers +# Sets the [H2SerializeHeaders](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2serializeheaders) +# directive which toggles if HTTP/2 requests are serialized in HTTP/1.1 +# format for processing by httpd core. +# +# @param h2_stream_max_mem_size +# Sets the [H2StreamMaxMemSize](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2streammaxmemsize) +# directive which sets the maximum number of outgoing data bytes buffered in +# memory for an active stream. +# +# @param h2_tls_cool_down_secs +# Sets the [H2TLSCoolDownSecs](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2tlscooldownsecs) +# directive which sets the number of seconds of idle time on a TLS connection +# before the TLS write size falls back to a small (~1300 bytes) length. +# +# @param h2_tls_warm_up_size +# Sets the [H2TLSWarmUpSize](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2tlswarmupsize) +# directive which sets the number of bytes to be sent in small TLS records (~1300 +# bytes) until doing maximum sized writes (16k) on https: HTTP/2 connections. +# +# @param h2_upgrade +# Sets the [H2Upgrade](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2upgrade) +# directive which toggles the usage of the HTTP/1.1 Upgrade method for switching +# to HTTP/2. +# +# @param h2_window_size +# Sets the [H2WindowSize](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2windowsize) +# directive which sets the size of the window that is used for flow control from +# client to server and limits the amount of data the server has to buffer. +# +# @param headers +# Adds lines to replace, merge, or remove response headers. See +# [Apache's mod_headers documentation](https://httpd.apache.org/docs/current/mod/mod_headers.html#header) for more information. +# +# @param ip +# Sets the IP address the virtual host listens on. By default, uses Apache's default behavior +# of listening on all IPs. +# +# @param ip_based +# Enables an [IP-based](https://httpd.apache.org/docs/current/vhosts/ip-based.html) virtual +# host. This parameter inhibits the creation of a NameVirtualHost directive, since those are +# used to funnel requests to name-based virtual hosts. +# +# @param itk +# Configures [ITK](http://mpm-itk.sesse.net/) in a hash.
+# Usage typically looks something like: +# ``` puppet +# apache::vhost { 'sample.example.net': +# docroot => '/path/to/directory', +# itk => { +# user => 'someuser', +# group => 'somegroup', +# }, +# } +# ``` +# Valid values are: a hash, which can include the keys: +# * `user` + `group` +# * `assignuseridexpr` +# * `assigngroupidexpr` +# * `maxclientvhost` +# * `nice` +# * `limituidrange` (Linux 3.5.0 or newer) +# * `limitgidrange` (Linux 3.5.0 or newer) +# +# @param action +# Specifies whether you wish to configure mod_actions action directive which will +# activate cgi-script when triggered by a request. +# +# @param jk_mounts +# Sets up a virtual host with `JkMount` and `JkUnMount` directives to handle the paths +# for URL mapping between Tomcat and Apache.
+# The parameter must be an array of hashes where each hash must contain the `worker` +# and either the `mount` or `unmount` keys.
+# Usage typically looks like: +# ``` puppet +# apache::vhost { 'sample.example.net': +# jk_mounts => [ +# { mount => '/*', worker => 'tcnode1', }, +# { unmount => '/*.jpg', worker => 'tcnode1', }, +# ], +# } +# ``` +# +# @param http_protocol_options +# Specifies the strictness of HTTP protocol checks. +# +# @param keepalive +# Determines whether to enable persistent HTTP connections with the `KeepAlive` directive +# for the virtual host. By default, the global, server-wide `KeepAlive` setting is in effect.
+# Use the `keepalive_timeout` and `max_keepalive_requests` parameters to set relevant options +# for the virtual host. +# +# @param keepalive_timeout +# Sets the `KeepAliveTimeout` directive for the virtual host, which determines the amount +# of time to wait for subsequent requests on a persistent HTTP connection. By default, the +# global, server-wide `KeepAlive` setting is in effect.
+# This parameter is only relevant if either the global, server-wide `keepalive` parameter or +# the per-vhost `keepalive` parameter is enabled. +# +# @param max_keepalive_requests +# Limits the number of requests allowed per connection to the virtual host. By default, +# the global, server-wide `KeepAlive` setting is in effect.
+# This parameter is only relevant if either the global, server-wide `keepalive` parameter or +# the per-vhost `keepalive` parameter is enabled. +# +# @param auth_kerb +# Enable `mod_auth_kerb` parameters for a virtual host.
+# Usage typically looks like: +# ``` puppet +# apache::vhost { 'sample.example.net': +# auth_kerb => `true`, +# krb_method_negotiate => 'on', +# krb_auth_realms => ['EXAMPLE.ORG'], +# krb_local_user_mapping => 'on', +# directories => { +# path => '/var/www/html', +# auth_name => 'Kerberos Login', +# auth_type => 'Kerberos', +# auth_require => 'valid-user', +# }, +# } +# ``` +# +# @param krb_method_negotiate +# Determines whether to use the Negotiate method. +# +# @param krb_method_k5passwd +# Determines whether to use password-based authentication for Kerberos v5. +# +# @param krb_authoritative +# If set to `off`, authentication controls can be passed on to another module. +# +# @param krb_auth_realms +# Specifies an array of Kerberos realms to use for authentication. +# +# @param krb_5keytab +# Specifies the Kerberos v5 keytab file's location. +# +# @param krb_local_user_mapping +# Strips @REALM from usernames for further use. +# +# @param krb_verify_kdc +# This option can be used to disable the verification tickets against local keytab to prevent +# KDC spoofing attacks. +# +# @param krb_servicename +# Specifies the service name that will be used by Apache for authentication. Corresponding +# key of this name must be stored in the keytab. +# +# @param krb_save_credentials +# This option enables credential saving functionality. +# +# @param logroot +# Specifies the location of the virtual host's logfiles. +# +# @param logroot_ensure +# Determines whether or not to remove the logroot directory for a virtual host. +# +# @param logroot_mode +# Overrides the mode the logroot directory is set to. Do *not* grant write access to the +# directory the logs are stored in without being aware of the consequences; for more +# information, see [Apache's log security documentation](https://httpd.apache.org/docs/2.4/logs.html#security). +# +# @param logroot_owner +# Sets individual user access to the logroot directory. +# +# @param logroot_group +# Sets group access to the `logroot` directory. +# +# @param log_level +# Specifies the verbosity of the error log. +# +# @param modsec_body_limit +# Configures the maximum request body size (in bytes) ModSecurity accepts for buffering. +# +# @param modsec_disable_vhost +# Disables `mod_security` on a virtual host. Only valid if `apache::mod::security` is included. +# +# @param modsec_disable_ids +# Removes `mod_security` IDs from the virtual host.
+# Also takes a hash allowing removal of an ID from a specific location. +# ``` puppet +# apache::vhost { 'sample.example.net': +# modsec_disable_ids => [ 90015, 90016 ], +# } +# ``` +# +# ``` puppet +# apache::vhost { 'sample.example.net': +# modsec_disable_ids => { '/location1' => [ 90015, 90016 ] }, +# } +# ``` +# +# @param modsec_disable_ips +# Specifies an array of IP addresses to exclude from `mod_security` rule matching. +# +# @param modsec_disable_msgs +# Array of mod_security Msgs to remove from the virtual host. Also takes a hash allowing +# removal of an Msg from a specific location. +# ``` puppet +# apache::vhost { 'sample.example.net': +# modsec_disable_msgs => ['Blind SQL Injection Attack', 'Session Fixation Attack'], +# } +# ``` +# ``` puppet +# apache::vhost { 'sample.example.net': +# modsec_disable_msgs => { '/location1' => ['Blind SQL Injection Attack', 'Session Fixation Attack'] }, +# } +# ``` +# +# @param modsec_disable_tags +# Array of mod_security Tags to remove from the virtual host. Also takes a hash allowing +# removal of an Tag from a specific location. +# ``` puppet +# apache::vhost { 'sample.example.net': +# modsec_disable_tags => ['WEB_ATTACK/SQL_INJECTION', 'WEB_ATTACK/XSS'], +# } +# ``` +# ``` puppet +# apache::vhost { 'sample.example.net': +# modsec_disable_tags => { '/location1' => ['WEB_ATTACK/SQL_INJECTION', 'WEB_ATTACK/XSS'] }, +# } +# ``` +# +# @param modsec_audit_log_file +# If set, it is relative to `logroot`.
+# One of the parameters that determines how to send `mod_security` audit +# log ([SecAuditLog](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#SecAuditLog)). +# If none of those parameters are set, the global audit log is used +# (`/var/log/httpd/modsec\_audit.log`; Debian and derivatives: `/var/log/apache2/modsec\_audit.log`; others: ). +# +# @param modsec_audit_log_pipe +# If `modsec_audit_log_pipe` is set, it should start with a pipe. Example +# `|/path/to/mlogc /path/to/mlogc.conf`.
+# One of the parameters that determines how to send `mod_security` audit +# log ([SecAuditLog](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#SecAuditLog)). +# If none of those parameters are set, the global audit log is used +# (`/var/log/httpd/modsec\_audit.log`; Debian and derivatives: `/var/log/apache2/modsec\_audit.log`; others: ). +# +# @param modsec_audit_log +# If `modsec_audit_log` is `true`, given a virtual host ---for instance, example.com--- it +# defaults to `example.com\_security\_ssl.log` for SSL-encrypted virtual hosts +# and `example.com\_security.log` for unencrypted virtual hosts.
+# One of the parameters that determines how to send `mod_security` audit +# log ([SecAuditLog](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#SecAuditLog)).
+# If none of those parameters are set, the global audit log is used +# (`/var/log/httpd/modsec\_audit.log`; Debian and derivatives: `/var/log/apache2/modsec\_audit.log`; others: ). +# +# @param no_proxy_uris +# Specifies URLs you do not want to proxy. This parameter is meant to be used in combination +# with [`proxy_dest`](#proxy_dest). +# +# @param no_proxy_uris_match +# This directive is equivalent to `no_proxy_uris`, but takes regular expressions. +# +# @param proxy_preserve_host +# Sets the [ProxyPreserveHost Directive](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypreservehost).
+# Setting this parameter to `true` enables the `Host:` line from an incoming request to be +# proxied to the host instead of hostname. Setting it to `false` sets this directive to 'Off'. +# +# @param proxy_add_headers +# Sets the [ProxyAddHeaders Directive](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyaddheaders).
+# This parameter controlls whether proxy-related HTTP headers (X-Forwarded-For, +# X-Forwarded-Host and X-Forwarded-Server) get sent to the backend server. +# +# @param proxy_error_override +# Sets the [ProxyErrorOverride Directive](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyerroroverride). +# This directive controls whether Apache should override error pages for proxied content. +# +# @param options +# Sets the `Options` for the specified virtual host. For example: +# ``` puppet +# apache::vhost { 'site.name.fdqn': +# ... +# options => ['Indexes','FollowSymLinks','MultiViews'], +# } +# ``` +# > **Note**: If you use the `directories` parameter of `apache::vhost`, 'Options', +# 'Override', and 'DirectoryIndex' are ignored because they are parameters within `directories`. +# +# @param override +# Sets the overrides for the specified virtual host. Accepts an array of +# [AllowOverride](https://httpd.apache.org/docs/current/mod/core.html#allowoverride) arguments. +# +# @param passenger_enabled +# Sets the value for the [PassengerEnabled](http://www.modrails.com/documentation/Users%20guide%20Apache.html#PassengerEnabled) +# directive to `on` or `off`. Requires `apache::mod::passenger` to be included. +# ``` puppet +# apache::vhost { 'sample.example.net': +# docroot => '/path/to/directory', +# directories => [ +# { path => '/path/to/directory', +# passenger_enabled => 'on', +# }, +# ], +# } +# ``` +# > **Note:** There is an [issue](http://www.conandalton.net/2010/06/passengerenabled-off-not-working.html) +# using the PassengerEnabled directive with the PassengerHighPerformance directive. +# +# @param passenger_base_uri +# Sets [PassengerBaseURI](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerbase_rui), +# to specify that the given URI is a distinct application served by Passenger. +# +# @param passenger_ruby +# Sets [PassengerRuby](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerruby), +# specifying the Ruby interpreter to use when serving the relevant web applications. +# +# @param passenger_python +# Sets [PassengerPython](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerpython), +# specifying the Python interpreter to use when serving the relevant web applications. +# +# @param passenger_nodejs +# Sets the [`PassengerNodejs`](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengernodejs), +# specifying Node.js command to use when serving the relevant web applications. +# +# @param passenger_meteor_app_settings +# Sets [PassengerMeteorAppSettings](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermeteorappsettings), +# specifying a JSON file with settings for the application when using a Meteor +# application in non-bundled mode. +# +# @param passenger_app_env +# Sets [PassengerAppEnv](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerappenv), +# the environment for the Passenger application. If not specified, defaults to the global +# setting or 'production'. +# +# @param passenger_app_root +# Sets [PassengerRoot](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerapproot), +# the location of the Passenger application root if different from the DocumentRoot. +# +# @param passenger_app_group_name +# Sets [PassengerAppGroupName](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerappgroupname), +# the name of the application group that the current application should belong to. +# +# @param passenger_app_start_command +# Sets [PassengerAppStartCommand](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerappstartcommand), +# how Passenger should start your app on a specific port. +# +# @param passenger_app_type +# Sets [PassengerAppType](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerapptype), +# to force Passenger to recognize the application as a specific type. +# +# @param passenger_startup_file +# Sets the [PassengerStartupFile](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstartupfile), +# path. This path is relative to the application root. +# +# @param passenger_restart_dir +# Sets the [PassengerRestartDir](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerrestartdir), +# to customize the directory in which `restart.txt` is searched for. +# +# @param passenger_spawn_method +# Sets [PassengerSpawnMethod](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerspawnmethod), +# whether Passenger spawns applications directly, or using a prefork copy-on-write mechanism. +# +# @param passenger_load_shell_envvars +# Sets [PassengerLoadShellEnvvars](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerloadshellenvvars), +# to enable or disable the loading of shell environment variables before spawning the application. +# +# @param passenger_rolling_restarts +# Sets [PassengerRollingRestarts](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerrollingrestarts), +# to enable or disable support for zero-downtime application restarts through `restart.txt`. +# +# @param passenger_resist_deployment_errors +# Sets [PassengerResistDeploymentErrors](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerresistdeploymenterrors), +# to enable or disable resistance against deployment errors. +# +# @param passenger_user +# Sets [PassengerUser](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengeruser), +# the running user for sandboxing applications. +# +# @param passenger_group +# Sets [PassengerGroup](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengergroup), +# the running group for sandboxing applications. +# +# @param passenger_friendly_error_pages +# Sets [PassengerFriendlyErrorPages](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerfriendlyerrorpages), +# which can display friendly error pages whenever an application fails to start. This +# friendly error page presents the startup error message, some suggestions for solving +# the problem, a backtrace and a dump of the environment variables. +# +# @param passenger_min_instances +# Sets [PassengerMinInstances](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermininstances), +# the minimum number of application processes to run. +# +# @param passenger_max_instances +# Sets [PassengerMaxInstances](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxinstances), +# the maximum number of application processes to run. +# +# @param passenger_max_preloader_idle_time +# Sets [PassengerMaxPreloaderIdleTime](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxpreloaderidletime), +# the maximum amount of time the preloader waits before shutting down an idle process. +# +# @param passenger_force_max_concurrent_requests_per_process +# Sets [PassengerForceMaxConcurrentRequestsPerProcess](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerforcemaxconcurrentrequestsperprocess), +# the maximum amount of concurrent requests the application can handle per process. +# +# @param passenger_start_timeout +# Sets [PassengerStartTimeout](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstarttimeout), +# the timeout for the application startup. +# +# @param passenger_concurrency_model +# Sets [PassengerConcurrencyModel](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerconcurrencyodel), +# to specify the I/O concurrency model that should be used for Ruby application processes. +# Passenger supports two concurrency models:
+# * `process` - single-threaded, multi-processed I/O concurrency. +# * `thread` - multi-threaded, multi-processed I/O concurrency. +# +# @param passenger_thread_count +# Sets [PassengerThreadCount](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerthreadcount), +# the number of threads that Passenger should spawn per Ruby application process.
+# This option only has effect if PassengerConcurrencyModel is `thread`. +# +# @param passenger_max_requests +# Sets [PassengerMaxRequests](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxrequests), +# the maximum number of requests an application process will process. +# +# @param passenger_max_request_time +# Sets [PassengerMaxRequestTime](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxrequesttime), +# the maximum amount of time, in seconds, that an application process may take to +# process a request. +# +# @param passenger_memory_limit +# Sets [PassengerMemoryLimit](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermemorylimit), +# the maximum amount of memory that an application process may use, in megabytes. +# +# @param passenger_stat_throttle_rate +# Sets [PassengerStatThrottleRate](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstatthrottlerate), +# to set a limit, in seconds, on how often Passenger will perform it's filesystem checks. +# +# @param passenger_pre_start +# Sets [PassengerPreStart](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerprestart), +# the URL of the application if pre-starting is required. +# +# @param passenger_high_performance +# Sets [PassengerHighPerformance](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerhighperformance), +# to enhance performance in return for reduced compatibility. +# +# @param passenger_buffer_upload +# Sets [PassengerBufferUpload](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerbufferupload), +# to buffer HTTP client request bodies before they are sent to the application. +# +# @param passenger_buffer_response +# Sets [PassengerBufferResponse](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerbufferresponse), +# to buffer Happlication-generated responses. +# +# @param passenger_error_override +# Sets [PassengerErrorOverride](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengererroroverride), +# to specify whether Apache will intercept and handle response with HTTP status codes of +# 400 and higher. +# +# @param passenger_max_request_queue_size +# Sets [PassengerMaxRequestQueueSize](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxrequestqueuesize), +# to specify the maximum amount of requests that are allowed to queue whenever the maximum +# concurrent request limit is reached. If the queue is already at this specified limit, then +# Passenger immediately sends a "503 Service Unavailable" error to any incoming requests.
+# A value of 0 means that the queue size is unbounded. +# +# @param passenger_max_request_queue_time +# Sets [PassengerMaxRequestQueueTime](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengermaxrequestqueuetime), +# to specify the maximum amount of time that requests are allowed to stay in the queue +# whenever the maximum concurrent request limit is reached. If a request reaches this specified +# limit, then Passenger immeaditly sends a "504 Gateway Timeout" error for that request.
+# A value of 0 means that the queue time is unbounded. +# +# @param passenger_sticky_sessions +# Sets [PassengerStickySessions](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstickysessions), +# to specify that, whenever possible, all requests sent by a client will be routed to the same +# originating application process. +# +# @param passenger_sticky_sessions_cookie_name +# Sets [PassengerStickySessionsCookieName](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstickysessionscookiename), +# to specify the name of the sticky sessions cookie. +# +# @param passenger_sticky_sessions_cookie_attributes +# Sets [PassengerStickySessionsCookieAttributes](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerstickysessionscookieattributes), +# the attributes of the sticky sessions cookie. +# +# @param passenger_allow_encoded_slashes +# Sets [PassengerAllowEncodedSlashes](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerallowencodedslashes), +# to allow URLs with encoded slashes. Please note that this feature will not work properly +# unless Apache's `AllowEncodedSlashes` is also enabled. +# +# @param passenger_app_log_file +# Sets [PassengerAppLogFile](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerapplogfile), +# app specific messages logged to a different file in addition to Passenger log file. +# +# @param passenger_debugger +# Sets [PassengerDebugger](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerdebugger), +# to turn support for Ruby application debugging on or off. +# +# @param passenger_lve_min_uid +# Sets [PassengerLveMinUid](https://www.phusionpassenger.com/docs/references/config_reference/apache/#passengerlveminuid), +# to only allow the spawning of application processes with UIDs equal to, or higher than, this +# specified value on LVE-enabled kernels. +# +# @param php_values +# Allows per-virtual host setting [`php_value`s](http://php.net/manual/en/configuration.changes.php). +# These flags or values can be overwritten by a user or an application. +# Within a vhost declaration: +# ``` puppet +# php_values => [ 'include_path ".:/usr/local/example-app/include"' ], +# ``` +# +# @param php_flags +# Allows per-virtual host setting [`php_flags\``](http://php.net/manual/en/configuration.changes.php). +# These flags or values can be overwritten by a user or an application. +# +# @param php_admin_values +# Allows per-virtual host setting [`php_admin_value`](http://php.net/manual/en/configuration.changes.php). +# These flags or values cannot be overwritten by a user or an application. +# +# @param php_admin_flags +# Allows per-virtual host setting [`php_admin_flag`](http://php.net/manual/en/configuration.changes.php). +# These flags or values cannot be overwritten by a user or an application. +# +# @param port +# Sets the port the host is configured on. The module's defaults ensure the host listens +# on port 80 for non-SSL virtual hosts and port 443 for SSL virtual hosts. The host only +# listens on the port set in this parameter. +# +# @param priority +# Sets the relative load-order for Apache HTTPD VirtualHost configuration files.
+# If nothing matches the priority, the first name-based virtual host is used. Likewise, +# passing a higher priority causes the alphabetically first name-based virtual host to be +# used if no other names match.
+# > **Note:** You should not need to use this parameter. However, if you do use it, be +# aware that the `default_vhost` parameter for `apache::vhost` passes a priority of '15'.
+# To omit the priority prefix in file names, pass a priority of `false`. +# +# @param protocols +# Sets the [Protocols](https://httpd.apache.org/docs/current/en/mod/core.html#protocols) +# directive, which lists available protocols for the virutal host. +# +# @param protocols_honor_order +# Sets the [ProtocolsHonorOrder](https://httpd.apache.org/docs/current/en/mod/core.html#protocolshonororder) +# directive which determines wether the order of Protocols sets precedence during negotiation. +# +# @param proxy_dest +# Specifies the destination address of a [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass) configuration. +# +# @param proxy_pass +# Specifies an array of `path => URI` values for a [ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass) +# configuration. Optionally, parameters can be added as an array. +# ``` puppet +# apache::vhost { 'site.name.fdqn': +# ... +# proxy_pass => [ +# { 'path' => '/a', 'url' => 'http://backend-a/' }, +# { 'path' => '/b', 'url' => 'http://backend-b/' }, +# { 'path' => '/c', 'url' => 'http://backend-a/c', 'params' => {'max'=>20, 'ttl'=>120, 'retry'=>300}}, +# { 'path' => '/l', 'url' => 'http://backend-xy', +# 'reverse_urls' => ['http://backend-x', 'http://backend-y'] }, +# { 'path' => '/d', 'url' => 'http://backend-a/d', +# 'params' => { 'retry' => '0', 'timeout' => '5' }, }, +# { 'path' => '/e', 'url' => 'http://backend-a/e', +# 'keywords' => ['nocanon', 'interpolate'] }, +# { 'path' => '/f', 'url' => 'http://backend-f/', +# 'setenv' => ['proxy-nokeepalive 1','force-proxy-request-1.0 1']}, +# { 'path' => '/g', 'url' => 'http://backend-g/', +# 'reverse_cookies' => [{'path' => '/g', 'url' => 'http://backend-g/',}, {'domain' => 'http://backend-g', 'url' => 'http:://backend-g',},], }, +# { 'path' => '/h', 'url' => 'http://backend-h/h', +# 'no_proxy_uris' => ['/h/admin', '/h/server-status'] }, +# ], +# } +# ``` +# * `reverse_urls`. *Optional.* This setting is useful when used with `mod_proxy_balancer`. Values: an array or string. +# * `reverse_cookies`. *Optional.* Sets `ProxyPassReverseCookiePath` and `ProxyPassReverseCookieDomain`. +# * `params`. *Optional.* Allows for ProxyPass key-value parameters, such as connection settings. +# * `setenv`. *Optional.* Sets [environment variables](https://httpd.apache.org/docs/current/mod/mod_proxy.html#envsettings) for the proxy directive. Values: array. +# +# @param proxy_dest_match +# This directive is equivalent to `proxy_dest`, but takes regular expressions, see +# [ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch) +# for details. +# +# @param proxy_dest_reverse_match +# Allows you to pass a ProxyPassReverse if `proxy_dest_match` is specified. See +# [ProxyPassReverse](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassreverse) +# for details. +# +# @param proxy_pass_match +# This directive is equivalent to `proxy_pass`, but takes regular expressions, see +# [ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch) +# for details. +# +# @param redirect_dest +# Specifies the address to redirect to. +# +# @param redirect_source +# Specifies the source URIs that redirect to the destination specified in `redirect_dest`. +# If more than one item for redirect is supplied, the source and destination must be the same +# length, and the items are order-dependent. +# ``` puppet +# apache::vhost { 'site.name.fdqn': +# ... +# redirect_source => ['/images','/downloads'], +# redirect_dest => ['http://img.example.com/','http://downloads.example.com/'], +# } +# ``` +# +# @param redirect_status +# Specifies the status to append to the redirect. +# ``` puppet +# apache::vhost { 'site.name.fdqn': +# ... +# redirect_status => ['temp','permanent'], +# } +# ``` +# +# @param redirectmatch_regexp +# Determines which server status should be raised for a given regular expression +# and where to forward the user to. Entered as an array alongside redirectmatch_status +# and redirectmatch_dest. +# ``` puppet +# apache::vhost { 'site.name.fdqn': +# ... +# redirectmatch_status => ['404','404'], +# redirectmatch_regexp => ['\.git(/.*|$)/','\.svn(/.*|$)'], +# redirectmatch_dest => ['http://www.example.com/$1','http://www.example.com/$2'], +# } +# ``` +# +# @param redirectmatch_status +# Determines which server status should be raised for a given regular expression +# and where to forward the user to. Entered as an array alongside redirectmatch_regexp +# and redirectmatch_dest. +# ``` puppet +# apache::vhost { 'site.name.fdqn': +# ... +# redirectmatch_status => ['404','404'], +# redirectmatch_regexp => ['\.git(/.*|$)/','\.svn(/.*|$)'], +# redirectmatch_dest => ['http://www.example.com/$1','http://www.example.com/$2'], +# } +# ``` +# +# @param redirectmatch_dest +# Determines which server status should be raised for a given regular expression +# and where to forward the user to. Entered as an array alongside redirectmatch_status +# and redirectmatch_regexp. +# ``` puppet +# apache::vhost { 'site.name.fdqn': +# ... +# redirectmatch_status => ['404','404'], +# redirectmatch_regexp => ['\.git(/.*|$)/','\.svn(/.*|$)'], +# redirectmatch_dest => ['http://www.example.com/$1','http://www.example.com/$2'], +# } +# ``` +# +# @param request_headers +# Modifies collected [request headers](https://httpd.apache.org/docs/current/mod/mod_headers.html#requestheader) +# in various ways, including adding additional request headers, removing request headers, +# and so on. +# ``` puppet +# apache::vhost { 'site.name.fdqn': +# ... +# request_headers => [ +# 'append MirrorID "mirror 12"', +# 'unset MirrorID', +# ], +# } +# ``` +# +# @param rewrites +# Creates URL rewrite rules. Expects an array of hashes.
+# Valid Hash keys include `comment`, `rewrite_base`, `rewrite_cond`, `rewrite_rule` +# or `rewrite_map`.
+# For example, you can specify that anyone trying to access index.html is served welcome.html +# ``` puppet +# apache::vhost { 'site.name.fdqn': +# ... +# rewrites => [ { rewrite_rule => ['^index\.html$ welcome.html'] } ] +# } +# ``` +# The parameter allows rewrite conditions that, when `true`, execute the associated rule. +# For instance, if you wanted to rewrite URLs only if the visitor is using IE +# ``` puppet +# apache::vhost { 'site.name.fdqn': +# ... +# rewrites => [ +# { +# comment => 'redirect IE', +# rewrite_cond => ['%{HTTP_USER_AGENT} ^MSIE'], +# rewrite_rule => ['^index\.html$ welcome.html'], +# }, +# ], +# } +# ``` +# You can also apply multiple conditions. For instance, rewrite index.html to welcome.html +# only when the browser is Lynx or Mozilla (version 1 or 2) +# ``` puppet +# apache::vhost { 'site.name.fdqn': +# ... +# rewrites => [ +# { +# comment => 'Lynx or Mozilla v1/2', +# rewrite_cond => ['%{HTTP_USER_AGENT} ^Lynx/ [OR]', '%{HTTP_USER_AGENT} ^Mozilla/[12]'], +# rewrite_rule => ['^index\.html$ welcome.html'], +# }, +# ], +# } +# ``` +# Multiple rewrites and conditions are also possible +# ``` puppet +# apache::vhost { 'site.name.fdqn': +# ... +# rewrites => [ +# { +# comment => 'Lynx or Mozilla v1/2', +# rewrite_cond => ['%{HTTP_USER_AGENT} ^Lynx/ [OR]', '%{HTTP_USER_AGENT} ^Mozilla/[12]'], +# rewrite_rule => ['^index\.html$ welcome.html'], +# }, +# { +# comment => 'Internet Explorer', +# rewrite_cond => ['%{HTTP_USER_AGENT} ^MSIE'], +# rewrite_rule => ['^index\.html$ /index.IE.html [L]'], +# }, +# { +# rewrite_base => /apps/, +# rewrite_rule => ['^index\.cgi$ index.php', '^index\.html$ index.php', '^index\.asp$ index.html'], +# }, +# { comment => 'Rewrite to lower case', +# rewrite_cond => ['%{REQUEST_URI} [A-Z]'], +# rewrite_map => ['lc int:tolower'], +# rewrite_rule => ['(.*) ${lc:$1} [R=301,L]'], +# }, +# ], +# } +# ``` +# Refer to the [`mod_rewrite` documentation](https://httpd.apache.org/docs/2.4/mod/mod_rewrite.html) +# for more details on what is possible with rewrite rules and conditions.
+# > **Note**: If you include rewrites in your directories, also include `apache::mod::rewrite` +# and consider setting the rewrites using the `rewrites` parameter in `apache::vhost` rather +# than setting the rewrites in the virtual host's directories. +# +# @param rewrite_base +# The parameter [`rewrite_base`](https://httpd.apache.org/docs/current/mod/mod_rewrite.html#rewritebase) +# specifies the URL prefix to be used for per-directory (htaccess) RewriteRule directives +# that substitue a relative path. +# +# @param rewrite_rule +# The parameter [`rewrite_rile`](https://httpd.apache.org/docs/current/mod/mod_rewrite.html#rewriterule) +# allows the user to define the rules that will be used by the rewrite engine. +# +# @param rewrite_cond +# The parameter [`rewrite_cond`](https://httpd.apache.org/docs/current/mod/mod_rewrite.html#rewritecond) +# defines a rule condition, that when satisfied will implement that rule within the +# rewrite engine. +# +# @param rewrite_inherit +# Determines whether the virtual host inherits global rewrite rules.
+# Rewrite rules may be specified globally (in `$conf_file` or `$confd_dir`) or +# inside the virtual host `.conf` file. By default, virtual hosts do not inherit +# global settings. To activate inheritance, specify the `rewrites` parameter and set +# `rewrite_inherit` parameter to `true`: +# ``` puppet +# apache::vhost { 'site.name.fdqn': +# ... +# rewrites => [ +# , +# ], +# rewrite_inherit => `true`, +# } +# ``` +# > **Note**: The `rewrites` parameter is **required** for this to have effect
+# Apache activates global `Rewrite` rules inheritance if the virtual host files contains +# the following directives: +# ``` ApacheConf +# RewriteEngine On +# RewriteOptions Inherit +# ``` +# Refer to the official [`mod_rewrite`](https://httpd.apache.org/docs/2.2/mod/mod_rewrite.html) +# documentation, section "Rewriting in Virtual Hosts". +# +# @param scriptalias +# Defines a directory of CGI scripts to be aliased to the path '/cgi-bin', such as +# '/usr/scripts'. +# +# @param scriptaliases +# > **Note**: This parameter is deprecated in favor of the `aliases` parameter.
+# Passes an array of hashes to the virtual host to create either ScriptAlias or +# ScriptAliasMatch statements per the `mod_alias` documentation. +# ``` puppet +# scriptaliases => [ +# { +# alias => '/myscript', +# path => '/usr/share/myscript', +# }, +# { +# aliasmatch => '^/foo(.*)', +# path => '/usr/share/fooscripts$1', +# }, +# { +# aliasmatch => '^/bar/(.*)', +# path => '/usr/share/bar/wrapper.sh/$1', +# }, +# { +# alias => '/neatscript', +# path => '/usr/share/neatscript', +# }, +# ] +# ``` +# The ScriptAlias and ScriptAliasMatch directives are created in the order specified. +# As with [Alias and AliasMatch](#aliases) directives, specify more specific aliases +# before more general ones to avoid shadowing. +# +# @param serveradmin +# Specifies the email address Apache displays when it renders one of its error pages. +# +# @param serveraliases +# Sets the [ServerAliases](https://httpd.apache.org/docs/current/mod/core.html#serveralias) +# of the site. +# +# @param servername +# Sets the servername corresponding to the hostname you connect to the virtual host at. +# +# @param setenv +# Used by HTTPD to set environment variables for virtual hosts.
+# Example: +# ``` puppet +# apache::vhost { 'setenv.example.com': +# setenv => ['SPECIAL_PATH /foo/bin'], +# } +# ``` +# +# @param setenvif +# Used by HTTPD to conditionally set environment variables for virtual hosts. +# +# @param setenvifnocase +# Used by HTTPD to conditionally set environment variables for virtual hosts (caseless matching). +# +# @param suexec_user_group +# Allows the spcification of user and group execution privileges for CGI programs through +# inclusion of the `mod_suexec` module. +# +# @param suphp_addhandler +# Sets up a virtual host with [suPHP](http://suphp.org/DocumentationView.html?file=apache/CONFIG) +# working together with suphp_configpath and suphp_engine.
+# An example virtual host configuration with suPHP: +# ``` puppet +# apache::vhost { 'suphp.example.com': +# port => '80', +# docroot => '/home/appuser/myphpapp', +# suphp_addhandler => 'x-httpd-php', +# suphp_engine => 'on', +# suphp_configpath => '/etc/php5/apache2', +# directories => { path => '/home/appuser/myphpapp', +# 'suphp' => { user => 'myappuser', group => 'myappgroup' }, +# } +# } +# ``` +# +# @param suphp_configpath +# Sets up a virtual host with [suPHP](http://suphp.org/DocumentationView.html?file=apache/CONFIG) +# working together with suphp_addhandler and suphp_engine.
+# An example virtual host configuration with suPHP: +# ``` puppet +# apache::vhost { 'suphp.example.com': +# port => '80', +# docroot => '/home/appuser/myphpapp', +# suphp_addhandler => 'x-httpd-php', +# suphp_engine => 'on', +# suphp_configpath => '/etc/php5/apache2', +# directories => { path => '/home/appuser/myphpapp', +# 'suphp' => { user => 'myappuser', group => 'myappgroup' }, +# } +# } +# ``` +# +# @param suphp_engine +# Sets up a virtual host with [suPHP](http://suphp.org/DocumentationView.html?file=apache/CONFIG) +# working together with suphp_configpath and suphp_addhandler.
+# An example virtual host configuration with suPHP: +# ``` puppet +# apache::vhost { 'suphp.example.com': +# port => '80', +# docroot => '/home/appuser/myphpapp', +# suphp_addhandler => 'x-httpd-php', +# suphp_engine => 'on', +# suphp_configpath => '/etc/php5/apache2', +# directories => { path => '/home/appuser/myphpapp', +# 'suphp' => { user => 'myappuser', group => 'myappgroup' }, +# } +# } +# ``` +# +# @param vhost_name +# Enables name-based virtual hosting. If no IP is passed to the virtual host, but the +# virtual host is assigned a port, then the virtual host name is `vhost_name:port`. +# If the virtual host has no assigned IP or port, the virtual host name is set to the +# title of the resource. +# +# @param virtual_docroot +# Sets up a virtual host with a wildcard alias subdomain mapped to a directory with the +# same name. For example, `http://example.com` would map to `/var/www/example.com`. +# Note that the `DocumentRoot` directive will not be present even though there is a value +# set for `docroot` in the manifest. See [`virtual_use_default_docroot`](#virtual_use_default_docroot) to change this behavior. +# ``` puppet +# apache::vhost { 'subdomain.loc': +# vhost_name => '*', +# port => '80', +# virtual_docroot => '/var/www/%-2+', +# docroot => '/var/www', +# serveraliases => ['*.loc',], +# } +# ``` +# +# @param virtual_use_default_docroot +# By default, when using `virtual_docroot`, the value of `docroot` is ignored. Setting this +# to `true` will mean both directives will be added to the configuration. +# ``` puppet +# apache::vhost { 'subdomain.loc': +# vhost_name => '*', +# port => '80', +# virtual_docroot => '/var/www/%-2+', +# docroot => '/var/www', +# virtual_use_default_docroot => true, +# serveraliases => ['*.loc',], +# } +# ``` +# +# @param wsgi_daemon_process +# Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +# wsgi_daemon_process_options, wsgi_process_group, +# wsgi_script_aliases and wsgi_pass_authorization.
+# A hash that sets the name of the WSGI daemon, accepting +# [certain keys](http://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIDaemonProcess.html).
+# An example virtual host configuration with WSGI: +# ``` puppet +# apache::vhost { 'wsgi.example.com': +# port => '80', +# docroot => '/var/www/pythonapp', +# wsgi_daemon_process => 'wsgi', +# wsgi_daemon_process_options => +# { processes => '2', +# threads => '15', +# display-name => '%{GROUP}', +# }, +# wsgi_process_group => 'wsgi', +# wsgi_script_aliases => { '/' => '/var/www/demo.wsgi' }, +# wsgi_chunked_request => 'On', +# } +# ``` +# +# @param wsgi_daemon_process_options +# Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +# wsgi_daemon_process, wsgi_process_group, +# wsgi_script_aliases and wsgi_pass_authorization.
+# Sets the group ID that the virtual host runs under. +# +# @param wsgi_application_group +# Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +# wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group, +# and wsgi_pass_authorization.
+# This parameter defines the [`WSGIApplicationGroup directive`](https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIApplicationGroup.html), +# thus allowing you to specify which application group the WSGI application belongs to, +# with all WSGI applications within the same group executing within the context of the +# same Python sub interpreter. +# +# @param wsgi_import_script +# Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +# wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group, +# and wsgi_pass_authorization.
+# This parameter defines the [`WSGIImportScript directive`](https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIImportScript.html), +# which can be used in order to specify a script file to be loaded upon a process starting. +# +# @param wsgi_import_script_options +# Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +# wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group, +# and wsgi_pass_authorization.
+# This parameter defines the [`WSGIImportScript directive`](https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIImportScript.html), +# which can be used in order to specify a script file to be loaded upon a process starting.
+# Specifies the process and aplication groups of the script. +# +# @param wsgi_chunked_request +# Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +# wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group, +# and wsgi_pass_authorization.
+# This parameter defines the [`WSGIChunkedRequest directive`](https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIChunkedRequest.html), +# allowing you to enable support for chunked request content.
+# WSGI is technically incapable of supporting chunked request content without all chunked +# request content having first been read in and buffered. +# +# @param wsgi_process_group +# Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +# wsgi_daemon_process, wsgi_daemon_process_options, +# wsgi_script_aliases and wsgi_pass_authorization.
+# Requires a hash of web paths to filesystem `.wsgi paths/`. +# +# @param wsgi_script_aliases +# Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +# wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group, +# and wsgi_pass_authorization.
+# Uses the WSGI application to handle authorization instead of Apache when set to `On`.
+# For more information, see mod_wsgi's [WSGIPassAuthorization documentation](https://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIPassAuthorization.html). +# +# @param wsgi_script_aliases_match +# Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +# wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group, +# and wsgi_pass_authorization.
+# Uses the WSGI application to handle authorization instead of Apache when set to `On`.
+# This directive is similar to `wsgi_script_aliases`, but makes use of regular expressions +# in place of simple prefix matching.
+# For more information, see mod_wsgi's [WSGIPassAuthorization documentation](https://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIPassAuthorization.html). +# +# @param wsgi_pass_authorization +# Sets up a virtual host with [WSGI](https://github.com/GrahamDumpleton/mod_wsgi) alongside +# wsgi_daemon_process, wsgi_daemon_process_options, wsgi_process_group and +# wsgi_script_aliases.
+# Enables support for chunked requests. +# +# @param directories +# The `directories` parameter within the `apache::vhost` class passes an array of hashes +# to the virtual host to create [Directory](https://httpd.apache.org/docs/current/mod/core.html#directory), +# [File](https://httpd.apache.org/docs/current/mod/core.html#files), and +# [Location](https://httpd.apache.org/docs/current/mod/core.html#location) directive blocks. +# These blocks take the form, `< Directory /path/to/directory>...< /Directory>`.
+# The `path` key sets the path for the directory, files, and location blocks. Its value +# must be a path for the `directory`, `files`, and `location` providers, or a regex for +# the `directorymatch`, `filesmatch`, or `locationmatch` providers. Each hash passed to +# `directories` **must** contain `path` as one of the keys.
+# The `provider` key is optional. If missing, this key defaults to `directory`. +# Values: `directory`, `files`, `proxy`, `location`, `directorymatch`, `filesmatch`, +# `proxymatch` or `locationmatch`. If you set `provider` to `directorymatch`, it +# uses the keyword `DirectoryMatch` in the Apache config file.
+# An example use of `directories`: +# ``` puppet +# apache::vhost { 'files.example.net': +# docroot => '/var/www/files', +# directories => [ +# { 'path' => '/var/www/files', +# 'provider' => 'files', +# 'deny' => 'from all', +# }, +# ], +# } +# ``` +# > **Note:** At least one directory should match the `docroot` parameter. After you +# start declaring directories, `apache::vhost` assumes that all required Directory blocks +# will be declared. If not defined, a single default Directory block is created that matches +# the `docroot` parameter.
+# Available handlers, represented as keys, should be placed within the `directory`, +# `files`, or `location` hashes. This looks like +# ``` puppet +# apache::vhost { 'sample.example.net': +# docroot => '/path/to/directory', +# directories => [ { path => '/path/to/directory', handler => value } ], +# } +# ``` +# Any handlers you do not set in these hashes are considered `undefined` within Puppet and +# are not added to the virtual host, resulting in the module using their default values. +# +# @param custom_fragment +# Pass a string of custom configuration directives to be placed at the end of the directory +# configuration. +# ``` puppet +# apache::vhost { 'monitor': +# ... +# directories => [ +# { +# path => '/path/to/directory', +# custom_fragment => ' +# +# SetHandler balancer-manager +# Order allow,deny +# Allow from all +# +# +# SetHandler server-status +# Order allow,deny +# Allow from all +# +# ProxyStatus On', +# }, +# ] +# } +# ``` +# +# @param error_documents +# An array of hashes used to override the [ErrorDocument](https://httpd.apache.org/docs/current/mod/core.html#errordocument) +# settings for the directory. +# ``` puppet +# apache::vhost { 'sample.example.net': +# directories => [ +# { path => '/srv/www', +# error_documents => [ +# { 'error_code' => '503', +# 'document' => '/service-unavail', +# }, +# ], +# }, +# ], +# } +# ``` +# +# @param h2_copy_files +# Sets the [H2CopyFiles](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2copyfiles) directive.
+# Note that you must declare `class {'apache::mod::http2': }` before using this directive. +# +# @param h2_push_resource +# Sets the [H2PushResource](https://httpd.apache.org/docs/current/mod/mod_http2.html#h2pushresource) directive.
+# Note that you must declare `class {'apache::mod::http2': }` before using this directive. +# +# @param headers +# Adds lines for [Header](https://httpd.apache.org/docs/current/mod/mod_headers.html#header) directives. +# ``` puppet +# apache::vhost { 'sample.example.net': +# docroot => '/path/to/directory', +# directories => { +# path => '/path/to/directory', +# headers => 'Set X-Robots-Tag "noindex, noarchive, nosnippet"', +# }, +# } +# ``` +# +# @param options +# Lists the [Options](https://httpd.apache.org/docs/current/mod/core.html#options) for the +# given Directory block. +# ``` puppet +# apache::vhost { 'sample.example.net': +# docroot => '/path/to/directory', +# directories => [ +# { path => '/path/to/directory', +# options => ['Indexes','FollowSymLinks','MultiViews'], +# }, +# ], +# } +# ``` +# +# @param shib_compat_valid_user +# Default is Off, matching the behavior prior to this command's existence. Addresses a conflict +# when using Shibboleth in conjunction with other auth/auth modules by restoring `standard` +# Apache behavior when processing the `valid-user` and `user` Require rules. See the +# [`mod_shib`documentation](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPApacheConfig#NativeSPApacheConfig-Server/VirtualHostOptions), +# and [NativeSPhtaccess](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPhtaccess) +# topic for more details. This key is disabled if `apache::mod::shib` is not defined. +# +# @param ssl_options +# String or list of [SSLOptions](https://httpd.apache.org/docs/current/mod/mod_ssl.html#ssloptions), +# which configure SSL engine run-time options. This handler takes precedence over SSLOptions +# set in the parent block of the virtual host. +# ``` puppet +# apache::vhost { 'secure.example.net': +# docroot => '/path/to/directory', +# directories => [ +# { path => '/path/to/directory', +# ssl_options => '+ExportCertData', +# }, +# { path => '/path/to/different/dir', +# ssl_options => ['-StdEnvVars', '+ExportCertData'], +# }, +# ], +# } +# ``` +# +# @param additional_includes +# Specifies paths to additional static, specific Apache configuration files in virtual +# host directories. +# ``` puppet +# apache::vhost { 'sample.example.net': +# docroot => '/path/to/directory', +# directories => [ +# { path => '/path/to/different/dir', +# additional_includes => ['/custom/path/includes', '/custom/path/another_includes',], +# }, +# ], +# } +# ``` +# +# @param gssapi +# Specfies mod_auth_gssapi parameters for particular directories in a virtual host directory +# ```puppet +# include apache::mod::auth_gssapi +# apache::vhost { 'sample.example.net': +# docroot => '/path/to/directory', +# directories => [ +# { path => '/path/to/different/dir', +# gssapi => { +# credstore => 'keytab:/foo/bar.keytab', +# localname => 'Off', +# sslonly => 'On', +# } +# }, +# ], +# } +# ``` +# +# @param ssl +# Enables SSL for the virtual host. SSL virtual hosts only respond to HTTPS queries. +# +# @param ssl_ca +# Specifies the SSL certificate authority to be used to verify client certificates used +# for authentication. +# +# @param ssl_cert +# Specifies the SSL certification. +# +# @param ssl_protocol +# Specifies [SSLProtocol](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslprotocol). +# Expects an array or space separated string of accepted protocols. +# +# @param ssl_cipher +# Specifies [SSLCipherSuite](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslciphersuite). +# +# @param ssl_honorcipherorder +# Sets [SSLHonorCipherOrder](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslhonorcipherorder), +# to cause Apache to use the server's preferred order of ciphers rather than the client's +# preferred order. +# +# @param ssl_certs_dir +# Specifies the location of the SSL certification directory to verify client certs. +# +# @param ssl_chain +# Specifies the SSL chain. This default works out of the box, but it must be updated in +# the base `apache` class with your specific certificate information before being used in +# production. +# +# @param ssl_crl +# Specifies the certificate revocation list to use. (This default works out of the box but +# must be updated in the base `apache` class with your specific certificate information +# before being used in production.) +# +# @param ssl_crl_path +# Specifies the location of the certificate revocation list to verify certificates for +# client authentication with. (This default works out of the box but must be updated in +# the base `apache` class with your specific certificate information before being used in +# production.) +# +# @param ssl_crl_check +# Sets the certificate revocation check level via the [SSLCARevocationCheck directive](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslcarevocationcheck) +# for ssl client authentication. The default works out of the box but must be specified when +# using CRLs in production. Only applicable to Apache 2.4 or higher; the value is ignored on +# older versions. +# +# @param ssl_key +# Specifies the SSL key.
+# Defaults are based on your operating system. Default work out of the box but must be +# updated in the base `apache` class with your specific certificate information before +# being used in production. +# +# @param ssl_verify_client +# Sets the [SSLVerifyClient](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslverifyclient) +# directive, which sets the certificate verification level for client authentication. +# ``` puppet +# apache::vhost { 'sample.example.net': +# ... +# ssl_verify_client => 'optional', +# } +# ``` +# +# @param ssl_verify_depth +# Sets the [SSLVerifyDepth](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslverifydepth) +# directive, which specifies the maximum depth of CA certificates in client certificate +# verification. You must set `ssl_verify_client` for it to take effect. +# ``` puppet +# apache::vhost { 'sample.example.net': +# ... +# ssl_verify_client => 'require', +# ssl_verify_depth => 1, +# } +# ``` +# +# @param ssl_proxy_protocol +# Sets the [SSLProxyProtocol](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyprotocol) +# directive, which controls which SSL protocol flavors `mod_ssl` should use when establishing +# its server environment for proxy. It connects to servers using only one of the provided +# protocols. +# +# @param ssl_proxy_verify +# Sets the [SSLProxyVerify](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyverify) +# directive, which configures certificate verification of the remote server when a proxy is +# configured to forward requests to a remote SSL server. +# +# @param ssl_proxy_verify_depth +# Sets the [SSLProxyVerifyDepth](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyverifydepth) +# directive, which configures how deeply mod_ssl should verify before deciding that the +# remote server does not have a valid certificate.
+# A depth of 0 means that only self-signed remote server certificates are accepted, +# the default depth of 1 means the remote server certificate can be self-signed or +# signed by a CA that is directly known to the server. +# +# @param ssl_proxy_cipher_suite +# Sets the [SSLProxyCipherSuite](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyciphersuite) +# directive, which controls cipher suites supported for ssl proxy traffic. +# +# @param ssl_proxy_ca_cert +# Sets the [SSLProxyCACertificateFile](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycacertificatefile) +# directive, which specifies an all-in-one file where you can assemble the Certificates +# of Certification Authorities (CA) whose remote servers you deal with. These are used +# for Remote Server Authentication. This file should be a concatenation of the PEM-encoded +# certificate files in order of preference. +# +# @param ssl_proxy_machine_cert +# Sets the [SSLProxyMachineCertificateFile](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxymachinecertificatefile) +# directive, which specifies an all-in-one file where you keep the certs and keys used +# for this server to authenticate itself to remote servers. This file should be a +# concatenation of the PEM-encoded certificate files in order of preference. +# ``` puppet +# apache::vhost { 'sample.example.net': +# ... +# ssl_proxy_machine_cert => '/etc/httpd/ssl/client_certificate.pem', +# } +# ``` +# @param ssl_proxy_machine_cert_chain +# Sets the [SSLProxyMachineCertificateChainFile](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxymachinecertificatechainfile) +# directive, which specifies an all-in-one file where you keep the certificate chain for +# all of the client certs in use. This directive will be needed if the remote server +# presents a list of CA certificates that are not direct signers of one of the configured +# client certificates. This referenced file is simply the concatenation of the various +# PEM-encoded certificate files. Upon startup, each client certificate configured will be +# examined and a chain of trust will be constructed. +# +# @param ssl_proxy_check_peer_cn +# Sets the [SSLProxyCheckPeerCN](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeercn) +# directive, which specifies whether the remote server certificate's CN field is compared +# against the hostname of the request URL. +# +# @param ssl_proxy_check_peer_name +# Sets the [SSLProxyCheckPeerName](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeername) +# directive, which specifies whether the remote server certificate's CN field is compared +# against the hostname of the request URL. +# +# @param ssl_proxy_check_peer_expire +# Sets the [SSLProxyCheckPeerExpire](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeerexpire) +# directive, which specifies whether the remote server certificate is checked for expiration +# or not. +# +# @param ssl_options +# Sets the [SSLOptions](https://httpd.apache.org/docs/current/mod/mod_ssl.html#ssloptions) +# directive, which configures various SSL engine run-time options. This is the global +# setting for the given virtual host and can be a string or an array.
+# A string: +# ``` puppet +# apache::vhost { 'sample.example.net': +# ... +# ssl_options => '+ExportCertData', +# } +# ``` +# An array: +# ``` puppet +# apache::vhost { 'sample.example.net': +# ... +# ssl_options => ['+StrictRequire', '+ExportCertData'], +# } +# ``` +# +# @param ssl_openssl_conf_cmd +# Sets the [SSLOpenSSLConfCmd](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslopensslconfcmd) +# directive, which provides direct configuration of OpenSSL parameters. +# +# @param ssl_proxyengine +# Specifies whether or not to use [SSLProxyEngine](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyengine). +# +# @param ssl_stapling +# Specifies whether or not to use [SSLUseStapling](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslusestapling). +# By default, uses what is set globally.
+# This parameter only applies to Apache 2.4 or higher and is ignored on older versions. +# +# @param ssl_stapling_timeout +# Can be used to set the [SSLStaplingResponderTimeout](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslstaplingrespondertimeout) directive.
+# This parameter only applies to Apache 2.4 or higher and is ignored on older versions. +# +# @param ssl_stapling_return_errors +# Can be used to set the [SSLStaplingReturnResponderErrors](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslstaplingreturnrespondererrors) directive.
+# This parameter only applies to Apache 2.4 or higher and is ignored on older versions. +# +# @param ssl_user_name +# Sets the [SSLUserName](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslusername) directive. +# +# @param ssl_reload_on_change +# Enable reloading of apache if the content of ssl files have changed. +# +# @param use_canonical_name +# Specifies whether to use the [`UseCanonicalName directive`](https://httpd.apache.org/docs/2.4/mod/core.html#usecanonicalname), +# which allows you to configure how the server determines it's own name and port. +# +# @param define +# this lets you define configuration variables inside a vhost using [`Define`](https://httpd.apache.org/docs/2.4/mod/core.html#define), +# these can then be used to replace configuration values. All Defines are Undefined at the end of the VirtualHost. +# +# @param auth_oidc +# Enable `mod_auth_openidc` parameters for OpenID Connect authentication. +# +# @param oidc_settings +# An Apache::OIDCSettings Struct containing (mod_auth_openidc settings)[https://github.com/zmartzone/mod_auth_openidc/blob/master/auth_openidc.conf]. +# +# @param limitreqfields +# The `limitreqfields` parameter sets the maximum number of request header fields in +# an HTTP request. This directive gives the server administrator greater control over +# abnormal client request behavior, which may be useful for avoiding some forms of +# denial-of-service attacks. The value should be increased if normal clients see an error +# response from the server that indicates too many fields were sent in the request. +# +# @param limitreqfieldsize +# The `limitreqfieldsize` parameter sets the maximum ammount of _bytes_ that will +# be allowed within a request header. +# +# @param limitreqline +# Limit the size of the HTTP request line that will be accepted from the client +# This directive sets the number of bytes that will be allowed on the HTTP +# request-line. The LimitRequestLine directive allows the server administrator +# to set the limit on the allowed size of a client's HTTP request-line. Since +# the request-line consists of the HTTP method, URI, and protocol version, the +# LimitRequestLine directive places a restriction on the length of a request-URI +# allowed for a request on the server. A server needs this value to be large +# enough to hold any of its resource names, including any information that might +# be passed in the query part of a GET request. +# +# @param limitreqbody +# Restricts the total size of the HTTP request body sent from the client +# The LimitRequestBody directive allows the user to set a limit on the allowed +# size of an HTTP request message body within the context in which the +# directive is given (server, per-directory, per-file or per-location). If the +# client request exceeds that limit, the server will return an error response +# instead of servicing the request. +# +# @param $use_servername_for_filenames +# When set to true, default log / config file names will be derived from the sanitized +# value of the $servername parameter. +# When set to false (default), the existing behaviour of using the $name parameter +# will remain. +# +# @param $use_port_for_filenames +# When set to true and use_servername_for_filenames is also set to true, default log / +# config file names will be derived from the sanitized value of both the $servername and +# $port parameters. +# When set to false (default), the port is not included in the file names and may lead to +# duplicate declarations if two virtual hosts use the same domain. +# +# @param $mdomain +# All the names in the list are managed as one Managed Domain (MD). mod_md will request +# one single certificate that is valid for all these names. +define apache::vhost ( Variant[Boolean,String] $docroot, $manage_docroot = true, $virtual_docroot = false, + $virtual_use_default_docroot = false, $port = undef, $ip = undef, Boolean $ip_based = false, $add_listen = true, $docroot_owner = 'root', - $docroot_group = $::apache::params::root_group, + $docroot_group = $apache::params::root_group, $docroot_mode = undef, + Array[Enum['h2', 'h2c', 'http/1.1']] $protocols = [], + Optional[Boolean] $protocols_honor_order = undef, $serveradmin = undef, Boolean $ssl = false, - $ssl_cert = $::apache::default_ssl_cert, - $ssl_key = $::apache::default_ssl_key, - $ssl_chain = $::apache::default_ssl_chain, - $ssl_ca = $::apache::default_ssl_ca, - $ssl_crl_path = $::apache::default_ssl_crl_path, - $ssl_crl = $::apache::default_ssl_crl, - $ssl_crl_check = $::apache::default_ssl_crl_check, - $ssl_certs_dir = $::apache::params::ssl_certs_dir, + $ssl_cert = $apache::default_ssl_cert, + $ssl_key = $apache::default_ssl_key, + $ssl_chain = $apache::default_ssl_chain, + $ssl_ca = $apache::default_ssl_ca, + $ssl_crl_path = $apache::default_ssl_crl_path, + $ssl_crl = $apache::default_ssl_crl, + $ssl_crl_check = $apache::default_ssl_crl_check, + $ssl_certs_dir = $apache::params::ssl_certs_dir, + Boolean $ssl_reload_on_change = $apache::default_ssl_reload_on_change, $ssl_protocol = undef, $ssl_cipher = undef, - $ssl_honorcipherorder = undef, - $ssl_verify_client = undef, + Variant[Boolean, Enum['on', 'On', 'off', 'Off'], Undef] $ssl_honorcipherorder = undef, + Optional[Enum['none', 'optional', 'require', 'optional_no_ca']] $ssl_verify_client = undef, $ssl_verify_depth = undef, Optional[Enum['none', 'optional', 'require', 'optional_no_ca']] $ssl_proxy_verify = undef, - $ssl_proxy_verify_depth = undef, + Optional[Integer[0]] $ssl_proxy_verify_depth = undef, $ssl_proxy_ca_cert = undef, Optional[Enum['on', 'off']] $ssl_proxy_check_peer_cn = undef, Optional[Enum['on', 'off']] $ssl_proxy_check_peer_name = undef, Optional[Enum['on', 'off']] $ssl_proxy_check_peer_expire = undef, $ssl_proxy_machine_cert = undef, + $ssl_proxy_machine_cert_chain = undef, + $ssl_proxy_cipher_suite = undef, $ssl_proxy_protocol = undef, $ssl_options = undef, $ssl_openssl_conf_cmd = undef, @@ -39,34 +1804,45 @@ define apache::vhost( Optional[Boolean] $ssl_stapling = undef, $ssl_stapling_timeout = undef, $ssl_stapling_return_errors = undef, + Optional[String] $ssl_user_name = undef, $priority = undef, Boolean $default_vhost = false, $servername = $name, $serveraliases = [], $options = ['Indexes','FollowSymLinks','MultiViews'], - $override = ['All'], + $override = ['None'], $directoryindex = '', $vhost_name = '*', - $logroot = $::apache::logroot, + $logroot = $apache::logroot, Enum['directory', 'absent'] $logroot_ensure = 'directory', $logroot_mode = undef, $logroot_owner = undef, $logroot_group = undef, - $log_level = undef, + Optional[Apache::LogLevel] $log_level = undef, Boolean $access_log = true, $access_log_file = false, $access_log_pipe = false, $access_log_syslog = false, $access_log_format = false, $access_log_env_var = false, - $access_logs = undef, + Optional[Array] $access_logs = undef, + Optional[Boolean] $use_servername_for_filenames = false, + Optional[Boolean] $use_port_for_filenames = false, $aliases = undef, - $directories = undef, + Optional[Variant[Hash, Array[Variant[Array,Hash]]]] $directories = undef, Boolean $error_log = true, $error_log_file = undef, $error_log_pipe = undef, $error_log_syslog = undef, - $http_protocol_options = undef, + Optional[ + Array[ + Variant[ + String, + Hash[String, Enum['connection', 'request']] + ] + ] + ] $error_log_format = undef, + Optional[Pattern[/^((Strict|Unsafe)?\s*(\b(Registered|Lenient)Methods)?\s*(\b(Allow0\.9|Require1\.0))?)$/]] $http_protocol_options = undef, $modsec_audit_log = undef, $modsec_audit_log_file = undef, $modsec_audit_log_pipe = undef, @@ -74,14 +1850,19 @@ define apache::vhost( Optional[Variant[Stdlib::Absolutepath, Enum['disabled']]] $fallbackresource = undef, $scriptalias = undef, $scriptaliases = [], + Optional[Integer] $limitreqfieldsize = undef, + Optional[Integer] $limitreqfields = undef, + Optional[Integer] $limitreqline = undef, + Optional[Integer] $limitreqbody = undef, $proxy_dest = undef, $proxy_dest_match = undef, $proxy_dest_reverse_match = undef, $proxy_pass = undef, $proxy_pass_match = undef, - $suphp_addhandler = $::apache::params::suphp_addhandler, - Enum['on', 'off'] $suphp_engine = $::apache::params::suphp_engine, - $suphp_configpath = $::apache::params::suphp_configpath, + Boolean $proxy_requests = false, + $suphp_addhandler = $apache::params::suphp_addhandler, + Enum['on', 'off'] $suphp_engine = $apache::params::suphp_engine, + $suphp_configpath = $apache::params::suphp_configpath, $php_flags = {}, $php_values = {}, $php_admin_flags = {}, @@ -97,8 +1878,6 @@ define apache::vhost( $redirectmatch_status = undef, $redirectmatch_regexp = undef, $redirectmatch_dest = undef, - $rack_base_uris = undef, - $passenger_base_uris = undef, $headers = undef, $request_headers = undef, $filters = undef, @@ -113,7 +1892,7 @@ define apache::vhost( $block = [], Enum['absent', 'present'] $ensure = 'present', $wsgi_application_group = undef, - $wsgi_daemon_process = undef, + Optional[Variant[String,Hash]] $wsgi_daemon_process = undef, Optional[Hash] $wsgi_daemon_process_options = undef, $wsgi_import_script = undef, Optional[Hash] $wsgi_import_script_options = undef, @@ -130,28 +1909,78 @@ define apache::vhost( $fastcgi_dir = undef, $fastcgi_idle_timeout = undef, $additional_includes = [], - $use_optional_includes = $::apache::use_optional_includes, - $apache_version = $::apache::apache_version, + $use_optional_includes = $apache::use_optional_includes, + $apache_version = $apache::apache_version, Optional[Enum['on', 'off', 'nodecode']] $allow_encoded_slashes = undef, - $suexec_user_group = undef, - $passenger_app_root = undef, - $passenger_app_env = undef, - $passenger_ruby = undef, - $passenger_min_instances = undef, - $passenger_max_requests = undef, - $passenger_start_timeout = undef, - $passenger_pre_start = undef, - $passenger_user = undef, - $passenger_high_performance = undef, - $passenger_nodejs = undef, + Optional[Pattern[/^[\w-]+ [\w-]+$/]] $suexec_user_group = undef, + + Optional[Boolean] $h2_copy_files = undef, + Optional[Boolean] $h2_direct = undef, + Optional[Boolean] $h2_early_hints = undef, + Optional[Integer] $h2_max_session_streams = undef, + Optional[Boolean] $h2_modern_tls_only = undef, + Optional[Boolean] $h2_push = undef, + Optional[Integer] $h2_push_diary_size = undef, + Array[String] $h2_push_priority = [], + Array[String] $h2_push_resource = [], + Optional[Boolean] $h2_serialize_headers = undef, + Optional[Integer] $h2_stream_max_mem_size = undef, + Optional[Integer] $h2_tls_cool_down_secs = undef, + Optional[Integer] $h2_tls_warm_up_size = undef, + Optional[Boolean] $h2_upgrade = undef, + Optional[Integer] $h2_window_size = undef, + + Optional[Boolean] $passenger_enabled = undef, + Optional[String] $passenger_base_uri = undef, + Optional[Stdlib::Absolutepath] $passenger_ruby = undef, + Optional[Stdlib::Absolutepath] $passenger_python = undef, + Optional[Stdlib::Absolutepath] $passenger_nodejs = undef, + Optional[String] $passenger_meteor_app_settings = undef, + Optional[String] $passenger_app_env = undef, + Optional[Stdlib::Absolutepath] $passenger_app_root = undef, + Optional[String] $passenger_app_group_name = undef, + Optional[String] $passenger_app_start_command = undef, + Optional[Enum['meteor', 'node', 'rack', 'wsgi']] $passenger_app_type = undef, + Optional[String] $passenger_startup_file = undef, + Optional[String] $passenger_restart_dir = undef, + Optional[Enum['direct', 'smart']] $passenger_spawn_method = undef, + Optional[Boolean] $passenger_load_shell_envvars = undef, + Optional[Boolean] $passenger_rolling_restarts = undef, + Optional[Boolean] $passenger_resist_deployment_errors = undef, + Optional[String] $passenger_user = undef, + Optional[String] $passenger_group = undef, + Optional[Boolean] $passenger_friendly_error_pages = undef, + Optional[Integer] $passenger_min_instances = undef, + Optional[Integer] $passenger_max_instances = undef, + Optional[Integer] $passenger_max_preloader_idle_time = undef, + Optional[Integer] $passenger_force_max_concurrent_requests_per_process = undef, + Optional[Integer] $passenger_start_timeout = undef, + Optional[Enum['process', 'thread']] $passenger_concurrency_model = undef, + Optional[Integer] $passenger_thread_count = undef, + Optional[Integer] $passenger_max_requests = undef, + Optional[Integer] $passenger_max_request_time = undef, + Optional[Integer] $passenger_memory_limit = undef, + Optional[Integer] $passenger_stat_throttle_rate = undef, + Optional[Variant[String,Array[String]]] $passenger_pre_start = undef, + Optional[Boolean] $passenger_high_performance = undef, + Optional[Boolean] $passenger_buffer_upload = undef, + Optional[Boolean] $passenger_buffer_response = undef, + Optional[Boolean] $passenger_error_override = undef, + Optional[Integer] $passenger_max_request_queue_size = undef, + Optional[Integer] $passenger_max_request_queue_time = undef, Optional[Boolean] $passenger_sticky_sessions = undef, - $passenger_startup_file = undef, + Optional[String] $passenger_sticky_sessions_cookie_name = undef, + Optional[String] $passenger_sticky_sessions_cookie_attributes = undef, + Optional[Boolean] $passenger_allow_encoded_slashes = undef, + Optional[String] $passenger_app_log_file = undef, + Optional[Boolean] $passenger_debugger = undef, + Optional[Integer] $passenger_lve_min_uid = undef, $add_default_charset = undef, $modsec_disable_vhost = undef, - $modsec_disable_ids = undef, + Optional[Variant[Hash, Array]] $modsec_disable_ids = undef, $modsec_disable_ips = undef, - $modsec_disable_msgs = undef, - $modsec_disable_tags = undef, + Optional[Variant[Hash, Array]] $modsec_disable_msgs = undef, + Optional[Variant[Hash, Array]] $modsec_disable_tags = undef, $modsec_body_limit = undef, $jk_mounts = undef, Boolean $auth_kerb = false, @@ -169,45 +1998,37 @@ define apache::vhost( $max_keepalive_requests = undef, $cas_attribute_prefix = undef, $cas_attribute_delimiter = undef, + $cas_root_proxied_as = undef, $cas_scrub_request_headers = undef, $cas_sso_enabled = undef, $cas_login_url = undef, $cas_validate_url = undef, $cas_validate_saml = undef, + $cas_cookie_path = undef, + Optional[String] $shib_compat_valid_user = undef, + Optional[Enum['On', 'on', 'Off', 'off', 'DNS', 'dns']] $use_canonical_name = undef, + Optional[Variant[String,Array[String]]] $comment = undef, + Hash $define = {}, + Boolean $auth_oidc = false, + Optional[Apache::OIDCSettings] $oidc_settings = undef, + Optional[Variant[Boolean,String]] $mdomain = undef, ) { - # The base class must be included first because it is used by parameter defaults if ! defined(Class['apache']) { fail('You must include the apache base class before using any apache defined resources') } - $apache_name = $::apache::apache_name + $apache_name = $apache::apache_name - if $http_protocol_options != undef { - validate_re($http_protocol_options, '^((Strict|Unsafe)?\s*(\b(RegisteredMethods|LenientMethods))?\s*(\b(Allow0\.9|Require1\.0))?)$', - "${http_protocol_options} is not supported for http_protocol_options. - Allowed value is any sequence of the following alternative values: - 'Strict' or Unsafe, 'RegisteredMethods' or 'LenientMethods', and - 'Allow0.9' or 'Require1.0'.") - } if $rewrites { unless empty($rewrites) { $rewrites_flattened = delete_undef_values(flatten([$rewrites])) - validate_hash($rewrites_flattened[0]) + assert_type(Array[Hash], $rewrites_flattened) } } # Input validation begins - if $suexec_user_group { - validate_re($suexec_user_group, '^[\w-]+ [\w-]+$', - "${suexec_user_group} is not supported for suexec_user_group. Must be 'user group'.") - } - - if $log_level { - validate_apache_log_level($log_level) - } - if $access_log_file and $access_log_pipe { fail("Apache::Vhost[${name}]: 'access_log_file' and 'access_log_pipe' cannot be defined at the same time") } @@ -220,36 +2041,48 @@ define apache::vhost( fail("Apache::Vhost[${name}]: 'modsec_audit_log_file' and 'modsec_audit_log_pipe' cannot be defined at the same time") } - if $ssl_proxy_verify_depth { - validate_integer($ssl_proxy_verify_depth) - } - # Input validation ends if $ssl and $ensure == 'present' { - include ::apache::mod::ssl + include apache::mod::ssl # Required for the AddType lines. - include ::apache::mod::mime + include apache::mod::mime + } + + if $ssl_honorcipherorder =~ Boolean or $ssl_honorcipherorder == undef { + $_ssl_honorcipherorder = $ssl_honorcipherorder + } else { + $_ssl_honorcipherorder = $ssl_honorcipherorder ? { + 'on' => true, + 'On' => true, + 'off' => false, + 'Off' => false, + default => true, + } } if $auth_kerb and $ensure == 'present' { - include ::apache::mod::auth_kerb + include apache::mod::auth_kerb + } + + if $auth_oidc and $ensure == 'present' { + include apache::mod::auth_openidc } if $virtual_docroot { - include ::apache::mod::vhost_alias + include apache::mod::vhost_alias } - if $wsgi_daemon_process { - include ::apache::mod::wsgi + if $wsgi_application_group or $wsgi_daemon_process or ($wsgi_import_script and $wsgi_import_script_options) or $wsgi_process_group or ($wsgi_script_aliases and ! empty($wsgi_script_aliases)) or $wsgi_pass_authorization { + include apache::mod::wsgi } if $suexec_user_group { - include ::apache::mod::suexec + include apache::mod::suexec } - if $passenger_app_root or $passenger_app_env or $passenger_ruby or $passenger_min_instances or $passenger_max_requests or $passenger_start_timeout or $passenger_pre_start or $passenger_user or $passenger_high_performance or $passenger_nodejs or $passenger_sticky_sessions or $passenger_startup_file { - include ::apache::mod::passenger + if $passenger_enabled != undef or $passenger_start_timeout != undef or $passenger_ruby != undef or $passenger_python != undef or $passenger_nodejs != undef or $passenger_meteor_app_settings != undef or $passenger_app_env != undef or $passenger_app_root != undef or $passenger_app_group_name != undef or $passenger_app_start_command != undef or $passenger_app_type != undef or $passenger_startup_file != undef or $passenger_restart_dir != undef or $passenger_spawn_method != undef or $passenger_load_shell_envvars != undef or $passenger_rolling_restarts != undef or $passenger_resist_deployment_errors != undef or $passenger_min_instances != undef or $passenger_max_instances != undef or $passenger_max_preloader_idle_time != undef or $passenger_force_max_concurrent_requests_per_process != undef or $passenger_concurrency_model != undef or $passenger_thread_count != undef or $passenger_high_performance != undef or $passenger_max_request_queue_size != undef or $passenger_max_request_queue_time != undef or $passenger_user != undef or $passenger_group != undef or $passenger_friendly_error_pages != undef or $passenger_buffer_upload != undef or $passenger_buffer_response != undef or $passenger_allow_encoded_slashes != undef or $passenger_lve_min_uid != undef or $passenger_base_uri != undef or $passenger_error_override != undef or $passenger_sticky_sessions != undef or $passenger_sticky_sessions_cookie_name != undef or $passenger_sticky_sessions_cookie_attributes != undef or $passenger_app_log_file != undef or $passenger_debugger != undef or $passenger_max_requests != undef or $passenger_max_request_time != undef or $passenger_memory_limit != undef { + include apache::mod::passenger } # Configure the defaultness of a vhost @@ -263,8 +2096,64 @@ define apache::vhost( $priority_real = '25-' } - ## Apache include does not always work with spaces in the filename - $filename = regsubst($name, ' ', '_', 'G') + # https://httpd.apache.org/docs/2.4/fr/mod/core.html#servername + # Syntax: ServerName [scheme://]domain-name|ip-address[:port] + # Sometimes, the server runs behind a device that processes SSL, such as a reverse proxy, load balancer or SSL offload + # appliance. + # When this is the case, specify the https:// scheme and the port number to which the clients connect in the ServerName + # directive to make sure that the server generates the correct self-referential URLs. + $normalized_servername = regsubst($servername, '(https?:\/\/)?([a-z0-9\/%_+.,#?!@&=-]+)(:?\d+)?', '\2', 'G') + + # IAC-1186: A number of configuration and log file names are generated using the $name parameter. It is possible for + # the $name parameter to contain spaces, which could then be transferred to the log / config filenames. Although + # POSIX compliant, this can be cumbersome. + # + # It seems more appropriate to use the $servername parameter to derive default log / config filenames from. We should + # also perform some sanitiation on the $servername parameter to strip spaces from it, as it defaults to the value of + # $name, should $servername NOT be defined. + # + # Because a single hostname may be use by multiple virtual hosts listening on different ports, the $port paramter can + # optionaly be used to avoid duplicate resources. + # + # We will retain the default behaviour for filenames but allow the use of a sanitized version of $servername to be + # used, using the new $use_servername_for_filenames and $use_port_for_filenames parameters. + # + # This will default to false until the next major release (v7.0.0), at which point, we will default this to true and + # warn about it's imminent deprecation in the subsequent major release (v8.0.0) + # + # In v8.0.0, we will deprecate the $use_servername_for_filenames and $use_port_for_filenames parameters altogether + # and use the sanitized value of $servername for default log / config filenames. + $filename = $use_servername_for_filenames ? { + true => $use_port_for_filenames ? { + true => regsubst("${normalized_servername}-${port}", ' ', '_', 'G'), + false => regsubst($normalized_servername, ' ', '_', 'G'), + }, + false => $name, + } + + if ! $use_servername_for_filenames and $name != $normalized_servername { + $use_servername_for_filenames_warn_msg = ' + It is possible for the $name parameter to be defined with spaces in it. Although supported on POSIX systems, this + can lead to cumbersome file names. The $servername attribute has stricter conditions from Apache (i.e. no spaces) + When $use_servername_for_filenames = true, the $servername parameter, sanitized, is used to construct log and config + file names. + + From version v7.0.0 of the puppetlabs-apache module, this parameter will default to true. From version v8.0.0 of the + module, the $use_servername_for_filenames will be removed and log/config file names will be derived from the + sanitized $servername parameter when not explicitly defined.' + warning($use_servername_for_filenames_warn_msg) + } elsif ! $use_port_for_filenames { + $use_port_for_filenames_warn_msg = ' + It is possible for multiple virtual hosts to be configured using the same $servername but a different port. When + using $use_servername_for_filenames, this can lead to duplicate resource declarations. + When $use_port_for_filenames = true, the $servername and $port parameters, sanitized, are used to construct log and + config file names. + + From version v7.0.0 of the puppetlabs-apache module, this parameter will default to true. From version v8.0.0 of the + module, the $use_port_for_filenames will be removed and log/config file names will be derived from the + sanitized $servername parameter when not explicitly defined.' + warning($use_port_for_filenames_warn_msg) + } # This ensures that the docroot exists # But enables it to be specified across multiple vhost resources @@ -288,13 +2177,10 @@ define apache::vhost( mode => $logroot_mode, require => Package['httpd'], before => Concat["${priority_real}${filename}.conf"], + notify => Class['Apache::Service'], } } - - # Is apache::mod::passenger enabled (or apache::mod['passenger']) - $passenger_enabled = defined(Apache::Mod['passenger']) - # Is apache::mod::shib enabled (or apache::mod['shib2']) $shibboleth_enabled = defined(Apache::Mod['shib2']) @@ -302,31 +2188,14 @@ define apache::vhost( $cas_enabled = defined(Apache::Mod['auth_cas']) if $access_log and !$access_logs { - if $access_log_file { - if $access_log_file =~ /^\// { - # Absolute path provided - don't prepend $logroot - $_logs_dest = $access_log_file - } else { - $_logs_dest = "${logroot}/${access_log_file}" - } - } elsif $access_log_pipe { - $_logs_dest = $access_log_pipe - } elsif $access_log_syslog { - $_logs_dest = $access_log_syslog - } else { - $_logs_dest = undef - } $_access_logs = [{ - 'file' => $access_log_file, - 'pipe' => $access_log_pipe, - 'syslog' => $access_log_syslog, - 'format' => $access_log_format, - 'env' => $access_log_env_var + 'file' => $access_log_file, + 'pipe' => $access_log_pipe, + 'syslog' => $access_log_syslog, + 'format' => $access_log_format, + 'env' => $access_log_env_var }] } elsif $access_logs { - if !is_array($access_logs) { - fail("Apache::Vhost[${name}]: access_logs must be an array of hashes") - } $_access_logs = $access_logs } @@ -343,12 +2212,19 @@ define apache::vhost( $error_log_destination = $error_log_syslog } else { if $ssl { - $error_log_destination = "${logroot}/${name}_error_ssl.log" + $error_log_destination = "${logroot}/${filename}_error_ssl.log" } else { - $error_log_destination = "${logroot}/${name}_error.log" + $error_log_destination = "${logroot}/${filename}_error.log" } } + if versioncmp($apache_version, '2.4') >= 0 { + $error_log_format24 = $error_log_format + } + else { + $error_log_format24 = undef + } + if $modsec_audit_log == false { $modsec_audit_log_destination = undef } elsif $modsec_audit_log_file { @@ -357,15 +2233,14 @@ define apache::vhost( $modsec_audit_log_destination = $modsec_audit_log_pipe } elsif $modsec_audit_log { if $ssl { - $modsec_audit_log_destination = "${logroot}/${name}_security_ssl.log" + $modsec_audit_log_destination = "${logroot}/${filename}_security_ssl.log" } else { - $modsec_audit_log_destination = "${logroot}/${name}_security.log" + $modsec_audit_log_destination = "${logroot}/${filename}_security.log" } } else { $modsec_audit_log_destination = undef } - if $ip { $_ip = any2array(enclose_ipv6($ip)) if $port { @@ -391,74 +2266,66 @@ define apache::vhost( } } } + if $add_listen { - if $ip and defined(Apache::Listen["${port}"]) { + if $ip and defined(Apache::Listen[String($port)]) { fail("Apache::Vhost[${name}]: Mixing IP and non-IP Listen directives is not possible; check the add_listen parameter of the apache::vhost define to disable this") } if $listen_addr_port and $ensure == 'present' { - ensure_resource('apache::listen', $listen_addr_port, {'port'=> $port}) + ensure_resource('apache::listen', $listen_addr_port) } } if ! $ip_based { if $ensure == 'present' and (versioncmp($apache_version, '2.4') < 0) { - ensure_resource('::apache::namevirtualhost', $nvh_addr_port, {'port' => $port}) + ensure_resource('apache::namevirtualhost', $nvh_addr_port) } } # Load mod_rewrite if needed and not yet loaded if $rewrites or $rewrite_cond { if ! defined(Class['apache::mod::rewrite']) { - include ::apache::mod::rewrite + include apache::mod::rewrite } } # Load mod_alias if needed and not yet loaded - if ($scriptalias or $scriptaliases != []) or ($aliases and $aliases != []) or ($redirect_source and $redirect_dest) { + if ($scriptalias or $scriptaliases != []) + or ($aliases and $aliases != []) + or ($redirect_source and $redirect_dest) + or ($redirectmatch_regexp or $redirectmatch_status or $redirectmatch_dest) { if ! defined(Class['apache::mod::alias']) and ($ensure == 'present') { - include ::apache::mod::alias + include apache::mod::alias } } # Load mod_proxy if needed and not yet loaded if ($proxy_dest or $proxy_pass or $proxy_pass_match or $proxy_dest_match) { if ! defined(Class['apache::mod::proxy']) { - include ::apache::mod::proxy + include apache::mod::proxy } if ! defined(Class['apache::mod::proxy_http']) { - include ::apache::mod::proxy_http + include apache::mod::proxy_http } } - # Load mod_passenger if needed and not yet loaded - if $rack_base_uris { - if ! defined(Class['apache::mod::passenger']) { - include ::apache::mod::passenger - } - } - - # Load mod_passenger if needed and not yet loaded - if $passenger_base_uris { - include ::apache::mod::passenger - } - - # Load mod_fastci if needed and not yet loaded + # Load mod_fastcgi if needed and not yet loaded if $fastcgi_server and $fastcgi_socket { if ! defined(Class['apache::mod::fastcgi']) { - include ::apache::mod::fastcgi + include apache::mod::fastcgi } } # Check if mod_headers is required to process $headers/$request_headers if $headers or $request_headers { if ! defined(Class['apache::mod::headers']) { - include ::apache::mod::headers + include apache::mod::headers } } # Check if mod_filter is required to process $filters if $filters { if ! defined(Class['apache::mod::filter']) { - include ::apache::mod::filter + include apache::mod::filter } } @@ -467,7 +2334,7 @@ define apache::vhost( $use_env_mod = $setenv and ! empty($setenv) if ($use_env_mod) { if ! defined(Class['apache::mod::env']) { - include ::apache::mod::env + include apache::mod::env } } # Check if mod_setenvif is required and not yet loaded. @@ -476,15 +2343,12 @@ define apache::vhost( if ($use_setenvif_mod) { if ! defined(Class['apache::mod::setenvif']) { - include ::apache::mod::setenvif + include apache::mod::setenvif } } ## Create a default directory list if none defined if $directories { - if !is_hash($directories) and !(is_array($directories) and is_hash($directories[0])) { - fail("Apache::Vhost[${name}]: 'directories' must be either a Hash or an Array of Hashes") - } $_directories = $directories } elsif $docroot { $_directory = { @@ -506,76 +2370,74 @@ define apache::vhost( } } - $_directories = [ merge($_directory, $_directory_version) ] + $_directories = [merge($_directory, $_directory_version)] } else { $_directories = undef } ## Create a global LocationMatch if locations aren't defined if $modsec_disable_ids { - if is_hash($modsec_disable_ids) { - $_modsec_disable_ids = $modsec_disable_ids - } elsif is_array($modsec_disable_ids) { + if $modsec_disable_ids =~ Array { $_modsec_disable_ids = { '.*' => $modsec_disable_ids } } else { - fail("Apache::Vhost[${name}]: 'modsec_disable_ids' must be either a Hash of location/IDs or an Array of IDs") + $_modsec_disable_ids = $modsec_disable_ids } } if $modsec_disable_msgs { - if is_hash($modsec_disable_msgs) { - $_modsec_disable_msgs = $modsec_disable_msgs - } elsif is_array($modsec_disable_msgs) { + if $modsec_disable_msgs =~ Array { $_modsec_disable_msgs = { '.*' => $modsec_disable_msgs } } else { - fail("Apache::Vhost[${name}]: 'modsec_disable_msgs' must be either a Hash of location/Msgs or an Array of Msgs") + $_modsec_disable_msgs = $modsec_disable_msgs } } if $modsec_disable_tags { - if is_hash($modsec_disable_tags) { - $_modsec_disable_tags = $modsec_disable_tags - } elsif is_array($modsec_disable_tags) { + if $modsec_disable_tags =~ Array { $_modsec_disable_tags = { '.*' => $modsec_disable_tags } } else { - fail("Apache::Vhost[${name}]: 'modsec_disable_tags' must be either a Hash of location/Tags or an Array of Tags") + $_modsec_disable_tags = $modsec_disable_tags } } concat { "${priority_real}${filename}.conf": ensure => $ensure, - path => "${::apache::vhost_dir}/${priority_real}${filename}.conf", + path => "${apache::vhost_dir}/${priority_real}${filename}.conf", owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, + group => $apache::params::root_group, + mode => $apache::file_mode, order => 'numeric', require => Package['httpd'], notify => Class['apache::service'], } # NOTE(pabelanger): This code is duplicated in ::apache::vhost::custom and # needs to be converted into something generic. - if $::apache::vhost_enable_dir { - $vhost_enable_dir = $::apache::vhost_enable_dir + if $apache::vhost_enable_dir { + $vhost_enable_dir = $apache::vhost_enable_dir $vhost_symlink_ensure = $ensure ? { - present => link, + 'present' => link, default => $ensure, } - file{ "${priority_real}${filename}.conf symlink": + file { "${priority_real}${filename}.conf symlink": ensure => $vhost_symlink_ensure, path => "${vhost_enable_dir}/${priority_real}${filename}.conf", - target => "${::apache::vhost_dir}/${priority_real}${filename}.conf", + target => "${apache::vhost_dir}/${priority_real}${filename}.conf", owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, + group => $apache::params::root_group, + mode => $apache::file_mode, require => Concat["${priority_real}${filename}.conf"], notify => Class['apache::service'], } } # Template uses: + # - $comment # - $nvh_addr_port # - $servername # - $serveradmin + # - $protocols + # - $protocols_honor_order + # - $apache_version concat::fragment { "${name}-apache-header": target => "${priority_real}${filename}.conf", order => 0, @@ -584,6 +2446,7 @@ define apache::vhost( # Template uses: # - $virtual_docroot + # - $virtual_use_default_docroot # - $docroot if $docroot { concat::fragment { "${name}-docroot": @@ -660,6 +2523,7 @@ define apache::vhost( # Template uses: # - $error_log + # - $error_log_format24 # - $log_level # - $error_log_destination # - $log_level @@ -744,6 +2608,25 @@ define apache::vhost( } } + # Template uses: + # - $ssl_proxyengine + # - $ssl_proxy_verify + # - $ssl_proxy_verify_depth + # - $ssl_proxy_ca_cert + # - $ssl_proxy_check_peer_cn + # - $ssl_proxy_check_peer_name + # - $ssl_proxy_check_peer_expire + # - $ssl_proxy_machine_cert + # - $ssl_proxy_machine_cert_chain + # - $ssl_proxy_protocol + if $ssl_proxyengine { + concat::fragment { "${name}-sslproxy": + target => "${priority_real}${filename}.conf", + order => 160, + content => template('apache/vhost/_sslproxy.erb'), + } + } + # Template uses: # - $proxy_dest # - $proxy_pass @@ -753,29 +2636,9 @@ define apache::vhost( # - $no_proxy_uris if $proxy_dest or $proxy_pass or $proxy_pass_match or $proxy_dest_match or $proxy_preserve_host { concat::fragment { "${name}-proxy": - target => "${priority_real}${filename}.conf", - order => 160, - content => template('apache/vhost/_proxy.erb'), - } - } - - # Template uses: - # - $rack_base_uris - if $rack_base_uris { - concat::fragment { "${name}-rack": target => "${priority_real}${filename}.conf", order => 170, - content => template('apache/vhost/_rack.erb'), - } - } - - # Template uses: - # - $passenger_base_uris - if $passenger_base_uris { - concat::fragment { "${name}-passenger_uris": - target => "${priority_real}${filename}.conf", - order => 175, - content => template('apache/vhost/_passenger_base_uris.erb'), + content => template('apache/vhost/_proxy.erb'), } } @@ -817,7 +2680,7 @@ define apache::vhost( # Template uses: # - $scriptaliases # - $scriptalias - if ( $scriptalias or $scriptaliases != [] ) { + if ( $scriptalias or $scriptaliases != []) { concat::fragment { "${name}-scriptalias": target => "${priority_real}${filename}.conf", order => 200, @@ -858,36 +2721,36 @@ define apache::vhost( # - $ssl_crl_check # - $ssl_protocol # - $ssl_cipher - # - $ssl_honorcipherorder + # - $_ssl_honorcipherorder # - $ssl_verify_client # - $ssl_verify_depth # - $ssl_options # - $ssl_openssl_conf_cmd # - $ssl_stapling # - $apache_version - if $ssl { + if $ssl and $ensure == 'present' { concat::fragment { "${name}-ssl": target => "${priority_real}${filename}.conf", order => 230, content => template('apache/vhost/_ssl.erb'), } - } - # Template uses: - # - $ssl_proxyengine - # - $ssl_proxy_verify - # - $ssl_proxy_verify_depth - # - $ssl_proxy_ca_cert - # - $ssl_proxy_check_peer_cn - # - $ssl_proxy_check_peer_name - # - $ssl_proxy_check_peer_expire - # - $ssl_proxy_machine_cert - # - $ssl_proxy_protocol - if $ssl_proxyengine { - concat::fragment { "${name}-sslproxy": - target => "${priority_real}${filename}.conf", - order => 230, - content => template('apache/vhost/_sslproxy.erb'), + if $ssl_reload_on_change { + [$ssl_cert, $ssl_key, $ssl_ca, $ssl_chain, $ssl_crl].each |$ssl_file| { + if $ssl_file { + include apache::mod::ssl::reload + $_ssl_file_copy = regsubst($ssl_file, '/', '_', 'G') + file { "${filename}${_ssl_file_copy}": + path => "${apache::params::puppet_ssl_dir}/${filename}${_ssl_file_copy}", + source => "file://${ssl_file}", + owner => 'root', + group => $apache::params::root_group, + mode => '0640', + seltype => 'cert_t', + notify => Class['apache::service'], + } + } + } } } @@ -950,6 +2813,9 @@ define apache::vhost( # - $wsgi_process_group # - $wsgi_script_aliases # - $wsgi_pass_authorization + if $wsgi_daemon_process_options { + deprecation('apache::vhost::wsgi_daemon_process_options', 'This parameter is deprecated. Please add values inside Hash `wsgi_daemon_process`.') + } if $wsgi_application_group or $wsgi_daemon_process or ($wsgi_import_script and $wsgi_import_script_options) or $wsgi_process_group or ($wsgi_script_aliases and ! empty($wsgi_script_aliases)) or $wsgi_pass_authorization { concat::fragment { "${name}-wsgi": target => "${priority_real}${filename}.conf", @@ -992,19 +2858,65 @@ define apache::vhost( } } + if $h2_copy_files != undef or $h2_direct != undef or $h2_early_hints != undef or $h2_max_session_streams != undef or $h2_modern_tls_only != undef or $h2_push != undef or $h2_push_diary_size != undef or $h2_push_priority != [] or $h2_push_resource != [] or $h2_serialize_headers != undef or $h2_stream_max_mem_size != undef or $h2_tls_cool_down_secs != undef or $h2_tls_warm_up_size != undef or $h2_upgrade != undef or $h2_window_size != undef { + include apache::mod::http2 + + concat::fragment { "${name}-http2": + target => "${priority_real}${filename}.conf", + order => 300, + content => template('apache/vhost/_http2.erb'), + } + } + + if $mdomain { + include apache::mod::md + } + # Template uses: - # - $passenger_app_root - # - $passenger_app_env - # - $passenger_ruby - # - $passenger_min_instances - # - $passenger_max_requests + # - $passenger_enabled # - $passenger_start_timeout - # - $passenger_pre_start - # - $passenger_user + # - $passenger_ruby + # - $passenger_python # - $passenger_nodejs - # - $passenger_sticky_sessions + # - $passenger_meteor_app_settings + # - $passenger_app_env + # - $passenger_app_root + # - $passenger_app_group_name + # - $passenger_app_start_command + # - $passenger_app_type # - $passenger_startup_file - if $passenger_app_root or $passenger_app_env or $passenger_ruby or $passenger_min_instances or $passenger_start_timeout or $passenger_pre_start or $passenger_user or $passenger_nodejs or $passenger_sticky_sessions or $passenger_startup_file{ + # - $passenger_restart_dir + # - $passenger_spawn_method + # - $passenger_load_shell_envvars + # - $passenger_rolling_restarts + # - $passenger_resist_deployment_errors + # - $passenger_min_instances + # - $passenger_max_instances + # - $passenger_max_preloader_idle_time + # - $passenger_force_max_concurrent_requests_per_process + # - $passenger_concurrency_model + # - $passenger_thread_count + # - $passenger_high_performance + # - $passenger_max_request_queue_size + # - $passenger_max_request_queue_time + # - $passenger_user + # - $passenger_group + # - $passenger_friendly_error_pages + # - $passenger_buffer_upload + # - $passenger_buffer_response + # - $passenger_allow_encoded_slashes + # - $passenger_lve_min_uid + # - $passenger_base_uri + # - $passenger_error_override + # - $passenger_sticky_sessions + # - $passenger_sticky_sessions_cookie_name + # - $passenger_sticky_sessions_cookie_attributes + # - $passenger_app_log_file + # - $passenger_debugger + # - $passenger_max_requests + # - $passenger_max_request_time + # - $passenger_memory_limit + if $passenger_enabled != undef or $passenger_start_timeout != undef or $passenger_ruby != undef or $passenger_python != undef or $passenger_nodejs != undef or $passenger_meteor_app_settings != undef or $passenger_app_env != undef or $passenger_app_root != undef or $passenger_app_group_name != undef or $passenger_app_start_command != undef or $passenger_app_type != undef or $passenger_startup_file != undef or $passenger_restart_dir != undef or $passenger_spawn_method != undef or $passenger_load_shell_envvars != undef or $passenger_rolling_restarts != undef or $passenger_resist_deployment_errors != undef or $passenger_min_instances != undef or $passenger_max_instances != undef or $passenger_max_preloader_idle_time != undef or $passenger_force_max_concurrent_requests_per_process != undef or $passenger_concurrency_model != undef or $passenger_thread_count != undef or $passenger_high_performance != undef or $passenger_max_request_queue_size != undef or $passenger_max_request_queue_time != undef or $passenger_user != undef or $passenger_group != undef or $passenger_friendly_error_pages != undef or $passenger_buffer_upload != undef or $passenger_buffer_response != undef or $passenger_allow_encoded_slashes != undef or $passenger_lve_min_uid != undef or $passenger_base_uri != undef or $passenger_error_override != undef or $passenger_sticky_sessions != undef or $passenger_sticky_sessions_cookie_name != undef or $passenger_sticky_sessions_cookie_attributes != undef or $passenger_app_log_file != undef or $passenger_debugger != undef or $passenger_max_requests != undef or $passenger_max_request_time != undef or $passenger_memory_limit != undef { concat::fragment { "${name}-passenger": target => "${priority_real}${filename}.conf", order => 300, @@ -1090,6 +3002,36 @@ define apache::vhost( } } + # Template uses: + # - $auth_oidc + # - $oidc_settings + if $auth_oidc { + concat::fragment { "${name}-auth_oidc": + target => "${priority_real}${filename}.conf", + order => 360, + content => template('apache/vhost/_auth_oidc.erb'), + } + } + + # Template uses: + # - $shib_compat_valid_user + if $shibboleth_enabled { + concat::fragment { "${name}-shibboleth": + target => "${priority_real}${filename}.conf", + order => 370, + content => template('apache/vhost/_shib.erb'), + } + } + + # - $use_canonical_name + if $use_canonical_name { + concat::fragment { "${name}-use_canonical_name": + target => "${priority_real}${filename}.conf", + order => 360, + content => template('apache/vhost/_use_canonical_name.erb'), + } + } + # Template uses no variables concat::fragment { "${name}-file_footer": target => "${priority_real}${filename}.conf", diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhost/custom.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhost/custom.pp index cfb06c273..56e8b1258 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhost/custom.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhost/custom.pp @@ -1,18 +1,34 @@ -# See README.md for usage information -define apache::vhost::custom( +# @summary +# A wrapper around the `apache::custom_config` defined type. +# +# The `apache::vhost::custom` defined type is a thin wrapper around the `apache::custom_config` defined type, and simply overrides some of its default settings specific to the virtual host directory in Apache. +# +# @param content +# Sets the configuration file's content. +# +# @param ensure +# Specifies if the virtual host file is present or absent. +# +# @param priority +# Sets the relative load order for Apache HTTPD VirtualHost configuration files. +# +# @param verify_config +# Specifies whether to validate the configuration file before notifying the Apache service. +# +define apache::vhost::custom ( $content, $ensure = 'present', $priority = '25', $verify_config = true, ) { - include ::apache + include apache ## Apache include does not always work with spaces in the filename $filename = regsubst($name, ' ', '_', 'G') ::apache::custom_config { $filename: ensure => $ensure, - confdir => $::apache::vhost_dir, + confdir => $apache::vhost_dir, content => $content, priority => $priority, verify_config => $verify_config, @@ -20,19 +36,19 @@ define apache::vhost::custom( # NOTE(pabelanger): This code is duplicated in ::apache::vhost and needs to # converted into something generic. - if $::apache::vhost_enable_dir { + if $apache::vhost_enable_dir { $vhost_symlink_ensure = $ensure ? { - present => link, + 'present' => link, default => $ensure, } file { "${priority}-${filename}.conf symlink": ensure => $vhost_symlink_ensure, - path => "${::apache::vhost_enable_dir}/${priority}-${filename}.conf", - target => "${::apache::vhost_dir}/${priority}-${filename}.conf", + path => "${apache::vhost_enable_dir}/${priority}-${filename}.conf", + target => "${apache::vhost_dir}/${priority}-${filename}.conf", owner => 'root', - group => $::apache::params::root_group, - mode => $::apache::file_mode, + group => $apache::params::root_group, + mode => $apache::file_mode, require => Apache::Custom_config[$filename], notify => Class['apache::service'], } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhost/fragment.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhost/fragment.pp new file mode 100644 index 000000000..b331214bb --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhost/fragment.pp @@ -0,0 +1,84 @@ +# @summary Define a fragment within a vhost +# +# @param vhost +# The title of the vhost resource to append to +# +# @param priority +# Set the priority to match the one `apache::vhost` sets. This must match the +# one `apache::vhost` sets or else the concat fragment won't be found. +# +# @param content +# The content to put in the fragment. Only when it's non-empty the actual +# fragment will be created. +# +# @param order +# The order to insert the fragment at +# +# @example With a vhost without priority +# include apache +# apache::vhost { 'myvhost': +# } +# apache::vhost::fragment { 'myfragment': +# vhost => 'myvhost', +# content => '# Foo', +# } +# +# @example With a vhost with priority +# include apache +# apache::vhost { 'myvhost': +# priority => '42', +# } +# apache::vhost::fragment { 'myfragment': +# vhost => 'myvhost', +# priority => '42', +# content => '# Foo', +# } +# +# @example With a vhost with default vhost +# include apache +# apache::vhost { 'myvhost': +# default_vhost => true, +# } +# apache::vhost::fragment { 'myfragment': +# vhost => 'myvhost', +# priority => '10', # default_vhost implies priority 10 +# content => '# Foo', +# } +# +# @example Adding a fragment to the built in default vhost +# include apache +# apache::vhost::fragment { 'myfragment': +# vhost => 'default', +# priority => '15', +# content => '# Foo', +# } +# +define apache::vhost::fragment ( + String[1] $vhost, + Optional[Integer[0]] $port = undef, + $priority = undef, + Optional[String] $content = undef, + Integer[0] $order = 900, +) { + # This copies the logic from apache::vhost + if $priority { + $priority_real = "${priority}-" + } elsif $priority == false { + $priority_real = '' + } else { + $priority_real = '25-' + } + + $filename = $port ? { + Integer => regsubst("${vhost}-${port}", ' ', '_', 'G'), + Undef => regsubst($vhost, ' ', '_', 'G'), + } + + if $content =~ String[1] { + concat::fragment { "${vhost}-${title}": + target => "${priority_real}${filename}.conf", + order => $order, + content => $content, + } + } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhosts.pp b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhosts.pp index cf212c4b1..6d0fcf27f 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhosts.pp +++ b/modules/services/unix/http/apache_stretch_compatible/apache/manifests/vhosts.pp @@ -1,6 +1,26 @@ +# @summary +# Creates `apache::vhost` defined types. +# +# @note See the `apache::vhost` defined type's reference for a list of all virtual +# host parameters or Configuring virtual hosts in the README section. +# +# @example To create a [name-based virtual host](https://httpd.apache.org/docs/current/vhosts/name-based.html) `custom_vhost_1` +# class { 'apache::vhosts': +# vhosts => { +# 'custom_vhost_1' => { +# 'docroot' => '/var/www/custom_vhost_1', +# 'port' => '81', +# }, +# }, +# } +# +# @param vhosts +# A hash, where the key represents the name and the value represents a hash of +# `apache::vhost` defined type's parameters. +# class apache::vhosts ( $vhosts = {}, ) { - include ::apache + include apache create_resources('apache::vhost', $vhosts) } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/metadata.json b/modules/services/unix/http/apache_stretch_compatible/apache/metadata.json index dffb29dd4..29255598e 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/metadata.json +++ b/modules/services/unix/http/apache_stretch_compatible/apache/metadata.json @@ -1,38 +1,37 @@ { "name": "puppetlabs-apache", - "version": "2.0.0", - "author": "puppet", + "version": "7.0.0", + "author": "puppetlabs", "summary": "Installs, configures, and manages Apache virtual hosts, web services, and modules.", "license": "Apache-2.0", - "source": "git://github.com/puppetlabs/puppetlabs-apache.git", + "source": "https://github.com/puppetlabs/puppetlabs-apache", "project_page": "https://github.com/puppetlabs/puppetlabs-apache", "issues_url": "https://tickets.puppetlabs.com/browse/MODULES", "dependencies": [ { "name": "puppetlabs/stdlib", - "version_requirement": ">= 4.13.1 < 5.3.0" + "version_requirement": ">= 4.13.1 < 9.0.0" }, { "name": "puppetlabs/concat", - "version_requirement": ">= 2.2.1 < 5.3.0" + "version_requirement": ">= 2.2.1 < 8.0.0" } ], - "data_provider": null, "operatingsystem_support": [ { "operatingsystem": "RedHat", "operatingsystemrelease": [ - "5", "6", - "7" + "7", + "8" ] }, { "operatingsystem": "CentOS", "operatingsystemrelease": [ - "5", "6", - "7" + "7", + "8" ] }, { @@ -45,7 +44,6 @@ { "operatingsystem": "Scientific", "operatingsystemrelease": [ - "5", "6", "7" ] @@ -53,33 +51,41 @@ { "operatingsystem": "Debian", "operatingsystemrelease": [ - "6", - "7", - "8" + "9", + "10", + "11" ] }, { "operatingsystem": "SLES", "operatingsystemrelease": [ - "11 SP1", - "12" + "12", + "15" ] }, { "operatingsystem": "Ubuntu", "operatingsystemrelease": [ - "10.04", - "12.04", - "14.04", - "16.04" + "16.04", + "18.04", + "20.04" + ] + }, + { + "operatingsystem": "Rocky", + "operatingsystemrelease": [ + "8" ] } ], "requirements": [ { "name": "puppet", - "version_requirement": ">= 4.7.0 < 6.0.0" + "version_requirement": ">= 6.0.0 < 8.0.0" } ], - "description": "Module for Apache configuration" + "description": "Module for Apache configuration", + "pdk-version": "2.1.0", + "template-url": "https://github.com/puppetlabs/pdk-templates.git#main", + "template-ref": "heads/main-0-g03daa92" } diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/pdk.yaml b/modules/services/unix/http/apache_stretch_compatible/apache/pdk.yaml new file mode 100644 index 000000000..4bef4bd0f --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/pdk.yaml @@ -0,0 +1,2 @@ +--- +ignore: [] diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/provision.yaml b/modules/services/unix/http/apache_stretch_compatible/apache/provision.yaml new file mode 100644 index 000000000..e3cd93296 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/provision.yaml @@ -0,0 +1,70 @@ +--- +default: + provisioner: docker + images: + - litmusimage/debian:8 +vagrant: + provisioner: vagrant + images: + - centos/7 + - generic/ubuntu1804 +travis_deb: + provisioner: docker + images: + - litmusimage/debian:8 + - litmusimage/debian:9 + - litmusimage/debian:10 +travis_ub_6: + provisioner: docker + images: + - litmusimage/ubuntu:14.04 + - litmusimage/ubuntu:16.04 + - litmusimage/ubuntu:18.04 + - litmusimage/ubuntu:20.04 +travis_el7: + provisioner: docker + images: + - litmusimage/centos:7 + - litmusimage/oraclelinux:7 + - litmusimage/scientificlinux:7 +travis_el8: + provisioner: docker + images: + - litmusimage/centos:8 +release_checks_6: + provisioner: abs + images: + - redhat-6-x86_64 + - redhat-7-x86_64 + - redhat-8-x86_64 + - centos-6-x86_64 + - centos-7-x86_64 + - centos-8-x86_64 + - oracle-6-x86_64 + - oracle-7-x86_64 + - scientific-6-x86_64 + - scientific-7-x86_64 + - debian-8-x86_64 + - debian-9-x86_64 + - debian-10-x86_64 + - ubuntu-1404-x86_64 + - ubuntu-1604-x86_64 + - ubuntu-1804-x86_64 + - ubuntu-2004-x86_64 + - sles-12-x86_64 + - sles-15-x86_64 +release_checks_7: + provisioner: abs + images: + - redhat-7-x86_64 + - redhat-8-x86_64 + - centos-7-x86_64 + - centos-8-x86_64 + - oracle-7-x86_64 + - scientific-7-x86_64 + - debian-9-x86_64 + - debian-10-x86_64 + - sles-12-x86_64 + - sles-15-x86_64 + - ubuntu-1804-x86_64 + - ubuntu-2004-x86_64 diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/readmes/README_ja_JP.md b/modules/services/unix/http/apache_stretch_compatible/apache/readmes/README_ja_JP.md new file mode 100644 index 000000000..22fbebcc1 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/readmes/README_ja_JP.md @@ -0,0 +1,5748 @@ +# apache + +[モジュールの概要]: #module-description + +[セットアップ]: #setup +[Apacheの使用を始める]: #beginning-with-apache + +[使用方法]: #usage +[バーチャルホストの設定]: #configuring-virtual-hosts +[SSLを使ったバーチャルホストの設定]: #configuring-virtual-hosts-with-ssl +[バーチャルホストのポートおよびアドレスのバインディング設定]: #configuring-virtual-host-port-and-address-bindings +[アプリおよびプロセッサのバーチャルホストの設定]: #configuring-virtual-hosts-for-apps-and-processors +[IPベースのバーチャルホストの設定]: #configuring-ip-based-virtual-hosts +[Apacheモジュールのインストール]: #installing-apache-modules +[任意モジュールのインストール]: #installing-arbitrary-modules +[固有モジュールのインストール]: #installing-specific-modules +[FastCGIサーバの設定]: #configuring-fastcgi-servers-to-handle-php-files +[ロードバランシングの例]: #load-balancing-examples +[apacheの影響]: #what-the-apache-module-affects + +[リファレンス]: #reference +[パブリッククラス]: #public-classes +[プライベートクラス]: #private-classes +[パブリック定義タイプ]: #public-defined-types +[プライベート定義タイプ]: #private-defined-types +[テンプレート]: #templates +[タスク]: #tasks + +[制約事項]: #limitations + +[開発]: #development +[貢献]: #contributing + +[`AddDefaultCharset`]: https://httpd.apache.org/docs/current/mod/core.html#adddefaultcharset +[`add_listen`]: #add_listen +[`Alias`]: https://httpd.apache.org/docs/current/mod/mod_alias.html#alias +[`AliasMatch`]: https://httpd.apache.org/docs/current/mod/mod_alias.html#aliasmatch +[エイリアスサーバ]: https://httpd.apache.org/docs/current/urlmapping.html +[`AllowEncodedSlashes`]: https://httpd.apache.org/docs/current/mod/core.html#allowencodedslashes +[`apache`]: #class-apache +[`apache_version`]: #apache_version +[`apache::balancer`]: #defined-type-apachebalancer +[`apache::balancermember`]: #defined-type-apachebalancermember +[`apache::fastcgi::server`]: #defined-type-apachefastcgiserver +[`apache::mod`]: #defined-type-apachemod +[`apache::mod::`]: #classes-apachemodmodule-name +[`apache::mod::alias`]: #class-apachemodalias +[`apache::mod::auth_cas`]: #class-apachemodauth_cas +[`apache::mod::auth_mellon`]: #class-apachemodauth_mellon +[`apache::mod::authn_dbd`]: #class-apachemodauthn_dbd +[`apache::mod::authnz_ldap`]: #class-apachemodauthnz_ldap +[`apache::mod::cluster`]: #class-apachemodcluster +[`apache::mod::data]: #class-apachemoddata +[`apache::mod::disk_cache`]: #class-apachemoddisk_cache +[`apache::mod::dumpio`]: #class-apachemoddumpio +[`apache::mod::event`]: #class-apachemodevent +[`apache::mod::ext_filter`]: #class-apachemodext_filter +[`apache::mod::geoip`]: #class-apachemodgeoip +[`apache::mod::itk`]: #class-apachemoditk +[`apache::mod::jk`]: #class-apachemodjk +[`apache::mod::ldap`]: #class-apachemodldap +[`apache::mod::passenger`]: #class-apachemodpassenger +[`apache::mod::peruser`]: #class-apachemodperuser +[`apache::mod::prefork`]: #class-apachemodprefork +[`apache::mod::proxy`]: #class-apachemodproxy +[`apache::mod::proxy_balancer`]: #class-apachemodproxybalancer +[`apache::mod::proxy_fcgi`]: #class-apachemodproxy_fcgi +[`apache::mod::proxy_html`]: #class-apachemodproxy_html +[`apache::mod::python`]: #class-apachemodpython +[`apache::mod::security`]: #class-apachemodsecurity +[`apache::mod::shib`]: #class-apachemodshib +[`apache::mod::ssl`]: #class-apachemodssl +[`apache::mod::status`]: #class-apachemodstatus +[`apache::mod::userdir`]: #class-apachemoduserdir +[`apache::mod::worker`]: #class-apachemodworker +[`apache::mod::wsgi`]: #class-apachemodwsgi +[`apache::params`]: #class-apacheparams +[`apache::version`]: #class-apacheversion +[`apache::vhost`]: #defined-type-apachevhost +[`apache::vhost::custom`]: #defined-type-apachevhostcustom +[`apache::vhost::WSGIImportScript`]: #wsgiimportscript +[Apache HTTPサーバ]: https://httpd.apache.org +[Apacheモジュール]: https://httpd.apache.org/docs/current/mod/ +[配列]: https://docs.puppet.com/puppet/latest/reference/lang_data_array.html + +[オーディットログ]: https://github.com/SpiderLabs/ModSecurity/wiki/ModSecurity-2-Data-Formats#audit-log + +[beaker-rspec]: https://github.com/puppetlabs/beaker-rspec + +[証明書失効リスト]: https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslcarevocationfile +[証明書失効リストパス]: https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslcarevocationpath +[コモンゲートウェイインターフェース]: https://httpd.apache.org/docs/current/howto/cgi.html +[`confd_dir`]: #confd_dir +[`content`]: #content +[CONTRIBUTING.md]: CONTRIBUTING.md +[カスタムエラードキュメント]: https://httpd.apache.org/docs/current/custom-error.html +[`custom_fragment`]: #custom_fragment + +[`default_mods`]: #default_mods +[`default_ssl_crl`]: #default_ssl_crl +[`default_ssl_crl_path`]: #default_ssl_crl_path +[`default_ssl_vhost`]: #default_ssl_vhost +[`dev_packages`]: #dev_packages +[`directory`]: #directory +[`directories`]: #parameter-directories-for-apachevhost +[`DirectoryIndex`]: https://httpd.apache.org/docs/current/mod/mod_dir.html#directoryindex +[`docroot`]: #docroot +[`docroot_owner`]: #docroot_owner +[`docroot_group`]: #docroot_group +[`DocumentRoot`]: https://httpd.apache.org/docs/current/mod/core.html#documentroot + +[`EnableSendfile`]: https://httpd.apache.org/docs/current/mod/core.html#enablesendfile +[適用モード]: http://selinuxproject.org/page/Guide/Mode +[`ensure`]: https://docs.puppet.com/latest/type.html#package-attribute-ensure +[`error_log_file`]: #error_log_file +[`error_log_syslog`]: #error_log_syslog +[`error_log_pipe`]: #error_log_pipe +[`ExpiresByType`]: https://httpd.apache.org/docs/current/mod/mod_expires.html#expiresbytype +[エクスポートリソース]: http://docs.puppet.com/latest/reference/lang_exported.md +[`ExtendedStatus`]: https://httpd.apache.org/docs/current/mod/core.html#extendedstatus + +[Facter]: http://docs.puppet.com/facter/ +[FastCGI]: http://www.fastcgi.com/ +[FallbackResource]: https://httpd.apache.org/docs/current/mod/mod_dir.html#fallbackresource +[`fallbackresource`]: #fallbackresource +[`FileETag`]: https://httpd.apache.org/docs/current/mod/core.html#fileetag +[フィルタルール]: https://httpd.apache.org/docs/current/filter.html +[`filters`]: #filters +[`ForceType`]: https://httpd.apache.org/docs/current/mod/core.html#forcetype + +[GeoIPScanProxyHeaders]: http://dev.maxmind.com/geoip/legacy/mod_geoip2/#Proxy-Related_Directives +[`gentoo/puppet-portage`]: https://github.com/gentoo/puppet-portage + +[ハッシュ]: https://docs.puppet.com/puppet/latest/reference/lang_data_hash.html +[`HttpProtocolOptions`]: http://httpd.apache.org/docs/current/mod/core.html#httpprotocoloptions + +[`IncludeOptional`]: https://httpd.apache.org/docs/current/mod/core.html#includeoptional +[`Include`]: https://httpd.apache.org/docs/current/mod/core.html#include +[インターバル構文]: https://httpd.apache.org/docs/current/mod/mod_expires.html#AltSyn +[`ip`]: #ip +[`ip_based`]: #ip_based +[IPベースのバーチャルホスト]: https://httpd.apache.org/docs/current/vhosts/ip-based.html + +[`KeepAlive`]: https://httpd.apache.org/docs/current/mod/core.html#keepalive +[`KeepAliveTimeout`]: https://httpd.apache.org/docs/current/mod/core.html#keepalivetimeout +[`keepalive`パラメータ]: #keepalive +[`keepalive_timeout`]: #keepalive_timeout +[`limitreqfieldsize`]: https://httpd.apache.org/docs/current/mod/core.html#limitrequestfieldsize +[`limitreqfields`]: http://httpd.apache.org/docs/current/mod/core.html#limitrequestfields + +[`lib`]: #lib +[`lib_path`]: #lib_path +[`Listen`]: https://httpd.apache.org/docs/current/bind.html +[`ListenBackLog`]: https://httpd.apache.org/docs/current/mod/mpm_common.html#listenbacklog +[`LoadFile`]: https://httpd.apache.org/docs/current/mod/mod_so.html#loadfile +[`LogFormat`]: https://httpd.apache.org/docs/current/mod/mod_log_config.html#logformat +[`logroot`]: #logroot +[ログセキュリティ]: https://httpd.apache.org/docs/current/logs.html#security + +[`manage_docroot`]: #manage_docroot +[`manage_user`]: #manage_user +[`manage_group`]: #manage_group +[`supplementary_groups`]: #supplementary_groups +[`MaxConnectionsPerChild`]: https://httpd.apache.org/docs/current/mod/mpm_common.html#maxconnectionsperchild +[`max_keepalive_requests`]: #max_keepalive_requests +[`MaxRequestWorkers`]: https://httpd.apache.org/docs/current/mod/mpm_common.html#maxrequestworkers +[`MaxSpareThreads`]: https://httpd.apache.org/docs/current/mod/mpm_common.html#maxsparethreads +[MIME `content-type`]: https://www.iana.org/assignments/media-types/media-types.xhtml +[`MinSpareThreads`]: https://httpd.apache.org/docs/current/mod/mpm_common.html#minsparethreads +[`mod_alias`]: https://httpd.apache.org/docs/current/mod/mod_alias.html +[`mod_auth_cas`]: https://github.com/Jasig/mod_auth_cas +[`mod_auth_kerb`]: http://modauthkerb.sourceforge.net/configure.html +[`mod_auth_gssapi`]: https://github.com/modauthgssapi/mod_auth_gssapi +[`mod_authnz_external`]: https://github.com/phokz/mod-auth-external +[`mod_auth_dbd`]: http://httpd.apache.org/docs/current/mod/mod_authn_dbd.html +[`mod_auth_mellon`]: https://github.com/UNINETT/mod_auth_mellon +[`mod_dbd`]: http://httpd.apache.org/docs/current/mod/mod_dbd.html +[`mod_disk_cache`]: https://httpd.apache.org/docs/2.2/mod/mod_disk_cache.html +[`mod_dumpio`]: https://httpd.apache.org/docs/2.4/mod/mod_dumpio.html +[`mod_env`]: http://httpd.apache.org/docs/current/mod/mod_env.html +[`mod_expires`]: https://httpd.apache.org/docs/current/mod/mod_expires.html +[`mod_ext_filter`]: https://httpd.apache.org/docs/current/mod/mod_ext_filter.html +[`mod_fcgid`]: https://httpd.apache.org/mod_fcgid/mod/mod_fcgid.html +[`mod_geoip`]: http://dev.maxmind.com/geoip/legacy/mod_geoip2/ +[`mod_info`]: https://httpd.apache.org/docs/current/mod/mod_info.html +[`mod_ldap`]: https://httpd.apache.org/docs/2.2/mod/mod_ldap.html +[`mod_mpm_event`]: https://httpd.apache.org/docs/current/mod/event.html +[`mod_negotiation`]: https://httpd.apache.org/docs/current/mod/mod_negotiation.html +[`mod_pagespeed`]: https://developers.google.com/speed/pagespeed/module/?hl=en +[`mod_passenger`]: https://www.phusionpassenger.com/library/config/apache/reference/ +[`mod_php`]: http://php.net/manual/en/book.apache.php +[`mod_proxy`]: https://httpd.apache.org/docs/current/mod/mod_proxy.html +[`mod_proxy_balancer`]: https://httpd.apache.org/docs/current/mod/mod_proxy_balancer.html +[`mod_reqtimeout`]: https://httpd.apache.org/docs/current/mod/mod_reqtimeout.html +[`mod_python`]: http://modpython.org/ +[`mod_rewrite`]: https://httpd.apache.org/docs/current/mod/mod_rewrite.html +[`mod_security`]: https://www.modsecurity.org/ +[`mod_ssl`]: https://httpd.apache.org/docs/current/mod/mod_ssl.html +[`mod_status`]: https://httpd.apache.org/docs/current/mod/mod_status.html +[`mod_version`]: https://httpd.apache.org/docs/current/mod/mod_version.html +[`mod_wsgi`]: https://modwsgi.readthedocs.org/en/latest/ +[モジュール貢献ガイド]: https://docs.puppet.com/forge/contributing.html +[`mpm_module`]: #mpm_module +[マルチプロセッシングモジュール]: https://httpd.apache.org/docs/current/mpm.html + +[名前ベースのバーチャルホスト]: https://httpd.apache.org/docs/current/vhosts/name-based.html +[`no_proxy_uris`]: #no_proxy_uris + +[オープンソース版Puppet]: https://docs.puppet.com/puppet/ +[`Options`]: https://httpd.apache.org/docs/current/mod/core.html#options + +[`path`]: #path +[`Peruser`]: https://www.freebsd.org/cgi/url.cgi?ports/www/apache22-peruser-mpm/pkg-descr +[`port`]: #port +[`priority`]: #defined-types-apachevhost +[`proxy_dest`]: #proxy_dest +[`proxy_dest_match`]: #proxy_dest_match +[`proxy_pass`]: #proxy_pass +[`ProxyPass`]: https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass +[`ProxySet`]: https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyset +[Puppet Enterprise]: https://docs.puppet.com/pe/ +[Puppet Forge]: https://forge.puppet.com +[Puppet]: https://puppet.com +[Puppetモジュール]: https://docs.puppet.com/puppet/latest/reference/modules_fundamentals.html +[Puppetモジュールのコード]: https://github.com/puppetlabs/puppetlabs-apache/blob/main/manifests/default_mods.pp +[`purge_configs`]: #purge_configs +[`purge_vhost_dir`]: #purge_vhost_dir +[Python]: https://www.python.org/ + +[Rack]: http://rack.github.io/ +[`rack_base_uris`]: #rack_base_uris +[RFC 2616]: https://www.ietf.org/rfc/rfc2616.txt +[`RequestReadTimeout`]: https://httpd.apache.org/docs/current/mod/mod_reqtimeout.html#requestreadtimeout +[rspec-puppet]: http://rspec-puppet.com/ + +[`ScriptAlias`]: https://httpd.apache.org/docs/current/mod/mod_alias.html#scriptalias +[`ScriptAliasMatch`]: https://httpd.apache.org/docs/current/mod/mod_alias.html#scriptaliasmatch +[`scriptalias`]: #scriptalias +[SELinux]: http://selinuxproject.org/ +[`ServerAdmin`]: https://httpd.apache.org/docs/current/mod/core.html#serveradmin +[`serveraliases`]: #serveraliases +[`ServerLimit`]: https://httpd.apache.org/docs/current/mod/mpm_common.html#serverlimit +[`ServerName`]: https://httpd.apache.org/docs/current/mod/core.html#servername +[`ServerRoot`]: https://httpd.apache.org/docs/current/mod/core.html#serverroot +[`ServerTokens`]: https://httpd.apache.org/docs/current/mod/core.html#servertokens +[`ServerSignature`]: https://httpd.apache.org/docs/current/mod/core.html#serversignature +[サービス属性リスタート]: http://docs.puppet.com/latest/type.html#service-attribute-restart +[`source`]: #source +[`SSLCARevocationCheck`]: https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslcarevocationcheck +[SSL証明書のキーファイル]: https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslcertificatekeyfile +[SSLチェーン]: https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslcertificatechainfile +[SSL暗号化]: https://httpd.apache.org/docs/current/ssl/index.html +[`ssl`]: #ssl +[`ssl_cert`]: #ssl_cert +[`ssl_compression`]: #ssl_compression +[`ssl_key`]: #ssl_key +[`StartServers`]: https://httpd.apache.org/docs/current/mod/mpm_common.html#startservers +[suPHP]: http://www.suphp.org/Home.html +[`suphp_addhandler`]: #suphp_addhandler +[`suphp_configpath`]: #suphp_configpath +[`suphp_engine`]: #suphp_engine +[対応するオペレーティングシステム]: https://forge.puppet.com/supported#puppet-supported-modules-compatibility-matrix + +[`ThreadLimit`]: https://httpd.apache.org/docs/current/mod/mpm_common.html#threadlimit +[`ThreadsPerChild`]: https://httpd.apache.org/docs/current/mod/mpm_common.html#threadsperchild +[`TimeOut`]: https://httpd.apache.org/docs/current/mod/core.html#timeout +[テンプレート]: http://docs.puppet.com/puppet/latest/reference/lang_template.html +[`TraceEnable`]: https://httpd.apache.org/docs/current/mod/core.html#traceenable + +[`UseCanonicalName`]: https://httpd.apache.org/docs/current/mod/core.html#usecanonicalname + +[`verify_config`]: #verify_config +[`vhost`]: #defined-type-apachevhost +[`vhost_dir`]: #vhost_dir +[`virtual_docroot`]: #virtual_docroot + +[Webサーバゲートウェイインターフェース ]: https://www.python.org/dev/peps/pep-3333/#abstract +[`WSGIRestrictEmbedded`]: http://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIRestrictEmbedded.html +[`WSGIPythonPath`]: http://modwsgi.readthedocs.org/en/develop/configuration-directives/WSGIPythonPath.html +[`WSGIPythonHome`]: http://modwsgi.readthedocs.org/en/develop/configuration-directives/WSGIPythonHome.html + +#### 目次 + +1. [モジュールの概要 - apacheモジュールとは? 何をするためのもの?][モジュールの概要] +2. [セットアップ - apacheの使用を開始するにあたっての基礎][セットアップ] + - [apacheモジュールが影響を与えるもの][apacheの影響] + - [Apacheの使用を始める - インストール][Apacheの使用を始める] +3. [使用方法 - 設定に使用できるクラスと定義タイプ][使用方法] + - [バーチャルホストの設定 - 使用開始に役立つ例][バーチャルホストの設定] + - [PHPファイルを処理するFastCGIサーバの設定][FastCGIサーバの設定] + - [エクスポートおよび非エクスポートリソースのロードバランシング][ロードバランシングの例] +4. [リファレンス - モジュールの機能と動作について][リファレンス] + - [パブリッククラス][] + - [プライベートクラス][] + - [パブリック定義タイプ][] + - [プライベート定義タイプ][] + - [テンプレート][] + - [タスク][] +5. [制約事項 - OSの互換性など][制約事項] +6. [開発 - モジュールへの貢献方法][開発] + - [apacheモジュールへの貢献][貢献] + - [テストの実施 - クイックガイド][テストの実施] + + +## モジュールの概要 + +[Apache HTTPサーバ][] (Apache HTTPD、あるいは単にApacheとも呼ばれます)は、広く使用されているWebサーバです。この[Puppetモジュール][]によって、インフラ内でApacheを管理するための設定がシンプルなものになります。幅広いバーチャルホストセットアップを設定および管理し、[Apacheモジュール][]を効率的にインストールして設定することができます。 + + +## セットアップ + + +### apacheモジュールが影響を与えるもの: + +- (作成し、書き込みを行う)設定ファイルおよびディレクトリ + - **警告**: Puppetにより管理*されていない*設定はパージされます。 +- Apacheのパッケージ/サービス/設定ファイル +- Apacheモジュール +- バーチャルホスト +- リッスンするポート +- FreeBSDおよびGentooの`/etc/make.conf` + +Gentooでは、このモジュールは [`gentoo/puppet-portage`][] Puppetモジュールに依存します。Gentooについては、いくつかのオプションが適用され、一部の機能や設定が有効になりますが、このモジュールに[対応するオペレーティングシステム][]ではない点に留意してください。 + +> **警告**: このモジュールにより、Apache設定ファイルおよびディレクトリが修正され、Puppetで管理されていない設定がパージされます。Apache設定はPuppetで管理する必要があります。これは、管理されていない設定ファイルにより、予期せぬ不具合が生じる可能性があるためです。 +> +>全面的なPuppet管理を一時的に無効にするには、[`apache`][]クラス宣言の[`purge_configs`][]パラメータをfalseに設定します。この手順は、カスタマイズした設定を保存し、リロケーションするための一時的な対策としてのみ推奨されます。 + + +### Apacheの使用を始める + +デフォルトパラメータを用いてPuppetでApacheをインストールするには、[`apache`][]クラスを宣言します。 + +``` puppet +class { 'apache': } +``` + +デフォルトオプションを用いてこのクラスを宣言すると、モジュールでは以下のことが実行されます。 + +- オペレーティングシステムに適したApacheソフトウェアパッケージおよび[必要なApacheモジュール](#default_mods)をインストールします。 +- オペレーティングシステムに応じた[デフォルトロケーション](#conf_dir)を用いて、ディレクトリ内に必要な設定ファイルを配置します。 +- デフォルトのバーチャルホストおよび標準的なポート('80')とアドレス('\*')のバインディングを用いてサーバを設定します。 +- ドキュメントルートディレクトリを作成します。オペレーティングシステムによって異なりますが、通常は`/var/www`です。 +- Apacheサービスを開始します。 + +Apacheのデフォルト設定は、オペレーティングシステムによって異なります。これらのデフォルトは、テスト環境では機能しますが、本稼働環境には推奨されません。実際のサイトに応じてクラスのパラメータをカスタマイズすることを推奨します。 + +例えば、以下の宣言では、apacheモジュールの[デフォルトのバーチャルホスト設定][バーチャルホストの設定]を使わずにApacheがインストールされるので、すべてのApacheバーチャルホストをカスタマイズすることができます。 + +``` puppet +class { 'apache': + default_vhost => false, +} +``` + +> **注意**: `default_vhost`を`false`に設定する場合、少なくとも1つの`apache::vhost`リソースを追加する必要があります。追加しなければ、Apacheは起動しません。デフォルトのバーチャルホストを設定するには、`apache`クラスで`default_vhost`を設定するか、[`apache::vhost`][]定義タイプを使用します。[`apache::vhost`][]定義タイプを用いて、追加の固有バーチャルホストを設定することもできます。 + + +## 使用方法 + + +### バーチャルホストの設定 + +デフォルトの[`apache`][]クラスは、ポート80にバーチャルホストを設定します。すべてのインターフェースをリッスンし、[`docroot`][]パラメータのデフォルトディレクトリ`/var/www`をサーブします。 + + +基本の[名前ベースのバーチャルホスト][]を設定するには、[`apache::vhost`][]定義タイプで[`port`][]および[`docroot`][]パラメータを指定します。 + +``` puppet +apache::vhost { 'vhost.example.com': + port => '80', + docroot => '/var/www/vhost', +} +``` + +すべてのバーチャルホストパラメータのリストについては、[`apache::vhost`][]定義タイプのリファレンスを参照してください。 + +> **注意**: Apacheはバーチャルホストをアルファベット順に処理します。サーバ管理者は、バーチャルホスト設定ファイル名の先頭に数字を付けることで、 Apacheバーチャルホスト処理の優先順位を設定できます。[`apache::vhost`][]定義タイプは、デフォルトの [`priority`][]である25を適用します。これはPuppetではバーチャルホストのファイル名の先頭に`25-`が付いていると解釈されます。そのため、優先順位が同じサイトが複数ある場合や、`priority`パラメータの値をfalseに設定して優先順位番号を無効にした場合でも、Apacheはバーチャルホストをアルファベット順に処理します。 + +`docroot`のユーザおよびグループのオーナーシップを設定するには、[`docroot_owner`][]および[`docroot_group`][]パラメータを使用します。 + +``` puppet +apache::vhost { 'user.example.com': + port => '80', + docroot => '/var/www/user', + docroot_owner => 'www-data', + docroot_group => 'www-data', +} +``` + +#### SSLを使ったバーチャルホストの設定 + +[SSL encryption][]およびデフォルトのSSL証明書を使うようにバーチャルホストを設定するには、[`ssl`][]パラメータを設定します。また、[`port`][]パラメータを指定する必要もあります。通常は、'443'という値がHTTPSリクエストに対応します。 + +``` puppet +apache::vhost { 'ssl.example.com': + port => '443', + docroot => '/var/www/ssl', + ssl => true, +} +``` + +SSLおよび固有SSL証明書を使うようにバーチャルホストを設定するには、[`ssl_cert`][]および[`ssl_key`][]パラメータで証明書およびキーへのパスを使用します。 + +``` puppet +apache::vhost { 'cert.example.com': + port => '443', + docroot => '/var/www/cert', + ssl => true, + ssl_cert => '/etc/ssl/fourth.example.com.cert', + ssl_key => '/etc/ssl/fourth.example.com.key', +} +``` + +同じドメインでSSLと暗号化されていないバーチャルホストを混ぜて設定するには、それぞれを個別の[`apache::vhost`][]定義タイプで宣言します。 + +``` puppet +# The non-ssl virtual host +apache::vhost { 'mix.example.com non-ssl': + servername => 'mix.example.com', + port => '80', + docroot => '/var/www/mix', +} + +# The SSL virtual host at the same domain +apache::vhost { 'mix.example.com ssl': + servername => 'mix.example.com', + port => '443', + docroot => '/var/www/mix', + ssl => true, +} +``` + +暗号化されていない接続をSSLにリダイレクトするようにバーチャルホストを設定するには、それぞれを個別の[`apache::vhost`][]定義タイプで宣言し、SSLが有効化されているバーチャルホストに、暗号化されていないリクエストをリダイレクトします。 + +``` puppet +apache::vhost { 'redirect.example.com non-ssl': + servername => 'redirect.example.com', + port => '80', + docroot => '/var/www/redirect', + redirect_status => 'permanent', + redirect_dest => 'https://redirect.example.com/' +} + +apache::vhost { 'redirect.example.com ssl': + servername => 'redirect.example.com', + port => '443', + docroot => '/var/www/redirect', + ssl => true, +} +``` + +#### バーチャルホストのポートおよびアドレスのバインディング設定  + +バーチャルホストはデフォルトですべてのIPアドレス('\*')をリッスンします。特定のIPアドレスをリッスンするようにバーチャルホストを設定するには、[`ip`][]パラメータを使用します。 + +``` puppet +apache::vhost { 'ip.example.com': + ip => '127.0.0.1', + port => '80', + docroot => '/var/www/ip', +} +``` + +[`ip`][]パラメータにIPアドレスの配列を使えば、1つのバーチャルホストに複数のIPアドレスを設定することもできます。 + +``` puppet +apache::vhost { 'ip.example.com': + ip => ['127.0.0.1','169.254.1.1'], + port => '80', + docroot => '/var/www/ip', +} +``` + +[`port`][]パラメータにポートの配列を使えば、1つのバーチャルホストに複数のポートを設定することができます。 + +``` puppet +apache::vhost { 'ip.example.com': + ip => ['127.0.0.1'], + port => ['80','8080'] + docroot => '/var/www/ip', +} +``` + +[エイリアスサーバ][]を使ってバーチャルホストを設定するには、[`serveraliases`][]パラメータを使ってエイリアスを指定します。 + +``` puppet +apache::vhost { 'aliases.example.com': + serveraliases => [ + 'aliases.example.org', + 'aliases.example.net', + ], + port => '80', + docroot => '/var/www/aliases', +} +``` + +`/var/www/example.com`に'http://example.com.loc'をマッピングするケースのように、 同じ名前のディレクトリにマッピングされたサブドメイン用にワイルドカードエイリアスを使ってバーチャルホストを設定するには、[`serveraliases`][]パラメータを使ってワイルドカードエイリアスを、[`virtual_docroot`][]パラメータを使ってドキュメントルートを定義します。 + +``` puppet +apache::vhost { 'subdomain.loc': + vhost_name => '*', + port => '80', + virtual_docroot => '/var/www/%-2+', + docroot => '/var/www', + serveraliases => ['*.loc',], +} +``` + +[フィルタルール][]を使ってバーチャルホストを設定するには、[`filters`][]パラメータを使って、フィルタディレクティブを[array][]として渡します。 + +``` puppet +apache::vhost { 'subdomain.loc': + port => '80', + filters => [ + 'FilterDeclare COMPRESS', + 'FilterProvider COMPRESS DEFLATE resp=Content-Type $text/html', + 'FilterChain COMPRESS', + 'FilterProtocol COMPRESS DEFLATE change=yes;byteranges=no', + ], + docroot => '/var/www/html', +} +``` + +#### アプリおよびプロセッサのバーチャルホストの設定  + +[suPHP][]を使ってバーチャルホストを設定するには、以下のパラメータを使用します。 + +* [`suphp_engine`][]、suPHPエンジンを有効にします。 +* [`suphp_addhandler`][]、MIMEタイプを定義します。 +* [`suphp_configpath`][]、suPHPがPHPインタープリタに渡すパスを設定します。 +* [`directory`][]、ディレクトリ、ファイル、ロケーションの各ディレクティブブロックを設定します。 + +例:  + +``` puppet +apache::vhost { 'suphp.example.com': + port => '80', + docroot => '/home/appuser/myphpapp', + suphp_addhandler => 'x-httpd-php', + suphp_engine => 'on', + suphp_configpath => '/etc/php5/apache2', + directories => [ + { 'path' => '/home/appuser/myphpapp', + 'suphp' => { + user => 'myappuser', + group => 'myappgroup', + }, + }, + ], +} +``` + +[Python][]アプリケーション用の[Webサーバゲートウェイインターフェース][] (WSGI)を使ってバーチャルホストを設定するには、`wsgi`パラメータセットを使用します。 + +``` puppet +apache::vhost { 'wsgi.example.com': + port => '80', + docroot => '/var/www/pythonapp', + wsgi_application_group => '%{GLOBAL}', + wsgi_daemon_process => 'wsgi', + wsgi_daemon_process_options => { + processes => '2', + threads => '15', + display-name => '%{GROUP}', + }, + wsgi_import_script => '/var/www/demo.wsgi', + wsgi_import_script_options => { + process-group => 'wsgi', + application-group => '%{GLOBAL}', + }, + wsgi_process_group => 'wsgi', + wsgi_script_aliases => { '/' => '/var/www/demo.wsgi' }, +} +``` + +Apache 2.2.16の時点では、Apacheは[FallbackResource][]をサポートしています。これは、一般的なRewriteRulesに代わるシンプルなディレクティブです。[`fallbackresource`][]パラメータを使えば、FallbackResourceを設定できます。 + +``` puppet +apache::vhost { 'wordpress.example.com': + port => '80', + docroot => '/var/www/wordpress', + fallbackresource => '/index.php', +} +``` + +> **注意**: Apache 2.2.24以降では、`fallbackresource`パラメータがサポートするのは'disabled'値のみです。 + +[コモンゲートウェイインターフェース][] (CGI)ファイル用の指定ディレクトリを使ってバーチャルホストを設定するには、[`scriptalias`][]パラメータを使って`cgi-bin`パスを定義します。 + +``` puppet +apache::vhost { 'cgi.example.com': + port => '80', + docroot => '/var/www/cgi', + scriptalias => '/usr/lib/cgi-bin', +} +``` + +[Rack][]用のバーチャルホストを設定するには、[`rack_base_uris`][]パラメータを使用します。 + +``` puppet +apache::vhost { 'rack.example.com': + port => '80', + docroot => '/var/www/rack', + rack_base_uris => ['/rackapp1', '/rackapp2'], +} +``` + +#### IPベースのバーチャルホストの設定  + +任意のポートをリッスンし、固有IPアドレスのリクエストに応答する[IPベースのバーチャルホスト][]を設定することができます。この例では、サーバはポート80および81をリッスンします。これは、この例のバーチャルホストが[`port`][]パラメータにより宣言されて_いない_ ためです。 + +``` puppet +apache::listen { '80': } + +apache::listen { '81': } +``` + +[`ip_based`][]パラメータを使ってIPベースのバーチャルホストを設定します。 + +``` puppet +apache::vhost { 'first.example.com': + ip => '10.0.0.10', + docroot => '/var/www/first', + ip_based => true, +} + +apache::vhost { 'second.example.com': + ip => '10.0.0.11', + docroot => '/var/www/second', + ip_based => true, +} +``` + +任意の[SSL][SSL暗号化]構成と暗号化されていない構成を組み合わせ、IPベースと[名前ベースのバーチャルホスト][]を混ぜて設定することもできます。 + +この例では、1つのIPアドレス(この例では、10.0.0.10)に2つのIPベースのバーチャルホストを追加します。一方はSSLを使用するもの、もう一方は暗号化されていないものです。 + +``` puppet +apache::vhost { 'The first IP-based virtual host, non-ssl': + servername => 'first.example.com', + ip => '10.0.0.10', + port => '80', + ip_based => true, + docroot => '/var/www/first', +} + +apache::vhost { 'The first IP-based vhost, ssl': + servername => 'first.example.com', + ip => '10.0.0.10', + port => '443', + ip_based => true, + docroot => '/var/www/first-ssl', + ssl => true, +} +``` + +次に、第2のIPアドレス(10.0.0.20)に2つの名前ベースのバーチャルホストを追加します。 + +``` puppet +apache::vhost { 'second.example.com': + ip => '10.0.0.20', + port => '80', + docroot => '/var/www/second', +} + +apache::vhost { 'third.example.com': + ip => '10.0.0.20', + port => '80', + docroot => '/var/www/third', +} +``` + +10.0.0.10または10.0.0.20のいずれかで応答する名前ベースのバーチャルホストを追加するには、Apacheのデフォルトの`Listen 80`を無効にする**必要があります**。これは、前述のIPベースのバーチャルホストとコンフリクトするためです。無効にするには、[`add_listen`][]パラメータを`false`に設定します。 + +``` puppet +apache::vhost { 'fourth.example.com': + port => '80', + docroot => '/var/www/fourth', + add_listen => false, +} + +apache::vhost { 'fifth.example.com': + port => '80', + docroot => '/var/www/fifth', + add_listen => false, +} +``` + +### Apacheモジュールのインストール  + +Puppet apacheモジュールを使って[Apacheモジュール][]をインストールするには、2つの方法があります。 + +- [`apache::mod::`][] クラスを使って、[パラメータを伴う固有のApacheモジュールをインストール][固有モジュールのインストール]する方法 +- [`apache::mod`][]定義タイプを使って、[任意のApacheモジュールをインストール][任意モジュールのインストール]する方法 + +#### 固有モジュールのインストール + +Puppet apacheモジュールは、多くの一般的な[Apacheモジュール][]のインストールをサポートしており、多くの場合、パラメータ化された設定オプションがあります。サポートされるApacheモジュールのリストについては、[`apache::mod::`][]クラスリファレンスを参照してください。 + +例えば、[`apache::mod::ssl`][]クラスを宣言すれば、デフォルト設定で`mod_ssl` Apacheモジュールをインストールすることができます。 + +``` puppet +class { 'apache::mod::ssl': } +``` + +[`apache::mod::ssl`][]には複数のパラメータ化されたオプションがあり、宣言する際に設定することができます。たとえば、圧縮を有効にして`mod_ssl`を有効化するには、[`ssl_compression`][]パラメータをtrueに設定します。 + +``` puppet +class { 'apache::mod::ssl': + ssl_compression => true, +} +``` + +一部のモジュールには必須条件があります。[`apache::mod::`][]のリファレンスを参照してください。 + +#### 任意モジュールのインストール + +オペレーティングシステムのパッケージマネージャでインストール可能な任意のモジュールの名前を[`apache::mod`][]定義タイプに渡し、それをインストールすることができます。固有モジュールクラスとは異なり、 [`apache::mod`][]定義タイプでは、インストールされている他のモジュールや固有のパラメータに基づいてインストールが調整されることはありません。Puppetはモジュールのパッケージを取得し、インストールするだけです。詳細な設定はユーザが必要に応じて行います。 + +例えば、[`mod_authnz_external`][] Apacheモジュールをインストールするには、'mod_authnz_external'の名前を使って定義タイプを宣言します。 + +``` puppet +apache::mod { 'mod_authnz_external': } +``` + +この方法でApacheモジュールを定義する際には、いくつかのオプションパラメータを指定できます。詳細については、[定義タイプのリファレンス][`apache::mod`]を参照してください。 + + +### PHPファイルを処理するFastCGIサーバの設定 + +[`apache::fastcgi::server`][]定義タイプを追加すれば、 [FastCGI][]サーバで特定のファイルに関するリクエストを処理することができます。以下の例では、PHPリクエストを処理するFastCGIサーバをポート9000の127.0.0.1 (ローカルホスト)で定義しています。 + +``` puppet +apache::fastcgi::server { 'php': + host => '127.0.0.1:9000', + timeout => 15, + flush => false, + faux_path => '/var/www/php.fcgi', + fcgi_alias => '/php.fcgi', + file_type => 'application/x-httpd-php' +} +``` + +[`custom_fragment`][]パラメータを使えば、指定したファイルタイプがFastCGIサーバで処理されるように、バーチャルホストを設定することができます。 + +``` puppet +apache::vhost { 'www': + ... + custom_fragment => 'AddType application/x-httpd-php .php' + ... +} +``` + + +### ロードバランシングの例 + +Apacheは、[`mod_proxy`][] Apacheモジュールを通じて、複数のグループのサーバにわたるロードバランシングをサポートしています。Puppetでは、[`apache::balancer`][]および[`apache::balancermember`][]定義タイプにより、Apacheロードバランシンググループ(バランサクラスタとも呼ばれます)をサポートしています。 + +[エクスポートリソース][]でロードバランシングを有効にするには、[`apache::balancermember`][]定義タイプをロードバランサメンバーサーバからエクスポートします。 + +``` puppet +@@apache::balancermember { "${::fqdn}-puppet00": + balancer_cluster => 'puppet00', + url => "ajp://${::fqdn}:8009", + options => ['ping=5', 'disablereuse=on', 'retry=5', 'ttl=120'], +} +``` + +次に、プロキシサーバでロードバランシンググループを作成します。 + +``` puppet +apache::balancer { 'puppet00': } +``` + +リソースをエクスポートせずにロードバランシングを有効にするには、プロキシサーバで以下を宣言します。 + +``` puppet +apache::balancer { 'puppet00': } + +apache::balancermember { "${::fqdn}-puppet00": + balancer_cluster => 'puppet00', + url => "ajp://${::fqdn}:8009", + options => ['ping=5', 'disablereuse=on', 'retry=5', 'ttl=120'], +} +``` + +次に、プロキシサーバで`apache::balancer`および`apache::balancermember`定義タイプを宣言します。 + +バランサで[ProxySet](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyset)ディレクティブを使うには、`apache::balancer`の[`proxy_set`](#proxy_set)パラメータを使用します。 + +``` puppet +apache::balancer { 'puppet01': + proxy_set => { + 'stickysession' => 'JSESSIONID', + 'lbmethod' => 'bytraffic', + }, +} +``` + +ロードバランシングのスケジューラのアルゴリズム(`lbmethod`)は、[mod_proxy_balancerドキュメント](https://httpd.apache.org/docs/current/mod/mod_proxy_balancer.html)に記載されています。 + + +## リファレンス + +- [**パブリッククラス**](#public-classes) + - [クラス: apache](#class-apache) + - [クラス: apache::dev](#class-apachedev) + - [クラス: apache::vhosts](#class-apachevhosts) + - [クラス: apache::mod::\*](#classes-apachemodname) +- [**プライベートクラス**](#private-classes) + - [クラス: apache::confd::no_accf](#class-apacheconfdno_accf) + - [クラス: apache::default_confd_files](#class-apachedefault_confd_files) + - [クラス: apache::default_mods](#class-apachedefault_mods) + - [クラス: apache::package](#class-apachepackage) + - [クラス: apache::params](#class-apacheparams) + - [クラス: apache::service](#class-apacheservice) + - [クラス: apache::version](#class-apacheversion) +- [**パブリック定義タイプ**](#public-defined-types) + - [定義タイプ: apache::balancer](#defined-type-apachebalancer) + - [定義タイプ: apache::balancermember](#defined-type-apachebalancermember) + - [定義タイプ: apache::custom_config](#defined-type-apachecustom_config) + - [定義タイプ: apache::fastcgi::server](#defined-type-fastcgi-server) + - [定義タイプ: apache::listen](#defined-type-apachelisten) + - [定義タイプ: apache::mod](#defined-type-apachemod) + - [定義タイプ: apache::namevirtualhost](#defined-type-apachenamevirtualhost) + - [定義タイプ: apache::vhost](#defined-type-apachevhost) + - [定義タイプ: apache::vhost::custom](#defined-type-apachevhostcustom) +- [**プライベート定義タイプ**](#private-defined-types) + - [定義タイプ: apache::default_mods::load](#defined-type-default_mods-load) + - [定義タイプ: apache::peruser::multiplexer](#defined-type-apacheperusermultiplexer) + - [定義タイプ: apache::peruser::processor](#defined-type-apacheperuserprocessor) + - [定義タイプ: apache::security::file_link](#defined-type-apachesecurityfile_link) +- [**テンプレート**](#templates) +- [**タスク**](#tasks) + +### パブリッククラス + +#### クラス: `apache` + +システムでのApacheの基本的な設定とインストールをガイドします。 + +デフォルトオプションを用いてこのクラスを宣言すると、Puppetでは以下が実行されます。 + +- オペレーティングシステムに適したApacheソフトウェアパッケージおよび[必要なApacheモジュール](#default_mods)をインストールします。 +- [デフォルトロケーション](#conf_dir)を用いて、ディレクトリ内に必要な設定ファイルを配置します。デフォルトロケーションは、オペレーティングシステムによって異なります。 +- デフォルトのバーチャルホストおよび標準的なポート('80')とアドレス('\*')のバインディングを用いてサーバを設定します。 +- ドキュメントルートディレクトリを作成します。オペレーティングシステムによって異なりますが、通常は`/var/www`です。 +- Apacheサービスを開始します。 + +ここでは、デフォルトの`apache`クラスを宣言するだけです。 + +``` puppet +class { 'apache': } +``` + +##### `allow_encoded_slashes` + +[`AllowEncodedSlashes`][]宣言のサーバデフォルトを設定します。これにより、'\'および'/'を含むURLに対する応答が変更されます。このパラメータを指定しない場合、サーバの設定でこの宣言が省かれ、Apacheのデフォルト設定'off'が使用されます。 + +値: 'on'、'off'、'nodecode'。 + +デフォルト値: `undef`。 + +##### `apache_version` + +使用するApacheのバージョンを定義し、モジュールテンプレートの挙動、パッケージ名、デフォルトのApacheモジュールを設定します。このパラメータを理由なく手動で設定することは、推奨していません。 + +デフォルト値: [`apache::version`][]クラスにより検出されたオペレーティングシステムとリリースバージョンによって異なります。 + +##### `conf_dir` + +Apacheサーバのメイン設定ファイルを置くディレクトリを設定します。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**: `/etc/apache2` +- **FreeBSD**: `/usr/local/etc/apache22` +- **Gentoo**: `/etc/apache2` +- **Red Hat**: `/etc/httpd/conf` + +##### `conf_template` + +メインのApache設定ファイルで使用される[テンプレート][]を定義します。apacheモジュールは、`conf.d`エントリによりカスタマイズされた最小限の設定ファイルを使用するように設計されているため、このパラメータの変更には潜在的なリスクが伴います。 + +デフォルト値: `apache/httpd.conf.erb`。 + +##### `confd_dir` + +Apacheサーバのカスタム設定ディレクトリの場所を設定します。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**: `/etc/apache2/conf.d` +- **FreeBSD**: `/usr/local/etc/apache22` +- **Gentoo**: `/etc/apache2/conf.d` +- **Red Hat**: `/etc/httpd/conf.d` + +##### `default_charset` + +メイン設定ファイルで[`AddDefaultCharset`][]ディレクティブとして使用されます。 + +デフォルト値: `undef`。 + +##### `default_confd_files` + +[`confd_dir`][]パラメータにより定義されるディレクトリに、インクルード可能なApache設定ファイルのデフォルトセットを生成するかどうかを決定します。この設定ファイルは、サーバのオペレーティングシステムにApacheパッケージとともに通常インストールされるものに相当します。 + +ブーリアン。 + +デフォルト値: `true`。 + +##### `default_mods` + +オペレーティングシステムに応じたデフォルトの[Apacheモジュール][]のセットを設定して有効にするかどうかを決定します。 + +`false`の場合、Puppetはオペレーティングシステム上でHTTPデーモンを機能させるのに必要なApacheモジュールのみを含めます。[`apache::mod::`][]クラスまたは[`apache::mod`][]定義タイプを使えば、他のモジュールを個別に宣言することができます。 + +`true`の場合、Puppetはオペレーティングシステムと [`apache_version`][]および[`mpm_module`][]パラメータの値に応じて、その他のモジュールもインストールします。このモジュールリストは頻繁に変更されるので、最新のリストについては[Puppetモジュールのコード][]を参照してください。 + +このパラメータに配列が含まれる場合、Puppetは渡されたすべてのApacheモジュールを有効にします。 + +値: ブーリアンまたはApacheモジュール名の配列。 + +デフォルト値: `true`。 + +##### `default_ssl_ca` + +Apacheサーバのデフォルトの証明書認証局を設定します。 + +デフォルト値を使えばApacheサーバは機能しますが、本稼働環境にこのサーバをデプロイする前に、各自の認証局情報を用いてこのパラメータを更新する**必要があります**。 + +ブーリアン。 + +デフォルト値: `undef`。 + +##### `default_ssl_cert` + +[SSL暗号化][]証明書の保存場所を設定します。 + +デフォルト値を使えばApacheサーバは機能しますが、本稼働環境にこのサーバをデプロイする前に、各自の証明書ロケーション情報を用いてこのパラメータを更新する**必要があります**。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**: `/etc/ssl/certs/ssl-cert-snakeoil.pem` +- **FreeBSD**: `/usr/local/etc/apache22/server.crt` +- **Gentoo**: `/etc/ssl/apache2/server.crt` +- **Red Hat**: `/etc/pki/tls/certs/localhost.crt` + +##### `default_ssl_chain` + +デフォルトの[SSLチェーン][]の保存場所を設定します。 + +デフォルト値を使えばApacheサーバは機能しますが、本稼働環境にこのサーバをデプロイする前に、各自のSSLチェーンを用いてこのパラメータを更新する**必要があります**。 + +デフォルト値: `undef`。 + +##### `default_ssl_crl` + +使用するデフォルトの[証明書失効リスト][] (CRL)ファイルのパスを設定します。 + +デフォルト値を使えばApacheサーバは機能しますが、本稼働環境にこのサーバをデプロイする前に、CRLファイルパスを用いてこのパラメータを更新する**必要があります**。このパラメータは、[`default_ssl_crl_path`][]とともに使用することも、その代わりに使用することもできます。 + +デフォルト値: `undef`。 + +##### `default_ssl_crl_path` + +サーバの[証明書失効リストパス][]を設定します。これにはCRLが含まれます。 + +デフォルト値を使えばApacheサーバは機能しますが、本稼働環境でこのサーバをデプロイする前に、CRLファイルパスを用いてこのパラメータを更新する**必要があります**。 + +デフォルト値: `undef`。 + +##### `default_ssl_crl_check` + +[`SSLCARevocationCheck`][]ディレクティブを通じてデフォルトの証明書失効チェックレベルを設定します。このパラメータはApache 2.4以上にのみ適用され、それ以前のバージョンでは無視されます。 + +デフォルト値を使えばApacheサーバは機能しますが、本稼働環境で証明書失効リストを使用する際には、このパラメータを指定する**必要があります**。 + +デフォルト値: `undef`。 + +##### `default_ssl_key` + +[SSL証明書キーファイル][]の保存場所を設定します。 + +デフォルト値を使えばApacheサーバは機能しますが、本稼働環境にこのサーバをデプロイする前に、各自のSSLキーのロケーションを用いてこのパラメータを更新する**必要があります**。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**: `/etc/ssl/private/ssl-cert-snakeoil.key` +- **FreeBSD**: `/usr/local/etc/apache22/server.key` +- **Gentoo**: `/etc/ssl/apache2/server.key` +- **Red Hat**: `/etc/pki/tls/private/localhost.key` + + +##### `default_ssl_vhost` + +デフォルトの[SSL][SSL暗号化]バーチャルホストを設定します。 + +`true`の場合、Puppetは [`apache::vhost`][]定義タイプを用いて、以下のバーチャルホストを自動的に設定します。 + +```puppet +apache::vhost { 'default-ssl': + port => 443, + ssl => true, + docroot => $docroot, + scriptalias => $scriptalias, + serveradmin => $serveradmin, + access_log_file => "ssl_${access_log_file}", + } +``` + +> **注意**: SSLバーチャルホストはHTTPSクエリにのみ応答します。 + + +ブーリアン。 + +デフォルト値: `false`。 + +##### `default_type` + +_Apache 2.2のみ_。サーバが他の方法で適切な`content-type`を決定できない場合に送信される[MIME `content-type`][]を設定します。このディレクティブはApache 2.4以降では廃止予定になっており、設定ファイルの下位互換性確保の目的でのみ使われます。 + +デフォルト値: `undef`。 + +##### `default_vhost` + +クラスが宣言された際にデフォルトのバーチャルホストを設定します。 + +[カスタマイズしたバーチャルホスト][バーチャルホストの設定]を設定するには、このパラメータの値を`false`に設定します。 + +> **注意**: 少なくとも1つのバーチャルホストがなければ、Apacheは起動しません。このパラメータを`false`に設定する場合は、別の場所でバーチャルホストを設定する必要があります。 + +ブーリアン。 + +デフォルト値: `true`。 + +##### `dev_packages` + +使用する固有devパッケージを設定します。 + +値: 文字列または文字列の配列。 + +IUS yumリポジトリからhttpd 2.4を使用する例: + +``` puppet +include ::apache::dev +class { 'apache': + apache_name => 'httpd24u', + dev_packages => 'httpd24u-devel', +} +``` + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Red Hat:** 'httpd-devel' +- **Debian 8/Ubuntu 13.10以降:** ['libaprutil1-dev', 'libapr1-dev', 'apache2-dev'] +- **それ以前のDebian/Ubuntuバージョン:** ['libaprutil1-dev', 'libapr1-dev', 'apache2-prefork-dev'] +- **FreeBSD, Gentoo:** `undef` +- **Suse:** ['libapr-util1-devel', 'libapr1-devel'] + +##### `docroot` + +デフォルトの[`DocumentRoot`][]の場所を設定します。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**: `/var/www/html` +- **FreeBSD**: `/usr/local/www/apache22/data` +- **Gentoo**: `/var/www/localhost/htdocs` +- **Red Hat**: `/var/www/html` + +##### `error_documents` + +Apacheサーバの[カスタムエラードキュメント][]を有効にするかどうかを決定します。 + +ブーリアン。 + +デフォルト値: `false`。 + +##### `group` + +リクエストに応答するために生成されるApacheプロセスを所有するグループIDを設定します。 + +デフォルトでは、Puppetはこのグループを`apache`クラスの下のリソースとして管理するよう試み、[`apache::params`][]クラスにより検出されたオペレーティングシステムに基づいてグループを決定します。このグループリソースを作成せずに、別のPuppetモジュールで作成されたグループを使用するには、[`manage_group`][]パラメータの値を`false`に設定します。 + +> **注意**: このパラメータを修正すると、Apacheが子プロセスを生成してリソースにアクセスする際に使用するグループIDのみが変更されます。親サーバプロセスを所有するユーザは変更されません。 + +##### `httpd_dir` + +Apacheサーバの基本設定ディレクトリを設定します。これは、特別に再パッケージされたApacheサーバビルドにおいて、デフォルトのディストリビューションパッケージと組み合わせると意図せぬ結果が生じる可能性がある場合に役立ちます。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**: `/etc/apache2` +- **FreeBSD**: `/usr/local/etc/apache22` +- **Gentoo**: `/etc/apache2` +- **Red Hat**: `/etc/httpd` + +##### `http_protocol_options` + +HTTPプロトコルチェックの厳密さを指定します。 + +有効なオプション: 以下の値の選択肢のシーケンス: `Strict`または`Unsafe`、`RegisteredMethods`または`LenientMethods`、`Allow0.9`または`Require1.0`。 + +デフォルト '`Strict LenientMethods Allow0.9`'。 + +##### `keepalive` + +[`KeepAlive`][]ディレクティブによってHTTPの持続的接続を有効にするかどうかを決定します。 'On'に設定する場合は、[`keepalive_timeout`][]および[`max_keepalive_requests`][]パラメータを使って関連オプションを設定してください。 + +値: 'Off'、'On'。 + +デフォルト値: 'On'。 + +##### `keepalive_timeout` + +[`KeepAliveTimeout`]ディレクティブによって、HTTPの持続的接続でApacheサーバが後続のリクエストを行うまでの待機時間を設定します。このパラメータが意味を持つのは、[`keepalive` parameter][]を有効にしている場合のみです。 + +デフォルト値: '15'。 + +##### `max_keepalive_requests` + +[`keepalive` parameter][]が有効の場合に、1回の接続で許可されるリクエストの数を制限します。 + +デフォルト値: '100'。 + +##### `lib_path` + +[Apacheモジュール][Apacheモジュール]ファイルの保存場所を指定します。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**および**Gentoo**: `/usr/lib/apache2/modules` +- **FreeBSD**: `/usr/local/libexec/apache24` +- **Red Hat**: `modules` + +> **注意**: このパラメータは、特別な理由がない限り手動で設定しないでください。 + +##### `log_level` + +エラーログの詳細レベルを変更します。値: 'alert'、'crit'、'debug'、'emerg'、'error'、'info'、'notice'、'warn'。 + +デフォルト値: 'warn'。 + +##### `log_formats` + +追加の[`LogFormat`][]ディレクティブを定義します。値: [ハッシュ][]、例: + +``` puppet +$log_formats = { vhost_common => '%v %h %l %u %t \"%r\" %>s %b' } +``` + +Puppetの作成する`httpd.conf`には、以下のような複数の`LogFormats`が事前定義されています。 + +``` httpd +LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined +LogFormat "%h %l %u %t \"%r\" %>s %b" common +LogFormat "%{Referer}i -> %U" referer +LogFormat "%{User-agent}i" agent +LogFormat "%{X-Forwarded-For}i %l %u %t \"%r\" %s %b \"%{Referer}i\" \"%{User-agent}i\"" forwarded +``` + +定義した`log_formats`パラメータに上記のいずれかが含まれる場合は、**ユーザの**定義により上書きされます。 + +##### `logroot` + +バーチャルホストのApacheログファイルのディレクトリを変更します。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**: `/var/log/apache2` +- **FreeBSD**: `/var/log/apache22` +- **Gentoo**: `/var/log/apache2` +- **Red Hat**: `/var/log/httpd` + +##### `logroot_mode` + +デフォルトの[`logroot`][]ディレクトリをオーバーライドします。 + +> **注意**: 影響を把握できない場合は、ログが保存されているディレクトリへの書き込みアクセス権限を付与_しないで_ください。詳細については、[Apacheドキュメント][ログセキュリティ]を参照してください。 + +デフォルト値: `undef`。 + +##### `manage_group` + +`false`の場合、Puppetではグループリソースは作成されません。 + +別のPuppetモジュールで作成されたグループをApacheの実行に使用する場合は、この値を`false`に設定してください。このパラメータを設定せずに過去に作成されたグループを使用しようとすると、重複リソースエラーが生じます。 + +ブーリアン。 + +デフォルト値: `true`。 + +##### `supplementary_groups` + +ユーザの所属するグループのリスト。主要グループに加えて設定する場合に使用します。 + +デフォルト値: 追加グループなし。 + +注意: このオプションは、`manage_user`がtrueに設定されている場合のみ有効です。 + +##### `manage_user` + +`false`の場合、Puppetではユーザリソースが作成されません。 + +このパラメータは、別のPuppetモジュールで作成されたユーザをApache実行に使用する場合などに使用します。このパラメータを設定せずに過去に作成されたユーザを使用しようとすると、重複リソースエラーが生じます。 + +ブーリアン。 + +デフォルト値: `true`。 + +##### `mod_dir` + +Puppetが[Apacheモジュール][]の設定ファイルを置く場所を設定します。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**: `/etc/apache2/mods-available` +- **FreeBSD**: `/usr/local/etc/apache22/Modules` +- **Gentoo**: `/etc/apache2/modules.d` +- **Red Hat**: `/etc/httpd/conf.d` + +##### `mod_libs` + +デフォルトのモジュールライブラリ名をユーザがオーバーライドすることを許可します。 + +```puppet +include apache::params +class { 'apache': + mod_libs => merge($::apache::params::mod_libs, { + 'wsgi' => 'mod_wsgi_python3.so', + }) +} +``` + +ハッシュ。デフォルト値: `$apache::params::mod_libs` + +##### `mod_packages` + +デフォルトのモジュールパッケージ名をユーザがオーバーライドすることを許可します。 + +```puppet +include apache::params +class { 'apache': + mod_packages => merge($::apache::params::mod_packages, { + 'auth_kerb' => 'httpd24-mod_auth_kerb', + }) +} +``` + +ハッシュ。デフォルト値: `$apache::params::mod_packages`。 + +##### `mpm_module` + +HTTPDプロセスに関してロードおよび設定する[マルチプロセッシングモジュール][] (MPM)を決定します。値: 'event'、'itk'、'peruser'、'prefork'、'worker'、`false`。 + +カスタムパラメータを用いて以下のクラスを明示的に宣言するためには、このパラメータを`false`に設定する必要があります。 + +- [`apache::mod::event`][] +- [`apache::mod::itk`][] +- [`apache::mod::peruser`][] +- [`apache::mod::prefork`][] +- [`apache::mod::worker`][] + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**: 'worker' +- **FreeBSD、Gentoo、Red Hat**: 'prefork' + +##### `package_ensure` + +`package`リソースの[`ensure`][]属性を制御します。値: 'absent'、'installed' (またはそれに相当する'present')、またはバージョン文字列。 + +デフォルト値: 'installed'。 + +##### `pidfile` + +pidファイルのカスタムロケーションの設定を許可します。カスタムビルトのApache rpmを使用する場合に役立ちます。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian:** '\${APACHE_PID_FILE}' +- **FreeBSD:** '/var/run/httpd.pid' +- **Red Hat:** 'run/httpd.pid' + +##### `ports_file` + +Apacheポート設定を含むファイルのパスを設定します。 + +デフォルト値: '{$conf_dir}/ports.conf'。 + +##### `purge_configs` + +他のすべてのApache設定およびバーチャルホストを削除します。 + +このパラメータを`false`に設定すると、一時的な対策として、既存の設定や管理されていない設定をApacheモジュールと共存させることができます。この場合、設定をこのモジュール内のリソースに移すことを推奨します。バーチャルホストの設定については、[`purge_vhost_dir`][]を参照してください。 + +ブーリアン。 + +デフォルト値: `true`。 + +##### `purge_vhost_dir` + +[`vhost_dir`][]パラメータの値が[`confd_dir`][]パラメータの値と異なる場合は、このパラメータにより、Puppetにより管理されて_いない_`vhost_dir`内の設定を削除するかどうかが決定されます。 + +`purge_vhost_dir`を`false`に設定すると、一時的な対策として、`vhost_dir`内の既存の設定や管理されていない設定をapacheモジュールと共存させることができます。 + +ブーリアン。 + +デフォルト値: [`purge_configs`][]と同じ。 + +##### `rewrite_lock` + +リライトロックのカスタムロケーションの設定を可能にします。これは、バーチャルホストの[`rewrites`][]パラメータでタイプprgのRewriteMapを使用している場合のベストプラクティスとされています。このパラメータは、Apacheバージョン2.2以前のみに適用され、それよりも新しいバージョンでは無視されます。 + +デフォルト値: `undef`。 + +##### `sendfile` + +[`EnableSendfile`][]ディレクティブで静的ファイルをサーブする際に、ApacheがLinuxカーネルの`sendfile`サポートを使用するようにします。値: 'On'、'Off'。 + +デフォルト値: 'On'。 + +##### `serveradmin` + +Apacheの[`ServerAdmin`][]ディレクティブでApacheサーバ管理者の連絡先情報を設定します。 + +デフォルト値: 'root@localhost'。 + +##### `servername` + +Apacheの[`ServerName`][]ディレクティブでApacheサーバ名を設定します。 + +`false`に設定すると、ServerNameは設定されません。 + +デフォルト値: [Facter][]により報告された'fqdn' fact。 + +##### `server_root` + +Apacheの[`ServerRoot`][]ディレクティブでApacheサーバのルートを設定します。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**: `/etc/apache2` +- **FreeBSD**: `/usr/local` +- **Gentoo**: `/var/www` +- **Red Hat**: `/etc/httpd` + +##### `server_signature` + +Apacheの[`ServerSignature`][]ディレクティブで、エラードキュメントや一部の[Apacheモジュール][]のアウトプットなどの、サーバ生成ドキュメントの下部に表示される末尾のフッタの行を設定します。値: 'Off'、'On'。 + +デフォルト値: 'On'。 + +##### `server_tokens` + +Apacheの[`ServerTokens`][]ディレクティブで、Apacheからブラウザに送信される、Apacheやオペレーティングシステムに関する情報の量を制御します。 + +デフォルト値: 'Prod'. + +##### `service_enable` + +システムの起動時にPuppetがApache HTTPDサービスを有効にするかどうかを決定します。 + +ブーリアン。 + +デフォルト値: `true`。 + +##### `service_ensure` + +サービスが稼働していることをPuppetが確認するかどうかを決定します。値: `true` (または'running')、`false` (または'stopped')。 + +値を`false`または'stopped'にすると、'httpd'サービスリソースの`ensure`パラメータが`false`に設定されます。この設定は、Pacemakerなどの別のアプリケーションでサービスを管理する場合に役立ちます。 + +デフォルト値: 'running'。 + +##### `service_name` + +Apacheサービスの名前を設定します。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **DebianおよびGentoo**: 'apache2' +- **FreeBSD**: 'apache22' +- **Red Hat**: 'httpd' + +##### `service_manage` + +PuppetでHTTPDサービスの状態を管理するかどうかを決定します。 + +ブーリアン。 + +デフォルト値: `true`。 + +##### `service_restart` + +HTTPDサービスの再起動にあたり、Puppetが特定のコマンドを使用するかどうかを決定します。 + +値: Apacheサービスを再起動するためのコマンド。デフォルト設定では、 [デフォルトのPuppet挙動][サービス属性リスタート]が使われます。 + +デフォルト値: `undef`。 + +##### `ssl_cert` + +特定の SSLCertificateFile を指定できるようになります。 + +詳細については、[SSLCertificateFile](https://httpd.apache.org/docs/current/mod/mod_ssl.html#SSLCertificateFile)を参照してください。 + +デフォルト値: `undef`。 + +##### `ssl_key` +特定の SSLCertificateKey を指定できるようになります。 + +詳細については、[SSLCertificateKey](https://httpd.apache.org/docs/current/mod/mod_ssl.html#SSLCertificateKeyFile)を参照してください。 + +デフォルト値: `undef`。 + + +##### `ssl_ca` + +SSL証明書認証局を指定します。[SSLCACertificateFile](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslcacertificatefile)を使用してSSLクライアント認証で使用する証明書を確認します。 + +これはバーチャルホストレベルでオーバーライドすることが可能です。 + +デフォルト値: `undef`。 + + +##### `timeout` + +Apacheの[`TimeOut`][]ディレクティブを設定します。このディレクティブは、一部のイベントに関してリクエスト履行を止めるまでの Apacheの待機秒数を定義します。 + +デフォルト値: 120。 + +##### `trace_enable` + +[`TraceEnable`][]ディレクティブで、Apacheが`TRACE`リクエスト([RFC 2616][]ごと)をどのように処理するかを制御します。 + +値: 'Off'、'On'。 + +デフォルト値: 'On'。 + +##### `use_canonical_name` + +Apacheの [`UseCanonicalName`][]ディレクティブを制御します。このディレクティブは、Apacheが自己参照URLをどのように処理するかを制御します。指定しない場合、このパラメータの宣言がサーバの設定から除外され、Apacheのデフォルト設定'off'が使用されます。 + +値: 'On', 'on', 'Off', 'off', 'DNS', 'dns'。 + +デフォルト値: `undef`。 + +##### `use_systemd` + +systemdモジュールをCentos 7サーバにインストールするかどうかを制御します。これは、カスタムビルトのRPMを使用している場合は特に役立ちます。 + +ブーリアン。 + +デフォルト値: `true`。 + +##### `file_mode` + +設定ファイルの許可モードを設定します。 + +値: 文字列、記号表記法または数字表記法での許可モード。 + +デフォルト値: '0644'。 + +##### `root_directory_options` + +httpd.confの/ディレクトリで指定するオプションの配列。 + +デフォルト値: 'FollowSymLinks'。 + +##### `root_directory_secured` + +httpd.confの/ディレクトリについて、デフォルトのアクセスポリシーを設定します。`false`にすると、特定のアクセスポリシーがないすべてのリソースへのアクセスが許可されます。 `true`にするとデフォルトですべてのリソースへのアクセスが拒否されます。`true`の場合、リソースへのアクセスを許可するには、具体的なルールを使用する必要があります([`directories`](#parameter-directories-for-apachevhost)パラメータを用いたディレクトリブロックなどで)。 + +ブーリアン。 + +デフォルト値: `false`。 + +##### `vhost_dir` + +バーチャルホストの設定ファイルの保存場所を変更します。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**: `/etc/apache2/sites-available` +- **FreeBSD**: `/usr/local/etc/apache22/Vhosts` +- **Gentoo**: `/etc/apache2/vhosts.d` +- **Red Hat**: `/etc/httpd/conf.d` + +##### `vhost_include_pattern` + +`vhost_dir`に含まれるファイルのパターンを定義します。 + +`[^.#]\*.conf[^~]`などの値に設定すると、このディレクトリで偶発的に作成されたファイル(バージョン管理システムやエディタのバックアップにより作成されたファイルなど)がサーバ設定に*含まれなく*なります。 + +デフォルト値: '*'。 + +一部のオペレーティングシステムでは、`*.conf`の値が使用されます。デフォルトでは、このモジュールは`.conf`で終わる設定ファイルを作成します。 + +##### `user` + +Apacheがリクエストの応答に使用するユーザを変更します。Apacheの親プロセスは引き続きルートとして稼働しますが、子プロセスはこのパラメータで定義されたユーザとしてリソースにアクセスします。Puppetがこのユーザを管理しないようにするには、[`manage_user`][]パラメータを`false`に設定します。 + +デフォルト値: [`apache::params`][]クラスにより設定されたユーザに依存します。これはオペレーティングシステムによって異なります。 + +- **Debian**: 'www-data' +- **FreeBSD**: 'www' +- **Gentoo**および**Red Hat**: 'apache' + +Puppetがこのユーザを管理しないようにするには、[`manage_user`][]パラメータをfalseに設定します。 + +##### `apache_name` + +インストールするApacheパッケージの名前。標準的ではないApacheパッケージを使用している場合は、デフォルト設定をオーバーライドする必要があるかもしれません。 + +CentOS/RHELソフトウェアコレクション(SCL)では、`apache::version::scl_httpd_version`も使用できます。 + +デフォルト値: [`apache::params`][]クラスにより設定されたユーザに依存します。これはオペレーティングシステムによって異なります。 + +- **Debian**: 'apache2' +- **FreeBSD**: 'apache24' +- **Gentoo**: 'www-servers/apache' +- **Red Hat**: 'httpd' + +##### `error_log` + +メインサーバインスタンスのエラーログファイルの名前。`/`、`|`、または`syslog`で始まる文字列の場合、フルパスが設定されます。それ以外の場合は、ファイル名の先頭に`$logroot`がつきます。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**: 'error.log' +- **FreeBSD**: 'httpd-error.log' +- **Gentoo**: 'error.log' +- **Red Hat**: 'error_log' +- **Suse**: 'error.log' + +##### `scriptalias` + +グローバルスクリプトエイリアスに使用するディレクトリ。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**: '/usr/lib/cgi-bin' +- **FreeBSD**: '/usr/local/www/apache24/cgi-bin' +- **Gentoo**: 'var/www/localhost/cgi-bin' +- **Red Hat**: '/var/www/cgi-bin' +- **Suse**: '/usr/lib/cgi-bin' + +##### `access_log_file` + +メインサーバインスタンスのアクセスログファイルの名前。 + +デフォルト値: オペレーティングシステムによって異なります。 + +- **Debian**: 'error.log' +- **FreeBSD**: 'httpd-access.log' +- **Gentoo**: 'access.log' +- **Red Hat**: 'access_log' +- **Suse**: 'access.log' + +##### `limitreqfields` + +[`limitreqfields`][]パラメータは、HTTPリクエスト内のリクエストヘッダフィールドの最大数を設定します。このディレクティブを使用すると、サーバ管理者は異常なクライアントリクエスト動作の制御を強化できるので、ある種のDoS攻撃の防止に役立てることができます。送信リクエスト内のフィールドが多過ぎることを示すエラー応答が、通常のクライアントに対して表示される場合、この値を増やす必要があります。 + +デフォルト値: '100'。 + +#### クラス: `apache::dev` + +Apache開発ライブラリをインストールします。 + +デフォルト値: オペレーティングシステムによって異なります。使用するオペレーティングシステムに基づく、[`apache::params`][]クラスの[`dev_packages`][]パラメータ。 + +- **Debian**: Ubuntu 13.10およびDebian 8では'libaprutil1-dev'、'libapr1-dev'、'apache2-dev'。その他のバージョンでは'apache2-prefork-dev'。 +- **FreeBSD**: `undef`; FreeBSDでは、`apache::dev`を宣言する前に`apache::package`または`apache`クラスを宣言する必要があります。 +- **Gentoo**: `undef` +- **Red Hat**: 'httpd-devel' + +#### クラス: `apache::vhosts` + +[`apache::vhost`][]定義タイプを作成します。 + +**パラメータ**:  + +* `vhosts`: [`apache::vhost`][]定義タイプのパラメータを指定します。 + + 値: [ハッシュ][]、キーは名前を表し、値は[`apache::vhost`][]定義タイプのパラメータの[ハッシュ][]を表します。 + + デフォルト値: '{}'。 + + > **注意**: すべてのバーチャルホストのパラメータのリストや[バーチャルホストの設定]については、[`apache::vhost`][]定義タイプのリファレンスを参照してください。 + + 例えば、[名前ベースのバーチャルホスト][名前ベースのバーチャルホスト]のcustom_vhost_1を作成するには、`vhosts`パラメータを'{ "custom_vhost_1" => { "docroot" => "/var/www/custom_vhost_1", "port" => "81" }'に設定し、このクラスを宣言します。 + +``` puppet +class { 'apache::vhosts': + vhosts => { + 'custom_vhost_1' => { + 'docroot' => '/var/www/custom_vhost_1', + 'port' => '81', + }, + }, +} +``` + +#### クラス: `apache::mod::` + +指定した[Apacheモジュール][]を有効にします。Apacheモジュールを有効にして設定するには、このクラスを宣言します。 + +例えば、アイコンなしで[`mod_alias`][]をインストールして有効にするには、`icons_options`パラメータをNone'に設定して[`apache::mod::alias`][]クラスを宣言します。 + +``` puppet +class { 'apache::mod::alias': + icons_options => 'None', +} +``` + +以下のApacheモジュールにはサポートするクラスがあり、その多くは、パラメータ化された設定が可能です。[`apache::mod`][]定義タイプを使えば、他のApacheモジュールをインストールできます。 + +* `actions` +* `alias` ([`apache::mod::alias`][]参照) +* `auth_basic` +* `auth_cas`\* ([`apache::mod::auth_cas`][]参照) +* `auth_mellon`\* ([`apache::mod::auth_mellon`][]参照) +* `auth_kerb` +* auth_gssapi +* `authn_core` +* `authn_dbd`\* ([`apache::mod::authn_dbd`][]参照) +* `authn_file` +* `authnz_ldap`\* ([`apache::mod::authnz_ldap`][]参照) +* `authnz_pam` +* `authz_default` +* `authz_user` +* `autoindex` +* `cache` +* `cgi` +* `cgid` +* `cluster` ([`apache::mod::cluster`][]参照) +* `data` +* `dav` +* `dav_fs` +* `dav_svn`\* +* `dbd` +* `deflate\` +* `dev` +* `dir`\* +* `disk_cache` ([`apache::mod::disk_cache`][]参照) +* `dumpio` ([`apache::mod::dumpio`][]参照) +* `env` +* `event` ([`apache::mod::event`][]参照) +* `expires` +* `ext_filter` ([`apache::mod::ext_filter`][]参照) +* `fastcgi` +* `fcgid` +* `filter` +* `geoip` ([`apache::mod::geoip`][]参照) +* `headers` +* `include` +* `info`\* +* `intercept_form_submit` +* `itk` +* `jk` ([`apache::mod::jk`]参照) +* `ldap` ([`apache::mod::ldap`][]参照) +* `lookup_identity` +* `macro` ([`apache:mod:macro`][]参照) +* `mime` +* `mime_magic`\* +* `negotiation` +* `nss`\* ([`apache::mod::nss`][]参照) +* `pagespeed` ([`apache::mod::pagespeed`][]参照) +* `passenger`\* ([`apache::mod::passenger`][]参照) +* `perl` +* `peruser` +* `php` ([`mpm_module`][]を`prefork`に設定する必要があります) +* `prefork`\* +* `proxy`\* ([`apache::mod::proxy`][]参照) +* `proxy_ajp` +* `proxy_balancer`\* ([`apache::mod::proxy_balancer`][]参照) +* `proxy_balancer` +* `proxy_html` ([`apache::mod::proxy_html`][]参照) +* `proxy_http` +* `python` ([`apache::mod::python`][]参照) +* `reqtimeout` +* `remoteip`\* +* `rewrite` +* `rpaf`\* +* `setenvif` +* `security` +* `shib`\* ([`apache::mod::shib`]参照) +* `speling` +* `ssl`\* ([`apache::mod::ssl`][]参照) +* `status`\* ([`apache::mod::status`][]参照) +* `suphp` +* `userdir`\* ([`apache::mod::userdir`][]参照) +* `version` +* `vhost_alias` +* `worker`\* +* `wsgi` ([`apache::mod::wsgi`][]参照) +* `xsendfile` + +モジュールに付いている*のマークは、設定やモジュールを設定するためのパラメータが含まれるテンプレートがあることを示しています。ほとんどのApacheモジュールクラスパラメータにはデフォルト値があり、設定は必要ありません。 テンプレートのあるモジュールについては、Puppetでモジュールとともにテンプレートファイルがインストールされます。これらのテンプレートファイルは、モジュールが機能するために必要です。 + +##### クラス: `apache::mod::alias` + +[`mod_alias`][]をインストールして管理します。 + +**パラメータ**:  + +* `icons_options`: Apache [`Options`]ディレクティブにより、アイコンディレクトリのディレクトリリスティングを無効にします。 + + デフォルト値: 'Indexes MultiViews'。 + +* `icons_path`: `/icons/`エイリアスのローカルパスを設定します。 + + デフォルト値: オペレーティングシステムによって異なります。 + + * **Debian**: `/usr/share/apache2/icons` + * **FreeBSD**: `/usr/local/www/apache24/icons` + * **Gentoo**: `/var/www/icons` + * **Red Hat**: `/var/www/icons`、Apache 2.4の場合のみ、`/usr/share/httpd/icons` + +#### クラス: `apache::mod::disk_cache` + +Apache 2.2に[`mod_disk_cache`][]、またはApache 2.4に[`mod_cache_disk`][]をインストールして設定します。 + +デフォルト値: Apacheバージョンとオペレーティングシステムによって異なります。 + +- **Debian**: `/var/cache/apache2/mod_cache_disk` +- **FreeBSD**: `/var/cache/mod_cache_disk` +- **Red Hat、Apache 2.4**: `/var/cache/httpd/proxy` +- **Red Hat、Apache 2.2**: `/var/cache/mod_proxy` + +キャッシュルートを指定するには、パスを文字列として`cache_root`パラメータに渡します。 + +``` puppet +class {'::apache::mod::disk_cache': + cache_root => '/path/to/cache', +} +``` + +キャッシュ無視ヘッダを指定するには、文字列を`cache_ignore_headers`パラメータに渡します。 + +``` puppet +class {'::apache::mod::disk_cache': + cache_ignore_headers => "Set-Cookie", +} +``` + +##### クラス: `apache::mod::dumpio` + +[`mod_dumpio`][]をインストールして設定します。 + +```puppet +class{'apache': + default_mods => false, + log_level => 'dumpio:trace7', +} +class{'apache::mod::dumpio': + dump_io_input => 'On', + dump_io_output => 'Off', +} +``` + +**パラメータ**:  + +* `dump_io_input`: すべての入力データをエラーログにダンプします。 + + 値: 'On'、'Off'。  + + デフォルト値: 'Off'。 + +* `dump_io_output`: すべての出力データをエラーログにダンプします。 + + 値: 'On'、'Off'。  + + デフォルト値: 'Off'。 + +##### クラス: `apache::mod::event` + +[`mod_mpm_event`][]をインストールして管理します。同じサーバ上に、`apache::mod::event`と一緒に[`apache::mod::itk`][]、[`apache::mod::peruser`][]、[`apache::mod::prefork`][]、[`apache::mod::worker`][]を含めることはできません。 + +**パラメータ**:  + +* `listenbacklog`: モジュールの[`ListenBackLog`][]ディレクティブでペンディング接続キューの最大長を設定します。`false`に設定すると、このパラメータが削除されます。 + + デフォルト値: '511'。 + +* `maxrequestworkers` (_Apache 2.3.12以前_: `maxclients`): モジュールの[`MaxRequestWorkers`][]ディレクティブで、Apacheが同時に処理できる接続の最大数を設定します。`false`に設定すると、このパラメータが削除されます。 + + デフォルト値: '150'。 + +* `maxconnectionsperchild` (_Apache 2.3.8以前_: `maxrequestsperchild`): モジュールの[`MaxConnectionsPerChild`][]ディレクティブで、子サーバが稼働中に処理する接続の数を制限します。`false`に設定すると、このパラメータが削除されます。 + + デフォルト値: '0'。 + +* `maxsparethreads` and `minsparethreads`: [`MaxSpareThreads`][]および[`MinSpareThreads`][]ディレクティブで、待機スレッドの最大数と最小数を設定します。`false`に設定すると、このパラメータが削除されます。 + + デフォルト値: それぞれ'75'および'25'。 + +* `serverlimit`: [`ServerLimit`][]ディレクティブで、プロセスの設定数を制限します。`false`に設定すると、このパラメータが削除されます。 + + デフォルト値: '25'。 + +* `startservers`: モジュールの[`StartServers`][]ディレクティブで、起動時に作成される子サーバプロセスの数を設定します。`false`に設定すると、このパラメータが削除されます。 + + デフォルト値: '2'。 + +* `threadlimit`: モジュールの[`ThreadLimit`][]ディレクティブで、イベントスレッドの数を制限します。`false`に設定すると、このパラメータが削除されます。 + + デフォルト値: '64'。 + +* `threadsperchild`: [`ThreadsPerChild`][]ディレクティブで、各子サーバにより作成されるスレッドの数を設定します。 + + デフォルト値: '25'。`false`に設定すると、このパラメータが削除されます。 + +##### クラス: `apache::mod::auth_cas` + +[`mod_auth_cas`][]をインストールして管理します。パラメータの名前はApacheモジュールのディレクティブと共通です。 + +`cas_login_url`および`cas_validate_url`パラメータは必須です。 その他のいくつかのパラメータのデフォルト値は`undef`です。 + +> **注意**: auth_casモジュールは、EPELにより提供される依存関係パッケージがなければ、RH/CentOSで使用できません。 [https://github.com/Jasig/mod_auth_cas]()を参照してください。 + +**パラメータ**:  + +- `cas_attribute_prefix`: ヘッダを追加します。SAMLバリデーションが有効になっている場合には、このヘッダの値が属性値になります。 + + デフォルト値: CAS_。 + +- `cas_attribute_delimiter`:`cas_attribute_prefix`により作成されたヘッダの属性値の区切り文字。 + + デフォルト値: ,。 + +- `cas_authoritative`: オプションの認証ディレクティブを承認してバインドするかどうかを決定します。 + + デフォルト値: `undef`。 + +- `cas_certificate_path`: `cas_login_url`および`cas_validate_url`のサーバについて、証明書認証局のX509証明書へのパスを設定します。 + + デフォルト値: `undef`。 + +- `cas_cache_clean_interval`: キャッシュクリーニング時間の最小秒数を設定します。 + + デフォルト値: `undef`。 + +- `cas_cookie_domain`: `Set-Cookie` HTTPヘッダの`Domain=`パラメータの値を設定します。 + + デフォルト値: `undef`。 + +- `cas_cookie_entropy`: セッション識別子を作成する際に使用するバイト数を設定します。 + + デフォルト値: `undef`。 + +- `cas_cookie_http_only`: `mod_auth_cas`がクッキーを発行する際のオプションの`HttpOnly`フラグを設定します。 + + デフォルト値: `undef`。 + +- `cas_cookie_path`: casクッキーセッションデータの保存場所。Webサーバユーザによる書き込みを可能にする必要があります。 + + デフォルト値: OSによって異なります。 + +- `cas_cookie_path_mode`: `cas_cookie_path`のモード。 + + デフォルト値: '0750'。 + +- `cas_debug`: モジュールのデバッギングモードを有効にするかどうかを決定します。 + + デフォルト値: 'Off'。 + +- `cas_idle_timeout`: 待機タイムアウトの制限を秒数で設定します。 + + デフォルト値: `undef`。 + +- `cas_login_url`: **必須**。ユーザがCASで保護されたリソースへのアクセスを試み、かつアクティブなセッションがない場合に、モジュールがユーザをリダイレクトする先のURLを設定します。 + +- `cas_proxy_validate_url`: プロキシバリデーションを実施する際に使用するURL。 + + デフォルト値: `undef`。 + +- `cas_root_proxied_as`: このApacheサーバへのアクセスがプロキシされた場合に、エンドユーザに表示されるURLを設定します。 + + デフォルト値: `undef`。 + +- `cas_scrub_request_headers`: mod_auth_cas内で特別な意味を持つ可能性のあるインバウンドリクエストヘッダを削除します。 + +- `cas_sso_enabled`: シングルサインアウトの実験的サポートを有効にします(POSTデータが壊れる可能性があります)。 + + デフォルト値: 'Off'。 + +- `cas_timeout`: `mod_auth_cas`セッションのアクティブ状態を維持する時間(秒数)を制限します。 + + デフォルト値: `undef`。 + +- `cas_validate_depth`: チェーンされた証明書バリデーションの深さを制限します。 + + デフォルト値: `undef`。 + +- `cas_validate_saml`: SAMLに関するCASサーバからの解析応答。 + + デフォルト値: 'Off'。 + +- `cas_validate_server`: CASサーバの証明書をバリデーションするかどうか(1.1 - RedHat 7では廃止予定)。 + + デフォルト値: `undef`。 + +- `cas_validate_url`: **必須**。HTTPクエリ文字列でクライアントの提示するチケットをバリデーションする際に使用するURL。 + +- `cas_version`: 従うべきCASプロトコルバージョン。値: '1'、'2'。 + + デフォルト値: '2'。 + +- `suppress_warning`: RedHat上にいることを示す警告を表示しないようにします(`mod_auth_cas`パッケージは、現在はepel-testingレポジトリで使用できます)。 + + デフォルト値: `false`。 + +##### クラス: `apache::mod::auth_mellon` + +[`mod_auth_mellon`][]をインストールして管理します。パラメータの名前はApacheモジュールのディレクティブと共通です。 + +``` puppet +class{ 'apache::mod::auth_mellon': + mellon_cache_size => 101, +} +``` + +**パラメータ**:  + +* `mellon_cache_entry_size`: 1回のセッションの最大サイズ。 + + デフォルト値: `undef`。 + +* `mellon_cache_size`: mellonキャッシュのサイズ、単位はメガバイト。 + + デフォルト値: 100。 + +* `mellon_lock_file`: ロックファイルの場所。 + + デフォルト値: '`/run/mod_auth_mellon/lock`'。 + +* `mellon_post_directory`: ポストリクエストが保存される場所のフルパス。 + + デフォルト値: '`/var/cache/apache2/mod_auth_mellon/`'。 + +* `mellon_post_ttl`: ポストリクエストの維持時間。 + + デフォルト値: `undef`。 + +* `mellon_post_size`: ポストリクエストの最大サイズ。 + + デフォルト値: `undef`。 + +* `mellon_post_count`: ポストリクエストの最大数。 + + デフォルト値: `undef`。 + +##### クラス: `apache::mod::authn_dbd` + +`mod_authn_dbd`をインストールし、`authn_dbd.conf.erb`テンプレートを使用して設定を生成します。オプションで、AuthnProviderAliasを作成します。 + +``` puppet +class { 'apache::mod::authn_dbd': + $authn_dbd_params => + 'host=db01 port=3306 user=apache password=xxxxxx dbname=apacheauth', + $authn_dbd_query => 'SELECT password FROM authn WHERE user = %s', + $authn_dbd_alias => 'db_auth', +} +``` + +**パラメータ**:  + +* `authn_dbd_alias`: AuthnProviderAlias'の名前。 + +* `authn_dbd_dbdriver`: 使用するデータベースドライブを指定します。 + + デフォルト値: 'mysql'。 + +* `authn_dbd_exptime`: DBDExptimeに相当します。 + + デフォルト値: 300。 + +* `authn_dbd_keep`: DBDKeepに相当します。 + + デフォルト値: 8。 + +* `authn_dbd_max`: DBDMaxに相当します。 + + デフォルト値: 20。 + +* `authn_dbd_min`: DBDMinに相当します。 + + デフォルト値: 4。  + +* `authn_dbd_params`: **必須**。接続文字列に関して、DBDParamsに相当します。 + +* `authn_dbd_query`: 認証に関してユーザとパスワードを問い合わせるかどうか。 + +##### クラス: `apache::mod::authnz_ldap` + +`mod_authnz_ldap`をインストールし、`authnz_ldap.conf.erb`テンプレートを使用して設定を生成します。 + +**パラメータ**:  + +* `package_name`: パッケージの名前。 + + デフォルト値: `undef`。 + +* `verify_server_cert`: サーバの証明書を確認するかどうか。 + + デフォルト値: `undef`。 + +##### クラス: `apache::mod::cluster` + +**注意**: `mod_cluster`に関して提供されている公式なパッケージはありません。そのため、Apacheモジュールの外部から使用できるようにする必要があります。バイナリは[こちら](http://mod-cluster.jboss.org/)にあります。 + +``` puppet +class { '::apache::mod::cluster': + ip => '172.17.0.1', + allowed_network => '172.17.0.', + balancer_name => 'mycluster', + version => '1.3.1' +} +``` + +**パラメータ**:  + +* `port`: mod_clusterのリッスンポート。 + + デフォルト値: '6666'。 + +* `server_advertise`: サーバをアドバタイズするかどうか。 + + デフォルト値: `true`。 + +* `advertise_frequency`: アドバタイズメッセージ間のインターバルを秒数[.ミリ秒]で設定します。 + + デフォルト値: 10。 + +* `manager_allowed_network`: ネットワークにmod_cluster_managerへのアクセスを許可するかどうか。 + + デフォルト値: '127.0.0.1'。 + +* `keep_alive_timeout`: Apacheがリクエストを待機する長さを秒数で指定します。 + + デフォルト値: 60。 + +* `max_keep_alive_requests`: 維持されるリクエストの最大数。 + + デフォルト値: 0。 + +* `enable_mcpm_receive`: MCPMを有効にするかどうか。 + + デフォルト値: `true`。 + +* `ip`: リッスンするIPアドレスを指定します。 + +* `allowed_network`: バランスドメンバーネットワーク。 + +* `version`: `mod_cluster`バージョンを指定します。httpd 2.4ではバージョン1.3.0以上が必要です。 + +##### クラス: `apache::mod::deflate` + +[`mod_deflate`][]をインストールして設定します。 + +**パラメータ**:  + +* `types`: デフレートする[配列][]または[MIMEタイプ][MIME `content-type`]。 + + デフォルト値: ['text/html text/plain text/xml', 'text/css', 'application/x-javascript application/javascript application/ecmascript', 'application/rss+xml', 'application/json']。 + +* `notes`: [ハッシュ][]、キーはタイプを表し、値はノート名を表します。 + + デフォルト値: { 'Input' => 'instream'、'Output' => 'outstream'、'Ratio' => 'ratio' }。 + +##### クラス: `apache::mod::expires` + +[`mod_expires`][]をインストールし、`expires.conf.erb`を使用して設定を生成します。 + +**パラメータ**:  + +* `expires_active`: ドキュメント領域に関して`Expires`ヘッダの生成を有効にします。 + + ブーリアン。 + + デフォルト値: `true`。 + +* `expires_default`: [`ExpiresByType`][]構文または[インターバル構文][]を用いた有効期限計算のためのデフォルトアルゴリズムを指定します。 + + デフォルト値: `undef`。 + +* `expires_by_type`: 一連の[MIME `content-type`][]とその有効期限を表します。 + + 値: [ハッシュ][ハッシュ]の[配列][]、各ハッシュのキーは有効なMIME `content-type` ('text/json'など)、値は以下の有効な [インターバル構文][]。 + + デフォルト値: `undef`。 + +##### クラス: `apache::mod::ext_filter` + +[`mod_ext_filter`][]をインストールして設定します。 + +``` puppet +class { 'apache::mod::ext_filter': + ext_filter_define => { + 'slowdown' => 'mode=output cmd=/bin/cat preservescontentlength', + 'puppetdb-strip' => 'mode=output outtype=application/json cmd="pdb-resource-filter"', + }, +} +``` + +**パラメータ**:  + +* `ext_filter_define`: フィルタ名とそのパラメータのハッシュ。 + + デフォルト値: `undef`。 + +##### クラス: `apache::mod::fcgid` + +[`mod_fcgid`][]をインストールして設定します。 + +このクラスでは、使用可能なすべてのオプションを個別にパラメータ化するのではなく、`options` [ハッシュ][]を使って`mod_fcgid`を設定します。例: + +``` puppet +class { 'apache::mod::fcgid': + options => { + 'FcgidIPCDir' => '/var/run/fcgidsock', + 'SharememPath' => '/var/run/fcgid_shm', + 'AddHandler' => 'fcgid-script .fcgi', + }, +} +``` + +すべてのオプションのリストについては、[公式`mod_fcgid`ドキュメント][`mod_fcgid`]を参照してください。 + +`apache::mod::fcgid`を含める場合は、ディレクトリごと、バーチャルホストごとに[`FcgidWrapper`][]を設定できます。最初にモジュールをロードする必要があります。`apache::vhost`で`fcgiwrapper`パラメータを設定している場合、Puppetは自動的にはモジュールを有効化しません。 + +``` puppet +include apache::mod::fcgid + +apache::vhost { 'example.org': + docroot => '/var/www/html', + directories => { + path => '/var/www/html', + fcgiwrapper => { + command => '/usr/local/bin/fcgiwrapper', + } + }, +} +``` + +##### クラス: `apache::mod::geoip` + +[`mod_geoip`][]をインストールして管理します。 + +**パラメータ**:  + +* `db_file`: GeoIPデータベースファイルのパスを設定します。 + + 値: パス、または複数のGeoIPデータベースファイルの[配列][]パス。 + + デフォルト値: `/usr/share/GeoIP/GeoIP.dat`。 + +* `enable`: [`mod_geoip`][]を全体で有効にするかどうかを決定します。 + + ブーリアン。 + + デフォルト値: `false`。 + +* `flag`: GeoIPフラグを設定します。 + + 値: 'CheckCache'、'IndexCache'、'MemoryCache'、'Standard'。 + + デフォルト値: 'Standard'。 + +* `output`: 使用するアウトプット変数を定義します。 + + 値: 'All'、'Env'、'Request'、'Notes'。 + + デフォルト値: 'All'。 + +* `enable_utf8`: アウトプットをISO*8859*1 (ラテン*1)からUTF*8に変更します。 + + ブーリアン。 + + デフォルト値: `undef`。 + +* `scan_proxy_headers`: [GeoIPScanProxyHeaders][]オプションを有効にします。 + + ブーリアン。 + + デフォルト値: `undef`。 + +* `scan_proxy_header_field`: クライアントのIPアドレスの決定に使用するヘッダの[`mod_geoip`][]を指定します。 + + デフォルト値: `undef`。 + +* `use_last_xforwarededfor_ip` (sic): IPアドレスのカンマ区切りリストで見つかったクライアントのIPの最初または最後のIPアドレスを使うかどうかを決定します。 + + ブーリアン。 + + デフォルト値: `undef`。 + +##### クラス: `apache::mod::info` + +サーバ設定の全体的な概要を提供する[`mod_info`][]をインストールして管理します。 + +**パラメータ**:  + +* `allow_from`: IPv4またはIPv6アドレスのホワイトリスト、または`/server*info`にアクセスできる範囲。 + + 値: IPv4アドレス、IPv6アドレス、または範囲の1つまたは複数のオクテット、またはいずれかの配列。 + + デフォルト値: ['127.0.0.1','::1']。  + +* `apache_version`: 文字列で表されるApacheのバージョン番号、'2.2'や'2.4'など。  + + デフォルト値: [`$::apache::apache_version`][`apache_version`]の値。 + + +* `restrict_access`: アクセス制限を有効にするかどうかを決定します。`false`の場合、`allow_from`ホワイトリストは無視され、すべてのIPアドレスが `/server*info`にアクセスできるようになります。 + + ブーリアン。 + + デフォルト値: `true`。 + +##### クラス: `apache::mod::itk` + +[`mod_itk`][]をインストールして管理します。これはHTTPDプロセス向けにロードおよび設定されるMPMです。[公式ドキュメント](http://mpm-itk.sesse.net/)。 + +**パラメータ**:  + +* `startservers`: 起動時に作成される子サーバプロセスの数。 + + 値: 整数。 + + デフォルト値: `8`。 + +* `minspareservers`: 待機する子サーバプロセスに望ましい最小数。 + + 値: 整数。 + + デフォルト値: `5`。 + +* `maxspareservers`: 待機する子サーバプロセスに望ましい最大数。 + + 値: 整数。 + + デフォルト値: `20`。 + +* `serverlimit`: Apache httpdプロセスの継続期間に対して設定されるMaxRequestWorkersの最大数。 + + 値: 整数。 + + デフォルト値: `256`。 + +* `maxclients`: 処理される同時リクエストの最大数。 + + 値: 整数。 + + デフォルト値: `256`。 + +* `maxrequestsperchild`: 個々の子サーバプロセスが処理する接続の最大数。 + + 値: 整数。 + + デフォルト値: `4000`。 + +* `enablecapabilities`: 親プロセスのルート機能をほぼすべて削除し、User/Groupディレクティブで指定されたユーザとして、いくつかの追加機能(特にsetuid)付きで実行します。 セキュリティはある程度強化されますが、NFSなどの機能に対応しないファイルシステムによる処理では問題が生じるおそれがあります。 + + 値: ブール値。 + + デフォルト値: `undef`。 + +##### クラス: `apache::mod::jk` + +`mod_jk`をインストールして管理します。これは、Apache httpdリダイレクションと古いバージョンのTomCatおよびJBossを結ぶコネクタです。 + +**注意**: mod\_jkに関して提供されている公式のパッケージはありません。そのため、apacheモジュールの制御以外の手段で使用できるようにする必要があります。バイナリは[Apache Tomcatコネクタダウンロードページ](https://tomcat.apache.org/download-connectors.cgi)にあります。 + +``` puppet +class { '::apache::mod::jk': + ip => '192.168.2.15', + workers_file => 'conf/workers.properties', + mount_file => 'conf/uriworkermap.properties', + shm_file => 'run/jk.shm', + shm_size => '50M', + workers_file_content => { + + }, +} +``` + +詳細については、[templates/mod/jk/workers.properties.erb](templates/mod/jk/workers.properties.erb)を参照してください。 + +**`apache::mod::jk`**内のパラメータ: + +`mod_jk`パラメータを理解するための情報源としては、[公式ドキュメント](https://tomcat.apache.org/connectors-doc/reference/apache.html)が最適です。ただし、次はこれに含まれません: + +**add_listen** + +パラメータ`ip`および `port`に従って`Listen`ディレクティブを定義して(下記参照)、ApacheがIP/portの組合せをリッスンし`mod_jk`にリダイレクトするようにします。 +`Listen *:`または`Listen `のように、別の`Listen`ディレクティブが`mod_jk`バインディングで必要なものと競合するときに役立ちます。 + +タイプ: ブール値 +デフォルト: true + +**ip** + +`mod_jk`にバインディングするIP。 +バインディングアドレスがプライマリのネットワークインターフェースIPではないときに役立ちます。 + +タイプ: 文字列 +デフォルト: `$facts['ipaddress']` + +**port** + +`mod_jk`にバインディングするポート。 +リバースプロキシまたはキャッシュのような、別のものがポート80でリクエストを受信して、異なるポートのApacheに転送する必要があるときに役立ちます。 + +タイプ: 文字列(数値) +デフォルト: '80' + +**workers\_file\_content** + +各ディレクティブにはフォーマット`worker..=`があります。このマップは複数ハッシュのハッシュとして表され、外側のハッシュはワーカーを指定し、内側の各ハッシュは各ワーカーのプロパティと値を指定します。 +また、2つのグローバルディレクティブ 'worker.list'および'worker.maintain'もあります。 +例えば、以下のワーカーファイルは図1のようにパラメータ化します。 + +``` puppet +worker.list = status +worker.list = some_name,other_name + +worker.maintain = 60 + +# Optional comment +worker.some_name.type=ajp13 +worker.some_name.socket_keepalive=true + +# I just like comments +worker.other_name.type=ajp12 (why would you?) +worker.other_name.socket_keepalive=false +``` + +**図1:** + +``` puppet +$workers_file_content = { + worker_lists => ['status', 'some_name,other_name'], + worker_maintain => '60', + some_name => { + comment => 'Optional comment', + type => 'ajp13', + socket_keepalive => 'true', + }, + other_name => { + comment => 'I just like comments', + type => 'ajp12', + socket_keepalive => 'false', + }, +} +``` + +**mount\_file\_content** + +各ディレクティブにはフォーマット` = `があります。このマップは複数ハッシュのハッシュとして表され、外側のハッシュはワーカーを指定し、内側の各ハッシュは次の2つのアイテムを含みます: +* uri_list&mdash - ワーカーにマップするURIを用いた配列 +* comment&mdash - ワーカーに関するコメントを記したオプションの文字列 +例えば、以下のマウントファイルは図2のようにパラメータ化します。 + +``` puppet +# Worker 1 +/context_1/ = worker_1 +/context_1/* = worker_1 + +# Worker 2 +/ = worker_2 +/context_2/ = worker_2 +/context_2/* = worker_2 +``` + +**図2:** + +``` puppet +$mount_file_content = { + worker_1 => { + uri_list => ['/context_1/', '/context_1/*'], + comment => 'Worker 1', + }, + worker_2 => { + uri_list => ['/context_2/', '/context_2/*'], + comment => 'Worker 2', + }, +}, +``` + +**shm\_file and log\_file** + +これらのファイルがどのように定義されているかによって、クラスはそれらの最終パスを別々に作成します。 +- 相対パス: `logroot`で提供されたパスを追加します (下記参照) +- 絶対パスまたはパイプ: 提供されたパスをそのまま使用します + +例 (RHEL 6): + +``` puppet +shm_file => 'shm_file' +# Ends up in +$shm_path = '/var/log/httpd/shm_file' +``` +``` puppet +shm_file => '/run/shm_file' +# Ends up in +$shm_path = '/run/shm_file' +``` +``` puppet +shm_file => '"|rotatelogs /var/log/httpd/mod_jk.log.%Y%m%d 86400 -180"' +# Ends up in +$shm_path = '"|rotatelogs /var/log/httpd/mod_jk.log.%Y%m%d 86400 -180"' +``` + +> デフォルトのlogrootは十分健全です。このため、絶対パスを指定することは推奨しません。 + +**logroot** + +`shm_file`および`log_file`のベースディレクトリは`logroot`パラメータで決定されます。指定されない場合、デフォルトは`apache::params::logroot`です。 + +> デフォルトのlogrootは十分健全です。このため、上書きすることは推奨しません。 + +##### クラス: `apache::mod::passenger`  + +[`mod_passenger`][]をインストールして管理します。Red Hatベースのシステムの場合は、[passengerドキュメント](https://www.phusionpassenger.com/library/install/apache/install/oss/el6/#step-1:-upgrade-your-kernel,-or-disable-selinux)に記載された最小要件を満たしていることを確認してください。 + +現在のサーバ設定は、[Passengerリファレンス](https://www.phusionpassenger.com/library/config/apache/reference/)から直接取得されています。廃止予定の警告と削除失敗メッセージを有効にするには、 サーバにインストールされているバージョン番号を`passenger_installed_version`に設定します。 + +**パラメータ**:  + +|パラメータ|デフォルト値|passengerの設定|コンテキスト|注記| +|---------|-------------|------------------------|-------|-----| +|manage_repo|true|n/a||| +|mod_id|未定義|n/a||| +|mod_lib|未定義|n/a||| +|mod_lib_path|未定義|n/a||| +|mod_package|未定義|n/a||| +|mod_package_ensure|未定義|n/a||| +|mod_path|未定義|n/a||| +|passenger_allow_encoded_slashes|未定義|[`PassengerAllowEncodedSlashes`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerAllowEncodedSlashes)|server-config virutal-host htaccess directory || +|passenger_app_env|未定義|[`PassengerAppEnv`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerAppEnv)|server-config virutal-host htaccess directory || +|passenger_app_group_name|未定義|[`PassengerAppGroupName`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerAppGroupName)|server-config virutal-host htaccess directory || +|passenger_app_root|未定義|[`PassengerAppRoot`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerAppRoot)|server-config virutal-host htaccess directory || +|passenger_app_type|未定義|[`PassengerAppType`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerAppType)|server-config virutal-host htaccess directory || +|passenger_base_uri|未定義|[`PassengerBaseURI`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerBaseURI)|server-config virutal-host htaccess directory || +|passenger_buffer_response|未定義|[`PassengerBufferResponse`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerBufferResponse)|server-config virutal-host htaccess directory || +|passenger_buffer_upload|未定義|[`PassengerBufferUpload`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerBufferUpload)|server-config virutal-host htaccess directory || +|passenger_concurrency_model|未定義|[`PassengerConcurrencyModel`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerConcurrencyModel)|server-config virutal-host htaccess directory || +|passenger_conf_file|$::apache::params::passenger_conf_file|n/a||| +|passenger_conf_package_file|$::apache::params::passenger_conf_package_file|n/a||| +|passenger_data_buffer_dir|未定義|[`PassengerDataBufferDir`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerDataBufferDir)|server-config || +|passenger_debug_log_file|未定義|PassengerDebugLogFile|server-config |このオプションの名前は、バージョン5.0.5でPassengerLogFileに変更されています。| +|passenger_debugger|未定義|[`PassengerDebugger`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerDebugger)|server-config virutal-host htaccess directory || +|passenger_default_group|未定義|[`PassengerDefaultGroup`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerDefaultGroup)|server-config || +|passenger_default_ruby|$::apache::params::passenger_default_ruby|[`PassengerDefaultRuby`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerDefaultRuby)|server-config || +|passenger_default_user|未定義|[`PassengerDefaultUser`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerDefaultUser)|server-config || +|passenger_disable_security_update_check|未定義|[`PassengerDisableSecurityUpdateCheck`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerDisableSecurityUpdateCheck)|server-config || +|passenger_enabled|未定義|[`PassengerEnabled`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerEnabled)|server-config virutal-host htaccess directory || +|passenger_error_override|未定義|[`PassengerErrorOverride`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerErrorOverride)|server-config virutal-host htaccess directory || +|passenger_file_descriptor_log_file|未定義|[`PassengerFileDescriptorLogFile`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerFileDescriptorLogFile)|server-config || +|passenger_fly_with|未定義|[`PassengerFlyWith`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerFlyWith)|server-config || +|passenger_force_max_concurrent_requests_per_process|未定義|[`PassengerForceMaxConcurrentRequestsPerProcess`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerForceMaxConcurrentRequestsPerProcess)|server-config virutal-host htaccess directory || +|passenger_friendly_error_pages|未定義|[`PassengerFriendlyErrorPages`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerFriendlyErrorPages)|server-config virutal-host htaccess directory || +|passenger_group|未定義|[`PassengerGroup`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerGroup)|server-config virutal-host directory || +|passenger_high_performance|未定義|[`PassengerHighPerformance`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerHighPerformance)|server-config virutal-host htaccess directory || +|passenger_installed_version|未定義|n/a| |このオプションを設定すると、指定した値に対するpassengerオプションのバージョンチェックが有効になります。| +|passenger_instance_registry_dir|未定義|[`PassengerInstanceRegistryDir`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerInstanceRegistryDir)|server-config || +|passenger_load_shell_envvars|未定義|[`PassengerLoadShellEnvvars`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerLoadShellEnvvars)|server-config virutal-host htaccess directory || +|passenger_log_file|未定義|[`PassengerLogFile`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerLogFile)|server-config || +|passenger_log_level|未定義|[`PassengerLogLevel`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerLogLevel)|server-config || +|passenger_lve_min_uid|未定義|[`PassengerLveMinUid`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerLveMinUid)|server-config virtual-host || +|passenger_max_instances|未定義|[`PassengerMaxInstances`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerMaxInstances)|server-config virutal-host htaccess directory || +|passenger_max_instances_per_app|未定義|[`PassengerMaxInstancesPerApp`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerMaxInstancesPerApp)|server-config || +|passenger_max_pool_size|未定義|[`PassengerMaxPoolSize`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerMaxPoolSize)|server-config || +|passenger_max_preloader_idle_time|未定義|[`PassengerMaxPreloaderIdleTime`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerMaxPreloaderIdleTime)|server-config virtual-host || +|passenger_max_request_queue_size|未定義|[`PassengerMaxRequestQueueSize`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerMaxRequestQueueSize)|server-config virutal-host htaccess directory || +|passenger_max_request_time|未定義|[`PassengerMaxRequestTime`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerMaxRequestTime)|server-config virutal-host htaccess directory || +|passenger_max_requests|未定義|[`PassengerMaxRequests`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerMaxRequests)|server-config virutal-host htaccess directory || +|passenger_memory_limit|未定義|[`PassengerMemoryLimit`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerMemoryLimit)|server-config virutal-host htaccess directory || +|passenger_meteor_app_settings|未定義|[`PassengerMeteorAppSettings`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerMeteorAppSettings)|server-config virutal-host htaccess directory || +|passenger_min_instances|未定義|[`PassengerMinInstances`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerMinInstances)|server-config virutal-host htaccess directory || +|passenger_nodejs|未定義|[`PassengerNodejs`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerNodejs)|server-config virutal-host htaccess directory || +|passenger_pool_idle_time|未定義|[`PassengerPoolIdleTime`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerPoolIdleTime)|server-config || +|passenger_pre_start|未定義|[`PassengerPreStart`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerPreStart)|server-config virtual-host || +|passenger_python|未定義|[`PassengerPython`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerPython)|server-config virutal-host htaccess directory || +|passenger_resist_deployment_errors|未定義|[`PassengerResistDeploymentErrors`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerResistDeploymentErrors)|server-config virutal-host htaccess directory || +|passenger_resolve_symlinks_in_document_root|未定義|[`PassengerResolveSymlinksInDocumentRoot`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerResolveSymlinksInDocumentRoot)|server-config virutal-host htaccess directory || +|passenger_response_buffer_high_watermark|未定義|[`PassengerResponseBufferHighWatermark`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerResponseBufferHighWatermark)|server-config || +|passenger_restart_dir|未定義|[`PassengerRestartDir`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerRestartDir)|server-config virutal-host htaccess directory || +|passenger_rolling_restarts|未定義|[`PassengerRollingRestarts`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerRollingRestarts)|server-config virutal-host htaccess directory || +|passenger_root|$::apache::params::passenger_root|[`PassengerRoot`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerRoot)|server-config || +|passenger_ruby|$::apache::params::passenger_ruby|[`PassengerRuby`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerRuby)|server-config virutal-host htaccess directory || +|passenger_security_update_check_proxy|未定義|[`PassengerSecurityUpdateCheckProxy`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerSecurityUpdateCheckProxy)|server-config || +|passenger_show_version_in_header|未定義|[`PassengerShowVersionInHeader`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerShowVersionInHeader)|server-config || +|passenger_socket_backlog|未定義|[`PassengerSocketBacklog`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerSocketBacklog)|server-config || +|passenger_spawn_method|未定義|[`PassengerSpawnMethod`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerSpawnMethod)|server-config virtual-host || +|passenger_start_timeout|未定義|[`PassengerStartTimeout`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerStartTimeout)|server-config virutal-host htaccess directory || +|passenger_startup_file|未定義|[`PassengerStartupFile`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerStartupFile)|server-config virutal-host htaccess directory || +|passenger_stat_throttle_rate|未定義|[`PassengerStatThrottleRate`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerStatThrottleRate)|server-config || +|passenger_sticky_sessions|未定義|[`PassengerStickySessions`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerStickySessions)|server-config virutal-host htaccess directory || +|passenger_sticky_sessions_cookie_name|未定義|[`PassengerStickySessionsCookieName`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerStickySessionsCookieName)|server-config virutal-host htaccess directory || +|passenger_thread_count|未定義|[`PassengerThreadCount`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerThreadCount)|server-config virutal-host htaccess directory || +|passenger_use_global_queue|未定義|PassengerUseGlobalQueue|server-config || +|passenger_user|未定義|[`PassengerUser`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerUser)|server-config virutal-host directory || +|passenger_user_switching|未定義|[`PassengerUserSwitching`](https://www.phusionpassenger.com/library/config/apache/reference/#PassengerUserSwitching)|server-config || +|rack_auto_detect|未定義|RackAutoDetect|server-config |これらのオプションは、バージョン4.0.0で最適化の一環として削除されました。代わりにPassengerEnabledを使用してください。| +|rack_autodetect|未定義|n/a||| +|rack_base_uri|未定義|RackBaseURI|server-config |3.0.0で廃止され、PassengerBaseURIが採用されました。| +|rack_env|未定義|[`RackEnv`](https://www.phusionpassenger.com/library/config/apache/reference/#RackEnv)|server-config virutal-host htaccess directory || +|rails_allow_mod_rewrite|未定義|RailsAllowModRewrite|server-config |このオプションは、バージョン4.0.0以降では何の影響も与えません。| +|rails_app_spawner_idle_time|未定義|RailsAppSpawnerIdleTime|server-config |このオプションはバージョン4.0.0で削除され、PassengerMaxPreloaderIdleTimeに置き換えられました。| +|rails_auto_detect|未定義|RailsAutoDetect|server-config |これらのオプションは、バージョン4.0.0で最適化の一環として削除されました。代わりにPassengerEnabledを使用してください。| +|rails_autodetect|未定義|n/a||| +|rails_base_uri|未定義|RailsBaseURI|server-config |3.0.0で廃止され、PassengerBaseURIが採用されました。| +|rails_default_user|未定義|RailsDefaultUser|server-config |3.0.0で廃止され、PassengerDefaultUserが採用されました。| +|rails_env|未定義|[`RailsEnv`](https://www.phusionpassenger.com/library/config/apache/reference/#RailsEnv)|server-config virutal-host htaccess directory || +|rails_framework_spawner_idle_time|未定義|RailsFrameworkSpawnerIdleTime|server-config |このオプションはバージョン4.0.0では使用できません。フレームワークスポーンも同時に削除されたので、代わりのオプションはありません。スマートスポーンを使用してください。| +|rails_ruby|未定義|RailsRuby|server-config |3.0.0で廃止され、PassengerRubyが採用されました。| +|rails_spawn_method|未定義|RailsSpawnMethod|server-config |3.0.0で廃止され、PassengerSpawnMethodが採用されました。| +|rails_user_switching|未定義|RailsUserSwitching|server-config |3.0.0で廃止され、PassengerUserSwitchingが採用されました。| +|wsgi_auto_detect|未定義|WsgiAutoDetect|server-config |これらのオプションは、バージョン4.0.0で最適化の一環として削除されました。代わりにPassengerEnabledを使用してください。| + + +##### クラス: `apache::mod::ldap` + +[`mod_ldap`][]をインストールして設定し、[`LDAPTrustedGlobalCert`](https://httpd.apache.org/docs/current/mod/mod_ldap.html#ldaptrustedglobalcert)ディレクティブの修正を可能にします。 + +``` puppet +class { 'apache::mod::ldap': + ldap_trusted_global_cert_file => '/etc/pki/tls/certs/ldap-trust.crt', + ldap_trusted_global_cert_type => 'CA_DER', + ldap_trusted_mode => 'TLS', + ldap_shared_cache_size => '500000', + ldap_cache_entries => '1024', + ldap_cache_ttl => '600', + ldap_opcache_entries => '1024', + ldap_opcache_ttl => '600', +} +``` + +**パラメータ**  + +* `apache_version`: インストールされたApacheバージョンを指定します。 + + デフォルト値: `undef`。 + +* `ldap_trusted_global_cert_file`: LDAPサーバ上でSSLまたはTLS接続を確立する際に使用する、信頼できるCA証明書のパスとファイル名を指定します。 + +* `ldap_trusted_global_cert_type`:グローバルな信頼できる証明書フォーマットを指定します。 + + デフォルト値: 'CA_BASE64'。 + +* `ldap_trusted_mode`: LDAPサーバ接続時に使用されるSSL/TLSモードを指定します。 + +* `ldap_shared_cache_size`: 共有されたメモリのキャッシュのサイズをバイトで指定します。 + +* `ldap_cache_entries`: 一次LDAPキャッシュのエントリの最大数を指定します。 + +* `ldap_cache_ttl`: キャッシュされたアイテムが有効に保たれる時間を秒数で指定します。 + +* `ldap_opcache_entries`: LDAP比較演算のキャッシュに用いるエントリ数を指定します。 + +* `ldap_opcache_ttl`: 演算キャッシュのエントリが有効に保たれる時間を秒数で指定します。 + +* `package_name`: カスタムパッケージ名を指定します。 + + デフォルト値: `undef`。 + +##### クラス: `apache::mod::negotiation` + +[`mod_negotiation`][]をインストールして設定します。 + +**パラメータ**:  + +* `force_language_priority`: `ForceLanguagePriority`オプションを設定します。 + + 値: 文字列。  + + デフォルト値: `Prefer Fallback`。 + +* `language_priority`: モジュールの`LanguagePriority`オプションを設定するための言語の[配列][]。 + + デフォルト値: ['en'、'ca'、cs'、'da'、'de'、'el'、'eo'、'es'、'et'、'fr'、'he'、'hr'、'it'、'ja'、'ko'、'ltz'、'nl'、'nn'、'no'、'pl'、'pt'、'pt-BR'、'ru'、'sv'、'zh-CN'、'zh-TW']。 + +##### クラス: `apache::mod::nss` + +NSS暗号化ライブラリを使用するApacheのSSLプロバイダ。 + +**パラメータ:** + +- `transfer_log`: access.logのパス。 +- `error_log`: error.logのパス。 +- `passwd_file`: NSSPassPhraseDialogディレクティブに使用するファイルのパス。 +- `port`: SSLポート。デフォルト値8443。 + +##### クラス: `apache::mod::pagespeed` + +[`mod_pagespeed`][]をインストールして管理します。これは、Webページをリライトして冗長性と帯域を軽減するためのGoogleモジュールです。 + +このapacheモジュールには`mod-pagespeed-stable`が必要ですが、Puppetはパッケージを自動的にインストールするために必要なソフトウェアを管理**しません**。パッケージがインストールされていないか、お使いのパッケージマネージャで使用できない場合にこのクラスを宣言すると、Puppet実行は失敗します。 + +> **注意:** お使いのシステムが最新のGoogle Pagespeed要件を満たしていることを確認してください。 + +**パラメータ**:  + +以下のパラメータはモジュールのディレクティブに相当します。詳細については、[モジュールのドキュメント][`mod_pagespeed`]を参照してください。 + +* `inherit_vhost_config`: デフォルト値: 'on'。 +* `filter_xhtml`: デフォルト値: `false`。 +* `cache_path`: デフォルト値: '/var/cache/mod_pagespeed/'。 +* `log_dir`: デフォルト値: '/var/log/pagespeed'。 +* `memcache_servers`: デフォルト値: []。 +* `rewrite_level`: デフォルト値: 'CoreFilters'。 +* `disable_filters`: デフォルト値: []。 +* `enable_filters`: デフォルト値: []。 +* `forbid_filters`: デフォルト値: []。 +* `rewrite_deadline_per_flush_ms`: デフォルト値: 10。 +* `additional_domains`: デフォルト値: `undef`。 +* `file_cache_size_kb`: デフォルト値: 102400。 +* `file_cache_clean_interval_ms`: デフォルト値: 3600000。 +* `lru_cache_per_process`: デフォルト値: 1024。 +* `lru_cache_byte_limit`: デフォルト値: 16384。 +* `css_flatten_max_bytes`: デフォルト値: 2048。 +* `css_inline_max_bytes`: デフォルト値: 2048。 +* `css_image_inline_max_bytes`: デフォルト値: 2048。 +* `image_inline_max_bytes`: デフォルト値: 2048。 +* `js_inline_max_bytes`: デフォルト値: 2048。 +* `css_outline_min_bytes`: デフォルト値: 3000。 +* `js_outline_min_bytes`: デフォルト値: 3000。 +* `inode_limit`: デフォルト値: 500000。 +* `image_max_rewrites_at_once`: デフォルト値: 8。 +* `num_rewrite_threads`: デフォルト値: 4。 +* `num_expensive_rewrite_threads`: デフォルト値: 4。 +* `collect_statistics`: デフォルト値: 'on'。 +* `statistics_logging`: デフォルト値: 'on'。 +* `allow_view_stats`: デフォルト値: []。 +* `allow_pagespeed_console`: デフォルト値: []。 +* `allow_pagespeed_message`: デフォルト値: []。 +* `message_buffer_size`: デフォルト値: 100000。 +* `additional_configuration`: ディレクティブ値ペアのハッシュ、またはpagespeed設定の最後に挿入する行の配列。デフォルト値: '{ }'。 + +##### クラス: `apache::mod::passenger`  + +`mod_passenger`をインストールして設定します。 + +>**注意**: passengerモジュールは、EPELにより提供される依存関係パッケージと`mod_passengers`カスタムリポジトリがなければ、RH/CentOSでは使用できません。前述の`manage_repo`パラメータと[https://www.phusionpassenger.com/library/install/apache/install/oss/el7/]()を参照してください。 + +**パラメータ**:  + +* `passenger_conf_file`: `$::apache::params::passenger_conf_file` +* `passenger_conf_package_file: `$::apache::params::passenger_conf_package_file` +* `passenger_high_performance`: デフォルト値: `undef` +* `passenger_pool_idle_time`: デフォルト値: `undef` +* `passenger_max_request_queue_size`: デフォルト値: `undef` +* `passenger_max_requests`: デフォルト値: `undef` +* `passenger_spawn_method`: デフォルト値: `undef` +* `passenger_stat_throttle_rate`: デフォルト値: `undef` +* `rack_autodetect`: デフォルト値: `undef` +* `rails_autodetect`: デフォルト値: `undef` +* `passenger_root` : `$::apache::params::passenger_root` +* `passenger_ruby` : `$::apache::params::passenger_ruby` +* `passenger_default_ruby`: `$::apache::params::passenger_default_ruby` +* `passenger_max_pool_size`: デフォルト値: `undef` +* `passenger_min_instances`: デフォルト値: `undef` +* `passenger_max_instances_per_app`: デフォルト値: `undef` +* `passenger_use_global_queue`: デフォルト値: `undef` +* `passenger_app_env`: デフォルト値: `undef` +* `passenger_log_file`: デフォルト値: `undef` +* `passenger_log_level`: デフォルト値: `undef` +* `passenger_data_buffer_dir`: デフォルト値: `undef` +* `manage_repo`: phusionpassenger.comリポジトリを管理するかどうか。デフォルト値: `true` +* `mod_package`: デフォルト値: `undef` +* `mod_package_ensure`: デフォルト値: `undef` +* `mod_lib`: デフォルト値: `undef` +* `mod_lib_path`: デフォルト値: `undef` +* `mod_id`: デフォルト値: `undef` +* `mod_path`: デフォルト値: `undef` + +##### クラス: `apache::mod::proxy` + +I`mod_proxy`をインストールし、`proxy.conf.erb`テンプレートを使用して設定を生成します。 + +**`apache::mod::proxy`内のパラメータ**: + +- `allow_from`: デフォルト値: `undef` +- `apache_version`: デフォルト値: `undef` +- `package_name`: デフォルト値: `undef` +- `proxy_requests`: デフォルト値: 'Off' +- `proxy_via`: デフォルト値: 'On' + +##### クラス: `apache::mod::proxy_balancer` + +ロードバランシングを提供する[`mod_proxy_balancer`][]をインストールして管理します。 + +**パラメータ**:  + +* `manager`: バランサマネージャのサポートを有効にするかどうかを決定します。 + + デフォルト値: `false`。 + +* `manager_path`: バランサマネージャのサーバロケーション。 + + デフォルト値: '/balancer-manager'。 + +* `allow_from`: `/balancer-manager`にアクセスできるIPv4またはIPv6アドレスの[配列][]。 + + デフォルト値: ['127.0.0.1','::1']。  + +* `apache_version`: 文字列で表されるApacheのバージョン番号、'2.2'や'2.4'など。  + + デフォルト値: [`$::apache::apache_version`][`apache_version`]の値。Apache 2.4以上では、`mod_slotmem_shm`がロードされます。 + +##### クラス: `apache::mod::php` + +[`mod_php`][]をインストールして設定します。 + +**パラメータ**:  + +以下のパラメータのデフォルト値は、オペレーティングシステムによって異なります。このクラスのパラメータのほとんどは、`mod_php`ディレクティブに相当します。詳細については、[モジュールのドキュメント][`mod_php`]を参照してください。 + +* `package_name`: `mod_php`をインストールするパッケージの名前。 +* `path`: `mod_php`共有オブジェクト(`.so`)ファイルのパスを定義します。 +* `source`: デフォルト設定のパスを定義します。値には`puppet:///`パスが含まれます。 +* `template`: Puppetが設定ファイルの生成に使用する`php.conf`テンプレートのパスを定義します。 +* `content`: `php.conf`に任意のコンテンツを追加します。 + +##### クラス: `apache::mod::proxy_html` + +**注意**: `mod_proxy_html`に関して提供されている公式なパッケージはありません。そのため、apacheモジュールの外部から使用できるようにする必要があります。 + +##### クラス: `apache::mod::python` + +[`mod_python`][]をインストールして設定します。 + +**パラメータ**  + +* `loadfile_name`: pythonモジュールのロードに使用される設定ファイルの名前を指定します。 + +##### クラス: `apache::mod::reqtimeout` + +[`mod_reqtimeout`][]をインストールして設定します。 + +**パラメータ**  + +* `timeouts`: [`RequestReadTimeout`][]オプションを設定します。 + + 値: 文字列または[配列][]。 + + デフォルト値: ['header=20-40,MinRate=500', 'body=20,MinRate=500']。 + +##### クラス: `apache::mod::rewrite` + +Apacheモジュール`mod_rewrite`をインストールして有効にします。 + +##### クラス: `apache::mod::shib` + +[Shibboleth](http://shibboleth.net/) Apacheモジュール`mod_shib`をインストールします。このモジュールは、Shibboleth認証プロバイダおよびShibboleth FederationsによるSAML2シングルサインオン(SSO)認証を有効にするものです。このクラスを定義すると、`apache::vhost`インスタンス内でShibboleth固有のパラメータが有効になります。 + +このクラスでインストールおよび設定されるのは、Shibboleth SSO認証をコンシュームするWebアプリケーションのApacheコンポーネントのみです。PuppetでShibboleth設定を手動で管理することも、[Shibboleth Puppetモジュール](https://github.com/aethylred/puppet-shibboleth)を使用することもできます。 + +**注意**: shibbolethモジュールは、Shibbolethのリポジトリにより提供される依存関係パッケージがなければ、RH/CentOSでは使用できません。[Shibboleth Service Provider Installation Guide](http://wiki.aaf.edu.au/tech-info/sp-install-guide)を参照してください。 + +##### クラス: `apache::mod::ssl` + +[Apache SSL機能][`mod_ssl`]をインストールし、`ssl.conf.erb`テンプレートを使用して設定を生成します。ほとんどのオペレーティングシステムでは、この`ssl.conf`はモジュール設定ディレクトリに置かれています。Red Hatベースのオペレーティングシステムでは、このファイルは`/etc/httpd/conf.d`にあります。これは、RPMが設定を保存するのと同じロケーションです。 + +バーチャルホストでSSLを使用するには、`::apache`の[`default_ssl_vhost`][]パラメータを`true`に設定する**か**、[`apache::vhost`][]の[`ssl`][]パラメータを`true`に設定する必要があります。 + +- `ssl_cipher`: デフォルト値: 'HIGH:MEDIUM:!aNULL:!MD5:!RC4' +- `ssl_compression`: デフォルト値: false +- `ssl_cryptodevice`: デフォルト値: 'builtin' +- `ssl_honorcipherorder`: デフォルト値: true +- `ssl_openssl_conf_cmd`: デフォルト値: undef +- `ssl_cert`: デフォルト値: undef。 +- `ssl_key`: デフォルト値: undef。 +- `ssl_options`: デフォルト値: ['StdEnvVars'] +- `ssl_pass_phrase_dialog`: デフォルト値: 'builtin' +- `ssl_protocol`: デフォルト値: ['all', '-SSLv2', '-SSLv3']。 +- `ssl_proxy_protocol`: デフォルト値: [] +- `ssl_random_seed_bytes`: 有効なオプション: 文字列、デフォルト値: '512' +- `ssl_sessioncache`: 有効なオプション: 文字列。デフォルト値: '300' +- `ssl_sessioncachetimeout`: 有効なオプション: 文字列。デフォルト値: '300' +- `ssl_mutex`: デフォルト値: OSによって異なります。有効なオプション: [mod_ssl][mod_ssl]ドキュメントを参照 + - RedHat/FreeBSD/Suse/Gentoo: 'default' + - Debian/Ubuntu + Apache >= 2.4: 'default' + - Debian/Ubuntu + Apache < 2.4: 'file:\${APACHE_RUN_DIR}/ssl_mutex' +**パラメータ: + +* `ssl_cipher` + + デフォルト値: 'HIGH:MEDIUM:!aNULL:!MD5:!RC4' + +* `ssl_compression` + + デフォルト値: `false`。 + +* `ssl_cryptodevice` + + デフォルト値: 'builtin'  + +* `ssl_honorcipherorder` + + デフォルト値: `true`。 + +* `ssl_openssl_conf_cmd` + + デフォルト値: `undef`。 + +* `ssl_cert` + + デフォルト値: `undef`。 + +* `ssl_key` + + デフォルト値: `undef`。 + +* `ssl_options` + + デフォルト値: ['StdEnvVars'] + +* `ssl_pass_phrase_dialog` + + デフォルト値: 'builtin'  + +* `ssl_protocol` + + デフォルト値: ['all', '-SSLv2', '-SSLv3'] + +* `ssl_random_seed_bytes` + + 値: 文字列。  + + デフォルト値: '512' + +* `ssl_sessioncachetimeout` + + 値: 文字列。  + + デフォルト値: '300' + +* `ssl_mutex`: + + 値: [mod_ssl][mod_ssl]ドキュメントを参照。 + + デフォルト値: OSによって異なります: + + * RedHat/FreeBSD/Suse/Gentoo: 'default'. + * Debian/Ubuntu + Apache >= 2.4: 'default'. + * Debian/Ubuntu + Apache < 2.4: 'file:\${APACHE_RUN_DIR}/ssl_mutex'. + + +##### クラス: `apache::mod::status` + +[`mod_status`][]をインストールし、`status.conf.erb`テンプレートを使用して設定を生成します。 + +**パラメータ**:  + +* `allow_from`: `/server-status`にアクセスできるIPv4またはIPv6アドレスの[配列][]。 + + デフォルト値: ['127.0.0.1','::1']。  + +* Apacheバージョン2.4以降の`mod_authz_host` ディレクティブ(`require ip`、`require host`など)を使用して、アクセスできる/できないIPまたは名前の文字列、[配列][]、または[ハッシュ][]。このパラメータは、以下のいずれかの構成で指定します。 + + > Apacheバージョンが2.4以降の場合のみ使用 + + - `undef` - `allow_from` および古いディレクティブ構文(`Allow from `)を使用し、廃止予定の警告を通知します。 + - String + - `''`または`'unmanaged'` - authディレクティブなし(アクセス制御は別の方法で実施) + - `'ip '` - `/server-status`にアクセスできるIP/範囲 + - `'host '` - `/server-status`にアクセスできる名前/ドメイン + - `'all [granted|denied]'` - すべてのユーザを許可/ブロック + - 配列 - 各要素には上記のいずれかの文字列が入ります。配列要素ごとに1つのディレクティブになります。 + - 以下の構造を持つハッシュ(キー => 値の形式で表示、キーは文字列) + - `'requires'` => 上記に従った配列 - 配列と同じ作用 + - `'enforce'` => `'Any'`、`'All'`、`'None'`のいずれかの文字列(任意指定) - `'requires'`キーで指定されたすべてのディレクティブを``ブロックで囲みます。 + + デフォルト値: 'ip 127.0.0.1 ::1' + +* `extended_status`: [`ExtendedStatus`][]ディレクティブをつうじて、各リクエストに関する拡張ステータス情報を追跡するかどうかを決定します。 + + 値: 'Off'、'On'。 + + デフォルト値: 'On'。 + +* `status_path`: ステータスページのサーバロケーション。 + + デフォルト値: '/server-status'。 + +##### クラス: `apache::mod::userdir` + +`http://example.com/~user/`構文を用いて、ユーザ指定のディレクトリにアクセスできるようにします。すべてのパラメータは、[公式のApacheドキュメント](https://httpd.apache.org/docs/2.4/mod/mod_userdir.html)で見られます。 + +**パラメータ**:  + +* `overrides`: ディレクティブタイプの[配列][]。 + + デフォルト値: ['FileInfo', 'AuthConfig', 'Limit', 'Indexes']。 + +##### クラス: `apache::mod::version` + +多くのオペレーティングシステムおよびApache構成上で[`mod_version`][]をインストールします。 + +Apache 2.4を使用するDebianおよびUbuntuが`apache::mod::version`で分類された場合は、`mod_version`がビルトインされているためロードできない旨の警告をPuppetが表示します。 + +##### クラス: `apache::mod::security` + +Trustwaveの[`mod_security`][]をインストールして設定します。これはすべてのバーチャルホストでデフォルトで有効化され、実行されます。 + +**パラメータ**:  + +* `activated_rules`: `modsec_crs_path`のルールの[配列][]またはsymlinkを使用してアクティベートする絶対値。 +* `allowed_methods`: 許可されるHTTPメソッドのスペース区切りリスト。 + + デフォルト値: 'GET HEAD POST OPTIONS'。 + +* `content_types`: 1つまたは複数の許可される[MIMEタイプ][MIME `content-type`]のリスト。 + + デフォルト値: 'application/x-www-form-urlencoded|multipart/form-data|text/xml|application/xml|application/x-amf'。 + +* `crs_package`: CRSルールをインストールするパッケージの名前。 + + デフォルト値: [`apache::params`][]内の`modsec_crs_package`。 + +* `manage_security_crs`: security_crs.confルールファイルを管理します。 + + デフォルト値: `true`。 + +* `modsec_dir`: Puppetがmodsec設定およびアクティベートされたルールリンクをインストールする場所のパスを定義します。 + + デフォルト値: 'On'、[`apache::params`][]の`modsec_dir`により設定。 +${modsec\_dir}/activated\_rules。 + +* `modsec_secruleengine`: modsecルールエンジンを設定します。値: 'On'、'Off'、'DetectionOnly'。 + + デフォルト値: [`apache::params`][]の`modsec_secruleengine`。 + +* `restricted_extensions`: 禁止されるファイル拡張子のスペース区切りリスト。 + + デフォルト値: '.asa/ .asax/ .ascx/ .axd/ .backup/ .bak/ .bat/ .cdx/ .cer/ .cfg/ .cmd/ .com/ .config/ .conf/ .cs/ .csproj/ .csr/ .dat/ .db/ .dbf/ .dll/ .dos/ .htr/ .htw/ .ida/ .idc/ .idq/ .inc/ .ini/ .key/ .licx/ .lnk/ .log/ .mdb/ .old/ .pass/ .pdb/ .pol/ .printer/ .pwd/ .resources/ .resx/ .sql/ .sys/ .vb/ .vbs/ .vbproj/ .vsdisco/ .webinfo/ .xsd/ .xsx/'。 + +* `restricted_headers`: 禁止されるヘッダのスラッシュおよびスペースで区切ったリスト。 + + デフォルト値: 'Proxy-Connection/ /Lock-Token/ /Content-Range/ /Translate/ /via/ /if/'。 + +* `secdefaultaction`: OWASP ModSecurityコアルールセットに関して、動作モード、自己完結('deny')、コラボレーティブ検出('pass')を設定します。 + + デフォルト値: 'deny'。"log,auditlog,deny,status:406,tag:'SLA 24/7'"などの完全な値を設定することもできます。 + +* `secpcrematchlimit`: PCREライブラリのマッチ限度数を設定します。 + + デフォルト値: 1500。  + +* `secpcrematchlimitrecursion`: PCREライブラリのマッチ再帰制限数を設定します。 + + デフォルト値: 1500。  + +* `logroot`: オーディットおよびデバッグログの場所を設定します。 + + デフォルト値はApacheのログディレクトリ(Redhat: `/var/log/httpd`、Debian: `/var/log/apache2`)。 + +* `audit_log_relevant_status`: オーディットロギングの目的に関して、考慮すべき応答ステータスコードを設定します。 + + デフォルト値: '^(?:5|4(?!04))'。 + +* `audit_log_parts`: [オーディットログ][]に入れるべきセクションを設定します。 + + デフォルト値: 'ABIJDEFHZ'。 + +* `anomaly_score_blocking`: OWASP ModSecurityコアルールセットのコラボレーティブ検出ブロッキングをアクティベートまたはディアクティベートします。 + + デフォルト値: 'off'。 + +* `inbound_anomaly_threshold`: OWASP ModSecurityコアルールセットのコラボレーティブ検出モードに関して、インバウンドブロッキングルールのスコアリング閾値レベルを設定します。 + + デフォルト値: 5。  + +* `outbound_anomaly_threshold`: OWASP ModSecurityコアルールセットのコラボレーティブ検出モードに関して、アウトバウンドブロッキングルールのスコアリング閾値レベルを設定します。 + + デフォルト値: 4。  + +* `critical_anomaly_score`: OWASP ModSecurityコアルールセットのコラボレーティブ検出モードに関して、重要なセキュリティレベルのスコアリングポイントを設定します。 + + デフォルト値: 5。  + +* `error_anomaly_score`: OWASP ModSecurityコアルールセットのコラボレーティブ検出モードに関して、エラー深刻度レベルのスコアリングポイントを設定します。 + + デフォルト値: 4。  + +* `warning_anomaly_score`: OWASP ModSecurityコアルールセットのコラボレーティブ検出モードに関して、警告深刻度レベルのスコアリングポイントを設定します。 + + デフォルト値: 3。 + +* `notice_anomaly_score`: OWASP ModSecurityコアルールセットのコラボレーティブ検出モードに関して、通知深刻度レベルのスコアリングポイントを設定します。 + +デフォルト値: 2。 + +* `secrequestmaxnumargs`: リクエストの引数の最大数を設定します。 + + デフォルト値: 255。 + +* `secrequestbodylimit`: バッファリングに関してModSecurityが受け入れる最大リクエストボディサイズを設定します。 + + デフォルト値: '13107200'。 + +* `secrequestbodynofileslimit`: バッファリングに関してModSecurityが受け入れる最大リクエストボディサイズを設定します。リクエスト内でトランスポートされたファイルのサイズは除外されます。 + + デフォルト値: '131072'。 + +* `secrequestbodyinmemorylimit`: ModSecurityがメモリに保存する最大リクエストボディサイズを設定します。 + + デフォルト値: '131072'。 + +##### クラス: `apache::mod::wsgi` + +[`mod_wsgi`][]を使用したPythonサポートを有効にします。 + +**パラメータ**:  + +* `mod_path`: `mod_wsgi`共有オブジェクト(`.so`)ファイルのパスを定義します。 + + デフォルト値: `undef`。 + + * `mod_path`パラメータに`/`が含まれていない場合、Puppetではオペレーティングシステムのデフォルトのモジュールパスの先頭にこれを付加します。含まれている場合は、そのとおりに扱われます。 + +* `package_name`: `mod_wsgi`をインストールするパッケージの名前。 + + デフォルト値: `undef`。 + +* `wsgi_python_home`: '/path/to/venv'などの[`WSGIPythonHome`][]ディレクティブを定義します。 + + 値: パスを指定する文字列。  + + デフォルト値: `undef`。 + +* `wsgi_python_path`: '/path/to/venv/site-packages'などの[`WSGIPythonPath`][]ディレクティブを定義します。 + + 値: パスを指定する文字列。  + + デフォルト値: `undef`。 + +* `wsgi_restrict_embedded`: 'On'などの[`WSGIRestrictEmbedded`][]ディレクティブを定義します。 + +値: On|Off|undef。 + +デフォルト値: undef。 + +* `wsgi_socket_prefix`: "\${APACHE\_RUN\_DIR}WSGI"などの[`WSGISocketPrefix`][]ディレクティブを定義します。 + + デフォルト値: [`apache::params`][]の`wsgi_socket_prefix`。 + +このクラスのパラメータはモジュールのディレクティブに相当します。詳細については、[モジュールのドキュメント][`mod_wsgi`]を参照してください。 + +### プライベートクラス + +#### クラス: `apache::confd::no_accf` + +FreeBSDの Apache 2.4で必要とされる`no-accf.conf`設定ファイルを`conf.d`内に作成します。 + +#### クラス: `apache::default_confd_files` + +FreeBSDに`conf.d`を含めます。 + +#### クラス: `apache::default_mods` + +デフォルト設定の実行に必要なApacheモジュールをインストールします。詳細については、`apache`クラスの[`default_mods`][]パラメータを参照してください。 + +#### クラス: `apache::package` + +基本のApacheパッケージをインストールして設定します。 + +#### クラス: `apache::params` + +各種のオペレーティングシステムのApacheパラメータを管理します。 + +#### クラス: `apache::service` + +Apacheデーモンを管理します。 + +#### クラス: `apache::version` + +オペレーティングシステムに基づき、Apacheバージョンの自動検出を試みます。 + +##### Red Hat Software Collections (SCL) + +CentOS/RHELのSoftware Collectionsでは、新しいApacheおよびPHPに加え、他のパッケージも使用できます。 + +`scl_httpd_version`が設定されている場合、Apache Httpdは[Software Collections](https://www.softwarecollections.org/en/)からインストールされます。 + +`scl_httpd_version`が設定されている場合、PHPをインストールする予定がない場合でも`scl_php_version`を設定する必要があります。 + +リポジトリはこのモジュールではまだ管理されていません。CentOSでは、`centos-release-scl-rh`パッケージをインストールすることでリポジトリを有効にできます。 + +##### `scl_httpd_version` + +Red Hat Software Collections (SCL)を使用してインストールされるhttpdのバージョン。CentOSおよびRHELのコレクションでは、新しいApacheおよびPHPパッケージを使用できます。 + +`scl_httpd_version`を設定すると、Apache httpdは[Software Collections](https://www.softwarecollections.org/en/)からインストールされます。 + +`scl_httpd_version`を設定した場合、PHPをインストールする予定がない場合でも`scl_php_version`を設定する必要があります。 + +SCLリポジトリはこのモジュールではまだ管理されていません。CentOSでは、`centos-release-scl-rh`パッケージをインストールすることでリポジトリを有効にできます。 + +有効な値: インストールするhttpdのバージョンを指定する文字列。例えば、Apache 2.4の場合は'2.4'を指定します。 + +デフォルト値: undef。 + +##### `scl_php_version` + +Red Hat Software Collections (SCL)を使用してインストールするhttpdのバージョン。CentOSおよびRHELのコレクションでは、新しいApacheおよびPHPのパッケージを使用できます。 + +`scl_php_version`を設定すると、PHPは[Software Collections](https://www.softwarecollections.org/en/)からインストールされます。 + +SCLリポジトリはこのモジュールではまだ管理されていません。CentOSでは、`centos-release-scl-rh`パッケージをインストールすることでリポジトリを有効にできます。 + +有効な値: インストールするPHPのバージョンを指定する文字列。例えば、PHP 7.1の場合は'7.1'を指定します。 + +デフォルト値: undef。 + +### パブリック定義タイプ  + +#### 定義タイプ: `apache::balancer` + +[`mod_proxy`][]を用いて、Apacheロードバランシンググループ(バランサクラスタとも呼ばれます)を作成します。各ロードバランシンググループには、1つ以上のバランサメンバーが必要です。これは、 [`apache::balancermember`][]定義タイプによりPuppet内で宣言することができます。 + +各Apacheロードバランシンググループにつき、1つの`apache::balancer`定義タイプを宣言します。すべてのバランサメンバーについて`apache::balancermember`定義タイプをエクスポートし、[エクスポートリソース][]を用いて単一のApacheロードバランササーバで収集することもできます。 + +**パラメータ**:  + +##### `name` + +バランサクラスタのタイトルと、その設定を含む`conf.d`の名前を設定します。 + +##### `proxy_set` + +キー‐値ペアを[`ProxySet`][]行として設定します。値: [ハッシュ][]。 + +デフォルト値: '{}'。 + +##### `options` + +バランサURLの後に[オプション](https://httpd.apache.org/docs/current/mod/mod_proxy.html#balancermember)の[配列][]を指定します。[`ProxyPass`][]で使用可能な任意のキー-値ペアを使用できます。 + +デフォルト値: []。  + +##### `collect_exported` + +[エクスポートリソース][]を使用するかどうかを決定します。 + +すべてのバックエンドサーバを静的に宣言する場合は、このパラメータを`false`に設定し、宣言済みの既存のバランサメンバーリソースに依存するようにします。また、[配列][]引数とともに`apache::balancermember`を使用します。 + +中央ノードで収集したエクスポートリソースを使用してバックエンドサーバを動的に宣言するには、このパラメータを`true`に設定し、バランサメンバーノードによりエクスポートされたバランサメンバーリソースを収集します。 + +エクスポートリソースを使用しない場合は、1回のPuppet実行ですべてのバランサメンバーが設定されます。エクスポートリソースを使用する場合は、まずバランシングしたノードについてPuppetを実行し、次にバランサで実行する必要があります。 + +ブーリアン。 + +デフォルト値: `true`。 + +#### 定義タイプ: `apache::balancermember` + +[`mod_proxy_balancer`][]のメンバーを定義します。これにより、ロードバランサの`apache.cfg`内でリッスンするサービス設定ブロック内のバランサメンバーが設定されます。 + +**パラメータ**:  + +##### `balancer_cluster` + +**必須**。  + +Apacheサービスのインスタンス名を設定します。宣言された[`apache::balancer`][]リソースの名前と一致する必要があります。 + +##### `url` + +バランサメンバーサーバとの連絡に使用するURLを指定します。 + +デフォルト値: 'http://${::fqdn}/'。 + +##### `options` + +URL後に[オプション](https://httpd.apache.org/docs/current/mod/mod_proxy.html#balancermember)の[配列][]を指定します。[`ProxyPass`][]で使用可能な任意のキー-値ペアを使用できます。 + +デフォルト値: 空配列。  + +#### 定義タイプ: `apache::custom_config` + +Apacheサーバの`conf.d`ディレクトリにカスタム設定ファイルを追加します。このファイルが無効で、この定義タイプの[`verify_config`][]パラメータの値が`true`になっている場合は、Puppet実行時にエラーが生じます。 + +**パラメータ**:  + +##### `ensure` + +設定ファイルが存在するべきかどうかを指定します。 + +値: 'absent'、'present'。  + +デフォルト値: 'present'。  + +##### `confdir`  + +Puppetが設定ファイルを置くディレクトリを設定します。 + +デフォルト値: [`$::apache::confd_dir`][`confd_dir`]の値。 + +##### `content` + +設定ファイルのコンテンツを設定します。`content`および[`source`][]パラメータは、相互排他的な関係にあります。 + +デフォルト値: `undef`。  + +##### `filename` + +Puppetが設定を保存する`confdir`下のファイル名を設定します。 + +デフォルト値: `priority`パラメータから生成したファイル名およびリソース名。 + +##### `priority` + +Apacheでは設定ファイルがアルファベット順に処理されるため、ファイル名の先頭にこのパラメータの数値を付加することで、設定ファイルの優先順位を設定します。 + +設定ファイル名の優先順位の接頭値を無視するには、このパラメータを`false`に設定します。 + +デフォルト値: '25'。 + +##### `source` + +設定ファイルのソースを指します。[`content`][]および`source`パラメータは互いに排他的です。 + +デフォルト値: `undef`。  + +##### `verify_command` + +Puppetが設定ファイルの確認に用いるコマンドを指定します。完全修飾コマンドを使用してください。 + +このパラメータは、[`verify_config`][]パラメータの値が`true`になっている場合にのみ使用されます。`verify_command`が失敗すると、Puppet実行により設定ファイルが削除されてエラーが生じますが、Apacheサービスには通知されません。 + +デフォルト値: '/usr/sbin/apachectl -t'。 + +##### `verify_config` + +Apacheサービスに通知する前に設定ファイルのバリデーションを行うかどうかを指定します。 + +ブーリアン。 + +デフォルト値: `true`。 + +#### 定義タイプ: `apache::fastcgi::server` + +特定のファイルタイプを処理する1つまたは複数の外部FastCGIサーバを定義します。この定義タイプは、[`mod_fastcgi`][FastCGI]とともに使用します。 + +**パラメータ**  + +##### `host` + +FastCGIのホスト名またはIPアドレスおよびTCPポート番号(1-65535)を決定します。 + +デフォルト値: '127.0.0.1:9000'。 + +##### `timeout` + +リクエストが中止され、エラーLogLevelにイベントが記録されるまでに、[FastCGI][]アプリケーションが非アクティブの状態で待機する秒数を設定します。この非アクティブタイマーは、FastCGIアプリケーションとの接続が待機中の場合のみ適用されます。アプリケーションの待ち行列に入ったリクエストに対して時間内に記述やフラッシュによる応答がないと、リクエストは中止されます。アプリケーションとの通信は完了したものの、クライアントとの通信が完了しなかった(応答がバッファリングされた)場合は、タイムアウトは適用されません。 + +デフォルト値: 15。 + +##### `flush` + +アプリケーションから受信したデータを、強制的に[`mod_fastcgi`][FastCGI]がクライアントに書き込みます。デフォルトでは、アプリケーションをできるだけ早くフリーな状態にするために、`mod_fastcgi`はデータをバッファリングします。 + +デフォルト値: `false`。 + +##### `faux_path` + +Apacheには、このファイル名を決定するURIを処理する[FastCGI][]があります。このパラメータで設定されたパスは、ローカルのファイルシステムに存在する必要はありません。 + +デフォルト値: "/var/www/${name}.fcgi"。 + +##### `alias` + +FastCGIサーバとアクションを内部でリンクします。このエイリアスは一意である必要があります。 + +デフォルト値: "/${name}.fcgi"。 + +##### `file_type` + +FastCGIサーバにより処理するファイルの[MIME `content-type`][]を設定します。 + +デフォルト値: 'application/x-httpd-php'。 + +#### 定義タイプ: `apache::listen` + +Apacheサーバまたはバーチャルホストのリッスンするアドレスとポートを定義する、Apache設定ディレクトリの`ports.conf`に、[`Listen`][]ディレクティブを追加します。[`apache::vhost`][]クラスはこの定義タイプを使用します。タイトルは ``、`:`、または`:`の形式をとります。 + +#### 定義タイプ: `apache::mod` + +対応する[`apache::mod::`][]クラスを持たないApacheモジュール用のパッケージをインストールし、Apacheサーバの`module`および`enable`ディレクトリ内で、モジュールのデフォルト設定ファイルを確認または配置します。デフォルトのロケーションは、オペレーティングシステムによって異なります。 + +**パラメータ**:  + +##### `package` + +**必須**。  + +PuppetがApacheモジュールのインストールに使用するパッケージの名前。 + +デフォルト値: `undef`。 + +##### `package_ensure` + +Apacheモジュールをインストールの必要性をPuppetが確認するかどうかを決定します。 + +値: 'absent'、'present'。  + +デフォルト値: 'present'。  + +##### `lib` + +モジュールの共有オブジェクト名を定義します。特別な理由がない限り、手動で設定しないでください。 + +デフォルト値: `mod_$name.so`。 + +##### `lib_path` + +モジュールのライブラリのパスを指定します。特別な理由がない限り、手動で設定しないでください。[`path`][]パラメータは、この値をオーバーライドします。 + +デフォルト値: `apache`クラスの[`lib_path`][]パラメータ。 + + +##### `loadfile_name` + +モジュールの[`LoadFile`][]ディレクティブのファイル名を設定します。Apacheの処理はアルファベット順に行われるため、ファイル名によってモジュールのロード順序も設定できます。 + +値: `\*.load`の形式のファイル名。 + +デフォルト値: '$name.load'のように、リソース名の後に'load'をつけた値。 + +##### `loadfiles` + +[`LoadFile`][]ディレクティブの配列を指定します。 + +デフォルト値: `undef`。 + +##### `path` + +モジュールのパスを指定します。特別な理由がない限り、このパラメータは手動で設定しないでください。 + +デフォルト値: [`lib_path`][]/[`lib`][]。 + +#### 定義タイプ: `apache::namevirtualhost` + +[名前ベースのバーチャルホスト][]を有効にし、Apache HTTPD設定ディレクトリの `ports.conf`ファイルに関連するすべてのディレクティブを追加します。タイトルは、'\*'、'\*:\'、'\_default\_:\、'\'、または'\:\'の形式をとることができます。 + +#### 定義タイプ: `apache::vhost` + +apacheモジュールでは、バーチャルホストのセットアップと設定に関して、かなりの柔軟性が認められています。この柔軟性の一部は、定義リソースタイプの`vhost`によるものです。これを使えば、さまざまなパラメータを用いて、Apacheを何度も検証することができます。 + +`apache::vhost`定義タイプを使えば、デフォルトの範囲外の要件を持つバーチャルホストについて、特別な設定をすることができます。基本の`::apache`クラス内でデフォルトのバーチャルホストを設定することも、カスタマイズしたバーチャルホストをデフォルトとして設定することもできます。カスタマイズしたバーチャルホストの[`priority`][]の数値は基本のクラスよりも小さくなるため、Apacheはカスタマイズしたバーチャルホストを先に処理します。 + +`apache::vhost`定義タイプでは、`concat::fragment`を使用して設定ファイルを構築します。定義タイプがもともとサポートしていない設定の要素についてカスタムフラグメントを挿入するには、カスタムフラグメントをひとつずつ追加します。 + +`apache::vhost`定義タイプでは、カスタムフラグメントの`order`パラメータについては10の倍数が使用されるため、10の倍数ではない`order`が機能します。 + +> **Note:** `apache::vhost`を作成するとき、`default`または`default-ssl`を指定することはできません。これはこの属性を持つvhostsが常にモジュールによって管理されるためです。これは`Apache::Vhost['default']`または`Apache::Vhost['default-ssl]`リソースを上書きできないことを意味します。 オプションの回避策として、`my default`などの別の名前のvhostを作成して、`default`および`default_ssl`が`false`に設定されていることを確認します。 + +``` +class { 'apache': + default_vhost => false + default_ssl_vhost => false, +} +``` + +**パラメータ**:  + +##### `access_log` + +`*_access.log`ディレクティブ(`*_file`,`*_pipe`または`*_syslog`)を設定するかどうかを決定します。 + +ブーリアン。 + +デフォルト値: `true`。 + +##### `access_log_env_var` + +特定の環境変数を持つリクエストのみをロギングするように指定します。 + +デフォルト値: `undef`。 + +##### `access_log_file` + +[`logroot`][]に置く`*_access.log`のファイル名を設定します。バーチャルホスト---例えばexample.comなど---を与えると、[SSL暗号化][SSL暗号化]バーチャルホストの場合はデフォルト値が'example.com_ssl.log'、暗号化されていないバーチャルホストの場合は'example.com_access.log'になります。 + +デフォルト値: `false`。 + +##### `access_log_format` + +アクセスログに、[`LogFormat`][]のニックネームかカスタムフォーマットの文字列のいずれを使うかを指定します。 + +デフォルト値: 'combined'。 + +##### `access_log_pipe` + +Apacheがアクセスログメッセージを送信するパイプを指定します。 + +デフォルト値: `undef`。 + +##### `access_log_syslog` + +すべてのアクセスログメッセージをsyslogに送ります。 + +デフォルト値: `undef`。 + +##### `add_default_charset` + +[`AddDefaultCharset`][]ディレクティブのデフォルトのメディア文字セット値を設定します。これは`text/plain`および`text/html`応答に追加されます。 + +デフォルト値: `undef`。 + +##### `add_listen` + +バーチャルホストが[`Listen`][]ステートメントを作成するかどうかを決定します。 + +`add_listen`を`false`に設定すると、バーチャルホストは`Listen`ステートメントを作成しません。これは、`ip`パラメータを渡されていないバーチャルホストと渡されているバーチャルホストを組み合わせる場合に重要となります。 + +ブーリアン。 + +デフォルト値: `true`。 + +##### `use_optional_includes` + +Apache 2.4以降の`additional_includes`について、Apacheが[`Include`][]の代わりに[`IncludeOptional`][]ディレクティブを使うかどうかを指定します。 + +ブーリアン。 + +デフォルト値: `false`。 + +##### `additional_includes` + +追加の静的なバーチャルホスト固有のApache設定ファイルのパスを指定します。このパラメータを使えば、このモジュールでサポートされていない固有のカスタム設定を実装することができます。 + +値: パスを指定する文字列また文字列の[配列][]。 + +デフォルト値: 空配列。  + +##### `aliases` + +[ハッシュ][ハッシュ]のリストをバーチャルホストに渡し、[`mod_alias`][]ドキュメントに従って[`Alias`][]、[`AliasMatch`][]、[`ScriptAlias`][]、または[`ScriptAliasMatch`][]ディレクティブを作成します。 + +例:  + +``` puppet +aliases => [ + { aliasmatch => '^/image/(.*)\.jpg$', + path => '/files/jpg.images/$1.jpg', + }, + { alias => '/image', + path => '/ftp/pub/image', + }, + { scriptaliasmatch => '^/cgi-bin(.*)', + path => '/usr/local/share/cgi-bin$1', + }, + { scriptalias => '/nagios/cgi-bin/', + path => '/usr/lib/nagios/cgi-bin/', + }, + { alias => '/nagios', + path => '/usr/share/nagios/html', + }, +], +``` + +`alias`、`aliasmatch`、`scriptalias`、`scriptaliasmatch`キーを機能させるには、``、``などの、それぞれに対応するコンテキストが必要です。Puppetは`aliases`パラメータで指定された順序でディレクティブを作成します。[`mod_alias`][]ドキュメントにもあるように、シャドーイングを避けるため、まず具体性の高い`alias`、`aliasmatch`、`scriptalias`、`scriptaliasmatch`パラメータを追加してから、全般的なパラメータを追加してください。 + +> **注意**: `scriptaliases`パラメータの代わりに`aliases`パラメータを使用すれば、各種のエイリアスディレクティブの順序を正確に制御できます。`scriptaliases`パラメータを使って`ScriptAliases`を定義すると、すべての*`Alias`ディレクティブの後に*すべての*`ScriptAlias`ディレクティブが*処理されます。これは`Alias`ディレクティブによる`ScriptAlias`ディレクティブのシャドーイングにつながり、多くの場合、問題が生じます。例えば、Nagiosに関する問題が生じる可能性があります。 + +I[`apache::mod::passenger`][]がロードされ、`PassengerHighPerformance`が`true`になっている場合、`Alias`ディレクティブが`PassengerEnabled => off`ステートメントを履行できない可能性があります。詳細については、[この記事](http://www.conandalton.net/2010/06/passengerenabled-off-not-working.html)を参照してください。 + +##### `allow_encoded_slashes` + +バーチャルホストの[`AllowEncodedSlashes`][]宣言を設定し、サーバのデフォルトをオーバーライドします。これにより、`\`および`/`文字を含むURLに対するバーチャルホストの応答が変更されます。値: 'nodecode'、'off'、'on'。デフォルト設定では、サーバ設定からこの宣言が省かれ、Apacheのデフォルト設定'Off'が選択されます。 + +デフォルト値: `undef`。  + +##### `block` + +Apacheがアクセスをブロックする対象のリストを指定します。有効なオプション: 'scm'、これにより、`.svn`、`.git`、`.bzr`ディレクティブへのWebアクセスがブロックされます。 + +デフォルト値: 空[配列][]。 + +##### `cas_attribute_prefix` + +SAMLバリデーションが有効になっている場合に、このヘッダの値を属性値としてヘッダを追加します。 + +デフォルト値: [`apache::mod::auth_cas`][]により設定された値。 + +##### `cas_attribute_delimiter` + +`cas_attribute_prefix`により作成されたヘッダの属性値の区切り文字を設定します。 + +デフォルト値: [`apache::mod::auth_cas`][]により設定された値。  + +##### `cas_login_url` + +ユーザがCASで保護されたリソースへのアクセスを試み、かつアクティブなセッションがない場合に、モジュールがユーザをリダイレクトする先のURLを設定します。 + +デフォルト値: [`apache::mod::auth_cas`][]により設定された値。  + +##### `cas_scrub_request_headers` + +mod_auth_cas内で特別な意味を持つ可能性のあるインバウンドリクエストヘッダを削除します。 + +デフォルト値: [`apache::mod::auth_cas`][]により設定された値。  + +##### `cas_sso_enabled` + +`cas_sso_enabled`: シングルサインアウトの実験的サポートを有効にします(POSTデータが壊れる可能性があります)。 + +デフォルト値: [`apache::mod::auth_cas`][]により設定された値。  + +##### `cas_validate_saml` + +SAMLに関するCASサーバからの解析応答。 + +デフォルト値: [`apache::mod::auth_cas`][]により設定された値。  + +##### `cas_validate_url` + +HTTPクエリ文字列でクライアントの提示するチケットをバリデーションする際に使用するURL。 + +デフォルト値: [`apache::mod::auth_cas`][]により設定された値。 + + +##### `comment` + +設定ファイルのヘッダにコメントを追加します。文字列または文字列の配列として渡します。 + +デフォルト値: `undef`。 + +例:  + +``` puppet +comment => "Account number: 123B", +``` + +Or: + +``` puppet +comment => [ + "Customer: X", + "Frontend domain: x.example.org", +] +``` + +##### `custom_fragment` + +カスタム設定ディレクティブの文字列を渡し、バーチャルホスト設定の最後に配置します。 + +デフォルト値: `undef`。 + +##### `default_vhost` + +任意の`apache::vhost`定義タイプを、他の`apache::vhost`定義タイプと一致しないリクエストをサーブするためのデフォルトとして設定します。 + +デフォルト値: `false`。 + +##### `directories` + +[`directories`](#parameter-directories-for-apachevhost)セクションを参照してください。 + +##### `directoryindex` + +ディレクトリ名の最後で'/'を指定することで、クライアントがディレクトリのインデックスをリクエストした際に探すべきリソースのリストを設定します。詳細については、[`DirectoryIndex`][]ディレクティブドキュメントを参照してください。 + +デフォルト値: `undef`。 + +##### `docroot` + +**必須**。  + +[`DocumentRoot`][]ロケーションを設定します。Apacheはここからファイルをサーブします。 + +`docroot`と[`manage_docroot`][]がともに`false`に設定されている場合、[`DocumentRoot`][]は設定されず、それに付随する``ブロックは作成されません。 + +値: ディレクトリパスを指定する文字列。 + +##### `docroot_group` + +[`docroot`][]ディレクトリへのグループアクセスを設定します。 + +値: システムグループを指定する文字列。 + +デフォルト値: 'root'。  + +##### `docroot_owner` + +[`docroot`][]ディレクトリへの個々のユーザのアクセスを設定します。 + +値: ユーザアカウントを指定する文字列。 + +デフォルト値: 'root'。  + +##### `docroot_mode` + +[`docroot`][]ディレクトリへのアクセス許可を数字表記法で設定します。 + +値: 文字列。  + +デフォルト値: `undef`。 + +##### `manage_docroot` + +Puppetが[`docroot`][]ディレクトリを管理するかどうかを決定します。 + +ブーリアン。 + +デフォルト値: `true`。 + +##### `error_log` + +`*_error.log`ディレクティブを設定するかどうかを指定します。 + +ブーリアン。 + +デフォルト値: `true`。 + +##### `error_log_file` + +バーチャルホストのエラーログについて、`*_error.log`ファイルを優先します。このパラメータが定義されていない場合、Puppetはまず[`error_log_pipe`][]で、次に[`error_log_syslog`][]で値を確認します。 + +これらのパラメータをいずれも設定しない場合は、例えばバーチャルホストが`example.com`なら、PuppetはSSLバーチャルホストのデフォルトを'$logroot/example.com_error_ssl.log'、非SSLバーチャルホストのデフォルトを'$logroot/example.com_error.log'とします。 + +デフォルト値: `undef`。 + +##### `error_log_pipe` + +エラーログメッセージを送るパイプを指定します。 + +[`error_log_file`][]パラメータに値がある場合は、このパラメータに効力は生じません。このパラメータにも`error_log_file`にも値がない場合、Puppetは[`error_log_syslog`][]をチェックします。 + +デフォルト値: `undef`。 + +##### `error_log_syslog` + +すべてのエラーログメッセージをsyslogに送るかどうかを決定します。 + +[`error_log_file`][]パラメータまたは[`error_log_pipe`][]パラメータのいずれかに値がある場合、このパラメータの効力は生じません。これらのパラメータのいずれにも値がない場合は、例えばバーチャルホスト`example.com`では、PuppetはSSLバーチャルホストのデフォルトを'$logroot/example.com_error_ssl.log'、非SSLバーチャルホストのデフォルトを '$logroot/example.com_error.log'とします。 + +ブーリアン。 + +デフォルト値: `undef`。 + +##### `error_documents` + +このバーチャルホストの[エラードキュメント](https://httpd.apache.org/docs/current/mod/core.html#errordocument)設定のオーバーライドに使用できるハッシュのリスト。 + +例:  + +``` puppet +apache::vhost { 'sample.example.net': + error_documents => [ + { 'error_code' => '503', 'document' => '/service-unavail' }, + { 'error_code' => '407', 'document' => 'https://example.com/proxy/login' }, + ], +} +``` + +デフォルト値: []。  + +##### `ensure` + +バーチャルホストが存在するかどうかを指定します。 + +値: 'absent'、'present'。  + +デフォルト値: 'present'。  + +##### `fallbackresource` + +[FallbackResource](https://httpd.apache.org/docs/current/mod/mod_dir.html#fallbackresource)ディレクティブを設定します。このディレクティブは、ファイルシステム内のどこにもマッピングされていないURLに対してどのようなアクションをとるか指定します。指定されていない場合は'HTTP 404 (Not Found)'が返されます。値は'/'で始めるか、'disabled'とする必要があります。 + +デフォルト値: `undef`。 + +##### `fastcgi_idle_timeout` + +fastcgiを使用する場合に、このオプションにより、サーバ応答のタイムアウトを設定します。 + +デフォルト値: `undef`。 + +##### `file_e_tag` + +[`FileETag`][]宣言のサーバデフォルトを設定します。これにより、静的ファイルの応答ヘッダフィールドが変更されます。 + +値: 'INode'、'MTime'、'Size'、'All'、'None'。 + +デフォルト値: `undef`、この場合、Apacheのデフォルト設定'MTime Size'が使用されます。 + +##### `filters` + +[フィルタ](https://httpd.apache.org/docs/current/mod/mod_filter.html)により、アウトプットコンテンツフィルタのスマートな文脈依存設定が有効になります。 + +``` puppet +apache::vhost { "$::fqdn": + filters => [ + 'FilterDeclare COMPRESS', + 'FilterProvider COMPRESS DEFLATE resp=Content-Type $text/html', + 'FilterChain COMPRESS', + 'FilterProtocol COMPRESS DEFLATE change=yes;byteranges=no', + ], +} +``` + +##### `force_type` + +[`ForceType`][]ディレクティブを設定します。このディレクティブは、[MIME `content-type`][]がこのパラメータの値に一致するすべてのマッチングファイルをApacheに強制的にサーブさせます。 + +#### `add_charset` + +ディレクトリおよびファイル拡張子ごとに、Apacheにカスタムコンテンツ文字セットを設定させます。 + +##### `headers` + +レスポンスヘッダを置換、結合、または削除するための行を追加します。詳細については、[Apacheのmod_headersドキュメント](https://httpd.apache.org/docs/current/mod/mod_headers.html#header)を参照してください。 + +値: 文字列または文字列の配列。  + +デフォルト値: `undef`。 + +##### `ip` + +バーチャルホストがリッスンするIPアドレスを設定します。デフォルトでは、Apacheのデフォルト挙動が使用され、すべてのIPをリッスンします。 + +値: 文字列または文字列の配列。  + +デフォルト値: `undef`。 + +##### `ip_based` + +[IPベースの](https://httpd.apache.org/docs/current/vhosts/ip-based.html)バーチャルホストを有効にします。このパラメータにより、NameVirtualHostディレクティブの作成が禁止されます。これは、このディレクティブが名前ベースのバーチャルホストにリクエストを送る際に使用されるためです。 + +デフォルト値: `false`。 + +##### `itk` + +ハッシュで[ITK](http://mpm-itk.sesse.net/)を設定します。 + +通常は、以下のように使用します。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + itk => { + user => 'someuser', + group => 'somegroup', + }, +} +```  + +値: ハッシュ。キーを含めることもできます。 + +* ユーザ + グループ +* `assignuseridexpr` +* `assigngroupidexpr` +* `maxclientvhost` +* `nice` +* `limituidrange` (Linux 3.5.0以降) +* `limitgidrange` (Linux 3.5.0以降) + +通常は、以下のように使用します。  + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + itk => { + user => 'someuser', + group => 'somegroup', + }, +} +```  + +デフォルト値: `undef`。 + +##### `jk_mounts` + +'JkMount'および'JkUnMount'ディレクティブによりバーチャルホストを設定し、TomcatとApacheの間をマッピングするURLのパスを処理します。 + +このパラメータは、ハッシュの配列にする必要があります。各ハッシュには、'worker'と、'mount'または'unmount'キーのいずれかが含まれている必要があります。 + +通常は、以下のように使用します。  + +``` puppet +apache::vhost { 'sample.example.net': + jk_mounts => [ + { mount => '/*', worker => 'tcnode1', }, + { unmount => '/*.jpg', worker => 'tcnode1', }, + ], +} +``` +デフォルト値: `undef`。 + +##### `keepalive` + +バーチャルホストで[`KeepAlive`][]ディレクティブによるHTTPの持続的接続を有効にするかどうかを決定します。デフォルトでは、グローバルなサーバ全体の[`KeepAlive`][]設定が有効になります。 + +バーチャルホストの関連オプションを設定するには、`keepalive_timeout`および`max_keepalive_requests`パラメータを使用します。 + +値: 'Off'、'On'。 + +デフォルト値: `undef`。  + +##### `keepalive_timeout` + +バーチャルホストの[`KeepAliveTimeout`]ディレクティブを設定します。これにより、HTTPの持続的接続で後続のリクエストを実行するまでの待機時間が決まります。デフォルトでは、グローバルなサーバ全体の[`KeepAlive`][]設定が有効になります。 + +このパラメータが意味を持つのは、グローバルなサーバ全体の[`keepalive`パラメータ][]またはバーチャルホストごとの`keepalive`パラメータのいずれかが有効になっている場合のみです。  + +デフォルト値: `undef`。  + +##### `max_keepalive_requests` + +接続1回につき許可されるバーチャルホストへのリクエスト数を制限します。デフォルトでは、グローバルなサーバ全体の[`KeepAlive`][]設定が有効になります。 + +このパラメータが意味を持つのは、グローバルなサーバ全体の[`keepalive`パラメータ][]またはバーチャルホストごとの`keepalive`パラメータのいずれかが有効になっている場合のみです。  + +デフォルト値: `undef`。 + +##### `auth_kerb` + +バーチャルホストの[`mod_auth_kerb`][]パラメータを有効にします。 + +通常は、以下のように使用します。  + +``` puppet +apache::vhost { 'sample.example.net': + auth_kerb => `true`, + krb_method_negotiate => 'on', + krb_auth_realms => ['EXAMPLE.ORG'], + krb_local_user_mapping => 'on', + directories => { + path => '/var/www/html', + auth_name => 'Kerberos Login', + auth_type => 'Kerberos', + auth_require => 'valid-user', + }, +} +``` + +関連するパラメータは、`mod_auth_kerb`ディレクティブの名前に従います。 + +- `krb_method_negotiate`: Negotiateメソッドを使用するかどうかを決定します。デフォルト値: 'on'。 +- `krb_method_k5passwd`: Kerberos v5に関してパスワードベースの認証を使用するかどうかを決定します。デフォルト値: 'on'。 +- `krb_authoritative`: 'off'に設定すると、認証コントロールを別のモジュールに渡すことができます。デフォルト値: 'on'。 +- `krb_auth_realms`: 認証に使用するKerberos領域の配列を指定します。デフォルト値: []。 +- `krb_5keytab`: Kerberos v5キータブファイルのロケーションを指定します。デフォルト値: `undef`。 +- `krb_local_user_mapping`: 今後の使用のために、ユーザ名から@REALMを取り除きます。デフォルト値: `undef`。 + +ブーリアン。 + +デフォルト値: `false`。 + +##### `krb_verify_kdc` + +このオプションを使えば、ローカルなキータブに対する認証チケットを無効にし、KDCスプーフィング攻撃を防ぐことができます。 + +デフォルト値: 'on'。 + +##### `krb_servicename` + +Apacheが認証に使用するサービス名を指定します。この名前に対応するキーをキータブに保存する必要があります。 + +デフォルト値: 'HTTP'。 + +##### `krb_save_credentials` + +このオプションにより、認証情報の保存機能が有効になります。 + +デフォルト値: 'off'。 + +##### `logroot` + +バーチャルホストのログファイルの保存場所を指定します。 + +デフォルト値: `/var/log//`。 + +##### `$logroot_ensure` + +バーチャルホストのlogrootディレクトリを削除するかどうかを決定します。 + +値: 'directory'、'absent'。 + +デフォルト値: 'directory'。 + +##### `logroot_mode` + +logrootディレクトリで設定されたモードをオーバーライドします。影響を把握できない場合は、ログが保存されているディレクトリへの書き込みアクセス権限を付与*しないで*ください。詳細については、[Apacheのログセキュリティドキュメント](https://httpd.apache.org/docs/2.4/logs.html#security)を参照してください。 + +デフォルト値: `undef`。 + +##### `logroot_owner` + +logrootディレクトリへの個々のユーザのアクセスを設定します。 + +デフォルト値:`undef`。 + +##### `logroot_group` + +[`logroot`][]ディレクトリへのグループアクセスを設定します。 + +デフォルト値:`undef`。 + +##### `log_level` + +エラーログの詳細レベルを指定します。 + +値: 'emerg'、'alert'、'crit'、'error'、'warn'、'notice'、'info'、'debug'。 + +デフォルト値: グローバルサーバ設定については'warn'。バーチャルホストごとにオーバーライドできます。 + +###### `modsec_body_limit` + +バッファリングに関してModSecurityが受け入れる最大リクエストボディサイズをバイト数で設定します。 + +値: 整数。 + +デフォルト値: `undef`。 + +###### `modsec_disable_vhost` + +バーチャルホストで[`mod_security`][]を無効にします。[`apache::mod::security`][]が含まれている場合にのみ有効です。 + +ブーリアン。 + +デフォルト値: `undef`。 + +###### `modsec_disable_ids` + +バーチャルホストから`mod_security` IDを削除します。 + +値: バーチャルホストから削除する`mod_security` IDの配列。ハッシュも使用できます。この場合、特定のロケーションからのIDの削除が可能です。 + +``` puppet +apache::vhost { 'sample.example.net': + modsec_disable_ids => [ 90015, 90016 ], +} +``` + +``` puppet +apache::vhost { 'sample.example.net': + modsec_disable_ids => { '/location1' => [ 90015, 90016 ] }, +} +``` + +デフォルト値: `undef`。 + +###### `modsec_disable_ips` + +[`mod_security`][]ルールマッチングから除外するIPアドレスの配列を指定します。 + +デフォルト値: `undef`。 + +###### `modsec_disable_msgs` + +バーチャルホストから削除するmod_security Msgの配列。ハッシュも使用できます。この場合、特定のロケーションからのMsgの削除が可能です。 + +``` puppet +apache::vhost { 'sample.example.net': + modsec_disable_msgs => ['Blind SQL Injection Attack', 'Session Fixation Attack'], +} +``` + +``` puppet +apache::vhost { 'sample.example.net': + modsec_disable_msgs => { '/location1' => ['Blind SQL Injection Attack', 'Session Fixation Attack'] }, +} +``` + +デフォルト値: `undef`。 + +###### `modsec_disable_tags` + + バーチャルホストから削除するmod_securityタグの配列。ハッシュも使用できます。この場合、特定のロケーションからのタグの削除が可能です。 + +``` puppet +apache::vhost { 'sample.example.net': + modsec_disable_tags => ['WEB_ATTACK/SQL_INJECTION', 'WEB_ATTACK/XSS'], +} +``` + +``` puppet +apache::vhost { 'sample.example.net': + modsec_disable_tags => { '/location1' => ['WEB_ATTACK/SQL_INJECTION', 'WEB_ATTACK/XSS'] }, +} +``` + +デフォルト値: `undef`。 + +##### `modsec_audit*` + +* `modsec_audit_log` +* `modsec_audit_log_file` +* `modsec_audit_log_pipe` + +この3つのパラメータは、いずれも`mod_security`オーディットログの送信方法を決定します([SecAuditLog](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#SecAuditLog))。 + +* `modsec_audit_log_file`が設定されている場合は、[`logroot`][]と比較されます。 + + デフォルト値: `undef`。 + +* `modsec_audit_log_pipe`を設定する場合は、パイプで始める必要があります。例えば、'|/path/to/mlogc /path/to/mlogc.conf'のようになります。 + + デフォルト値: `undef`。 + +* `modsec_audit_log`が`true`になっている場合、バーチャルホスト---example.comなど---を与えると、[SSL暗号化][SSL encryption]バーチャルホストの場合はデフォルト値が'example.com\_security\_ssl.log'、暗号化されていないバーチャルホストの場合は'example.com\_security.log'になります。 + + デフォルト値: `false`。 + +上述のパラメータがいずれも設定されていない場合、グローバルオーディットログが使用されます(''/var/log/httpd/modsec\_audit.log''; Debianおよびデリバティブ: ''/var/log/apache2/modsec\_audit.log''; その他: )。 + +##### `no_proxy_uris` + +プロキシを使用しないURLを指定します。このパラメータは、[`proxy_dest`](#proxy_dest)と組み合わせて使用することはできません。 + +デフォルト値: []。  + +##### `no_proxy_uris_match` + +このディレクティブは[`no_proxy_uris`][]と同じですが、正規表現をとります。 + +デフォルト値: []。  + +##### `proxy_preserve_host` + +[ProxyPreserveHostディレクティブ](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypreservehost)を設定します。 + +このパラメータを`true`に設定すると、受信リクエストの`Host:`行が有効になり、ホスト名ではなくホストにプロキシされます。`false`に設定すると、このディレクティブが'Off'になります。 + +ブーリアン。 + +デフォルト値: `false`。 + +##### `proxy_add_headers` + +[ProxyAddHeadersディレクティブ](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyaddheaders)を設定します。 + +このパラメータは、プロキシ関連のHTTPヘッダ(X-Forwarded-For、X-Forwarded-Host、X-Forwarded-Server)をバックエンドサーバに送信するかどうかを制御します。 + +ブーリアン。 + +デフォルト値: `false`。 + +##### `proxy_error_override` + +[ProxyErrorOverrideディレクティブ](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxyerroroverride)を設定します。このディレクティブは、プロキシされたコンテンツに関するエラーページをApacheによりオーバーライドすべきかどうかを制御します。 + +ブーリアン。 + +デフォルト値: `false`。 + +##### `options` + +指定されたバーチャルホストの[`Options`][]を設定します。例: + +``` puppet +apache::vhost { 'site.name.fdqn': + … + options => ['Indexes','FollowSymLinks','MultiViews'], +} +``` + +> **注意**: [`apache::vhost`][]の[`directories`][]パラメータを使うと、'Options'、'Override'、'DirectoryIndex'は`directories`内のパラメータであるため、無視されます。 + +デフォルト値: ['Indexes','FollowSymLinks','MultiViews']。 + +##### `override` + +指定されたバーチャルホストのオーバーライドを設定します。[AllowOverride](https://httpd.apache.org/docs/current/mod/core.html#allowoverride)引数の配列を使用できます。 + +デフォルト値: ['None']。 + +##### `passenger_spawn_method` + +[PassengerSpawnMethod](https://www.phusionpassenger.com/library/config/apache/reference/#passengerspawnmethod)を設定します。Passengerが引き起こしたアプリケーションに直接か、preforkのcopy-on-writeメカニズムを使用します。 + +有効なオプション: `smart`または`direct`。 + +デフォルト値: `undef`。 + +##### `passenger_app_root` + +[PassengerRoot](https://www.phusionpassenger.com/library/config/apache/reference/#passengerapproot)を設定します。これは、DocumentRootと異なる場合のPassengerアプリケーションルートのロケーションです。 + +値: パスを指定する文字列。  + +デフォルト値: `undef`。 + +##### `passenger_app_env` + +[PassengerAppEnv](https://www.phusionpassenger.com/library/config/apache/reference/#passengerappenv)を設定します。これは、Passengerアプリケーションに関する環境です。指定されていない場合は、グローバル設定の'production'がデフォルトになります。 + +値: 環境名を指定する文字列。 + +デフォルト値: `undef`。 + +##### `passenger_log_file` + +デフォルトでは、PassengerログメッセージはApacheグローバルエラーログに書き込まれます。[PassengerLogFile](https://www.phusionpassenger.com/library/config/apache/reference/#passengerlogfile)を使えば、そのメッセージを別のファイルに書き込むように設定することができます。このオプションは、Passenger 5.0.5以降でのみ使用できます。 + +値: パスを指定する文字列。  + +デフォルト値: `undef`。 + +##### `passenger_log_level` + +このオプションを使えば、ログファイルに書き込む情報の量を指定できます。設定されていない場合は、[PassengerLogLevel](https://www.phusionpassenger.com/library/config/apache/reference/#passengerloglevel)は設定ファイルに表示されず、デフォルト値が使用されます。 + +デフォルト値: 3.0.0以前のPassengerバージョン: '0'; 5.0.0以降: '3'。 + +##### `passenger_ruby` + +[PassengerRuby](https://www.phusionpassenger.com/library/config/apache/reference/#passengerruby)を設定します。これは、バーチャルホスト上でこのアプリケーションに関して使用するRubyインタープリタです。 + +デフォルト値: `undef`。 + +##### `passenger_min_instances` + +[PassengerMinInstances](https://www.phusionpassenger.com/library/config/apache/reference/#passengermininstances)を設定します。これは、実行するアプリケーションプロセスの最小数です。 + +##### `passenger_max_requests` + +[PassengerMaxRequests](https://www.phusionpassenger.com/library/config/apache/reference/#pas +sengermaxrequests)を設定します。これは、アプリケーションプロセスが処理するリクエストの最大数です。 + +##### `passenger_max_instances_per_app` + +[PassengerMaxInstancesPerApp](https://www.phusionpassenger.com/library/config/apache/reference/#passengermaxinstancesperapp)を設定します。これは、単一のアプリケーションに関して同時に存在できるアプリケーションプロセスの最大数です。 + +デフォルト値: `undef`。 + +##### `passenger_start_timeout` + +[PassengerStartTimeout](https://www.phusionpassenger.com/library/config/apache/reference/#passengerstarttimeout)を設定します。これは、アプリケーション起動のタイムアウトです。 + +##### `passenger_pre_start` + +[PassengerPreStart](https://www.phusionpassenger.com/library/config/apache/reference/#passengerprestart)を設定します。これは、プレ起動が必要とされる場合のアプリケーションのURLです。 + +##### `passenger_user` + +[PassengerUser](https://www.phusionpassenger.com/library/config/apache/reference/#passengeruser)を設定します。これは、サンドボックスアプリケーションの実行ユーザです。 + +##### passenger_group + + [PassengerGroup](https://www.phusionpassenger.com/library/config/apache/reference/#passengergroup)を設定します。これは、サンドボックスアプリケーションの実行グループです。 + +##### `passenger_high_performance` + +[`PassengerHighPerformance`](https://www.phusionpassenger.com/library/config/apache/reference/#passengerhighperformance)パラメータを設定します。 + +値: `true`、`false`。 + +デフォルト値: `undef`。 + +##### `passenger_nodejs` + +[`PassengerNodejs`](https://www.phusionpassenger.com/library/config/apache/reference/#passengernodejs)を設定します。これは、バーチャルホスト上でこのアプリケーションに関して使用するNodeJSインタープリタです。 + +##### `passenger_sticky_sessions` + +[`PassengerStickySessions`](https://www.phusionpassenger.com/library/config/apache/reference/#passengerstickysessions)パラメータを設定します。 + +ブーリアン。 + +デフォルト値: `undef`。 + +##### `passenger_startup_file` + +[`PassengerStartupFile`](https://www.phusionpassenger.com/library/config/apache/reference/#passengerstartupfile)パスを設定します。このパスは、アプリケーションルートに関連しています。 + +##### `php_values & php_flags` + +バーチャルホストごとの設定[`php_value`または`php_flag`](http://php.net/manual/en/configuration.changes.php)を許可します。これらのフラグや値は、ユーザまたはアプリケーションにより上書きすることができます。 + +デフォルト値: '{}'。 + +vhostの宣言内 +``` puppet + php_values => [ 'include_path ".:/usr/local/example-app/include"' ], +``` + +##### `php_admin_flags & values` + +バーチャルホストごとの設定[`php_admin_value`または`php_admin_flag`](http://php.net/manual/en/configuration.changes.php)を許可します。これらのフラグや値は、ユーザまたはアプリケーションにより上書きすることができます。 + +デフォルト値: '{}'。 + +##### `port` + +ホストを設定するポートを設定します。モジュールのデフォルトでは、ホストがリッスンするのは、非SSLバーチャルホストではポート80、SSLバーチャルホストではポート443です。ホストはこのパラメータで設定されたポートのみをリッスンします。 + +##### `priority` + +Apache HTTPD VirtualHost設定ファイルに関連するロード順序を設定します。 + +優先順位に一致するものがない場合は、アルファベット順で最初の名前ベースのバーチャルホストが使用されます。同様に、高い優先順位を渡すと、他に一致する名前がなければ、アルファベット順で最初の名前ベースのバーチャルホストが使用されます。 + +> **注意:** このパラメータを使用する必要はありません。ただし、使用する場合は、`apache::vhost`の`default_vhost`パラメータの優先順位は'15'になる点に留意してください。 + +ファイル名の優先順位の接頭値を無視するには、優先順位として`false`を渡します。 + +デフォルト値: '25'。 + +##### `proxy_dest` + +[ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass)設定の宛先アドレスを指定します。 + +デフォルト値: `undef`。 + +##### `proxy_pass` + +[ProxyPass](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass)設定の`path => URI`値の配列を指定します。オプションで、配列としてパラメータを追加できます。 + +デフォルト値: `undef`。 + +``` puppet +apache::vhost { 'site.name.fdqn': + … + proxy_pass => [ + { 'path' => '/a', 'url' => 'http://backend-a/' }, + { 'path' => '/b', 'url' => 'http://backend-b/' }, + { 'path' => '/c', 'url' => 'http://backend-a/c', 'params' => {'max'=>20, 'ttl'=>120, 'retry'=>300}}, + { 'path' => '/l', 'url' => 'http://backend-xy', + 'reverse_urls' => ['http://backend-x', 'http://backend-y'] }, + { 'path' => '/d', 'url' => 'http://backend-a/d', + 'params' => { 'retry' => '0', 'timeout' => '5' }, }, + { 'path' => '/e', 'url' => 'http://backend-a/e', + 'keywords' => ['nocanon', 'interpolate'] }, + { 'path' => '/f', 'url' => 'http://backend-f/', + 'setenv' => ['proxy-nokeepalive 1','force-proxy-request-1.0 1']}, + { 'path' => '/g', 'url' => 'http://backend-g/', + 'reverse_cookies' => [{'path' => '/g', 'url' => 'http://backend-g/',}, {'domain' => 'http://backend-g', 'url' => 'http:://backend-g',},], }, + { 'path' => '/h', 'url' => 'http://backend-h/h', + 'no_proxy_uris' => ['/h/admin', '/h/server-status'] }, + ], +} +``` + +* `reverse_urls`。*オプション。*この設定は、`mod_proxy_balancer`とともに使用する場合に役立ちます。値: 配列または文字列。 +* `reverse_cookies`。*オプション。*`ProxyPassReverseCookiePath`および`ProxyPassReverseCookieDomain`を設定します。 +* `params`。*オプション。*接続設定などのProxyPassキー-値パラメータを許可します。 +* `setenv`。*オプション。*プロキシディレクティブの[環境変数](https://httpd.apache.org/docs/current/mod/mod_proxy.html#envsettings)を設定します。値: 配列。 + +##### `proxy_dest_match` + +このディレクティブは[`proxy_dest`][]と同じですが、正規表現をとります。詳細については、[ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch)を参照してください。 + +##### `proxy_dest_reverse_match` + +[`proxy_dest_match`][]が指定されている場合に、ProxyPassReverseを渡せるようにします。詳細については、[ProxyPassReverse](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassreverse)を参照してください。 + +##### `proxy_pass_match` + +このディレクティブは[`proxy_pass`][]と同じですが、正規表現をとります。詳細については、[ProxyPassMatch](https://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassmatch)を参照してください。 + +##### `rack_base_uris` + +rack設定のリソース識別子を設定します。指定されたファイルパスは、_rack.erbテンプレート内の[Phusion Passenger](http://www.modrails.com/documentation/Users%20guide%20Apache.html#_railsbaseuri_and_rackbaseuri)のrackアプリケーションルートとしてリストされます。 + +デフォルト値: `undef`。 + +##### `passenger_base_uris` + +任意のURIをPhusion Passengerのサーブするアプリケーションとして指定するのに使用します。指定されたファイルパスは、_passenger_base_uris.erbテンプレート内の[Phusion Passenger](https://www.phusionpassenger.com/documentation/Users%20guide%20Apache.html#PassengerBaseURI)のpassengerアプリケーションルートとしてリストされます。 + +デフォルト値: `undef`。 + +##### `redirect_dest` + +リダイレクト先のアドレスを指定します。 + +デフォルト値: `undef`。 + +##### `redirect_source` + +`redirect_dest`で指定された宛先にリダイレクトするソースURIを指定します。リダイレクトするアイテムが複数提供されている場合は、ソースと宛先の長さを一致させる必要があります。また、アイテムは順序に依存します。 + +``` puppet +apache::vhost { 'site.name.fdqn': + … + redirect_source => ['/images','/downloads'], + redirect_dest => ['http://img.example.com/','http://downloads.example.com/'], +} +``` + +##### `redirect_status` + +リダイレクトに追加するステータスを指定します。 + +デフォルト値: `undef`。 + +``` puppet +apache::vhost { 'site.name.fdqn': + … + redirect_status => ['temp','permanent'], +} +``` + +##### `redirectmatch_*` + +* `redirectmatch_regexp` +* `redirectmatch_status` +* `redirectmatch_dest` + +任意の正規表現について呼び出すサーバステータスとユーザの転送先を決定します。配列として入力します。 + +デフォルト値: `undef`。 + +``` puppet +apache::vhost { 'site.name.fdqn': + … + redirectmatch_status => ['404','404'], + redirectmatch_regexp => ['\.git(/.*|$)/','\.svn(/.*|$)'], + redirectmatch_dest => ['http://www.example.com/$1','http://www.example.com/$2'], +} +``` + +##### `request_headers` + +他のリクエストヘッダの追加、リクエストヘッダの削除など、収集した[リクエストヘッダ](https://httpd.apache.org/docs/current/mod/mod_headers.html#requestheader)をさまざまな形で修正します。 + +デフォルト値: `undef`。 + +``` puppet +apache::vhost { 'site.name.fdqn': + … + request_headers => [ + 'append MirrorID "mirror 12"', + 'unset MirrorID', + ], +} +``` + +##### `rewrites` + +URLリライトルールを作成します。ハッシュの配列が求められます。 + +値: 'comment'、'rewrite_base'、'rewrite_cond'、'rewrite_rule'、'rewrite_map'のいずれかのハッシュキー。 + +デフォルト値: `undef`。 + +誰かがindex.htmlにアクセスした場合、welcome.htmlを表示するように指定できます。 + +``` puppet +apache::vhost { 'site.name.fdqn': + … + rewrites => [ { rewrite_rule => ['^index\.html$ welcome.html'] } ] +} +``` + +このパラメータにより条件をリライトし、`true`の場合に関連ルールを実行させることが可能です。例えば、ビジターがIEを使っている場合のみURLをリライトするには、以下のように設定します。 + +``` puppet +apache::vhost { 'site.name.fdqn': + … + rewrites => [ + { + comment => 'redirect IE', + rewrite_cond => ['%{HTTP_USER_AGENT} ^MSIE'], + rewrite_rule => ['^index\.html$ welcome.html'], + }, + ], +} +``` + +複数の条件を適用することもできます。たとえば、ブラウザがLynxかMozilla(バージョン1または2)の場合にのみ、index.htmlをwelcome.htmlにリライトする場合は、以下のようになります。 + +``` puppet +apache::vhost { 'site.name.fdqn': + … + rewrites => [ + { + comment => 'Lynx or Mozilla v1/2', + rewrite_cond => ['%{HTTP_USER_AGENT} ^Lynx/ [OR]', '%{HTTP_USER_AGENT} ^Mozilla/[12]'], + rewrite_rule => ['^index\.html$ welcome.html'], + }, + ], +} +``` + +複数のリライトと条件を設定することも可能です。 + +``` puppet +apache::vhost { 'site.name.fdqn': + … + rewrites => [ + { + comment => 'Lynx or Mozilla v1/2', + rewrite_cond => ['%{HTTP_USER_AGENT} ^Lynx/ [OR]', '%{HTTP_USER_AGENT} ^Mozilla/[12]'], + rewrite_rule => ['^index\.html$ welcome.html'], + }, + { + comment => 'Internet Explorer', + rewrite_cond => ['%{HTTP_USER_AGENT} ^MSIE'], + rewrite_rule => ['^index\.html$ /index.IE.html [L]'], + }, + { + rewrite_base => /apps/, + rewrite_rule => ['^index\.cgi$ index.php', '^index\.html$ index.php', '^index\.asp$ index.html'], + }, + { comment => 'Rewrite to lower case', + rewrite_cond => ['%{REQUEST_URI} [A-Z]'], + rewrite_map => ['lc int:tolower'], + rewrite_rule => ['(.*) ${lc:$1} [R=301,L]'], + }, + ], +} +``` + +リライトのルールおよび条件については、[`mod_rewrite`ドキュメント][`mod_rewrite`]を参照してください。 + +##### `rewrite_inherit` + +バーチャルホストが全体のリライトルールを継承するかどうかを決定します。 + +デフォルト値: `false`。 + +リライトルールは、全体(`$conf_file`または`$confd_dir`で)またはバーチャルホストの`.conf`ファイル内で指定することができます。デフォルトでは、バーチャルホストは全体の設定を継承しません。継承を有効にするには、`rewrites`パラメータを指定し、`rewrite_inherit`パラメータを`true`に設定します。 + +``` puppet +apache::vhost { 'site.name.fdqn': + … + rewrites => [ + , + ], + rewrite_inherit => `true`, +} +``` + +> **注意**: この設定を有効にするには、`rewrites`パラメータが**必須**です。 + +バーチャルホストに以下のディレクティブが含まれている場合は、Apacheが全体の`Rewrite`ルールを有効にします。 + +``` ApacheConf +RewriteEngine On +RewriteOptions Inherit +``` + +[公式`mod_rewrite`ドキュメント](https://httpd.apache.org/docs/2.2/mod/mod_rewrite.html)のセクション"Rewriting in Virtual Hosts"を参照してください。 + +##### `scriptalias` + +'/usr/scripts'などの、パス'/cgi-bin'のエイリアスとするCGIスクリプトのディレクトリを定義します。 + +デフォルト値: `undef`。 + +##### `scriptaliases` + +> **注意**: このパラメータは廃止予定であり、`aliases`パラメータに置き換えられます。 + +ハッシュの配列をバーチャルホストに渡し、[`mod_alias`ドキュメント][`mod_alias`]に従ってScriptAliasまたはScriptAliasMatchステートメントのいずれかを作成します。 + +``` puppet +scriptaliases => [ + { + alias => '/myscript', + path => '/usr/share/myscript', + }, + { + aliasmatch => '^/foo(.*)', + path => '/usr/share/fooscripts$1', + }, + { + aliasmatch => '^/bar/(.*)', + path => '/usr/share/bar/wrapper.sh/$1', + }, + { + alias => '/neatscript', + path => '/usr/share/neatscript', + }, +] +``` + +ScriptAliasおよびScriptAliasMatchディレクティブは、指定した順に作成されます。 [AliasおよびAliasMatch](#aliases)ディレクティブと同様、シャドーイングを避けるため、まず具体的なエイリアスを指定してから、全般的なものを指定してください。 + +##### `serveradmin` + +エラーページの表示時にApacheが表示するEメールアドレスを指定します。 + +デフォルト値: `undef`。 + +##### `serveraliases` + +サイトの[ServerAliases](https://httpd.apache.org/docs/current/mod/core.html#serveralias)を設定します。 + +デフォルト値: []。  + +##### `servername` + +バーチャルホストに接続するホスト名に対応するサーバ名を設定します。 + +デフォルト値: リソースのタイトル。 + +##### `setenv` + +HTTPDにより使用し、バーチャルホストの環境変数を設定します。 + +デフォルト値: []。  + +例: + +``` puppet +apache::vhost { 'setenv.example.com': + setenv => ['SPECIAL_PATH /foo/bin'], +} +``` + +##### `setenvif` + +HTTPDにより使用し、条件を用いてバーチャルホストの環境変数を設定します。 + +デフォルト値: []。  + +##### `setenvifnocase` + +HTTPDにより使用し、条件を用いてバーチャルホストの環境変数を設定します(大文字小文字を区別しないマッチング)。 + +デフォルト値: []。  + +##### `suphp_*` + +* `suphp_addhandler` +* `suphp_configpath` +* `suphp_engine` + +[suPHP](http://suphp.org/DocumentationView.html?file=apache/CONFIG)によりバーチャルホストを設定します。 + +* `suphp_addhandler`。デフォルト値: RedHatおよびFreeBSDでは'php5-script'、DebianおよびGentooでは'x-httpd-php'。 +* `suphp_configpath`。デフォルト値: RedHatおよびFreeBSDでは`undef`、DebianおよびGentooでは'/etc/php5/apache2'。 +* `suphp_engine`。値: 'on'または'off'。デフォルト値: 'off'。 + +suPHPによるバーチャルホスト設定の例: + +``` puppet +apache::vhost { 'suphp.example.com': + port => '80', + docroot => '/home/appuser/myphpapp', + suphp_addhandler => 'x-httpd-php', + suphp_engine => 'on', + suphp_configpath => '/etc/php5/apache2', + directories => { path => '/home/appuser/myphpapp', + 'suphp' => { user => 'myappuser', group => 'myappgroup' }, + } +} +``` + +##### `vhost_name` + +名前ベースのバーチャルホストを有効にします。バーチャルホストにIPではなくポートが割り当てられている場合は、バーチャルホスト名は'vhost_name:port'になります。バーチャルホストにIPもポートも割り当てられていない場合は、バーチャルホスト名はリソースのタイトルに設定されます。 + +デフォルト値: '*'。 + +##### `virtual_docroot` + +同じ名前を持つディレクトリにマッピングされたワイルドカードエイリアスサブドメインにより、バーチャルホストを設定します。例えば、'http://example.com' would map to '/var/www/example.com'のようになります。 + +デフォルト値: `false`。 + +``` puppet +apache::vhost { 'subdomain.loc': + vhost_name => '*', + port => '80', + virtual_docroot => '/var/www/%-2+', + docroot => '/var/www', + serveraliases => ['*.loc',], +} +``` + +##### `wsgi*` + +* `wsgi_daemon_process` +* `wsgi_daemon_process_options` +* `wsgi_process_group` +* `wsgi_script_aliases` +* `wsgi_pass_authorization` + +[WSGI](https://github.com/GrahamDumpleton/mod_wsgi)によりバーチャルホストを設定します。 + +* `wsgi_daemon_process`: WSGIデーモンの名前を設定するハッシュ。[特定のキー](http://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIDaemonProcess.html)を使用できます。デフォルト値: `undef`。 +* `wsgi_daemon_process_options`。_オプション。_ デフォルト値: `undef`。 +* `wsgi_process_group`: バーチャルホストが実行されるグループIDを設定します。デフォルト値: `undef`。 +* `wsgi_script_aliases`: ファイルシステム.wsgiパスへのWebパスのハッシュにする必要があります。デフォルト値: `undef`。 +* `wsgi_script_aliases_match`: ファイルシステム.wsgiパスへのWebパスの正規表現のハッシュにする必要があります。デフォルト値: `undef`。 +* `wsgi_pass_authorization`: 'On'に設定すると、Apacheの代わりにWSGIアプリケーションを使って認証を処理します。詳細については、[mod_wsgi's WSGIPassAuthorizationドキュメント] (https://modwsgi.readthedocs.org/en/latest/configuration-directives/WSGIPassAuthorization.html)を参照してください。デフォルト値: `undef`、これにより、Apacheのデフォルト値である'Off'が使われます。 +* `wsgi_chunked_request`: チャンク形式のリクエストのサポートを有効にします。デフォルト値: `undef`。 + +WSGIによるバーチャルホスト設定の例: + +``` puppet +apache::vhost { 'wsgi.example.com': + port => '80', + docroot => '/var/www/pythonapp', + wsgi_daemon_process => 'wsgi', + wsgi_daemon_process_options => + { processes => '2', + threads => '15', + display-name => '%{GROUP}', + }, + wsgi_process_group => 'wsgi', + wsgi_script_aliases => { '/' => '/var/www/demo.wsgi' }, + wsgi_chunked_request => 'On', +} +``` + +#### `apache::vhost`のパラメータ`directories` + +`apache::vhost`クラスの`directories`パラメータは、バーチャルホストにハッシュの配列を渡し、[Directory](https://httpd.apache.org/docs/current/mod/core.html#directory)、[File](https://httpd.apache.org/docs/current/mod/core.html#files)、[Location](https://httpd.apache.org/docs/current/mod/core.html#location)ディレクティブブロックを作成します。これらのブロックは、'< Directory /path/to/directory>...< /Directory>'の形式をとります。 + +`path`キーは、ディレクトリ、ファイル、ロケーションブロックのパスを設定します。この値は、'directory'、'files'、または'location'プロバイダのパスか、'directorymatch'、'filesmatch'、または 'locationmatch'プロバイダの正規表現でなければなりません。`directories`に渡される各ハッシュには、キーのひとつとして`path`が含まれていなければ**なりません**。 + +`provider`キーはオプションです。設定されていない場合、このキーのデフォルトは'directory'になります。値: 'directory'、'files'、'proxy'、'location'、'directorymatch'、'filesmatch'、'proxymatch'、'locationmatch'。`provider`を'directorymatch'に設定すると、 Apache設定ファイルでキーワード'DirectoryMatch'が使用されます。 + +`directories`の使用例: + +``` puppet +apache::vhost { 'files.example.net': + docroot => '/var/www/files', + directories => [ + { 'path' => '/var/www/files', + 'provider' => 'files', + 'deny' => 'from all', + }, + ], +} +``` + +> **注意:** 少なくとも1つのディレクトリが`docroot`パラメータとマッチする必要があります。ディレクトリの宣言を開始すると、`apache::vhost`は必要なすべてのディレクトリブロックが宣言されるものと見なします。定義されない場合、`docroot`パラメータにマッチする1つのデフォルトディレクトリブロックが作成されます。 + +`directory`、`files`、または`location`ハッシュ内に、使用可能なハンドラを配置し、キーとして表す必要があります。以下のようになります。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ { path => '/path/to/directory', handler => value } ], +} +``` + +これらのハッシュで設定していないハンドラは、Puppet内で'undefined'と見なされ、バーチャルホストに追加されず、モジュールではデフォルト値が使われます。サポートされているハンドラは、次のとおりです。 + +##### `addhandlers` + +[AddHandler](https://httpd.apache.org/docs/current/mod/mod_mime.html#addhandler)ディレクティブを設定します。これは、ファイル名の拡張子を指定されたハンドラにマッピングするものです。ハッシュのリストを使用し、`extensions`はハンドラによりマッピングされた拡張子を記述するために使用されます。`{ handler => 'handler-name', extensions => ['extension'] }`の形式をとります。 + +例: + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + addhandlers => [{ handler => 'cgi-script', extensions => ['.cgi']}], + }, + ], +} +``` + +##### `allow` + +[Allow](https://httpd.apache.org/docs/2.2/mod/mod_authz_host.html#allow)ディレクティブを設定します。これは、ホスト名またはIPに基づく認証をグループ化するものです。**廃止予定:**このパラメータは、Apacheが変更されたため、廃止予定になっています。Apache 2.2以下でのみ機能します。1つのルールに対する単一の文字列としても、複数のルールに対する配列としても使用できます。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + allow => 'from example.org', + }, + ], +} +``` + +##### `allow_override` + +[.htaccess](https://httpd.apache.org/docs/current/mod/core.html#allowoverride)ファイルで許可されるディレクティブのタイプを設定します。配列を使用できます。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + allow_override => ['AuthConfig', 'Indexes'], + }, + ], +} +``` + +##### `auth_basic_authoritative` + +[AuthBasicAuthoritative](https://httpd.apache.org/docs/current/mod/mod_auth_basic.html#authbasicauthoritative)の値を設定します。これにより、下位のApacheモジュールに権限と認証を渡すかどうかが決定されます。 + +##### `auth_basic_fake` + +[AuthBasicFake](https://httpd.apache.org/docs/current/mod/mod_auth_basic.html#authbasicfake)の値を設定します。これにより、任意のディレクティブブロックに関する認証情報が静的に設定されます。 + +##### `auth_basic_provider` + +[AuthBasicProvider](https://httpd.apache.org/docs/current/mod/mod_auth_basic.html#authbasicprovider)の値を設定します。これにより、任意のロケーションの認証プロバイダが設定されます。 + +##### `auth_digest_algorithm` + +[AuthDigestAlgorithm](https://httpd.apache.org/docs/current/mod/mod_auth_digest.html#authdigestalgorithm)の値を設定します。これにより、チャレンジおよびレスポンスハッシュの計算に用いるアルゴリズムを選択します。 + +###### `auth_digest_domain` + +[AuthDigestDomain](https://httpd.apache.org/docs/current/mod/mod_auth_digest.html#authdigestdomain)の値を設定します。これにより、ダイジェスト認証に関して、同じ保護スペースで1つまたは複数のURIを指定できます。 + +##### `auth_digest_nonce_lifetime` + +[AuthDigestNonceLifetime](https://httpd.apache.org/docs/current/mod/mod_auth_digest.html#authdigestnoncelifetime)の値を設定します。これにより、サーバのノンスが有効になる長さを制御します。 + +##### `auth_digest_provider` + +[AuthDigestProvider](https://httpd.apache.org/docs/current/mod/mod_auth_digest.html#authdigestprovider)の値を設定します。これにより、任意のロケーションに関する認証プロバイダを設定します。 + +##### `auth_digest_qop` + +[AuthDigestQop](https://httpd.apache.org/docs/current/mod/mod_auth_digest.html#authdigestqop)の値を設定します。これにより、ダイジェスト認証で用いる保護品質を決定します。 + +##### `auth_digest_shmem_size` + +[AuthAuthDigestShmemSize](https://httpd.apache.org/docs/current/mod/mod_auth_digest.html#authdigestshmemsize)の値を設定します。これにより、クライアントの追跡に関して、サーバに割り当てられる共通メモリの量を定義します。 + +##### `auth_group_file` + +[AuthGroupFile](https://httpd.apache.org/docs/current/mod/mod_authz_groupfile.html#authgroupfile)の値を設定します。これにより、認証に関して、ユーザグループのリストを含むテキストファイルの名前を設定します。 + +##### `auth_name` + +[AuthName](https://httpd.apache.org/docs/current/mod/mod_authn_core.html#authname)の値を設定します。これにより、認証領域の名前を設定します。 + +##### `auth_require` + +アクセスを許可するのに必要なエンティティ名を設定します。詳細については、[Require](https://httpd.apache.org/docs/current/mod/mod_authz_host.html#requiredirectives)を参照してください。 + +##### `auth_type` + +[AuthType](https://httpd.apache.org/docs/current/mod/mod_authn_core.html#authtype)の値を設定します。これにより、ユーザ認証のタイプをガイドします。 + +##### `auth_user_file` + +[AuthUserFile](https://httpd.apache.org/docs/current/mod/mod_authn_file.html#authuserfile)の値を設定します。これにより、認証に関するユーザ/パスワードを含むテキストファイルの名前を設定します。 + +##### `auth_merging` + +[AuthMerging](https://httpd.apache.org/docs/current/mod/mod_authz_core.html#authmerging)の値を設定します。これにより、認証ロジックを組み合わせるかどうかを決定します。 + +##### `auth_ldap_url` + +[AuthLDAPURL](https://httpd.apache.org/docs/current/mod/mod_authnz_ldap.html#authldapurl)の値を設定します。これにより、AuthBasicProvider 'ldap'を使用する場合のLDAPサーバのURLを決定します。 + +##### `auth_ldap_bind_dn` + +[AuthLDAPBindDN](https://httpd.apache.org/docs/current/mod/mod_authnz_ldap.html#authldapbinddn)の値を設定します。これにより、AuthBasicProvider 'ldap'を使用する場合に、エントリの検索時にLDAPサーバにバインドするオプションのDNを使用できるようになります。 + +##### `auth_ldap_bind_password` + +[AuthLDAPBindPassword](https://httpd.apache.org/docs/current/mod/mod_authnz_ldap.html#authldapbindpassword)の値を設定します。これにより、AuthBasicProvider 'ldap'を使用する場合に、バインドDNとともに用いるオプションのバインドパスワードを使用できるようになります。 + +##### `auth_ldap_group_attribute` + +[AuthLDAPGroupAttribute](https://httpd.apache.org/docs/current/mod/mod_authnz_ldap.html#authldapgroupattribute)の値の配列。ldapグループ内のユーザメンバーの確認に使用するLDAP属性を指定します。 + +デフォルト値: "member"および "uniquemember"。 + +##### `auth_ldap_group_attribute_is_dn` + +[AuthLDAPGroupAttributeIsDN](https://httpd.apache.org/docs/current/mod/mod_authnz_ldap.html#authldapgroupattributeisdn)の値を設定し、ldapグループのメンバーにDNかシンプルなユーザ名のどちらを使用するかを指定します。onに設定すると、グループメンバーシップの確認時に、クライアントユーザ名の識別名が使用されます。そうでない場合は、ユーザ名が使われます。有効な値は"on"か"off"です。 + +##### `custom_fragment` + +カスタム設定ディレクティブの文字列を渡し、ディレクトリ設定の最後に配置します。 + +``` puppet +apache::vhost { 'monitor': + … + directories => [ + { + path => '/path/to/directory', + custom_fragment => ' + + SetHandler balancer-manager + Order allow,deny + Allow from all + + + SetHandler server-status + Order allow,deny + Allow from all + +ProxyStatus On', + }, + ] +} +``` + +##### `dav` + +[Dav](http://httpd.apache.org/docs/current/mod/mod_dav.html#dav)の値を設定します。これにより、WebDAV HTTPメソッドを有効にするかどうかを決定します。値としては、'On'、'Off'、またはプロバイダの名前を使用できます。'On'に設定すると、`mod_dav_fs`モジュールにより実装されているデフォルトのファイルシステムプロバイダが有効になります。 + +##### `dav_depth_infinity` + +[DavDepthInfinity](http://httpd.apache.org/docs/current/mod/mod_dav.html#davdepthinfinity)の値を設定します。これは、`Depth: Infinity`ヘッダを持つ`PROPFIND`リクエストの処理を有効にするのに使用されます。 + +##### `dav_min_timeout` + +[DavMinTimeout](http://httpd.apache.org/docs/current/mod/mod_dav.html#davmintimeout)の値を設定します。DAVリソースでサーバがロック状態を維持する時間(秒数)を指定します。 + +##### `deny` + +[Deny](https://httpd.apache.org/docs/2.2/mod/mod_authz_host.html#deny)ディレクティブを設定し、サーバへのアクセスを否定するホストを指定します。**廃止予定:** このパラメータは、Apacheが変更されたため、廃止予定になっています。Apache 2.2以下でのみ機能します。1つのルールに対する単一の文字列としても、複数のルールに対する配列としても使用できます。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + deny => 'from example.org', + }, + ], +} +``` + +##### `error_documents` + +ディレクトリの[ErrorDocument](https://httpd.apache.org/docs/current/mod/core.html#errordocument)設定をオーバーライドするハッシュの配列。 + +``` puppet +apache::vhost { 'sample.example.net': + directories => [ + { path => '/srv/www', + error_documents => [ + { 'error_code' => '503', + 'document' => '/service-unavail', + }, + ], + }, + ], +} +``` + +##### `ext_filter_options` + +[ExtFilterOptions](https://httpd.apache.org/docs/current/mod/mod_ext_filter.html)ディレクティブを設定します。 +このディレクティブを使用する前に、`class { 'apache::mod::ext_filter': }`を宣言する必要があります。 + +``` puppet +apache::vhost { 'filter.example.org': + docroot => '/var/www/filter', + directories => [ + { path => '/var/www/filter', + ext_filter_options => 'LogStderr Onfail=abort', + }, + ], +} +``` + +##### `geoip_enable` + +[GeoIPEnable](http://dev.maxmind.com/geoip/legacy/mod_geoip2/#Configuration)ディレクティブを設定します。 +このディレクティブを使用する前に、`class {'apache::mod::geoip': }`を宣言する必要があります。 + +``` puppet +apache::vhost { 'first.example.com': + docroot => '/var/www/first', + directories => [ + { path => '/var/www/first', + geoip_enable => `true`, + }, + ], +} +``` + +##### `headers` + +[Header](https://httpd.apache.org/docs/current/mod/mod_headers.html#header)ディレクティブの行を追加します。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => { + path => '/path/to/directory', + headers => 'Set X-Robots-Tag "noindex, noarchive, nosnippet"', + }, +} +``` + +##### `index_options` + +[ディレクトリインデキシング](https://httpd.apache.org/docs/current/mod/mod_autoindex.html#indexoptions)の設定を可能にします。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + directoryindex => 'disabled', # this is needed on Apache 2.4 or mod_autoindex doesn't work + options => ['Indexes','FollowSymLinks','MultiViews'], + index_options => ['IgnoreCase', 'FancyIndexing', 'FoldersFirst', 'NameWidth=*', 'DescriptionWidth=*', 'SuppressHTMLPreamble'], + }, + ], +} +``` + +##### `index_order_default` + +ディレクトリインデックスの[デフォルトの順序付け](https://httpd.apache.org/docs/current/mod/mod_autoindex.html#indexorderdefault)を設定します。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + order => 'Allow,Deny', + index_order_default => ['Descending', 'Date'], + }, + ], +} +``` + +###### `index_style_sheet` + +[IndexStyleSheet](https://httpd.apache.org/docs/current/mod/mod_autoindex.html#indexstylesheet)を設定します。これにより、ディレクトリインデックスにCSSスタイルシートが追加されます。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + options => ['Indexes','FollowSymLinks','MultiViews'], + index_options => ['FancyIndexing'], + index_style_sheet => '/styles/style.css', + }, + ], +} +``` + +##### `limit` + +ディレクトリブロック内に[Limit](https://httpd.apache.org/docs/current/mod/core.html#limit)ブロックを作成します。`require`ディレクティブを含めることもできます。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/docroot', + directories => [ + { path => '/', + provider => 'location', + limit => [ + { methods => 'GET HEAD', + require => ['valid-user'] + }, + ], + }, + ], +} +``` + +##### `limit_except` + +ディレクトリブロック内に[LimitExcept](https://httpd.apache.org/docs/current/mod/core.html#limitexcept)ブロックを作成します。`require`ディレクティブを含めることもできます。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/docroot', + directories => [ + { path => '/', + provider => 'location', + limit_except => [ + { methods => 'GET HEAD', + require => ['valid-user'] + }, + ], + }, + ], +} +``` + +##### `mellon_enable` + +[MellonEnable][`mod_auth_mellon`]ディレクトリを設定し、 [`mod_auth_mellon`][]を有効にします。[`apache::mod::auth_mellon`][]を使って`mod_auth_mellon`をインストールできます。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/', + provider => 'directory', + mellon_enable => 'info', + mellon_sp_private_key_file => '/etc/certs/${::fqdn}.key', + mellon_endpoint_path => '/mellon', + mellon_set_env_no_prefix => { 'ADFS_GROUP' => 'http://schemas.xmlsoap.org/claims/Group', + 'ADFS_EMAIL' => 'http://schemas.xmlsoap.org/claims/EmailAddress', }, + mellon_user => 'ADFS_LOGIN', + }, + { path => '/protected', + provider => 'location', + mellon_enable => 'auth', + auth_type => 'Mellon', + auth_require => 'valid-user', + mellon_cond => ['ADFS_LOGIN userA [MAP]','ADFS_LOGIN userB [MAP]'], + }, + ] +} +``` + +関連するパラメータは、`mod_auth_mellon`ディレクティブの名前に従います。 + +- `mellon_cond`: アクセスを許可するために満たす必要のあるmellon条件の配列をとり、配列内の各アイテムについて [MellonCond][`mod_auth_mellon`]ディレクティブを作成します。 +- `mellon_endpoint_path`: [MellonEndpointPath][`mod_auth_mellon`]を設定し、mellonエンドポイントパスを設定します。 +- `mellon_sp_metadata_file`: SPメタデータファイルの[MellonSPMetadataFile][`mod_auth_mellon`]ロケーションを設定します。 +- `mellon_idp_metadata_file`: IDPメタデータファイルの[MellonIDPMetadataFile][`mod_auth_mellon`]ロケーションを設定します。 +- `mellon_saml_rsponse_dump`: [MellonSamlResponseDump][`mod_auth_mellon`]ディレクティブを設定し、SAMLのデバッグを有効にします。 +- `mellon_set_env_no_prefix`:環境変数にマッピングする属性名のハッシュに関する [MellonSetEnvNoPrefix][`mod_auth_mellon`]ディレクティブを +設定します。 +- `mellon_sp_private_key_file`: サービスプロバイダのプライベートキー保存場所に関する[MellonSPPrivateKeyFile][`mod_auth_mellon`]ディレクティブを設定します。 +- `mellon_sp_cert_file`: サービスプロバイダの公開キー保存場所に関する[MellonSPCertFile][`mod_auth_mellon`]ディレクティブを設定します。 +- `mellon_user`: ユーザ名に関して使用する[MellonUser][`mod_auth_mellon`]属性を設定します。 +- `mellon_session_length`: [MellonSessionLength][`mod_auth_mellon`]属性を設定します。 + +##### `options` + +任意のディレクトリブロックに関する[オプション](https://httpd.apache.org/docs/current/mod/core.html#options)をリスト化します。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + options => ['Indexes','FollowSymLinks','MultiViews'], + }, + ], +} +``` + +##### `order` + +[Apacheコアドキュメント](https://httpd.apache.org/docs/2.2/mod/mod_authz_host.html#order)に従い、AllowおよびDenyステートメントの処理順序を設定します。**廃止予定:** このパラメータは、Apacheが変更されたため、廃止予定になっています。Apache 2.2以下でのみ機能します。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + order => 'Allow,Deny', + }, + ], +} +``` + +##### `passenger_enabled` + +[PassengerEnabled](http://www.modrails.com/documentation/Users%20guide%20Apache.html#PassengerEnabled)ディレクティブの値を'on'または'off'に設定します。`apache::mod::passenger`を含める必要があります。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + passenger_enabled => 'on', + }, + ], +} +``` + +> **注意:** PassengerEnabledディレクティブをPassengerHighPerformanceディレクティブとともに使用すると、[問題](http://www.conandalton.net/2010/06/passengerenabled-off-not-working.html)が生じます。 + +##### `php_value`および`php_flag` + +`php_value`はディレクトリの値を設定し、`php_flag`はブーリアンを用いてディレクトリを設定します。詳細は[こちら](http://php.net/manual/en/configuration.changes.php)で確認できます。 + +##### `php_admin_value`および`php_admin_flag` + +`php_admin_value`はディレクトリの値を設定し、`php_admin_flag`はブーリアンを用いてディレクトリを設定します。詳細は[こちら](http://php.net/manual/en/configuration.changes.php)で確認できます。 + + +##### `require` + + +[Apache Authzドキュメント](https://httpd.apache.org/docs/current/mod/mod_authz_core.html#require)に従い、`Require`ディレクティブを設定します。`require`が設定されていない場合、`Require all granted`がデフォルトになります。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + require => 'ip 10.17.42.23', + } + ], +} +``` + +より複雑な要件設定が必要な場合、apache >= 2.4では[RequireAll](https://httpd.apache.org/docs/2.4/mod/mod_authz_core.html#requireall)、[RequireNone](https://httpd.apache.org/docs/2.4/mod/mod_authz_core.html#requirenone)または[RequireAny](https://httpd.apache.org/docs/2.4/mod/mod_authz_core.html#requireany)ディレクティブを使用できます。'any'、'none'、'all'のみをサポートする(その他の値は無視されます)'enforce'キーを使うと、以下のように設定できます。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + require => { + enforce => 'any', + requires => [ + 'ip 1.2.3.4', + 'not host host.example.com', + 'user xyz', + ], + }, + }, + ], +} +``` + +`require`を`unmanaged`に設定すると、何も設定されません。これは、カスタムフラグメントで扱われる複雑な認証/権限要件に役立ちます。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + require => 'unmanaged', + } + ], +} +``` + + + +##### `satisfy` + +[Apacheコアドキュメント](https://httpd.apache.org/docs/2.2/mod/core.html#satisfy)に従い、`Satisfy`ディレクティブを設定します。**廃止予定:** このパラメータは、Apacheが変更されたため、廃止予定になっています。Apache 2.2以下でのみ機能します。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + satisfy => 'Any', + } + ], +} +``` + +##### `sethandler` + +[Apache Coreドキュメント](https://httpd.apache.org/docs/2.2/mod/core.html#sethandler)に従い、`SetHandler`ディレクティブを設定します。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + sethandler => 'None', + } + ], +} +``` + +##### `set_output_filter` + +[Apache Coreドキュメント](https://httpd.apache.org/docs/current/mod/core.html#setoutputfilter)に従い、`SetOutputFilter`ディレクティブを設定します。 + +``` puppet +apache::vhost{ 'filter.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + set_output_filter => puppetdb-strip-resource-params, + }, + ], +} +``` + +##### `rewrites` + +バーチャルホストディレクトリ内でURL [`rewrites`](#rewrites)ルールを作成します。ハッシュの配列が求められます。ハッシュキーは'comment'、'rewrite_base'、'rewrite_cond'または'rewrite_rule'のいずれかにすることができます。 + +``` puppet +apache::vhost { 'secure.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + rewrites => [ { comment => 'Permalink Rewrites', + rewrite_base => '/' + }, + { rewrite_rule => ['^index\.php$ - [L]'] + }, + { rewrite_cond => ['%{REQUEST_FILENAME} !-f', + '%{REQUEST_FILENAME} !-d', + ], + rewrite_rule => ['. /index.php [L]'], + } + ], + }, + ], +} +``` + +> **注意**: ディレクトリにリライトを含める場合は、`apache::mod::rewrite`も含めてください。また、バーチャルホストのディレクトリのリライト設定ではなく、`apache::vhost`の`rewrites`パラメータを用いたリライトの設定を考慮してください。 + +##### `shib_request_settings` + +アプリケーションリクエストに関して、有効なコンテンツ設定の設定または変更を可能にします。このコマンドは、次の2つのパラメータをとります: コンテンツ設定の名前、およびそれについて設定する値。有効な設定については、Shibboleth [コンテンツ設定ドキュメント](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPContentSettings)を参照してください。このキーは、`apache::mod::shib`が定義されていない場合は無効になります。詳細については、[`mod_shib`ドキュメント](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPApacheConfig#NativeSPApacheConfig-Server/VirtualHostOptions)を参照してください。 + +``` puppet +apache::vhost { 'secure.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + shib_request_settings => { 'requiresession' => 'On' }, + shib_use_headers => 'On', + }, + ], +} +``` + +##### `shib_use_headers` + +'On'に設定すると、アプリケーションに属性を公開するリクエストヘッダの使用がオンになります。このキーの値は'On'または'Off'です。デフォルト値は'Off'です。このキーは、`apache::mod::shib`が定義されていない場合は無効になります。詳細については、[`mod_shib`ドキュメント](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPApacheConfig#NativeSPApacheConfig-Server/VirtualHostOptions)を参照してください。 + +##### `shib_compat_valid_user` + +このコマンドが存在しなかったときの動作と合わせるため、デフォルト値はOffです。 "valid-user"および"user"のRequireルールの処理で、「標準」Apacheの動作を復元して、Shibbolethをその他のauth/authモジュールと組み合わせて使用する場合の競合を解消します。詳細については、[`mod_shib`ドキュメント](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPApacheConfig#NativeSPApacheConfig-Server/VirtualHostOptions)、および[NativeSPhtaccess](https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPhtaccess)を参照してください。`apache::mod::shib`が定義されていない場合、このキーは無効です。 + +##### `ssl_options` + +[SSLOptions](https://httpd.apache.org/docs/current/mod/mod_ssl.html#ssloptions)の文字列またはリスト。これにより、SSLエンジンのランタイムオプションが設定されます。このハンドラは、バーチャルホストの親ブロック内のSSLOptionsセットよりも優先されます。 + +``` puppet +apache::vhost { 'secure.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + ssl_options => '+ExportCertData', + }, + { path => '/path/to/different/dir', + ssl_options => ['-StdEnvVars', '+ExportCertData'], + }, + ], +} +``` + +##### `suphp` + +[suPHP_UserGroup](http://www.suphp.org/DocumentationView.html?file=apache/CONFIG)設定に関する'user'および'group'キーを含むハッシュ。バーチャルホスト宣言で`suphp_engine => on`とともに使用する必要があり、`directories`内でのみ渡すことができます。 + +``` puppet +apache::vhost { 'secure.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/directory', + suphp => { + user => 'myappuser', + group => 'myappgroup', + }, + }, + ], +} +``` +##### `additional_includes` + +バーチャルホストディレクトリ内にある追加の静的な固有のApache設定ファイルのパスを指定します。値: 文字列パスの配列。 + +``` puppet +apache::vhost { 'sample.example.net': + docroot => '/path/to/directory', + directories => [ + { path => '/path/to/different/dir', + additional_includes => ['/custom/path/includes', '/custom/path/another_includes',], + }, + ], +} +``` + +#### `apache::vhost`のSSLパラメータ + +`::vhost`のすべてのSSLパラメータは、基本の`apache`クラスで設定された値がデフォルトになります。以下のパラメータを使えば、特定のバーチャルホストに関する個別のSSL設定を調整できます。 + +##### `ssl` + +バーチャルホストのSSLを有効にします。SSLバーチャルホストはHTTPSクエリにのみ応答します。値: ブーリアン。 + +デフォルト値: `false`。 + +##### `ssl_ca` + +使用するSSL認証局を指定して、認証に使用するクライアントの証明書を検証します。これを使用するには、`ssl_verify_client`も設定する必要があります。 + +デフォルト値: `undef`。 + +##### `ssl_cert` + +SSL証明書を指定します。 + +デフォルト値: オペレーティングシステムによって異なります。 + +* RedHat: '/etc/pki/tls/certs/localhost.crt' +* Debian: '/etc/ssl/certs/ssl-cert-snakeoil.pem' +* FreeBSD: '/usr/local/etc/apache22/server.crt' +* Gentoo: '/etc/ssl/apache2/server.crt' + +##### `ssl_protocol` + +[SSLProtocol](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslprotocol)を指定します。許可されるプロトコルの配列またはスペースで区切った文字列が求められます。 + +デフォルト値: 'all'、'-SSLv2'、'-SSLv3'。 + +##### `ssl_cipher` + +[SSLCipherSuite](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslciphersuite)を指定します。 + +デフォルト値: 'HIGH:MEDIUM:!aNULL:!MD5'。 + +##### `ssl_honorcipherorder` + +[SSLHonorCipherOrder](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslhonorcipherorder)を指定し、クライアントの優先順ではなくサーバの優先順をApacheに使用させます。値: + +値: ブーリアン、'on'、'off'。 + +デフォルト値: `true`。 + +##### `ssl_certs_dir` + +SSL認証ディレクトリの場所を指定してクライアントの証明書を検証します。`ssl_verify_client`も設定されていない限り使用されません(下記参照)。 + +デフォルト: undef + +##### `ssl_chain` + +SSLチェーンを指定します。このデフォルト値は設定しなくても機能しますが、本稼働環境で使用する前に、固有の証明書情報により基本の`apache`クラス内で更新する必要があります。 + +デフォルト値: `undef`。 + +##### `ssl_crl` + +使用する証明書失効リストを指定します。(このデフォルト値は設定しなくても機能しますが、本稼働環境で使用する前に、固有の証明書情報により基本の`apache`クラス内で更新する必要があります。) + +デフォルト値: `undef`。 + +##### `ssl_crl_path` + +証明書失効リストの保存場所を指定して、クライアント認証の証明書を検証します(このデフォルト値は設定しなくても機能しますが、本稼働環境で使用する前に、固有の証明書情報により基本の`apache`クラス内で更新する必要があります)。 + +デフォルト値: `undef`。 + +##### `ssl_crl_check` + +[SSLCARevocationCheckディレクティブ](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslcarevocationcheck)により、SSLクライアント認証の証明書失効チェックレベルを設定します。このデフォルト値は設定しなくても機能しますが、本稼働環境でCRLを使用する際に指定する必要があります。Apache 2.4以上にのみ適用され、それ以前のバージョンではこの値は無視されます。 + +デフォルト値: `undef`。 + +##### `ssl_key` + +SSLキーを指定します。 + +デフォルト値はオペレーティングシステムによって異なります。このデフォルト値は設定しなくても機能しますが、本稼働環境で使用する前に、固有の証明書情報により基本の`apache`クラス内で更新する必要があります。 + +* RedHat: '/etc/pki/tls/private/localhost.key' +* Debian: '/etc/ssl/private/ssl-cert-snakeoil.key' +* FreeBSD: '/usr/local/etc/apache22/server.key' +* Gentoo: '/etc/ssl/apache2/server.key' + +##### `ssl_verify_client` + +[SSLVerifyClient](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslverifyclient)ディレクティブを設定します。これにより、クライアント認証に関する証明書確認レベルが設定されます。 + +``` puppet +apache::vhost { 'sample.example.net': + … + ssl_verify_client => 'optional', +} +``` + +値: 'none'、'optional'、'require'、'optional_no_ca'。 + +デフォルト値: `undef`。 + + +##### `ssl_verify_depth` + +[SSLVerifyDepth](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslverifydepth)ディレクティブを設定します。これにより、クライアント認証確認におけるCA証明書の最大深さが指定されます。これを有効にするには、`ssl_verify_client`を設定する必要があります。 + +``` puppet +apache::vhost { 'sample.example.net': + … + ssl_verify_client => 'require', + ssl_verify_depth => 1, +} +``` + +デフォルト値: `undef`。 + +##### `ssl_proxy_protocol` + +[SSLProxyProtocol](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyprotocol)ディレクティブを設定します。これにより、プロキシに関するサーバ環境を確立する際に`mod_ssl`が使用すべきSSLプロトコルフレーバーを制御します。提示されたプロトコルのうちの1つのみを使用しているサーバに接続します。 + +デフォルト値: `undef`。 + +##### `ssl_proxy_verify` + +[SSLProxyVerify](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyverify)ディレクティブを設定します。これにより、リクエストをリモートSSLサーバに転送するようにプロキシが設定されている場合のリモートサーバの証明書確認を設定します。 + +デフォルト値: `undef`。 + +##### `ssl_proxy_verify_depth` + +[SSLProxyVerifyDepth](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyverifydepth)ディレクティブを設定します。これにより、リモートサーバに有効な証明書がないと判断するにあたり、mod_sslが行う確認の深さを設定します。 + +深さ0では、自己署名リモートサーバ証明書のみが許可されます。デフォルトの深さ 1では、リモートサーバ証明書を自己署名にすることも、サーバが直接知っているCAにより署名することもできます。 + +デフォルト値: `undef`。  + +##### `ssl_proxy_cipher_suite` + +[SSLProxyCipherSuite](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyciphersuite)ディレクティブを設定します。このディレクティブは、sslプロキシトラフィックに対してサポートされる暗号化スイートを制御します。 + +デフォルト値: `undef`。  + +##### `ssl_proxy_ca_cert` + +[SSLProxyCACertificateFile](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycacertificatefile)ディレクティブを設定します。これにより、やりとりするリモートサーバに関する認証局(CA)の証明書を集められるオールインワンファイルを指定します。これはリモートサーバ認証に用いられます。このファイルは、PEMエンコード証明書ファイルを優先順に連結したものにする必要があります。 + +デフォルト値: `undef`。  + +##### `ssl_proxy_machine_cert` + +[SSLProxyMachineCertificateFile](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxymachinecertificatefile)ディレクティブを設定します。これにより、このサーバがリモートサーバの認証に用いる証明書とキーを保存するオールインワンファイルを指定します。このファイルは、PEMエンコード証明書ファイルを優先順に連結したものにする必要があります。 + +``` puppet +apache::vhost { 'sample.example.net': + … + ssl_proxy_machine_cert => '/etc/httpd/ssl/client_certificate.pem', +} +``` + +デフォルト値: `undef`。  + +##### `ssl_proxy_check_peer_cn` + +[SSLProxyCheckPeerCN](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeercn)ディレクティブを設定します。これにより、リモートサーバの証明書のCNフィールドをリクエストURLのホスト名と比較するかどうかを指定します。 + +値: 'on'、'off'。  + +デフォルト値: `undef`。  + +##### `ssl_proxy_check_peer_name` + +[SSLProxyCheckPeerName](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeername)ディレクティブを設定します。これにより、リモートサーバの証明書のCNフィールドをリクエストURLのホスト名と比較するかどうかを決定します。 + +値: 'on'、'off'。  + +デフォルト値: `undef`。  + +##### `ssl_proxy_check_peer_expire` + +[SSLProxyCheckPeerExpire](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxycheckpeerexpire)ディレクティブを設定します。これにより、リモートサーバの証明書の有効期限をチェックするかどうかを指定します。 + +値: 'on'、'off'。  + +デフォルト値: `undef`。  + +##### `ssl_options` + +[SSLOptions](https://httpd.apache.org/docs/current/mod/mod_ssl.html#ssloptions)ディレクティブを設定します。これにより、各種のSSLエンジンのランタイムオプションを設定します。これは任意のバーチャルホスト全体の設定で、文字列にすることも配列にすることもできます。 + +文字列: + +``` puppet +apache::vhost { 'sample.example.net': + … + ssl_options => '+ExportCertData', +} +``` + +配列: + +``` puppet +apache::vhost { 'sample.example.net': + … + ssl_options => ['+StrictRequire', '+ExportCertData'], +} +``` + +デフォルト値: `undef`。 + +##### `ssl_openssl_conf_cmd` + +[SSLOpenSSLConfCmd](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslopensslconfcmd)ディレクティブを設定します。これにより、OpenSSLパラメータを直接設定できます。 + +デフォルト値: `undef`。  + +##### `ssl_proxyengine` + +[SSLProxyEngine](https://httpd.apache.org/docs/current/mod/mod_ssl.html#sslproxyengine)を使用するかどうかを指定します。 + +ブーリアン。 + +デフォルト値: `false`。 + +##### `ssl_stapling` + +[SSLUseStapling](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslusestapling)を使用するかどうかを指定します。デフォルトでは、全体で設定されているものを使用します。 + +このパラメータはApache 2.4以上にのみ適用され、それ以前のバージョンでは無視されます。  + +ブーリアンまたは`undef`。 + +デフォルト値: `undef`。  + +##### `ssl_stapling_timeout` + +[SSLStaplingResponderTimeout](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslstaplingrespondertimeout)ディレクティブの設定に使用できます。 + +このパラメータはApache 2.4以上にのみ適用され、それ以前のバージョンでは無視されます。  + +デフォルト値: なし。  + +##### `ssl_stapling_return_errors` + +[SSLStaplingReturnResponderErrors](http://httpd.apache.org/docs/current/mod/mod_ssl.html#sslstaplingreturnrespondererrors)ディレクティブの設定に使用できます。 + +このパラメータはApache 2.4以上にのみ適用され、それ以前のバージョンでは無視されます。  + +デフォルト値: なし。  + +#### 定義タイプ: FastCGIサーバ + +このタイプは、mod\_fastcgiとともに使用します。特定のファイルタイプを扱う1つまたは複数の外部FastCGIサーバを定義することができます。 + +** 注意 ** Ubuntu 10.04+では、マルチバースリポジトリを手動で有効にする必要があります。 + +例: + +``` puppet +apache::fastcgi::server { 'php': + host => '127.0.0.1:9000', + timeout => 15, + flush => `false`, + faux_path => '/var/www/php.fcgi', + fcgi_alias => '/php.fcgi', + file_type => 'application/x-httpd-php', + pass_header => '' +} +``` + +その後、バーチャルホスト内で、上で指定したfastcgiサーバで扱う特定のファイルタイプを設定することができます。 + +``` puppet +apache::vhost { 'www': + ... + custom_fragment => 'AddType application/x-httpd-php .php' + ... +} +``` + +##### `host` + +FastCGIサーバのホスト名またはIPアドレスおよびTCPポート番号(1-65535)。 + +unixソケットを渡すこともできます。 + +``` puppet +apache::fastcgi::server { 'php': + host => '/var/run/fcgi.sock', +} +``` + +##### `timeout` + +リクエストが中止され、(エラーLogLevel)にイベントが記録されるまでに、FastCGIアプリケーションが非アクティブの状態で待機する秒数。この非アクティブタイマーは、FastCGIアプリケーションとの接続が待機中の場合のみ適用されます。アプリケーションの待ち行列に入ったリクエストに対して、時間内に記述やフラッシュによる応答がないと、リクエストは中止されます。アプリケーションとの通信が完了したものの、クライアントとの通信が完了しなかった(応答がバッファリングされた)場合は、タイムアウトは適用されません。 + +##### `flush` + +アプリケーションから受信したデータを、強制的にクライアントに書き込みます。デフォルトでは、アプリケーションをできるだけ早くフリーな状態にするために、`mod_fastcgi`はデータをバッファリングします。 + +##### `faux_path` + +ローカルファイルシステムに存在する必要はありません。Apacheがこのファイル名に解読するURIは、この外部FastCGIアプリケーションにより処理されます。 + +##### `alias` + +一意のエイリアス。 アクションとFastCGIサーバをリンクさせるために内部で用いられます。 + +##### `file_type` + +FastCGIサーバにより処理するファイルのMIMEタイプ。 + +##### `pass_header` + +リクエスト環境で渡されるHTTPリクエストヘッダの名前。このオプションにより、通常はCGI環境で利用できないヘッダコンテンツ(認証など)が利用できるようになります。 + +#### 定義タイプ: `apache::vhost::custom` + +`apache::vhost::custom`定義タイプは、 `apache::custom_config`定義タイプのシンラッパーで、Apacheにおいてバーチャルホストディレクトリに固有のデフォルト設定の一部をオーバーライドします。 + +**`apache::vhost::custom`内のパラメータ**: + +##### `content` + +設定ファイルのコンテンツを設定します。 + +##### `ensure` + +バーチャルホストファイルが存在するかどうかを指定します。 + +値: 'absent'、'present'。  + +デフォルト値: 'present'。  + +##### `priority` + +Apache HTTPD VirtualHost設定ファイルに関する相対的なロード順序を設定します。 + +デフォルト値: '25'。 + +##### `verify_config` + +Apacheサービスに通知する前に設定ファイルのバリデーションを行うかどうかを指定します。 + +ブーリアン。 + +デフォルト値: `true`。 + +### プライベート定義タイプ + +#### 定義タイプ: `apache::peruser::multiplexer`  + +この定義タイプは、Apacheモジュールにクラスがあるかどうかを確認します。クラスがある場合は、そのクラスを含めます。ない場合は、モジュール名を[`apache::mod`][]定義タイプに渡します。 + +#### 定義タイプ: `apache::peruser::multiplexer`  + +FreeBSDに関してのみ、[`Peruser`][]モジュールを有効にします。  + +#### 定義タイプ: `apache::peruser::processor` + +FreeBSDに関してのみ、[`Peruser`][]モジュールを有効にします。  + +#### 定義タイプ: `apache::security::file_link` + +[`apache::mod::security`][]の`activated_rules`をディスク上のそれぞれのCRSルールにリンクします。 + +### テンプレート + +Apacheモジュールは、[`apache::vhost`][]および[`apache::mod`][]定義タイプを有効にするにあたり、テンプレートに大きく依存しています。このテンプレートは、オペレーティングシステムに固有の[Facter][] factsをベースに構築されています。明示的にコールアウトされない限り、ほとんどのテンプレートは設定には使われません。 + +### タスク + +Apacheモジュールには、サービスの再起動なしでApache設定を再ロードできるタスクがあります。タスクの実行方法については、[Puppet Enterpriseマニュアル](https://puppet.com/docs/pe/2017.3/orchestrator/running_tasks.html)または[Boltマニュアル](https://puppet.com/docs/bolt/latest/bolt.html)を参照してください。 + +### 関数 +#### apache_pw_hash +Apacheが読みこむhtpasswdファイルに適したフォーマットでパスワードをハッシュします。 + +現在はSHAハッシュを使用しています。これは、このフォーマットは安全ではないとされているものの、ほとんどのプラットフォームでサポートされているもっとも安全なフォーマットであるためです。 + + +## 制約事項 + + サポートされているオペレーティングシステムの一覧については、[metadata.json](https://github.com/puppetlabs/puppetlabs-apache/blob/main/metadata.json)を参照してください。 + +### FreeBSD + +FreeBSDでこのモジュールを使用するには、apache24-2.4.12 (www/apache24)以降を使用する_必要があります_。 + +### Gentoo + +Gentooでは、このモジュールは[`gentoo/puppet-portage`][] Puppetモジュールに依存します。Gentooに関しては、一部の機能や設定が適用または有効化されますが、このモジュールに[対応するオペレーティングシステム][]ではありません。 + +### RHEL/CentOS +[`apache::mod::auth_cas`][]、[`apache::mod::passenger`][]、[`apache::mod::proxy_html`][]、[`apache::mod::shib`][]クラスは、追加のリポジトリから依存関係パッケージが提供されていなければ、RH/CentOSでは機能しません。 + +関連するリポジトリとパッケージについては、以下の各ドキュメントを参照してください。 + +#### RHEL/CentOS 5 + +[`apache::mod::passenger`][]および[`apache::mod::proxy_html`][]クラスは、リポジトリに適合するパッケージがないため、テストされていません。 + +#### RHEL/CentOS 6 + +[`apache::mod::passenger`][]クラスは、EL6リポジトリに適合するパッケージがないため、インストールされません。 + +#### RHEL/CentOS 7 + +[`apache::mod::passenger`][]および[`apache::mod::proxy_html`][]クラスは、EL7リポジトリに適合するパッケージがないため、テストされていません。また、[`apache::vhost`][]定義タイプの[`rack_base_uris`][]パラメータも、同様の理由でテストされていません。 + +### SELinuxおよびカスタムパス + +[SELinux][]が[適用モード][]になっていて、`logroot`、`mod_dir`、`vhost_dir`、`docroot`に関してカスタムパスを使用したい場合は、ファイルのコンテキストを各自で管理する必要があります。 + +これにはPuppetを使用できます。 + +``` puppet +exec { 'set_apache_defaults': + command => 'semanage fcontext -a -t httpd_sys_content_t "/custom/path(/.*)?"', + path => '/bin:/usr/bin/:/sbin:/usr/sbin', + require => Package['policycoreutils-python'], +} + +package { 'policycoreutils-python': + ensure => installed, +} + +exec { 'restorecon_apache': + command => 'restorecon -Rv /apache_spec', + path => '/bin:/usr/bin/:/sbin:/usr/sbin', + before => Class['Apache::Service'], + require => Class['apache'], +} + +class { 'apache': } + +host { 'test.server': + ip => '127.0.0.1', +} + +file { '/custom/path': + ensure => directory, +} + +file { '/custom/path/include': + ensure => present, + content => '#additional_includes', +} + +apache::vhost { 'test.server': + docroot => '/custom/path', + additional_includes => '/custom/path/include', +} +``` + +`chcon`ではなく、`semanage fcontext`を用いてコンテキストを設定する必要があります。これは、Puppetの`file`リソースでは、リソースにより指定されていない場合、その値のコンテキストがリセットされるためです。 + +### Ubuntu 16.04 +[`apache::mod::suphp`][]クラスは、リポジトリに適合するパッケージがないため、テストされていません。 + + +## 開発 + +### 貢献 + +[Puppet Forge][]上の[Puppet][]モジュールはオープンプロジェクトであり、その価値を維持するにはコミュニティからの貢献が欠かせません。Puppetが提供する膨大な数のプラットフォームや、無数のハードウェア、ソフトウェア、デプロイ設定に弊社がアクセスすることは不可能です。 + +できるだけ変更に簡単に貢献していただき、お使いの環境でモジュールが動作するようにしたいと考えています。モジュールの品質の維持と改善のため、Puppetは貢献者に守っていただくガイドラインを設けています。 + +詳細については、[モジュールコントリビューションガイド][]および[CONTRIBUTING.md][]を参照してください。 diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/apache_parameters_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/apache_parameters_spec.rb deleted file mode 100755 index 2ba1a4452..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/apache_parameters_spec.rb +++ /dev/null @@ -1,536 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -describe 'apache parameters' do - - # Currently this test only does something on FreeBSD. - describe 'default_confd_files => false' do - it 'doesnt do anything' do - pp = "class { 'apache': default_confd_files => false }" - apply_manifest(pp, :catch_failures => true) - end - - if fact('osfamily') == 'FreeBSD' - describe file("#{$confd_dir}/no-accf.conf.erb") do - it { is_expected.not_to be_file } - end - end - end - describe 'default_confd_files => true' do - it 'copies conf.d files' do - pp = "class { 'apache': default_confd_files => true }" - apply_manifest(pp, :catch_failures => true) - end - - if fact('osfamily') == 'FreeBSD' - describe file("#{$confd_dir}/no-accf.conf.erb") do - it { is_expected.to be_file } - end - end - end - - describe 'when set adds a listen statement' do - it 'applys cleanly' do - pp = "class { 'apache': ip => '10.1.1.1', service_ensure => stopped }" - apply_manifest(pp, :catch_failures => true) - end - - describe file($ports_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'Listen 10.1.1.1' } - end - end - - describe 'service tests => true' do - it 'starts the service' do - pp = <<-EOS - class { 'apache': - service_enable => true, - service_manage => true, - service_ensure => running, - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - it { is_expected.to be_running } - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { is_expected.to be_enabled } - end - end - end - - describe 'service tests => false' do - it 'stops the service' do - pp = <<-EOS - class { 'apache': - service_enable => false, - service_ensure => stopped, - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - it { is_expected.not_to be_running } - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { is_expected.not_to be_enabled } - end - end - end - - describe 'service manage => false' do - it 'we dont manage the service, so it shouldnt start the service' do - pp = <<-EOS - class { 'apache': - service_enable => true, - service_manage => false, - service_ensure => true, - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - it { is_expected.not_to be_running } - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { is_expected.not_to be_enabled } - end - end - end - - describe 'purge parameters => false' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': - purge_configs => false, - purge_vhost_dir => false, - vhost_dir => "#{$confd_dir}.vhosts" - } - EOS - shell("touch #{$confd_dir}/test.conf") - shell("mkdir -p #{$confd_dir}.vhosts && touch #{$confd_dir}.vhosts/test.conf") - apply_manifest(pp, :catch_failures => true) - end - - # Ensure the files didn't disappear. - describe file("#{$confd_dir}/test.conf") do - it { is_expected.to be_file } - end - describe file("#{$confd_dir}.vhosts/test.conf") do - it { is_expected.to be_file } - end - end - - if fact('osfamily') != 'Debian' - describe 'purge parameters => true' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': - purge_configs => true, - purge_vhost_dir => true, - vhost_dir => "#{$confd_dir}.vhosts" - } - EOS - shell("touch #{$confd_dir}/test.conf") - shell("mkdir -p #{$confd_dir}.vhosts && touch #{$confd_dir}.vhosts/test.conf") - apply_manifest(pp, :catch_failures => true) - end - - # File should be gone - describe file("#{$confd_dir}/test.conf") do - it { is_expected.not_to be_file } - end - describe file("#{$confd_dir}.vhosts/test.conf") do - it { is_expected.not_to be_file } - end - end - end - - describe 'serveradmin' do - it 'applies cleanly' do - pp = "class { 'apache': serveradmin => 'test@example.com' }" - apply_manifest(pp, :catch_failures => true) - end - - describe file($vhost) do - it { is_expected.to be_file } - it { is_expected.to contain 'ServerAdmin test@example.com' } - end - end - - describe 'sendfile' do - describe 'setup' do - it 'applies cleanly' do - pp = "class { 'apache': sendfile => 'On' }" - apply_manifest(pp, :catch_failures => true) - end - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'EnableSendfile On' } - end - - describe 'setup' do - it 'applies cleanly' do - pp = "class { 'apache': sendfile => 'Off' }" - apply_manifest(pp, :catch_failures => true) - end - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'Sendfile Off' } - end - end - - describe 'error_documents' do - describe 'setup' do - it 'applies cleanly' do - pp = "class { 'apache': error_documents => true }" - apply_manifest(pp, :catch_failures => true) - end - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'Alias /error/' } - end - end - - describe 'timeout' do - describe 'setup' do - it 'applies cleanly' do - pp = "class { 'apache': timeout => '1234' }" - apply_manifest(pp, :catch_failures => true) - end - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'Timeout 1234' } - end - end - - describe 'httpd_dir' do - describe 'setup' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': httpd_dir => '/tmp', service_ensure => stopped } - include 'apache::mod::mime' - EOS - apply_manifest(pp, :catch_failures => true) - end - end - - describe file("#{$mod_dir}/mime.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'AddLanguage eo .eo' } - end - end - - describe 'http_protocol_options' do - # Actually >= 2.4.24, but the minor version is not provided - # https://bugs.launchpad.net/ubuntu/+source/apache2/2.4.7-1ubuntu4.15 - # basically versions of the ubuntu or sles apache package cause issue - if $apache_version >= '2.4' && fact('operatingsystem') !~ /Ubuntu|SLES/ - describe 'setup' do - it 'applies cleanly' do - pp = "class { 'apache': http_protocol_options => 'Unsafe RegisteredMethods Require1.0'}" - apply_manifest(pp, :catch_failures => true) - end - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'HttpProtocolOptions Unsafe RegisteredMethods Require1.0' } - end - end - end - - describe 'server_root' do - describe 'setup' do - it 'applies cleanly' do - pp = "class { 'apache': server_root => '/tmp/root', service_ensure => stopped }" - apply_manifest(pp, :catch_failures => true) - end - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'ServerRoot "/tmp/root"' } - end - end - - describe 'confd_dir' do - describe 'setup' do - it 'applies cleanly' do - pp = "class { 'apache': confd_dir => '/tmp/root', service_ensure => stopped, use_optional_includes => true }" - apply_manifest(pp, :catch_failures => true) - end - end - - if $apache_version == '2.4' - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'IncludeOptional "/tmp/root/*.conf"' } - end - else - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'Include "/tmp/root/*.conf"' } - end - end - end - - describe 'conf_template' do - describe 'setup' do - it 'applies cleanly' do - pp = "class { 'apache': conf_template => 'another/test.conf.erb', service_ensure => stopped }" - shell("mkdir -p #{default['distmoduledir']}/another/templates") - shell("echo 'testcontent' >> #{default['distmoduledir']}/another/templates/test.conf.erb") - apply_manifest(pp, :catch_failures => true) - end - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'testcontent' } - end - end - - describe 'servername' do - describe 'setup' do - it 'applies cleanly' do - pp = "class { 'apache': servername => 'test.server', service_ensure => stopped }" - apply_manifest(pp, :catch_failures => true) - end - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'ServerName "test.server"' } - end - end - - describe 'user' do - describe 'setup' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': - manage_user => true, - manage_group => true, - user => 'testweb', - group => 'testweb', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - end - - describe user('testweb') do - it { is_expected.to exist } - it { is_expected.to belong_to_group 'testweb' } - end - - describe group('testweb') do - it { is_expected.to exist } - end - end - - describe 'logformats' do - describe 'setup' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': - log_formats => { - 'vhost_common' => '%v %h %l %u %t \\\"%r\\\" %>s %b', - 'vhost_combined' => '%v %h %l %u %t \\\"%r\\\" %>s %b \\\"%{Referer}i\\\" \\\"%{User-agent}i\\\"', - } - } - EOS - apply_manifest(pp, :catch_failures => true) - end - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'LogFormat "%v %h %l %u %t \"%r\" %>s %b" vhost_common' } - it { is_expected.to contain 'LogFormat "%v %h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"" vhost_combined' } - end - end - - - describe 'keepalive' do - describe 'setup' do - it 'applies cleanly' do - pp = "class { 'apache': keepalive => 'Off', keepalive_timeout => '30', max_keepalive_requests => '200' }" - apply_manifest(pp, :catch_failures => true) - end - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'KeepAlive Off' } - it { is_expected.to contain 'KeepAliveTimeout 30' } - it { is_expected.to contain 'MaxKeepAliveRequests 200' } - end - end - - describe 'limitrequestfieldsize' do - describe 'setup' do - it 'applies cleanly' do - pp = "class { 'apache': limitreqfieldsize => '16830' }" - apply_manifest(pp, :catch_failures => true) - end - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'LimitRequestFieldSize 16830' } - end - end - - describe 'logging' do - describe 'setup' do - it 'applies cleanly' do - pp = <<-EOS - if $::osfamily == 'RedHat' and "$::selinux" == "true" { - $semanage_package = $::operatingsystemmajrelease ? { - '5' => 'policycoreutils', - default => 'policycoreutils-python', - } - - package { $semanage_package: ensure => installed } - exec { 'set_apache_defaults': - command => 'semanage fcontext -a -t httpd_log_t "/apache_spec(/.*)?"', - path => '/bin:/usr/bin/:/sbin:/usr/sbin', - require => Package[$semanage_package], - } - exec { 'restorecon_apache': - command => 'restorecon -Rv /apache_spec', - path => '/bin:/usr/bin/:/sbin:/usr/sbin', - before => Service['httpd'], - require => Class['apache'], - } - } - file { '/apache_spec': ensure => directory, } - class { 'apache': logroot => '/apache_spec' } - EOS - apply_manifest(pp, :catch_failures => true) - end - end - - describe file("/apache_spec/#{$error_log}") do - it { is_expected.to be_file } - end - end - - describe 'ports_file' do - it 'applys cleanly' do - pp = <<-EOS - file { '/apache_spec': ensure => directory, } - class { 'apache': - ports_file => '/apache_spec/ports_file', - ip => '10.1.1.1', - service_ensure => stopped - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file('/apache_spec/ports_file') do - it { is_expected.to be_file } - it { is_expected.to contain 'Listen 10.1.1.1' } - end - end - - describe 'server_tokens' do - it 'applys cleanly' do - pp = <<-EOS - class { 'apache': - server_tokens => 'Minor', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'ServerTokens Minor' } - end - end - - describe 'server_signature' do - it 'applys cleanly' do - pp = <<-EOS - class { 'apache': - server_signature => 'testsig', - service_ensure => stopped, - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'ServerSignature testsig' } - end - end - - describe 'trace_enable' do - it 'applys cleanly' do - pp = <<-EOS - class { 'apache': - trace_enable => 'Off', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'TraceEnable Off' } - end - end - - describe 'file_e_tag' do - it 'applys cleanly' do - pp = <<-EOS - class { 'apache': - file_e_tag => 'None', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file($conf_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'FileETag None' } - end - end - - describe 'package_ensure' do - it 'applys cleanly' do - pp = <<-EOS - class { 'apache': - package_ensure => present, - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe package($package_name) do - it { is_expected.to be_installed } - end - end - -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/apache_ssl_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/apache_ssl_spec.rb deleted file mode 100644 index 5df551a41..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/apache_ssl_spec.rb +++ /dev/null @@ -1,94 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -describe 'apache ssl' do - - describe 'ssl parameters' do - it 'runs without error' do - pp = <<-EOS - class { 'apache': - service_ensure => stopped, - default_ssl_vhost => true, - default_ssl_cert => '/tmp/ssl_cert', - default_ssl_key => '/tmp/ssl_key', - default_ssl_chain => '/tmp/ssl_chain', - default_ssl_ca => '/tmp/ssl_ca', - default_ssl_crl_path => '/tmp/ssl_crl_path', - default_ssl_crl => '/tmp/ssl_crl', - default_ssl_crl_check => 'chain', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/15-default-ssl.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'SSLCertificateFile "/tmp/ssl_cert"' } - it { is_expected.to contain 'SSLCertificateKeyFile "/tmp/ssl_key"' } - it { is_expected.to contain 'SSLCertificateChainFile "/tmp/ssl_chain"' } - it { is_expected.to contain 'SSLCACertificateFile "/tmp/ssl_ca"' } - it { is_expected.to contain 'SSLCARevocationPath "/tmp/ssl_crl_path"' } - it { is_expected.to contain 'SSLCARevocationFile "/tmp/ssl_crl"' } - if $apache_version == '2.4' - it { is_expected.to contain 'SSLCARevocationCheck "chain"' } - else - it { is_expected.not_to contain 'SSLCARevocationCheck' } - end - end - end - - describe 'vhost ssl parameters' do - it 'runs without error' do - pp = <<-EOS - class { 'apache': - service_ensure => stopped, - } - - apache::vhost { 'test_ssl': - docroot => '/tmp/test', - ssl => true, - ssl_cert => '/tmp/ssl_cert', - ssl_key => '/tmp/ssl_key', - ssl_chain => '/tmp/ssl_chain', - ssl_ca => '/tmp/ssl_ca', - ssl_crl_path => '/tmp/ssl_crl_path', - ssl_crl => '/tmp/ssl_crl', - ssl_crl_check => 'chain', - ssl_certs_dir => '/tmp', - ssl_protocol => 'test', - ssl_cipher => 'test', - ssl_honorcipherorder => 'test', - ssl_verify_client => 'test', - ssl_verify_depth => 'test', - ssl_options => ['test', 'test1'], - ssl_proxyengine => true, - ssl_proxy_protocol => 'TLSv1.2', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test_ssl.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'SSLCertificateFile "/tmp/ssl_cert"' } - it { is_expected.to contain 'SSLCertificateKeyFile "/tmp/ssl_key"' } - it { is_expected.to contain 'SSLCertificateChainFile "/tmp/ssl_chain"' } - it { is_expected.to contain 'SSLCACertificateFile "/tmp/ssl_ca"' } - it { is_expected.to contain 'SSLCARevocationPath "/tmp/ssl_crl_path"' } - it { is_expected.to contain 'SSLCARevocationFile "/tmp/ssl_crl"' } - it { is_expected.to contain 'SSLProxyEngine On' } - it { is_expected.to contain 'SSLProtocol test' } - it { is_expected.to contain 'SSLCipherSuite test' } - it { is_expected.to contain 'SSLHonorCipherOrder test' } - it { is_expected.to contain 'SSLVerifyClient test' } - it { is_expected.to contain 'SSLVerifyDepth test' } - it { is_expected.to contain 'SSLOptions test test1' } - if $apache_version == '2.4' - it { is_expected.to contain 'SSLCARevocationCheck "chain"' } - else - it { is_expected.not_to contain 'SSLCARevocationCheck' } - end - end - end - -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/class_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/class_spec.rb deleted file mode 100644 index d67b1a878..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/class_spec.rb +++ /dev/null @@ -1,89 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -describe 'apache class' do - context 'default parameters' do - let(:pp) { "class { 'apache': }" } - - it_behaves_like "a idempotent resource" - - describe 'apache_version fact' do - before :all do - apply_manifest("include apache", :catch_failures => true) - version_check_pp = <<-EOS - notice("apache_version = >${apache_version}<") - EOS - @result = apply_manifest(version_check_pp, :catch_failures => true) - end - - it { - expect(@result.output).to match(/apache_version = >#{$apache_version}.* 'policycoreutils', - default => 'policycoreutils-python', - } - - package { $semanage_package: ensure => installed } - exec { 'set_apache_defaults': - command => 'semanage fcontext -a -t httpd_sys_content_t "/apache_spec(/.*)?"', - path => '/bin:/usr/bin/:/sbin:/usr/sbin', - subscribe => Package[$semanage_package], - refreshonly => true, - } - exec { 'restorecon_apache': - command => 'restorecon -Rv /apache_spec', - path => '/bin:/usr/bin/:/sbin:/usr/sbin', - before => Service['httpd'], - require => Class['apache'], - subscribe => Exec['set_apache_defaults'], - refreshonly => true, - } - } - file { '/apache_spec': ensure => directory, } - file { '/apache_spec/apache_custom': ensure => directory, } - class { 'apache': - mod_dir => '/apache_spec/apache_custom/mods', - vhost_dir => '/apache_spec/apache_custom/vhosts', - } - EOS - end - - # Run it twice and test for idempotency - it_behaves_like "a idempotent resource" - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/custom_config_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/custom_config_spec.rb deleted file mode 100644 index c8e254e85..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/custom_config_spec.rb +++ /dev/null @@ -1,94 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -describe 'apache::custom_config define' do - context 'invalid config' do - it 'should not add the config' do - pp = <<-EOS - class { 'apache': } - apache::custom_config { 'acceptance_test': - content => 'INVALID', - } - EOS - - apply_manifest(pp, :expect_failures => true) - end - - describe file("#{$confd_dir}/25-acceptance_test.conf") do - it { is_expected.not_to be_file } - end - end - - context 'valid config' do - it 'should add the config' do - pp = <<-EOS - class { 'apache': } - apache::custom_config { 'acceptance_test': - content => '# just a comment', - } - EOS - - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$confd_dir}/25-acceptance_test.conf") do - it { is_expected.to contain '# just a comment' } - end - end - - context 'with a custom filename' do - it 'should store content in the described file' do - pp = <<-EOS - class { 'apache': } - apache::custom_config { 'filename_test': - filename => 'custom_filename', - content => '# just another comment', - } - EOS - - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$confd_dir}/custom_filename") do - it { is_expected.to contain '# just another comment' } - end - end - - describe 'custom_config without priority prefix' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - apache::custom_config { 'prefix_test': - priority => false, - content => '# just a comment', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$confd_dir}/prefix_test.conf") do - it { is_expected.to be_file } - end - end - - describe 'custom_config only applied after configs are written' do - it 'applies in the right order' do - pp = <<-EOS - class { 'apache': } - - apache::custom_config { 'ordering_test': - content => '# just a comment', - } - - # Try to wedge the apache::custom_config call between when httpd.conf is written and - # ports.conf is written. This should trigger a dependency cycle - File["#{$conf_file}"] -> Apache::Custom_config['ordering_test'] -> Concat["#{$ports_file}"] - EOS - expect(apply_manifest(pp, :expect_failures => true).stderr).to match(/Found 1 dependency cycle/i) - end - - describe file("#{$confd_dir}/25-ordering_test.conf") do - it { is_expected.not_to be_file } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/default_mods_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/default_mods_spec.rb deleted file mode 100644 index 35706c9a2..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/default_mods_spec.rb +++ /dev/null @@ -1,111 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -describe 'apache::default_mods class' do - describe 'no default mods' do - # Using puppet_apply as a helper - let(:pp) do - <<-EOS - class { 'apache': - default_mods => false, - } - EOS - end - - # Run it twice and test for idempotency - it_behaves_like "a idempotent resource" - describe service($service_name) do - it { is_expected.to be_running } - end - end - - unless (fact('operatingsystem') == 'SLES' && fact('operatingsystemmajrelease') == '12') - describe 'no default mods and failing' do - before :all do - pp = <<-PP - include apache::params - class { 'apache': default_mods => false, service_ensure => stopped, } - PP - apply_manifest(pp) - end - # Using puppet_apply as a helper - it 'should apply with errors' do - pp = <<-EOS - class { 'apache': - default_mods => false, - } - apache::vhost { 'defaults.example.com': - docroot => '#{$doc_root}/defaults', - aliases => { - alias => '/css', - path => '#{$doc_root}/css', - }, - directories => [ - { - 'path' => "#{$doc_root}/admin", - 'auth_basic_fake' => 'demo demopass', - } - ], - setenv => 'TEST1 one', - } - EOS - - apply_manifest(pp, { :expect_failures => true }) - end - end - - describe service($service_name) do - it { is_expected.not_to be_running } - end - end - - describe 'alternative default mods' do - # Using puppet_apply as a helper - let(:pp) do - <<-EOS - class { 'apache': - default_mods => [ - 'info', - 'alias', - 'mime', - 'env', - 'expires', - ], - } - apache::vhost { 'defaults.example.com': - docroot => '#{$doc_root}/defaults', - aliases => { - alias => '/css', - path => '#{$doc_root}/css', - }, - setenv => 'TEST1 one', - } - EOS - end - it_behaves_like "a idempotent resource" - - describe service($service_name) do - it { is_expected.to be_running } - end - end - - describe 'change loadfile name' do - let(:pp) do - <<-EOS - class { 'apache': default_mods => false } - ::apache::mod { 'auth_basic': - loadfile_name => 'zz_auth_basic.load', - } - EOS - end - # Run it twice and test for idempotency - it_behaves_like "a idempotent resource" - describe service($service_name) do - it { is_expected.to be_running } - end - - describe file("#{$mod_dir}/zz_auth_basic.load") do - it { is_expected.to be_file } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/itk_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/itk_spec.rb deleted file mode 100644 index 059589a3f..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/itk_spec.rb +++ /dev/null @@ -1,60 +0,0 @@ -require 'spec_helper_acceptance' - -case fact('osfamily') -when 'Debian' - service_name = 'apache2' - majrelease = fact('operatingsystemmajrelease') - if ['6', '7', '10.04', '12.04'].include?(majrelease) - variant = :itk_only - else - variant = :prefork - end -when 'RedHat' - unless fact('operatingsystemmajrelease') == '5' - service_name = 'httpd' - majrelease = fact('operatingsystemmajrelease') - if ['6'].include?(majrelease) - variant = :itk_only - else - variant = :prefork - end - end -when 'FreeBSD' - service_name = 'apache24' - majrelease = fact('operatingsystemmajrelease') - variant = :prefork -end - -describe 'apache::mod::itk class', :if => service_name do - describe 'running puppet code' do - # Using puppet_apply as a helper - let(:pp) do - case variant - when :prefork - <<-EOS - class { 'apache': - mpm_module => 'prefork', - } - class { 'apache::mod::itk': } - EOS - when :itk_only - <<-EOS - class { 'apache': - mpm_module => 'itk', - } - EOS - end - end - # Run it twice and test for idempotency - it_behaves_like "a idempotent resource" - end - - describe service(service_name) do - it { is_expected.to be_running } - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_dav_svn_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_dav_svn_spec.rb deleted file mode 100644 index 2b1522509..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_dav_svn_spec.rb +++ /dev/null @@ -1,63 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -describe 'apache::mod::dav_svn class', :unless => (fact('operatingsystem') == 'OracleLinux' and fact('operatingsystemmajrelease') == '7') || (fact('operatingsystem') == 'SLES' and fact('operatingsystemmajorrelease') < '11') do - case fact('osfamily') - when 'Debian' - if fact('operatingsystemmajrelease') == '6' or fact('operatingsystemmajrelease') == '10.04' or fact('operatingsystemrelease') == '10.04' or fact('operatingsystemmajrelease') == '16.04' - authz_svn_load_file = 'dav_svn_authz_svn.load' - else - authz_svn_load_file = 'authz_svn.load' - end - else - authz_svn_load_file = 'dav_svn_authz_svn.load' - end - - context "default dav_svn config" do - it 'succeeds in puppeting dav_svn' do - pp= <<-EOS - class { 'apache': } - include apache::mod::dav_svn - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file("#{$mod_dir}/dav_svn.load") do - it { is_expected.to contain "LoadModule dav_svn_module" } - end - end - - context "dav_svn with enabled authz_svn config" do - it 'succeeds in puppeting dav_svn' do - pp= <<-EOS - class { 'apache': } - class { 'apache::mod::dav_svn': - authz_svn_enabled => true, - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file("#{$mod_dir}/#{authz_svn_load_file}") do - it { is_expected.to contain "LoadModule authz_svn_module" } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_deflate_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_deflate_spec.rb deleted file mode 100644 index 1b55e087a..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_deflate_spec.rb +++ /dev/null @@ -1,33 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -describe 'apache::mod::deflate class' do - context "default deflate config" do - it 'succeeds in puppeting deflate' do - pp= <<-EOS - class { 'apache': } - include apache::mod::deflate - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file("#{$mod_dir}/deflate.conf") do - it { is_expected.to contain "AddOutputFilterByType DEFLATE text/html text/plain text/xml" } - it { is_expected.to contain "AddOutputFilterByType DEFLATE text/css" } - it { is_expected.to contain "AddOutputFilterByType DEFLATE application/x-javascript application/javascript application/ecmascript" } - it { is_expected.to contain "AddOutputFilterByType DEFLATE application/rss+xml" } - it { is_expected.to contain "DeflateFilterNote Input instream" } - it { is_expected.to contain "DeflateFilterNote Output outstream" } - it { is_expected.to contain "DeflateFilterNote Ratio ratio" } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_fcgid_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_fcgid_spec.rb deleted file mode 100644 index ce3b5b5b2..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_fcgid_spec.rb +++ /dev/null @@ -1,57 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'apache::mod::fcgid class', :if => ((fact('osfamily') == 'RedHat' and fact('operatingsystemmajrelease') != '5') and !(fact('operatingsystem') == 'OracleLinux' and fact('operatingsystemmajrelease') == '7')) do - context "default fcgid config" do - it 'succeeds in puppeting fcgid' do - pp = <<-EOS - class { 'epel': } # mod_fcgid lives in epel - class { 'apache': } - class { 'apache::mod::php': } # For /usr/bin/php-cgi - class { 'apache::mod::fcgid': - options => { - 'FcgidIPCDir' => '/var/run/fcgidsock', - }, - } - apache::vhost { 'fcgid.example.com': - port => '80', - docroot => '/var/www/fcgid', - directories => { - path => '/var/www/fcgid', - options => '+ExecCGI', - addhandlers => { - handler => 'fcgid-script', - extensions => '.php', - }, - fcgiwrapper => { - command => '/usr/bin/php-cgi', - suffix => '.php', - } - }, - } - file { '/var/www/fcgid/index.php': - ensure => file, - owner => 'root', - group => 'root', - content => "\\n", - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service('httpd') do - it { is_expected.to be_enabled } - it { is_expected.to be_running } - end - - it 'should answer to fcgid.example.com' do - shell("/usr/bin/curl -H 'Host: fcgid.example.com' 127.0.0.1:80") do |r| - expect(r.stdout).to match(/^Hello world$/) - expect(r.exit_code).to eq(0) - end - end - - it 'should run a php-cgi process' do - shell("pgrep -u apache php-cgi", :acceptable_exit_codes => [0]) - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_mime_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_mime_spec.rb deleted file mode 100644 index f8bc7c15c..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_mime_spec.rb +++ /dev/null @@ -1,30 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -describe 'apache::mod::mime class' do - context "default mime config" do - it 'succeeds in puppeting mime' do - pp= <<-EOS - class { 'apache': } - include apache::mod::mime - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file("#{$mod_dir}/mime.conf") do - it { is_expected.to contain "AddType application/x-compress .Z" } - it { is_expected.to contain "AddHandler type-map var\n" } - it { is_expected.to contain "AddType text/html .shtml\n" } - it { is_expected.to contain "AddOutputFilter INCLUDES .shtml\n" } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_negotiation_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_negotiation_spec.rb deleted file mode 100644 index 56c29e318..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_negotiation_spec.rb +++ /dev/null @@ -1,78 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -describe 'apache::mod::negotiation class' do - context "default negotiation config" do - it 'succeeds in puppeting negotiation' do - pp= <<-EOS - class { '::apache': default_mods => false } - class { '::apache::mod::negotiation': } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$mod_dir}/negotiation.conf") do - it { should contain "LanguagePriority en ca cs da de el eo es et fr he hr it ja ko ltz nl nn no pl pt pt-BR ru sv zh-CN zh-TW -ForceLanguagePriority Prefer Fallback" } - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { should be_running } - end - end - - context "with alternative force_language_priority" do - it 'succeeds in puppeting negotiation' do - pp= <<-EOS - class { '::apache': default_mods => false } - class { '::apache::mod::negotiation': - force_language_priority => 'Prefer', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$mod_dir}/negotiation.conf") do - it { should contain "ForceLanguagePriority Prefer" } - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { should be_running } - end - end - - context "with alternative language_priority" do - it 'succeeds in puppeting negotiation' do - pp= <<-EOS - class { '::apache': default_mods => false } - class { '::apache::mod::negotiation': - language_priority => [ 'en', 'es' ], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$mod_dir}/negotiation.conf") do - it { should contain "LanguagePriority en es" } - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { should be_running } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_pagespeed_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_pagespeed_spec.rb deleted file mode 100644 index 1455d5630..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_pagespeed_spec.rb +++ /dev/null @@ -1,61 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -# Only run the test on centos 7, this is to cut down on the different types of setup -# required. Installing the dependancies are highly prone to failure. -describe 'apache::mod::pagespeed class', :if => - ((fact('operatingsystem') == 'CentOS' ) and - (fact('operatingsystemmajrelease') == '7' )) do - context "default pagespeed config" do - it 'succeeds in puppeting pagespeed' do - pp= <<-EOS - yumrepo { 'mod-pagespeed': - baseurl => "http://dl.google.com/linux/mod-pagespeed/rpm/stable/$::architecture", - enabled => 1, - gpgcheck => 1, - gpgkey => 'https://dl-ssl.google.com/linux/linux_signing_key.pub', - before => Class['apache'], - } - - class { 'apache': - mpm_module => 'prefork', - } - class { 'apache::mod::pagespeed': - enable_filters => ['remove_comments'], - disable_filters => ['extend_cache'], - forbid_filters => ['rewrite_javascript'], - } - apache::vhost { 'pagespeed.example.com': - port => '80', - docroot => '#{$doc_root}/pagespeed', - } - host { 'pagespeed.example.com': ip => '127.0.0.1', } - file { '#{$doc_root}/pagespeed/index.html': - ensure => file, - content => "\n\n\n

Hello World!

\n\n", - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - it { should be_enabled } - it { is_expected.to be_running } - end - - describe file("#{$mod_dir}/pagespeed.conf") do - it { is_expected.to contain "AddOutputFilterByType MOD_PAGESPEED_OUTPUT_FILTER text/html" } - it { is_expected.to contain "ModPagespeedEnableFilters remove_comments" } - it { is_expected.to contain "ModPagespeedDisableFilters extend_cache" } - it { is_expected.to contain "ModPagespeedForbidFilters rewrite_javascript" } - end - - it 'should answer to pagespeed.example.com and include and be stripped of comments by mod_pagespeed' do - shell("/usr/bin/curl pagespeed.example.com:80") do |r| - expect(r.stdout).to match(//) - expect(r.stdout).not_to match(//) - expect(r.exit_code).to eq(0) - end - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_passenger_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_passenger_spec.rb deleted file mode 100644 index 4761d2c5b..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_passenger_spec.rb +++ /dev/null @@ -1,208 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -describe 'apache::mod::passenger class' do - pending 'This cannot run in the same test run as apache::vhost with passenger - as the passenger.conf file is not yet managed by puppet and will be wiped out - between tests and not replaced' - case fact('osfamily') - when 'Debian' - conf_file = "#{$mod_dir}/passenger.conf" - load_file = "#{$mod_dir}/zpassenger.load" - - case fact('operatingsystem') - when 'Ubuntu' - case fact('lsbdistrelease') - when '10.04' - passenger_root = '/usr' - passenger_ruby = '/usr/bin/ruby' - when '12.04' - passenger_root = '/usr' - passenger_ruby = '/usr/bin/ruby' - when '14.04' - passenger_root = '/usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini' - passenger_ruby = '/usr/bin/ruby' - passenger_default_ruby = '/usr/bin/ruby' - when '16.04' - passenger_root = '/usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini' - passenger_ruby = '/usr/bin/ruby' - passenger_default_ruby = '/usr/bin/ruby' - else - # This may or may not work on Ubuntu releases other than the above - passenger_root = '/usr' - passenger_ruby = '/usr/bin/ruby' - end - when 'Debian' - case fact('lsbdistcodename') - when 'wheezy' - passenger_root = '/usr' - passenger_ruby = '/usr/bin/ruby' - when 'jessie' - passenger_root = '/usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini' - passenger_ruby = '/usr/bin/ruby' - passenger_default_ruby = '/usr/bin/ruby' - else - # This may or may not work on Debian releases other than the above - passenger_root = '/usr' - passenger_ruby = '/usr/bin/ruby' - end - end - - passenger_module_path = '/usr/lib/apache2/modules/mod_passenger.so' - rackapp_user = 'www-data' - rackapp_group = 'www-data' - when 'RedHat' - conf_file = "#{$mod_dir}/passenger.conf" - load_file = "#{$mod_dir}/zpassenger.load" - # sometimes installs as 3.0.12, sometimes as 3.0.19 - so just check for the stable part - passenger_root = '/usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini' - passenger_ruby = '/usr/bin/ruby' - passenger_module_path = 'modules/mod_passenger.so' - rackapp_user = 'apache' - rackapp_group = 'apache' - end - - pp_rackapp = <<-EOS - /* a simple ruby rack 'hello world' app */ - file { '/var/www/passenger': - ensure => directory, - owner => '#{rackapp_user}', - group => '#{rackapp_group}', - } - file { '/var/www/passenger/config.ru': - ensure => file, - owner => '#{rackapp_user}', - group => '#{rackapp_group}', - content => "app = proc { |env| [200, { \\"Content-Type\\" => \\"text/html\\" }, [\\"hello world\\"]] }\\nrun app", - } - apache::vhost { 'passenger.example.com': - port => '80', - docroot => '/var/www/passenger/public', - docroot_group => '#{rackapp_group}', - docroot_owner => '#{rackapp_user}', - require => File['/var/www/passenger/config.ru'], - } - host { 'passenger.example.com': ip => '127.0.0.1', } - EOS - - case fact('osfamily') - when 'Debian' - context "default passenger config" do - it 'succeeds in puppeting passenger' do - pp = <<-EOS - /* stock apache and mod_passenger */ - class { 'apache': } - class { 'apache::mod::passenger': } - #{pp_rackapp} - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file(conf_file) do - it { is_expected.to contain "PassengerRoot \"#{passenger_root}\"" } - - case fact('operatingsystem') - when 'Ubuntu' - case fact('lsbdistrelease') - when '10.04' - it { is_expected.to contain "PassengerRuby \"#{passenger_ruby}\"" } - it { is_expected.not_to contain "/PassengerDefaultRuby/" } - when '12.04' - it { is_expected.to contain "PassengerRuby \"#{passenger_ruby}\"" } - it { is_expected.not_to contain "/PassengerDefaultRuby/" } - when '14.04' - it { is_expected.to contain "PassengerDefaultRuby \"#{passenger_ruby}\"" } - it { is_expected.not_to contain "/PassengerRuby/" } - when '16.04' - it { is_expected.to contain "PassengerDefaultRuby \"#{passenger_ruby}\"" } - it { is_expected.not_to contain "/PassengerRuby/" } - else - # This may or may not work on Ubuntu releases other than the above - it { is_expected.to contain "PassengerRuby \"#{passenger_ruby}\"" } - it { is_expected.not_to contain "/PassengerDefaultRuby/" } - end - when 'Debian' - case fact('lsbdistcodename') - when 'wheezy' - it { is_expected.to contain "PassengerRuby \"#{passenger_ruby}\"" } - it { is_expected.not_to contain "/PassengerDefaultRuby/" } - when 'jessie' - it { is_expected.to contain "PassengerDefaultRuby \"#{passenger_ruby}\"" } - it { is_expected.not_to contain "/PassengerRuby/" } - else - # This may or may not work on Debian releases other than the above - it { is_expected.to contain "PassengerRuby \"#{passenger_ruby}\"" } - it { is_expected.not_to contain "/PassengerDefaultRuby/" } - end - end - end - - describe file(load_file) do - it { is_expected.to contain "LoadModule passenger_module #{passenger_module_path}" } - end - - it 'should output status via passenger-memory-stats' do - shell("PATH=/usr/bin:$PATH /usr/sbin/passenger-memory-stats") do |r| - expect(r.stdout).to match(/Apache processes/) - expect(r.stdout).to match(/Nginx processes/) - expect(r.stdout).to match(/Passenger processes/) - - # passenger-memory-stats output on newer Debian/Ubuntu verions do not contain - # these two lines - unless ((fact('operatingsystem') == 'Ubuntu' && fact('operatingsystemrelease') == '14.04') or - (fact('operatingsystem') == 'Ubuntu' && fact('operatingsystemrelease') == '16.04') or - (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8')) - expect(r.stdout).to match(/### Processes: [0-9]+/) - expect(r.stdout).to match(/### Total private dirty RSS: [0-9\.]+ MB/) - end - - expect(r.exit_code).to eq(0) - end - end - - # passenger-status fails under stock ubuntu-server-12042-x64 + mod_passenger, - # even when the passenger process is successfully installed and running - unless fact('operatingsystem') == 'Ubuntu' && fact('operatingsystemrelease') == '12.04' - it 'should output status via passenger-status' do - # xml output not available on ubunutu <= 10.04, so sticking with default pool output - shell("PATH=/usr/bin:$PATH /usr/sbin/passenger-status") do |r| - # spacing may vary - expect(r.stdout).to match(/[\-]+ General information [\-]+/) - if fact('operatingsystem') == 'Ubuntu' && fact('operatingsystemrelease') == '14.04' or - (fact('operatingsystem') == 'Ubuntu' && fact('operatingsystemrelease') == '16.04') or - fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8' - expect(r.stdout).to match(/Max pool size[ ]+: [0-9]+/) - expect(r.stdout).to match(/Processes[ ]+: [0-9]+/) - expect(r.stdout).to match(/Requests in top-level queue[ ]+: [0-9]+/) - else - expect(r.stdout).to match(/max[ ]+= [0-9]+/) - expect(r.stdout).to match(/count[ ]+= [0-9]+/) - expect(r.stdout).to match(/active[ ]+= [0-9]+/) - expect(r.stdout).to match(/inactive[ ]+= [0-9]+/) - expect(r.stdout).to match(/Waiting on global queue: [0-9]+/) - end - - expect(r.exit_code).to eq(0) - end - end - end - - it 'should answer to passenger.example.com' do - shell("/usr/bin/curl passenger.example.com:80") do |r| - expect(r.stdout).to match(/^hello world<\/b>$/) - expect(r.exit_code).to eq(0) - end - end - - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_php_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_php_spec.rb deleted file mode 100644 index 59be2baaa..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_php_spec.rb +++ /dev/null @@ -1,152 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -unless (fact('operatingsystem') == 'SLES' && fact('operatingsystemmajrelease') == '12') - describe 'apache::mod::php class' do - context "default php config" do - it 'succeeds in puppeting php' do - pp= <<-EOS - class { 'apache': - mpm_module => 'prefork', - } - class { 'apache::mod::php': } - apache::vhost { 'php.example.com': - port => '80', - docroot => '#{$doc_root}/php', - } - host { 'php.example.com': ip => '127.0.0.1', } - file { '#{$doc_root}/php/index.php': - ensure => file, - content => "\\n", - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - if (fact('operatingsystem') == 'Ubuntu' && fact('operatingsystemmajrelease') == '16.04') - describe file("#{$mod_dir}/php7.0.conf") do - it { is_expected.to contain "DirectoryIndex index.php" } - end - else - describe file("#{$mod_dir}/php5.conf") do - it { is_expected.to contain "DirectoryIndex index.php" } - end - end - - it 'should answer to php.example.com' do - shell("/usr/bin/curl php.example.com:80") do |r| - expect(r.stdout).to match(/PHP Version/) - expect(r.exit_code).to eq(0) - end - end - end - - context "custom extensions, php_flag, php_value, php_admin_flag, and php_admin_value" do - it 'succeeds in puppeting php' do - pp= <<-EOS - class { 'apache': - mpm_module => 'prefork', - } - class { 'apache::mod::php': - extensions => ['.php','.php5'], - } - apache::vhost { 'php.example.com': - port => '80', - docroot => '#{$doc_root}/php', - php_values => { 'include_path' => '.:/usr/share/pear:/usr/bin/php', }, - php_flags => { 'display_errors' => 'on', }, - php_admin_values => { 'open_basedir' => '/var/www/php/:/usr/share/pear/', }, - php_admin_flags => { 'engine' => 'on', }, - } - host { 'php.example.com': ip => '127.0.0.1', } - file { '#{$doc_root}/php/index.php5': - ensure => file, - content => "\\n", - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file("#{$vhost_dir}/25-php.example.com.conf") do - it { is_expected.to contain " php_flag display_errors on" } - it { is_expected.to contain " php_value include_path \".:/usr/share/pear:/usr/bin/php\"" } - it { is_expected.to contain " php_admin_flag engine on" } - it { is_expected.to contain " php_admin_value open_basedir /var/www/php/:/usr/share/pear/" } - end - - it 'should answer to php.example.com' do - shell("/usr/bin/curl php.example.com:80") do |r| - expect(r.stdout).to match(/\/usr\/share\/pear\//) - expect(r.exit_code).to eq(0) - end - end - end - - context "provide custom config file" do - it 'succeeds in puppeting php' do - pp= <<-EOS - class {'apache': - mpm_module => 'prefork', - } - class {'apache::mod::php': - content => '# somecontent', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - if (fact('operatingsystem') == 'Ubuntu' && fact('operatingsystemmajrelease') == '16.04') - describe file("#{$mod_dir}/php7.0.conf") do - it { should contain "# somecontent" } - end - else - describe file("#{$mod_dir}/php5.conf") do - it { should contain "# somecontent" } - end - end - end - - context "provide content and template config file" do - it 'succeeds in puppeting php' do - pp= <<-EOS - class {'apache': - mpm_module => 'prefork', - } - class {'apache::mod::php': - content => '# somecontent', - template => 'apache/mod/php5.conf.erb', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - if (fact('operatingsystem') == 'Ubuntu' && fact('operatingsystemmajrelease') == '16.04') - describe file("#{$mod_dir}/php7.0.conf") do - it { should contain "# somecontent" } - end - else - describe file("#{$mod_dir}/php5.conf") do - it { should contain "# somecontent" } - end - end - end - - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_proxy_html_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_proxy_html_spec.rb deleted file mode 100644 index ce8aad6f3..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_proxy_html_spec.rb +++ /dev/null @@ -1,36 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -# Don't run proxy_html tests on RHEL7 because the yum repos are missing packages required by it. -describe 'apache::mod::proxy_html class', :unless => (fact('osfamily') == 'RedHat' and fact('operatingsystemmajrelease') == '7') do - context "default proxy_html config" do - if fact('osfamily') == 'RedHat' and fact('operatingsystemmajrelease') =~ /(5|6)/ - it 'adds epel' do - pp = "class { 'epel': }" - apply_manifest(pp, :catch_failures => true) - end - end - - it 'succeeds in puppeting proxy_html' do - pp= <<-EOS - class { 'apache': } - class { 'apache::mod::proxy': } - class { 'apache::mod::proxy_http': } - # mod_proxy_html doesn't exist in RHEL5 - if $::osfamily == 'RedHat' and $::operatingsystemmajrelease != '5' { - class { 'apache::mod::proxy_html': } - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_security_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_security_spec.rb deleted file mode 100644 index 095cce9da..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_security_spec.rb +++ /dev/null @@ -1,386 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -describe 'apache::mod::security class', :unless => (fact('osfamily') == 'Debian' and (fact('lsbdistcodename') == 'squeeze' or fact('lsbdistcodename') == 'lucid' or fact('lsbdistcodename') == 'precise' or fact('lsbdistcodename') == 'wheezy')) || (fact('operatingsystem') == 'SLES' and fact('operatingsystemrelease') < '11') do - context "default mod_security config" do - if fact('osfamily') == 'RedHat' and fact('operatingsystemmajrelease') =~ /(5|6)/ - it 'adds epel' do - pp = "class { 'epel': }" - apply_manifest(pp, :catch_failures => true) - end - elsif fact('osfamily') == 'RedHat' and fact('operatingsystemmajrelease') == '7' - it 'changes obsoletes, per PUP-4497' do - pp = <<-EOS - ini_setting { 'obsoletes': - path => '/etc/yum.conf', - section => 'main', - setting => 'obsoletes', - value => '0', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - end - - it 'succeeds in puppeting mod_security' do - pp= <<-EOS - host { 'modsec.example.com': ip => '127.0.0.1', } - class { 'apache': } - class { 'apache::mod::security': } - apache::vhost { 'modsec.example.com': - port => '80', - docroot => '#{$doc_root}/html', - } - file { '#{$doc_root}/html/index.html': - ensure => file, - content => 'Index page', - } - EOS - apply_manifest(pp, :catch_failures => true) - - #Need to add a short sleep here because on RHEL6 the service takes a bit longer to init - if fact('osfamily') == 'RedHat' and fact('operatingsystemmajrelease') =~ /(5|6)/ - sleep 5 - end - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe package($package_name) do - it { is_expected.to be_installed } - end - - describe file("#{$mod_dir}/security.conf") do - it { is_expected.to contain "mod_security2.c" } - end - - describe 'should be listening on port 80' do - it 'should return index page' do - shell('/usr/bin/curl -A beaker modsec.example.com:80') do |r| - expect(r.stdout).to match(/Index page/) - expect(r.exit_code).to eq(0) - end - end - - unless fact('operatingsystem') == 'SLES' - it 'should block query with SQL' do - shell '/usr/bin/curl -A beaker -f modsec.example.com:80?SELECT%20*FROM%20mysql.users', :acceptable_exit_codes => [22] - end - end - end - - end #default mod_security config - - context "mod_security should allow disabling by vhost" do - it 'succeeds in puppeting mod_security' do - pp= <<-EOS - host { 'modsec.example.com': ip => '127.0.0.1', } - class { 'apache': } - class { 'apache::mod::security': } - apache::vhost { 'modsec.example.com': - port => '80', - docroot => '#{$doc_root}/html', - } - file { '#{$doc_root}/html/index.html': - ensure => file, - content => 'Index page', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file("#{$mod_dir}/security.conf") do - it { is_expected.to contain "mod_security2.c" } - end - - unless fact('operatingsystem') == 'SLES' - it 'should block query with SQL' do - shell '/usr/bin/curl -A beaker -f modsec.example.com:80?SELECT%20*FROM%20mysql.users', :acceptable_exit_codes => [22] - end - end - - it 'should disable mod_security per vhost' do - pp= <<-EOS - class { 'apache': } - class { 'apache::mod::security': } - apache::vhost { 'modsec.example.com': - port => '80', - docroot => '#{$doc_root}/html', - modsec_disable_vhost => true, - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - it 'should return index page' do - shell('/usr/bin/curl -A beaker -f modsec.example.com:80?SELECT%20*FROM%20mysql.users') do |r| - expect(r.stdout).to match(/Index page/) - expect(r.exit_code).to eq(0) - end - end - end #mod_security should allow disabling by vhost - - context "mod_security should allow disabling by ip" do - it 'succeeds in puppeting mod_security' do - pp= <<-EOS - host { 'modsec.example.com': ip => '127.0.0.1', } - class { 'apache': } - class { 'apache::mod::security': } - apache::vhost { 'modsec.example.com': - port => '80', - docroot => '#{$doc_root}/html', - } - file { '#{$doc_root}/html/index.html': - ensure => file, - content => 'Index page', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file("#{$mod_dir}/security.conf") do - it { is_expected.to contain "mod_security2.c" } - end - - unless fact('operatingsystem') == 'SLES' - it 'should block query with SQL' do - shell '/usr/bin/curl -A beaker -f modsec.example.com:80?SELECT%20*FROM%20mysql.users', :acceptable_exit_codes => [22] - end - end - - it 'should disable mod_security per vhost' do - pp= <<-EOS - class { 'apache': } - class { 'apache::mod::security': } - apache::vhost { 'modsec.example.com': - port => '80', - docroot => '#{$doc_root}/html', - modsec_disable_ips => [ '127.0.0.1' ], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - it 'should return index page' do - shell('/usr/bin/curl -A beaker modsec.example.com:80') do |r| - expect(r.stdout).to match(/Index page/) - expect(r.exit_code).to eq(0) - end - end - end #mod_security should allow disabling by ip - - context "mod_security should allow disabling by id" do - it 'succeeds in puppeting mod_security' do - pp= <<-EOS - host { 'modsec.example.com': ip => '127.0.0.1', } - class { 'apache': } - class { 'apache::mod::security': } - apache::vhost { 'modsec.example.com': - port => '80', - docroot => '#{$doc_root}/html', - } - file { '#{$doc_root}/html/index.html': - ensure => file, - content => 'Index page', - } - file { '#{$doc_root}/html/index2.html': - ensure => file, - content => 'Page 2', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file("#{$mod_dir}/security.conf") do - it { is_expected.to contain "mod_security2.c" } - end - - unless fact('operatingsystem') == 'SLES' - it 'should block query with SQL' do - shell '/usr/bin/curl -A beaker -f modsec.example.com:80?SELECT%20*FROM%20mysql.users', :acceptable_exit_codes => [22] - end - end - - it 'should disable mod_security per vhost' do - pp= <<-EOS - class { 'apache': } - class { 'apache::mod::security': } - apache::vhost { 'modsec.example.com': - port => '80', - docroot => '#{$doc_root}/html', - modsec_disable_ids => [ '950007' ], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - it 'should return index page' do - shell('/usr/bin/curl -A beaker -f modsec.example.com:80?SELECT%20*FROM%20mysql.users') do |r| - expect(r.stdout).to match(/Index page/) - expect(r.exit_code).to eq(0) - end - end - - end #mod_security should allow disabling by id - - context "mod_security should allow disabling by msg" do - it 'succeeds in puppeting mod_security' do - pp= <<-EOS - host { 'modsec.example.com': ip => '127.0.0.1', } - class { 'apache': } - class { 'apache::mod::security': } - apache::vhost { 'modsec.example.com': - port => '80', - docroot => '#{$doc_root}/html', - } - file { '#{$doc_root}/html/index.html': - ensure => file, - content => 'Index page', - } - file { '#{$doc_root}/html/index2.html': - ensure => file, - content => 'Page 2', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file("#{$mod_dir}/security.conf") do - it { is_expected.to contain "mod_security2.c" } - end - - unless fact('operatingsystem') == 'SLES' - it 'should block query with SQL' do - shell '/usr/bin/curl -A beaker -f modsec.example.com:80?SELECT%20*FROM%20mysql.users', :acceptable_exit_codes => [22] - end - end - - it 'should disable mod_security per vhost' do - pp= <<-EOS - class { 'apache': } - class { 'apache::mod::security': } - apache::vhost { 'modsec.example.com': - port => '80', - docroot => '#{$doc_root}/html', - modsec_disable_msgs => [ 'Blind SQL Injection Attack' ], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - it 'should return index page' do - shell('/usr/bin/curl -A beaker -f modsec.example.com:80?SELECT%20*FROM%20mysql.users') do |r| - expect(r.stdout).to match(/Index page/) - expect(r.exit_code).to eq(0) - end - end - - end #mod_security should allow disabling by msg - - context "mod_security should allow disabling by tag" do - it 'succeeds in puppeting mod_security' do - pp= <<-EOS - host { 'modsec.example.com': ip => '127.0.0.1', } - class { 'apache': } - class { 'apache::mod::security': } - apache::vhost { 'modsec.example.com': - port => '80', - docroot => '#{$doc_root}/html', - } - file { '#{$doc_root}/html/index.html': - ensure => file, - content => 'Index page', - } - file { '#{$doc_root}/html/index2.html': - ensure => file, - content => 'Page 2', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file("#{$mod_dir}/security.conf") do - it { is_expected.to contain "mod_security2.c" } - end - - unless fact('operatingsystem') == 'SLES' - it 'should block query with SQL' do - shell '/usr/bin/curl -A beaker -f modsec.example.com:80?SELECT%20*FROM%20mysql.users', :acceptable_exit_codes => [22] - end - end - - it 'should disable mod_security per vhost' do - pp= <<-EOS - class { 'apache': } - class { 'apache::mod::security': } - apache::vhost { 'modsec.example.com': - port => '80', - docroot => '#{$doc_root}/html', - modsec_disable_tags => [ 'WEB_ATTACK/SQL_INJECTION' ], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - it 'should return index page' do - shell('/usr/bin/curl -A beaker -f modsec.example.com:80?SELECT%20*FROM%20mysql.users') do |r| - expect(r.stdout).to match(/Index page/) - expect(r.exit_code).to eq(0) - end - end - - end #mod_security should allow disabling by tag - -end #apache::mod::security class diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_suphp_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_suphp_spec.rb deleted file mode 100644 index 07486677f..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/mod_suphp_spec.rb +++ /dev/null @@ -1,57 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'apache::mod::suphp class', :if => (fact('operatingsystem') == 'Ubuntu' and fact('operatingsystemmajrelease') != '16.04') do - context "default suphp config" do - it 'succeeds in puppeting suphp' do - pp = <<-EOS -class { 'apache': - mpm_module => 'prefork', -} -host { 'suphp.example.com': ip => '127.0.0.1', } -apache::vhost { 'suphp.example.com': - port => '80', - docroot => '/var/www/suphp', -} -file { '/var/www/suphp/index.php': - ensure => file, - owner => 'daemon', - group => 'daemon', - content => "\\n", - require => File['/var/www/suphp'], - before => Class['apache::mod::php'], -} -class { 'apache::mod::php': } -class { 'apache::mod::suphp': } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service('apache2') do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - it 'should answer to suphp.example.com' do - timeout = 0 - loop do - r = shell('curl suphp.example.com:80') - timeout += 1 - break if r.stdout =~ /^daemon$/ - if timeout > 40 - expect(timeout < 40).to be true - break - end - sleep(1) - end - shell("/usr/bin/curl suphp.example.com:80") do |r| - expect(r.stdout).to match(/^daemon$/) - expect(r.exit_code).to eq(0) - end - end - - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/centos-7-x64.yml b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/centos-7-x64.yml deleted file mode 100644 index 5eebdefbf..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/centos-7-x64.yml +++ /dev/null @@ -1,10 +0,0 @@ -HOSTS: - centos-7-x64: - roles: - - agent - - default - platform: el-7-x86_64 - hypervisor: vagrant - box: puppetlabs/centos-7.2-64-nocm -CONFIG: - type: foss diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/debian-8-x64.yml b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/debian-8-x64.yml deleted file mode 100644 index fef6e63ca..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/debian-8-x64.yml +++ /dev/null @@ -1,10 +0,0 @@ -HOSTS: - debian-8-x64: - roles: - - agent - - default - platform: debian-8-amd64 - hypervisor: vagrant - box: puppetlabs/debian-8.2-64-nocm -CONFIG: - type: foss diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/default.yml b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/default.yml deleted file mode 100644 index dba339c46..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/default.yml +++ /dev/null @@ -1,10 +0,0 @@ -HOSTS: - ubuntu-1404-x64: - roles: - - agent - - default - platform: ubuntu-14.04-amd64 - hypervisor: vagrant - box: puppetlabs/ubuntu-14.04-64-nocm -CONFIG: - type: foss diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/docker/centos-7.yml b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/docker/centos-7.yml deleted file mode 100644 index a3333aac5..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/docker/centos-7.yml +++ /dev/null @@ -1,12 +0,0 @@ -HOSTS: - centos-7-x64: - platform: el-7-x86_64 - hypervisor: docker - image: centos:7 - docker_preserve_image: true - docker_cmd: '["/usr/sbin/init"]' - # install various tools required to get the image up to usable levels - docker_image_commands: - - 'yum install -y crontabs tar wget openssl sysvinit-tools iproute which initscripts' -CONFIG: - trace_limit: 200 diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/docker/debian-8.yml b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/docker/debian-8.yml deleted file mode 100644 index df5c31944..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/docker/debian-8.yml +++ /dev/null @@ -1,11 +0,0 @@ -HOSTS: - debian-8-x64: - platform: debian-8-amd64 - hypervisor: docker - image: debian:8 - docker_preserve_image: true - docker_cmd: '["/sbin/init"]' - docker_image_commands: - - 'apt-get update && apt-get install -y net-tools wget locales strace lsof && echo "en_US.UTF-8 UTF-8" > /etc/locale.gen && locale-gen' -CONFIG: - trace_limit: 200 diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/docker/ubuntu-14.04.yml b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/docker/ubuntu-14.04.yml deleted file mode 100644 index b1efa5839..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/docker/ubuntu-14.04.yml +++ /dev/null @@ -1,12 +0,0 @@ -HOSTS: - ubuntu-1404-x64: - platform: ubuntu-14.04-amd64 - hypervisor: docker - image: ubuntu:14.04 - docker_preserve_image: true - docker_cmd: '["/sbin/init"]' - docker_image_commands: - # ensure that upstart is booting correctly in the container - - 'rm /usr/sbin/policy-rc.d && rm /sbin/initctl && dpkg-divert --rename --remove /sbin/initctl && apt-get update && apt-get install -y net-tools wget && locale-gen en_US.UTF-8' -CONFIG: - trace_limit: 200 diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/suse.yml b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/suse.yml deleted file mode 100644 index ac0492699..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/nodesets/suse.yml +++ /dev/null @@ -1,25 +0,0 @@ ---- -HOSTS: - sles-11-x86_64-agent: - roles: - - agent - - default - platform: sles-11-x86_64 - template: sles-11-x86_64 - hypervisor: virtualbox - redhat-7-x86_64-master: - roles: - - master - - dashboard - - database - - agent - platform: el-7-x86_64 - template: redhat-7-x86_64 - hypervisor: virtualbox -CONFIG: - nfs_server: none - consoleport: 443 - datastore: instance0 - folder: Delivery/Quality Assurance/Enterprise/Dynamic - resourcepool: delivery/Quality Assurance/Enterprise/Dynamic - pooling_api: http://vcloud.delivery.puppetlabs.net/ diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/prefork_worker_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/prefork_worker_spec.rb deleted file mode 100644 index 668716144..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/prefork_worker_spec.rb +++ /dev/null @@ -1,80 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -case fact('osfamily') -when 'FreeBSD' - describe 'apache::mod::event class' do - describe 'running puppet code' do - # Using puppet_apply as a helper - it 'should work with no errors' do - pp = <<-EOS - class { 'apache': - mpm_module => 'event', - } - EOS - - # Run it twice and test for idempotency - apply_manifest(pp, :catch_failures => true) - expect(apply_manifest(pp, :catch_failures => true).exit_code).to be_zero - end - end - - describe service($service_name) do - it { is_expected.to be_running } - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - end - end -end - -describe 'apache::mod::worker class' do - describe 'running puppet code' do - # Using puppet_apply as a helper - let(:pp) do - <<-EOS - class { 'apache': - mpm_module => 'worker', - } - EOS - end - - # Run it twice and test for idempotency - it_behaves_like "a idempotent resource" - end - - describe service($service_name) do - it { is_expected.to be_running } - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - end -end - -describe 'apache::mod::prefork class' do - describe 'running puppet code' do - # Using puppet_apply as a helper - let(:pp) do - <<-EOS - class { 'apache': - mpm_module => 'prefork', - } - EOS - end - # Run it twice and test for idempotency - it_behaves_like "a idempotent resource" - end - - describe service($service_name) do - it { is_expected.to be_running } - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/service_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/service_spec.rb deleted file mode 100644 index c62a34973..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/service_spec.rb +++ /dev/null @@ -1,18 +0,0 @@ -require 'spec_helper_acceptance' - -describe 'apache::service class' do - describe 'adding dependencies in between the base class and service class' do - let(:pp) do - <<-EOS - class { 'apache': } - file { '/tmp/test': - require => Class['apache'], - notify => Class['apache::service'], - } - EOS - end - - # Run it twice and test for idempotency - it_behaves_like "a idempotent resource" - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/version.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/version.rb deleted file mode 100644 index fac4071e6..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/version.rb +++ /dev/null @@ -1,96 +0,0 @@ -_osfamily = fact('osfamily') -_operatingsystem = fact('operatingsystem') -_operatingsystemrelease = fact('operatingsystemrelease').to_f - -case _osfamily -when 'RedHat' - $confd_dir = '/etc/httpd/conf.d' - $conf_file = '/etc/httpd/conf/httpd.conf' - $ports_file = '/etc/httpd/conf/ports.conf' - $vhost_dir = '/etc/httpd/conf.d' - $vhost = '/etc/httpd/conf.d/15-default.conf' - $run_dir = '/var/run/httpd' - $doc_root = '/var/www' - $service_name = 'httpd' - $package_name = 'httpd' - $error_log = 'error_log' - $suphp_handler = 'php5-script' - $suphp_configpath = 'undef' - - if (_operatingsystem == 'Fedora' and _operatingsystemrelease >= 18) or (_operatingsystem != 'Fedora' and _operatingsystemrelease >= 7) - $apache_version = '2.4' - $mod_dir = '/etc/httpd/conf.modules.d' - else - $apache_version = '2.2' - $mod_dir = '/etc/httpd/conf.d' - end -when 'Debian' - $confd_dir = '/etc/apache2/conf.d' - $mod_dir = '/etc/apache2/mods-available' - $conf_file = '/etc/apache2/apache2.conf' - $ports_file = '/etc/apache2/ports.conf' - $vhost = '/etc/apache2/sites-available/15-default.conf' - $vhost_dir = '/etc/apache2/sites-enabled' - $run_dir = '/var/run/apache2' - $doc_root = '/var/www' - $service_name = 'apache2' - $package_name = 'apache2' - $error_log = 'error.log' - $suphp_handler = 'x-httpd-php' - $suphp_configpath = '/etc/php5/apache2' - - if _operatingsystem == 'Ubuntu' and _operatingsystemrelease >= 13.10 - $apache_version = '2.4' - elsif _operatingsystem == 'Debian' and _operatingsystemrelease >= 8.0 - $apache_version = '2.4' - else - $apache_version = '2.2' - end -when 'FreeBSD' - $confd_dir = '/usr/local/etc/apache24/Includes' - $mod_dir = '/usr/local/etc/apache24/Modules' - $conf_file = '/usr/local/etc/apache24/httpd.conf' - $ports_file = '/usr/local/etc/apache24/Includes/ports.conf' - $vhost = '/usr/local/etc/apache24/Vhosts/15-default.conf' - $vhost_dir = '/usr/local/etc/apache24/Vhosts' - $run_dir = '/var/run/apache24' - $doc_root = '/var/www' - $service_name = 'apache24' - $package_name = 'apache24' - $error_log = 'http-error.log' - - $apache_version = '2.2' -when 'Gentoo' - $confd_dir = '/etc/apache2/conf.d' - $mod_dir = '/etc/apache2/modules.d' - $conf_file = '/etc/apache2/httpd.conf' - $ports_file = '/etc/apache2/ports.conf' - $vhost = '/etc/apache2/vhosts.d/15-default.conf' - $vhost_dir = '/etc/apache2/vhosts.d' - $run_dir = '/var/run/apache2' - $doc_root = '/var/www' - $service_name = 'apache2' - $package_name = 'www-servers/apache' - $error_log = 'http-error.log' - - $apache_version = '2.4' -when 'Suse' - $confd_dir = '/etc/apache2/conf.d' - $mod_dir = '/etc/apache2/mods-available' - $conf_file = '/etc/apache2/httpd.conf' - $ports_file = '/etc/apache2/ports.conf' - $vhost = '/etc/apache2/sites-available/15-default.conf' - $vhost_dir = '/etc/apache2/sites-available' - $run_dir = '/var/run/apache2' - $doc_root = '/srv/www' - $service_name = 'apache2' - $package_name = 'apache2' - $error_log = 'error.log' - if _operatingsystemrelease < 12 - $apache_version = '2.2' - else - $apache_version = '2.4' - end -else - $apache_version = '0' -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/vhost_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/vhost_spec.rb deleted file mode 100644 index dae411538..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/vhost_spec.rb +++ /dev/null @@ -1,1716 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -describe 'apache::vhost define' do - context 'no default vhosts' do - it 'should create no default vhosts' do - pp = <<-EOS - class { 'apache': - default_vhost => false, - default_ssl_vhost => false, - service_ensure => stopped, - } - if ($::osfamily == 'Suse') { - exec { '/usr/bin/gensslcert': - require => Class['apache'], - } - } - EOS - - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/15-default.conf") do - it { is_expected.not_to be_file } - end - - describe file("#{$vhost_dir}/15-default-ssl.conf") do - it { is_expected.not_to be_file } - end - end - - context "default vhost without ssl" do - it 'should create a default vhost config' do - pp = <<-EOS - class { 'apache': } - EOS - - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/15-default.conf") do - it { is_expected.to contain '' } - end - - describe file("#{$vhost_dir}/15-default-ssl.conf") do - it { is_expected.not_to be_file } - end - end - - context 'default vhost with ssl' do - it 'should create default vhost configs' do - pp = <<-EOS - file { '#{$run_dir}': - ensure => 'directory', - recurse => true, - } - - class { 'apache': - default_ssl_vhost => true, - require => File['#{$run_dir}'], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/15-default.conf") do - it { is_expected.to contain '' } - end - - describe file("#{$vhost_dir}/15-default-ssl.conf") do - it { is_expected.to contain '' } - it { is_expected.to contain "SSLEngine on" } - end - end - - context 'new vhost on port 80' do - it 'should configure an apache vhost' do - pp = <<-EOS - class { 'apache': } - file { '/var/www': - ensure => 'directory', - recurse => true, - } - - apache::vhost { 'first.example.com': - port => '80', - docroot => '/var/www/first', - require => File['/var/www'], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-first.example.com.conf") do - it { is_expected.to contain '' } - it { is_expected.to contain "ServerName first.example.com" } - end - end - - context 'new proxy vhost on port 80' do - it 'should configure an apache proxy vhost' do - pp = <<-EOS - class { 'apache': } - apache::vhost { 'proxy.example.com': - port => '80', - docroot => '/var/www/proxy', - proxy_pass => [ - { 'path' => '/foo', 'url' => 'http://backend-foo/'}, - ], - proxy_preserve_host => true, - proxy_error_override => true, - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-proxy.example.com.conf") do - it { is_expected.to contain '' } - it { is_expected.to contain "ServerName proxy.example.com" } - it { is_expected.to contain "ProxyPass" } - it { is_expected.to contain "ProxyPreserveHost On" } - it { is_expected.to contain "ProxyErrorOverride On" } - it { is_expected.not_to contain "ProxyAddHeaders" } - it { is_expected.not_to contain "" } - end - end - - unless (fact('operatingsystem') == 'SLES' and fact('operatingsystemmajorrelease') <= '10') - context 'new proxy vhost on port 80' do - it 'should configure an apache proxy vhost' do - pp = <<-EOS - class { 'apache': } - apache::vhost { 'proxy.example.com': - port => '80', - docroot => '#{$docroot}/proxy', - proxy_pass_match => [ - { 'path' => '/foo', 'url' => 'http://backend-foo/'}, - ], - proxy_preserve_host => true, - proxy_error_override => true, - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-proxy.example.com.conf") do - it { is_expected.to contain '' } - it { is_expected.to contain "ServerName proxy.example.com" } - it { is_expected.to contain "ProxyPassMatch /foo http://backend-foo/" } - it { is_expected.to contain "ProxyPreserveHost On" } - it { is_expected.to contain "ProxyErrorOverride On" } - it { is_expected.not_to contain "ProxyAddHeaders" } - it { is_expected.not_to contain "" } - end - end - end - - context 'new vhost on port 80' do - it 'should configure two apache vhosts' do - pp = <<-EOS - class { 'apache': } - apache::vhost { 'first.example.com': - port => '80', - docroot => '/var/www/first', - } - host { 'first.example.com': ip => '127.0.0.1', } - file { '/var/www/first/index.html': - ensure => file, - content => "Hello from first\\n", - } - apache::vhost { 'second.example.com': - port => '80', - docroot => '/var/www/second', - } - host { 'second.example.com': ip => '127.0.0.1', } - file { '/var/www/second/index.html': - ensure => file, - content => "Hello from second\\n", - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - it 'should answer to first.example.com' do - shell("/usr/bin/curl first.example.com:80", {:acceptable_exit_codes => 0}) do |r| - expect(r.stdout).to eq("Hello from first\n") - end - end - - it 'should answer to second.example.com' do - shell("/usr/bin/curl second.example.com:80", {:acceptable_exit_codes => 0}) do |r| - expect(r.stdout).to eq("Hello from second\n") - end - end - end - - context 'new vhost with multiple IP addresses on port 80' do - it 'should configure one apache vhost with 2 ip addresses' do - pp = <<-EOS - class { 'apache': - default_vhost => false, - } - apache::vhost { 'example.com': - port => '80', - ip => ['127.0.0.1','127.0.0.2'], - ip_based => true, - docroot => '/var/www/html', - } - host { 'host1.example.com': ip => '127.0.0.1', } - host { 'host2.example.com': ip => '127.0.0.2', } - file { '/var/www/html/index.html': - ensure => file, - content => "Hello from vhost\\n", - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file("#{$vhost_dir}/25-example.com.conf") do - it { is_expected.to contain '' } - it { is_expected.to contain "ServerName example.com" } - end - - describe file($ports_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'Listen 127.0.0.1:80' } - it { is_expected.to contain 'Listen 127.0.0.2:80' } - it { is_expected.not_to contain 'NameVirtualHost 127.0.0.1:80' } - it { is_expected.not_to contain 'NameVirtualHost 127.0.0.2:80' } - end - - it 'should answer to host1.example.com' do - shell("/usr/bin/curl host1.example.com:80", {:acceptable_exit_codes => 0}) do |r| - expect(r.stdout).to eq("Hello from vhost\n") - end - end - - it 'should answer to host2.example.com' do - shell("/usr/bin/curl host2.example.com:80", {:acceptable_exit_codes => 0}) do |r| - expect(r.stdout).to eq("Hello from vhost\n") - end - end - end - - context 'new vhost with multiple ports on 1 IP address' do - it 'should configure one apache vhost with 2 ports' do - pp = <<-EOS - class { 'apache': - default_vhost => false, - } - apache::vhost { 'example.com': - port => ['80','8080'], - ip => '127.0.0.1', - ip_based => true, - docroot => '/var/www/html', - } - host { 'host1.example.com': ip => '127.0.0.1', } - file { '/var/www/html/index.html': - ensure => file, - content => "Hello from vhost\\n", - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file("#{$vhost_dir}/25-example.com.conf") do - it { is_expected.to contain '' } - it { is_expected.to contain "ServerName example.com" } - end - - describe file($ports_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'Listen 127.0.0.1:80' } - it { is_expected.to contain 'Listen 127.0.0.1:8080' } - it { is_expected.not_to contain 'NameVirtualHost 127.0.0.1:80' } - it { is_expected.not_to contain 'NameVirtualHost 127.0.0.1:8080' } - end - - it 'should answer to host1.example.com port 80' do - shell("/usr/bin/curl host1.example.com:80", {:acceptable_exit_codes => 0}) do |r| - expect(r.stdout).to eq("Hello from vhost\n") - end - end - - it 'should answer to host1.example.com port 8080' do - shell("/usr/bin/curl host1.example.com:8080", {:acceptable_exit_codes => 0}) do |r| - expect(r.stdout).to eq("Hello from vhost\n") - end - end - end - - context 'new vhost with multiple IP addresses on multiple ports' do - it 'should configure one apache vhost with 2 ip addresses and 2 ports' do - pp = <<-EOS - class { 'apache': - default_vhost => false, - } - apache::vhost { 'example.com': - port => ['80', '8080'], - ip => ['127.0.0.1','127.0.0.2'], - ip_based => true, - docroot => '/var/www/html', - } - host { 'host1.example.com': ip => '127.0.0.1', } - host { 'host2.example.com': ip => '127.0.0.2', } - file { '/var/www/html/index.html': - ensure => file, - content => "Hello from vhost\\n", - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file("#{$vhost_dir}/25-example.com.conf") do - it { is_expected.to contain '' } - it { is_expected.to contain "ServerName example.com" } - end - - describe file($ports_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'Listen 127.0.0.1:80' } - it { is_expected.to contain 'Listen 127.0.0.1:8080' } - it { is_expected.to contain 'Listen 127.0.0.2:80' } - it { is_expected.to contain 'Listen 127.0.0.2:8080' } - it { is_expected.not_to contain 'NameVirtualHost 127.0.0.1:80' } - it { is_expected.not_to contain 'NameVirtualHost 127.0.0.1:8080' } - it { is_expected.not_to contain 'NameVirtualHost 127.0.0.2:80' } - it { is_expected.not_to contain 'NameVirtualHost 127.0.0.2:8080' } - end - - it 'should answer to host1.example.com port 80' do - shell("/usr/bin/curl host1.example.com:80", {:acceptable_exit_codes => 0}) do |r| - expect(r.stdout).to eq("Hello from vhost\n") - end - end - - it 'should answer to host1.example.com port 8080' do - shell("/usr/bin/curl host1.example.com:8080", {:acceptable_exit_codes => 0}) do |r| - expect(r.stdout).to eq("Hello from vhost\n") - end - end - - it 'should answer to host2.example.com port 80' do - shell("/usr/bin/curl host2.example.com:80", {:acceptable_exit_codes => 0}) do |r| - expect(r.stdout).to eq("Hello from vhost\n") - end - end - - it 'should answer to host2.example.com port 8080' do - shell("/usr/bin/curl host2.example.com:8080", {:acceptable_exit_codes => 0}) do |r| - expect(r.stdout).to eq("Hello from vhost\n") - end - end - end - - context 'new vhost with IPv6 address on port 80', :ipv6 do - it 'should configure one apache vhost with an ipv6 address' do - pp = <<-EOS - class { 'apache': - default_vhost => false, - } - apache::vhost { 'example.com': - port => '80', - ip => '::1', - ip_based => true, - docroot => '/var/www/html', - } - host { 'ipv6.example.com': ip => '::1', } - file { '/var/www/html/index.html': - ensure => file, - content => "Hello from vhost\\n", - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - describe file("#{$vhost_dir}/25-example.com.conf") do - it { is_expected.to contain '' } - it { is_expected.to contain "ServerName example.com" } - end - - describe file($ports_file) do - it { is_expected.to be_file } - it { is_expected.to contain 'Listen [::1]:80' } - it { is_expected.not_to contain 'NameVirtualHost [::1]:80' } - end - - it 'should answer to ipv6.example.com' do - shell("/usr/bin/curl ipv6.example.com:80", {:acceptable_exit_codes => 0}) do |r| - expect(r.stdout).to eq("Hello from vhost\n") - end - end - end - - context 'apache_directories' do - describe 'readme example, adapted' do - it 'should configure a vhost with Files' do - pp = <<-EOS - class { 'apache': } - - if versioncmp($apache_version, '2.4') >= 0 { - $_files_match_directory = { 'path' => '(\.swp|\.bak|~)$', 'provider' => 'filesmatch', 'require' => 'all denied', } - } else { - $_files_match_directory = { 'path' => '(\.swp|\.bak|~)$', 'provider' => 'filesmatch', 'deny' => 'from all', } - } - - $_directories = [ - { 'path' => '/var/www/files', }, - $_files_match_directory, - ] - - apache::vhost { 'files.example.net': - docroot => '/var/www/files', - directories => $_directories, - } - file { '/var/www/files/index.html': - ensure => file, - content => "Hello World\\n", - } - file { '/var/www/files/index.html.bak': - ensure => file, - content => "Hello World\\n", - } - host { 'files.example.net': ip => '127.0.0.1', } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - it 'should answer to files.example.net' do - expect(shell("/usr/bin/curl -sSf files.example.net:80/index.html").stdout).to eq("Hello World\n") - expect(shell("/usr/bin/curl -sSf files.example.net:80/index.html.bak", {:acceptable_exit_codes => 22}).stderr).to match(/curl: \(22\) The requested URL returned error: 403/) - end - end - - describe 'other Directory options' do - it 'should configure a vhost with multiple Directory sections' do - pp = <<-EOS - class { 'apache': } - - if versioncmp($apache_version, '2.4') >= 0 { - $_files_match_directory = { 'path' => 'private.html$', 'provider' => 'filesmatch', 'require' => 'all denied' } - } else { - $_files_match_directory = [ - { 'path' => 'private.html$', 'provider' => 'filesmatch', 'deny' => 'from all' }, - { 'path' => '/bar/bar.html', 'provider' => 'location', allow => [ 'from 127.0.0.1', ] }, - ] - } - - $_directories = [ - { 'path' => '/var/www/files', }, - { 'path' => '/foo/', 'provider' => 'location', 'directoryindex' => 'notindex.html', }, - $_files_match_directory, - ] - - apache::vhost { 'files.example.net': - docroot => '/var/www/files', - directories => $_directories, - } - file { '/var/www/files/foo': - ensure => directory, - } - file { '/var/www/files/foo/notindex.html': - ensure => file, - content => "Hello Foo\\n", - } - file { '/var/www/files/private.html': - ensure => file, - content => "Hello World\\n", - } - file { '/var/www/files/bar': - ensure => directory, - } - file { '/var/www/files/bar/bar.html': - ensure => file, - content => "Hello Bar\\n", - } - host { 'files.example.net': ip => '127.0.0.1', } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - it 'should answer to files.example.net' do - expect(shell("/usr/bin/curl -sSf files.example.net:80/").stdout).to eq("Hello World\n") - expect(shell("/usr/bin/curl -sSf files.example.net:80/foo/").stdout).to eq("Hello Foo\n") - expect(shell("/usr/bin/curl -sSf files.example.net:80/private.html", {:acceptable_exit_codes => 22}).stderr).to match(/curl: \(22\) The requested URL returned error: 403/) - expect(shell("/usr/bin/curl -sSf files.example.net:80/bar/bar.html").stdout).to eq("Hello Bar\n") - end - end - - describe 'SetHandler directive' do - it 'should configure a vhost with a SetHandler directive' do - pp = <<-EOS - class { 'apache': } - apache::mod { 'status': } - host { 'files.example.net': ip => '127.0.0.1', } - apache::vhost { 'files.example.net': - docroot => '/var/www/files', - directories => [ - { path => '/var/www/files', }, - { path => '/server-status', provider => 'location', sethandler => 'server-status', }, - ], - } - file { '/var/www/files/index.html': - ensure => file, - content => "Hello World\\n", - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - it 'should answer to files.example.net' do - expect(shell("/usr/bin/curl -sSf files.example.net:80/index.html").stdout).to eq("Hello World\n") - expect(shell("/usr/bin/curl -sSf files.example.net:80/server-status?auto").stdout).to match(/Scoreboard: /) - end - end - - describe 'Satisfy and Auth directive', :unless => $apache_version == '2.4' do - it 'should configure a vhost with Satisfy and Auth directive' do - pp = <<-EOS - class { 'apache': } - host { 'files.example.net': ip => '127.0.0.1', } - apache::vhost { 'files.example.net': - docroot => '/var/www/files', - directories => [ - { - path => '/var/www/files/foo', - auth_type => 'Basic', - auth_name => 'Basic Auth', - auth_user_file => '/var/www/htpasswd', - auth_require => "valid-user", - }, - { - path => '/var/www/files/bar', - auth_type => 'Basic', - auth_name => 'Basic Auth', - auth_user_file => '/var/www/htpasswd', - auth_require => 'valid-user', - satisfy => 'Any', - }, - { - path => '/var/www/files/baz', - allow => 'from 10.10.10.10', - auth_type => 'Basic', - auth_name => 'Basic Auth', - auth_user_file => '/var/www/htpasswd', - auth_require => 'valid-user', - satisfy => 'Any', - }, - ], - } - file { '/var/www/files/foo': - ensure => directory, - } - file { '/var/www/files/bar': - ensure => directory, - } - file { '/var/www/files/baz': - ensure => directory, - } - file { '/var/www/files/foo/index.html': - ensure => file, - content => "Hello World\\n", - } - file { '/var/www/files/bar/index.html': - ensure => file, - content => "Hello World\\n", - } - file { '/var/www/files/baz/index.html': - ensure => file, - content => "Hello World\\n", - } - file { '/var/www/htpasswd': - ensure => file, - content => "login:IZ7jMcLSx0oQk", # "password" as password - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { should be_running } - end - - it 'should answer to files.example.net' do - shell("/usr/bin/curl -sSf files.example.net:80/foo/index.html", {:acceptable_exit_codes => 22}).stderr.should match(/curl: \(22\) The requested URL returned error: 401/) - shell("/usr/bin/curl -sSf -u login:password files.example.net:80/foo/index.html").stdout.should eq("Hello World\n") - shell("/usr/bin/curl -sSf files.example.net:80/bar/index.html").stdout.should eq("Hello World\n") - shell("/usr/bin/curl -sSf -u login:password files.example.net:80/bar/index.html").stdout.should eq("Hello World\n") - shell("/usr/bin/curl -sSf files.example.net:80/baz/index.html", {:acceptable_exit_codes => 22}).stderr.should match(/curl: \(22\) The requested URL returned error: 401/) - shell("/usr/bin/curl -sSf -u login:password files.example.net:80/baz/index.html").stdout.should eq("Hello World\n") - end - end - end - - case fact('lsbdistcodename') - when 'precise', 'wheezy' - context 'vhost FallbackResource example' do - it 'should configure a vhost with FallbackResource' do - pp = <<-EOS - class { 'apache': } - apache::vhost { 'fallback.example.net': - docroot => '/var/www/fallback', - fallbackresource => '/index.html' - } - file { '/var/www/fallback/index.html': - ensure => file, - content => "Hello World\\n", - } - host { 'fallback.example.net': ip => '127.0.0.1', } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - it 'should answer to fallback.example.net' do - shell("/usr/bin/curl fallback.example.net:80/Does/Not/Exist") do |r| - expect(r.stdout).to eq("Hello World\n") - end - end - - end - else - # The current stable RHEL release (6.4) comes with Apache httpd 2.2.15 - # That was released March 6, 2010. - # FallbackResource was backported to 2.2.16, and released July 25, 2010. - # Ubuntu Lucid (10.04) comes with apache2 2.2.14, released October 3, 2009. - # https://svn.apache.org/repos/asf/httpd/httpd/branches/2.2.x/STATUS - end - - context 'virtual_docroot hosting separate sites' do - it 'should configure a vhost with VirtualDocumentRoot' do - pp = <<-EOS - class { 'apache': } - apache::vhost { 'virt.example.com': - vhost_name => '*', - serveraliases => '*virt.example.com', - port => '80', - docroot => '/var/www/virt', - virtual_docroot => '/var/www/virt/%1', - } - host { 'virt.example.com': ip => '127.0.0.1', } - host { 'a.virt.example.com': ip => '127.0.0.1', } - host { 'b.virt.example.com': ip => '127.0.0.1', } - file { [ '/var/www/virt/a', '/var/www/virt/b', ]: ensure => directory, } - file { '/var/www/virt/a/index.html': ensure => file, content => "Hello from a.virt\\n", } - file { '/var/www/virt/b/index.html': ensure => file, content => "Hello from b.virt\\n", } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - it 'should answer to a.virt.example.com' do - shell("/usr/bin/curl a.virt.example.com:80", {:acceptable_exit_codes => 0}) do |r| - expect(r.stdout).to eq("Hello from a.virt\n") - end - end - - it 'should answer to b.virt.example.com' do - shell("/usr/bin/curl b.virt.example.com:80", {:acceptable_exit_codes => 0}) do |r| - expect(r.stdout).to eq("Hello from b.virt\n") - end - end - end - - context 'proxy_pass for alternative vhost' do - it 'should configure a local vhost and a proxy vhost' do - apply_manifest(%{ - class { 'apache': default_vhost => false, } - apache::vhost { 'localhost': - docroot => '/var/www/local', - ip => '127.0.0.1', - port => '8888', - } - apache::listen { '*:80': } - apache::vhost { 'proxy.example.com': - docroot => '/var/www', - port => '80', - add_listen => false, - proxy_pass => { - 'path' => '/', - 'url' => 'http://localhost:8888/subdir/', - }, - } - host { 'proxy.example.com': ip => '127.0.0.1', } - file { ['/var/www/local', '/var/www/local/subdir']: ensure => directory, } - file { '/var/www/local/subdir/index.html': - ensure => file, - content => "Hello from localhost\\n", - } - }, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - it 'should get a response from the back end' do - shell("/usr/bin/curl --max-redirs 0 proxy.example.com:80") do |r| - expect(r.stdout).to eq("Hello from localhost\n") - expect(r.exit_code).to eq(0) - end - end - end - - unless (fact('operatingsystem') == 'SLES' and fact('operatingsystemmajorrelease') <= '10') - context 'proxy_pass_match for alternative vhost' do - it 'should configure a local vhost and a proxy vhost' do - apply_manifest(%{ - class { 'apache': default_vhost => false, } - apache::vhost { 'localhost': - docroot => '/var/www/local', - ip => '127.0.0.1', - port => '8888', - } - apache::listen { '*:80': } - apache::vhost { 'proxy.example.com': - docroot => '/var/www', - port => '80', - add_listen => false, - proxy_pass_match => { - 'path' => '/', - 'url' => 'http://localhost:8888/subdir/', - }, - } - host { 'proxy.example.com': ip => '127.0.0.1', } - file { ['/var/www/local', '/var/www/local/subdir']: ensure => directory, } - file { '/var/www/local/subdir/index.html': - ensure => file, - content => "Hello from localhost\\n", - } - }, :catch_failures => true) - end - - describe service($service_name) do - if (fact('operatingsystem') == 'Debian' && fact('operatingsystemmajrelease') == '8') - pending 'Should be enabled - Bug 760616 on Debian 8' - else - it { should be_enabled } - end - it { is_expected.to be_running } - end - - it 'should get a response from the back end' do - shell("/usr/bin/curl --max-redirs 0 proxy.example.com:80") do |r| - expect(r.stdout).to eq("Hello from localhost\n") - expect(r.exit_code).to eq(0) - end - end - end - end - - describe 'ip_based' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - ip_based => true, - servername => 'test.server', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file($ports_file) do - it { is_expected.to be_file } - it { is_expected.not_to contain 'NameVirtualHost test.server' } - end - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain "ServerName test.server" } - end - end - - describe 'ip_based and no servername' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - ip_based => true, - servername => '', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file($ports_file) do - it { is_expected.to be_file } - it { is_expected.not_to contain 'NameVirtualHost test.server' } - end - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.not_to contain "ServerName" } - end - end - - describe 'add_listen' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': default_vhost => false } - host { 'testlisten.server': ip => '127.0.0.1' } - apache::listen { '81': } - apache::vhost { 'testlisten.server': - docroot => '/tmp', - port => '80', - add_listen => false, - servername => 'testlisten.server', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file($ports_file) do - it { is_expected.to be_file } - it { is_expected.not_to contain 'Listen 80' } - it { is_expected.to contain 'Listen 81' } - end - end - - describe 'docroot' do - it 'applies cleanly' do - pp = <<-EOS - user { 'test_owner': ensure => present, } - group { 'test_group': ensure => present, } - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp/test', - docroot_owner => 'test_owner', - docroot_group => 'test_group', - docroot_mode => '0750', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file('/tmp/test') do - it { is_expected.to be_directory } - it { is_expected.to be_owned_by 'test_owner' } - it { is_expected.to be_grouped_into 'test_group' } - it { is_expected.to be_mode 750 } - end - end - - describe 'default_vhost' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - default_vhost => true, - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file($ports_file) do - it { is_expected.to be_file } - if fact('osfamily') == 'RedHat' and fact('operatingsystemmajrelease') == '7' - it { is_expected.not_to contain 'NameVirtualHost test.server' } - elsif fact('operatingsystem') == 'Ubuntu' and fact('operatingsystemrelease') =~ /(14\.04|13\.10|16\.04)/ - it { is_expected.not_to contain 'NameVirtualHost test.server' } - elsif fact('operatingsystem') == 'Debian' and fact('operatingsystemmajrelease') == '8' - it { is_expected.not_to contain 'NameVirtualHost test.server' } - elsif fact('operatingsystem') == 'SLES' and fact('operatingsystemrelease') >= '12' - it { is_expected.not_to contain 'NameVirtualHost test.server' } - else - it { is_expected.to contain 'NameVirtualHost test.server' } - end - end - - describe file("#{$vhost_dir}/10-test.server.conf") do - it { is_expected.to be_file } - end - end - - describe 'options' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - options => ['Indexes','FollowSymLinks', 'ExecCGI'], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'Options Indexes FollowSymLinks ExecCGI' } - end - end - - describe 'override' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - override => ['All'], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'AllowOverride All' } - end - end - - describe 'logroot' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - logroot => '/tmp', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain ' CustomLog "/tmp' } - end - end - - ['access', 'error'].each do |logtype| - case logtype - when 'access' - logname = 'CustomLog' - when 'error' - logname = 'ErrorLog' - end - - describe "#{logtype}_log" do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - logroot => '/tmp', - #{logtype}_log => false, - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.not_to contain " #{logname} \"/tmp" } - end - end - - describe "#{logtype}_log_pipe" do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - logroot => '/tmp', - #{logtype}_log_pipe => '|/bin/sh', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain " #{logname} \"|/bin/sh" } - end - end - - describe "#{logtype}_log_syslog" do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - logroot => '/tmp', - #{logtype}_log_syslog => 'syslog', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain " #{logname} \"syslog\"" } - end - end - end - - describe 'access_log_format' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - logroot => '/tmp', - access_log_syslog => 'syslog', - access_log_format => '%h %l', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'CustomLog "syslog" "%h %l"' } - end - end - - describe 'access_log_env_var' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - logroot => '/tmp', - access_log_syslog => 'syslog', - access_log_env_var => 'admin', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'CustomLog "syslog" combined env=admin' } - end - end - - describe 'multiple access_logs' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - logroot => '/tmp', - access_logs => [ - {'file' => 'log1'}, - {'file' => 'log2', 'env' => 'admin' }, - {'file' => '/var/tmp/log3', 'format' => '%h %l'}, - {'syslog' => 'syslog' } - ] - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'CustomLog "/tmp/log1" combined' } - it { is_expected.to contain 'CustomLog "/tmp/log2" combined env=admin' } - it { is_expected.to contain 'CustomLog "/var/tmp/log3" "%h %l"' } - it { is_expected.to contain 'CustomLog "syslog" combined' } - end - end - - describe 'aliases' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - aliases => [ - { alias => '/image' , path => '/ftp/pub/image' } , - { scriptalias => '/myscript' , path => '/usr/share/myscript' } - ], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'Alias /image "/ftp/pub/image"' } - it { is_expected.to contain 'ScriptAlias /myscript "/usr/share/myscript"' } - end - end - - describe 'scriptaliases' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - scriptaliases => [{ alias => '/myscript', path => '/usr/share/myscript', }], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'ScriptAlias /myscript "/usr/share/myscript"' } - end - end - - describe 'proxy' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': service_ensure => stopped, } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - proxy_dest => 'test2', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'ProxyPass / test2/' } - end - end - - describe 'actions' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - action => 'php-fastcgi', - } - EOS - pp = pp + "\nclass { 'apache::mod::actions': }" if fact('osfamily') == 'Debian' || fact('osfamily') == 'Suse' - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'Action php-fastcgi /cgi-bin virtual' } - end - end - - describe 'suphp' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': service_ensure => stopped, } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - suphp_addhandler => '#{$suphp_handler}', - suphp_engine => 'on', - suphp_configpath => '#{$suphp_configpath}', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain "suPHP_AddHandler #{$suphp_handler}" } - it { is_expected.to contain 'suPHP_Engine on' } - it { is_expected.to contain "suPHP_ConfigPath \"#{$suphp_configpath}\"" } - end - end - - describe 'rack_base_uris' do - unless fact('osfamily') == 'RedHat' or fact('operatingsystem') == 'SLES' - it 'applies cleanly' do - test = lambda do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - rack_base_uris => ['/test'], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - test.call - end - end - end - - describe 'no_proxy_uris' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': service_ensure => stopped, } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - proxy_dest => 'http://test2', - no_proxy_uris => [ 'http://test2/test' ], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'ProxyPass http://test2/test !' } - it { is_expected.to contain 'ProxyPass / http://test2/' } - end - end - - describe 'redirect' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - redirect_source => ['/images'], - redirect_dest => ['http://test.server/'], - redirect_status => ['permanent'], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'Redirect permanent /images http://test.server/' } - end - end - - describe 'request_headers' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - request_headers => ['append MirrorID "mirror 12"'], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'append MirrorID "mirror 12"' } - end - end - - describe 'rewrite rules' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - rewrites => [ - { comment => 'test', - rewrite_cond => '%{HTTP_USER_AGENT} ^Lynx/ [OR]', - rewrite_rule => ['^index\.html$ welcome.html'], - rewrite_map => ['lc int:tolower'], - } - ], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain '#test' } - it { is_expected.to contain 'RewriteCond %{HTTP_USER_AGENT} ^Lynx/ [OR]' } - it { is_expected.to contain 'RewriteRule ^index.html$ welcome.html' } - it { is_expected.to contain 'RewriteMap lc int:tolower' } - end - end - - describe 'directory rewrite rules' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - if ! defined(Class['apache::mod::rewrite']) { - include ::apache::mod::rewrite - } - apache::vhost { 'test.server': - docroot => '/tmp', - directories => [ - { - path => '/tmp', - rewrites => [ - { - comment => 'Permalink Rewrites', - rewrite_base => '/', - }, - { rewrite_rule => [ '^index\\.php$ - [L]' ] }, - { rewrite_cond => [ - '%{REQUEST_FILENAME} !-f', - '%{REQUEST_FILENAME} !-d', ], rewrite_rule => [ '. /index.php [L]' ], } - ], - }, - ], - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { should be_file } - it { should contain '#Permalink Rewrites' } - it { should contain 'RewriteEngine On' } - it { should contain 'RewriteBase /' } - it { should contain 'RewriteRule ^index\.php$ - [L]' } - it { should contain 'RewriteCond %{REQUEST_FILENAME} !-f' } - it { should contain 'RewriteCond %{REQUEST_FILENAME} !-d' } - it { should contain 'RewriteRule . /index.php [L]' } - end - end - - describe 'setenv/setenvif' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - setenv => ['TEST /test'], - setenvif => ['Request_URI "\.gif$" object_is_image=gif'] - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'SetEnv TEST /test' } - it { is_expected.to contain 'SetEnvIf Request_URI "\.gif$" object_is_image=gif' } - end - end - - describe 'block' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - block => 'scm', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain '' } - end - end - - describe 'wsgi' do - context 'on lucid', :if => fact('lsbdistcodename') == 'lucid' do - it 'import_script applies cleanly' do - pp = <<-EOS - class { 'apache': } - class { 'apache::mod::wsgi': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - wsgi_application_group => '%{GLOBAL}', - wsgi_daemon_process => 'wsgi', - wsgi_daemon_process_options => {processes => '2'}, - wsgi_process_group => 'nobody', - wsgi_script_aliases => { '/test' => '/test1' }, - wsgi_script_aliases_match => { '/test/([^/*])' => '/test1' }, - wsgi_pass_authorization => 'On', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - end - - context 'on everything but lucid', :unless => (fact('lsbdistcodename') == 'lucid' or fact('operatingsystem') == 'SLES') do - it 'import_script applies cleanly' do - pp = <<-EOS - class { 'apache': } - class { 'apache::mod::wsgi': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - wsgi_application_group => '%{GLOBAL}', - wsgi_daemon_process => 'wsgi', - wsgi_daemon_process_options => {processes => '2'}, - wsgi_import_script => '/test1', - wsgi_import_script_options => { application-group => '%{GLOBAL}', process-group => 'wsgi' }, - wsgi_process_group => 'nobody', - wsgi_script_aliases => { '/test' => '/test1' }, - wsgi_script_aliases_match => { '/test/([^/*])' => '/test1' }, - wsgi_pass_authorization => 'On', - wsgi_chunked_request => 'On', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'WSGIApplicationGroup %{GLOBAL}' } - it { is_expected.to contain 'WSGIDaemonProcess wsgi processes=2' } - it { is_expected.to contain 'WSGIImportScript /test1 application-group=%{GLOBAL} process-group=wsgi' } - it { is_expected.to contain 'WSGIProcessGroup nobody' } - it { is_expected.to contain 'WSGIScriptAlias /test "/test1"' } - it { is_expected.to contain 'WSGIPassAuthorization On' } - it { is_expected.to contain 'WSGIChunkedRequest On' } - end - end - end - - describe 'custom_fragment' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - custom_fragment => inline_template('#weird test string'), - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain '#weird test string' } - end - end - - describe 'itk' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - itk => { user => 'nobody', group => 'nobody' } - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'AssignUserId nobody nobody' } - end - end - - # Limit testing to Debian, since Centos does not have fastcgi package. - case fact('osfamily') - when 'Debian' - describe 'fastcgi' do - it 'applies cleanly' do - pp = <<-EOS - $_os = $::operatingsystem - - if $_os == 'Ubuntu' { - $_location = "http://archive.ubuntu.com/ubuntu/" - $_security_location = "http://archive.ubuntu.com/ubuntu/" - $_release = $::lsbdistcodename - $_release_security = "${_release}-security" - $_repos = "main universe multiverse" - } else { - $_location = "http://httpredir.debian.org/debian/" - $_security_location = "http://security.debian.org/" - $_release = $::lsbdistcodename - $_release_security = "${_release}/updates" - $_repos = "main contrib non-free" - } - - include ::apt - apt::source { "${_os}_${_release}": - location => $_location, - release => $_release, - repos => $_repos, - } - - apt::source { "${_os}_${_release}-updates": - location => $_location, - release => "${_release}-updates", - repos => $_repos, - } - - apt::source { "${_os}_${_release}-security": - location => $_security_location, - release => $_release_security, - repos => $_repos, - } - EOS - - #apt-get update may not run clean here. Should be OK. - apply_manifest(pp, :catch_failures => false) - - pp2 = <<-EOS - class { 'apache': } - class { 'apache::mod::fastcgi': } - host { 'test.server': ip => '127.0.0.1' } - apache::vhost { 'test.server': - docroot => '/tmp', - fastcgi_server => 'localhost', - fastcgi_socket => '/tmp/fast/1234', - fastcgi_dir => '/tmp/fast', - } - EOS - apply_manifest(pp2, :catch_failures => true, :acceptable_exit_codes => [0, 2]) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'FastCgiExternalServer localhost -socket /tmp/fast/1234' } - it { is_expected.to contain '' } - end - end - end - - describe 'additional_includes' do - it 'applies cleanly' do - pp = <<-EOS - if $::osfamily == 'RedHat' and "$::selinux" == "true" { - $semanage_package = $::operatingsystemmajrelease ? { - '5' => 'policycoreutils', - default => 'policycoreutils-python', - } - exec { 'set_apache_defaults': - command => 'semanage fcontext -a -t httpd_sys_content_t "/apache_spec(/.*)?"', - path => '/bin:/usr/bin/:/sbin:/usr/sbin', - require => Package[$semanage_package], - } - package { $semanage_package: ensure => installed } - exec { 'restorecon_apache': - command => 'restorecon -Rv /apache_spec', - path => '/bin:/usr/bin/:/sbin:/usr/sbin', - before => Service['httpd'], - require => Class['apache'], - } - } - class { 'apache': } - host { 'test.server': ip => '127.0.0.1' } - file { '/apache_spec': ensure => directory, } - file { '/apache_spec/include': ensure => present, content => '#additional_includes' } - apache::vhost { 'test.server': - docroot => '/apache_spec', - additional_includes => '/apache_spec/include', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'Include "/apache_spec/include"' } - end - end - - describe 'virtualhost without priority prefix' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - apache::vhost { 'test.server': - priority => false, - docroot => '/tmp' - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/test.server.conf") do - it { is_expected.to be_file } - end - end - - describe 'SSLProtocol directive' do - it 'applies cleanly' do - pp = <<-EOS - class { 'apache': } - apache::vhost { 'test.server': - docroot => '/tmp', - ssl => true, - ssl_protocol => ['All', '-SSLv2'], - } - apache::vhost { 'test2.server': - docroot => '/tmp', - ssl => true, - ssl_protocol => 'All -SSLv2', - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-test.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'SSLProtocol *All -SSLv2' } - end - - describe file("#{$vhost_dir}/25-test2.server.conf") do - it { is_expected.to be_file } - it { is_expected.to contain 'SSLProtocol *All -SSLv2' } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/vhosts_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/vhosts_spec.rb deleted file mode 100644 index d8fb062f9..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/acceptance/vhosts_spec.rb +++ /dev/null @@ -1,32 +0,0 @@ -require 'spec_helper_acceptance' -require_relative './version.rb' - -describe 'apache::vhosts class' do - context 'custom vhosts defined via class apache::vhosts' do - it 'should create custom vhost config files' do - pp = <<-EOS - class { 'apache::vhosts': - vhosts => { - 'custom_vhost_1' => { - 'docroot' => '/var/www/custom_vhost_1', - 'port' => '81', - }, - 'custom_vhost_2' => { - 'docroot' => '/var/www/custom_vhost_2', - 'port' => '82', - }, - }, - } - EOS - apply_manifest(pp, :catch_failures => true) - end - - describe file("#{$vhost_dir}/25-custom_vhost_1.conf") do - it { is_expected.to contain '' } - end - - describe file("#{$vhost_dir}/25-custom_vhost_2.conf") do - it { is_expected.to contain '' } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/apache_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/apache_spec.rb deleted file mode 100644 index 715ed4124..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/apache_spec.rb +++ /dev/null @@ -1,910 +0,0 @@ -require 'spec_helper' - -describe 'apache', :type => :class do - context "on a Debian OS" do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_package("httpd").with( - 'notify' => 'Class[Apache::Service]', - 'ensure' => 'installed' - ) - } - it { is_expected.to contain_user("www-data") } - it { is_expected.to contain_group("www-data") } - it { is_expected.to contain_class("apache::service") } - it { is_expected.to contain_file("/var/www").with( - 'ensure' => 'directory' - ) - } - it { is_expected.to contain_file("/etc/apache2/sites-enabled").with( - 'ensure' => 'directory', - 'recurse' => 'true', - 'purge' => 'true', - 'notify' => 'Class[Apache::Service]', - 'require' => 'Package[httpd]' - ) - } - it { is_expected.to contain_file("/etc/apache2/mods-enabled").with( - 'ensure' => 'directory', - 'recurse' => 'true', - 'purge' => 'true', - 'notify' => 'Class[Apache::Service]', - 'require' => 'Package[httpd]' - ) - } - it { is_expected.to contain_file("/etc/apache2/mods-available").with( - 'ensure' => 'directory', - 'recurse' => 'true', - 'purge' => 'false', - 'notify' => 'Class[Apache::Service]', - 'require' => 'Package[httpd]' - ) - } - it { is_expected.to contain_concat("/etc/apache2/ports.conf").with( - 'owner' => 'root', - 'group' => 'root', - 'mode' => '0644', - 'notify' => 'Class[Apache::Service]' - ) - } - # Assert that load files are placed and symlinked for these mods, but no conf file. - [ - 'auth_basic', - 'authn_file', - 'authz_default', - 'authz_groupfile', - 'authz_host', - 'authz_user', - 'dav', - 'env' - ].each do |modname| - it { is_expected.to contain_file("#{modname}.load").with( - 'path' => "/etc/apache2/mods-available/#{modname}.load", - 'ensure' => 'file' - ) } - it { is_expected.to contain_file("#{modname}.load symlink").with( - 'path' => "/etc/apache2/mods-enabled/#{modname}.load", - 'ensure' => 'link', - 'target' => "/etc/apache2/mods-available/#{modname}.load" - ) } - it { is_expected.not_to contain_file("#{modname}.conf") } - it { is_expected.not_to contain_file("#{modname}.conf symlink") } - end - - context "with Apache version < 2.4" do - let :params do - { :apache_version => '2.2' } - end - - it { is_expected.to contain_file("/etc/apache2/apache2.conf").with_content %r{^Include "/etc/apache2/conf\.d/\*\.conf"$} } - end - - context "with Apache version >= 2.4" do - let :params do - { - :apache_version => '2.4', - :use_optional_includes => true - } - end - - it { is_expected.to contain_file("/etc/apache2/apache2.conf").with_content %r{^IncludeOptional "/etc/apache2/conf\.d/\*\.conf"$} } - end - - context "when specifying slash encoding behaviour" do - let :params do - { :allow_encoded_slashes => 'nodecode' } - end - - it { is_expected.to contain_file("/etc/apache2/apache2.conf").with_content %r{^AllowEncodedSlashes nodecode$} } - end - - context "when specifying fileETag behaviour" do - let :params do - { :file_e_tag => 'None' } - end - - it { is_expected.to contain_file("/etc/apache2/apache2.conf").with_content %r{^FileETag None$} } - end - - context "when specifying default character set" do - let :params do - { :default_charset => 'none' } - end - - it { is_expected.to contain_file("/etc/apache2/apache2.conf").with_content %r{^AddDefaultCharset none$} } - end - - # Assert that both load files and conf files are placed and symlinked for these mods - [ - 'alias', - 'autoindex', - 'dav_fs', - 'deflate', - 'dir', - 'mime', - 'negotiation', - 'setenvif', - ].each do |modname| - it { is_expected.to contain_file("#{modname}.load").with( - 'path' => "/etc/apache2/mods-available/#{modname}.load", - 'ensure' => 'file' - ) } - it { is_expected.to contain_file("#{modname}.load symlink").with( - 'path' => "/etc/apache2/mods-enabled/#{modname}.load", - 'ensure' => 'link', - 'target' => "/etc/apache2/mods-available/#{modname}.load" - ) } - it { is_expected.to contain_file("#{modname}.conf").with( - 'path' => "/etc/apache2/mods-available/#{modname}.conf", - 'ensure' => 'file' - ) } - it { is_expected.to contain_file("#{modname}.conf symlink").with( - 'path' => "/etc/apache2/mods-enabled/#{modname}.conf", - 'ensure' => 'link', - 'target' => "/etc/apache2/mods-available/#{modname}.conf" - ) } - end - - describe "Check default type" do - context "with Apache version < 2.4" do - let :params do - { - :apache_version => '2.2', - } - end - - context "when default_type => 'none'" do - let :params do - { :default_type => 'none' } - end - - it { is_expected.to contain_file("/etc/apache2/apache2.conf").with_content %r{^DefaultType none$} } - end - context "when default_type => 'text/plain'" do - let :params do - { :default_type => 'text/plain' } - end - - it { is_expected.to contain_file("/etc/apache2/apache2.conf").with_content %r{^DefaultType text/plain$} } - end - end - - context "with Apache version >= 2.4" do - let :params do - { - :apache_version => '2.4', - } - end - it { is_expected.to contain_file("/etc/apache2/apache2.conf").without_content %r{^DefaultType [.]*$} } - end - end - - describe "Don't create user resource" do - context "when parameter manage_user is false" do - let :params do - { :manage_user => false } - end - - it { is_expected.not_to contain_user('www-data') } - it { is_expected.to contain_file("/etc/apache2/apache2.conf").with_content %r{^User www-data\n} } - end - end - describe "Don't create group resource" do - context "when parameter manage_group is false" do - let :params do - { :manage_group => false } - end - - it { is_expected.not_to contain_group('www-data') } - it { is_expected.to contain_file("/etc/apache2/apache2.conf").with_content %r{^Group www-data\n} } - end - end - - describe "Add extra LogFormats" do - context "When parameter log_formats is a hash" do - let :params do - { :log_formats => { - 'vhost_common' => "%v %h %l %u %t \"%r\" %>s %b", - 'vhost_combined' => "%v %h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"" - } } - end - - it { is_expected.to contain_file("/etc/apache2/apache2.conf").with_content %r{^LogFormat "%v %h %l %u %t \"%r\" %>s %b" vhost_common\n} } - it { is_expected.to contain_file("/etc/apache2/apache2.conf").with_content %r{^LogFormat "%v %h %l %u %t \"%r\" %>s %b \"%\{Referer\}i\" \"%\{User-agent\}i\"" vhost_combined\n} } - end - end - - describe "Override existing LogFormats" do - context "When parameter log_formats is a hash" do - let :params do - { :log_formats => { - 'common' => "%v %h %l %u %t \"%r\" %>s %b", - 'combined' => "%v %h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"" - } } - end - - it { is_expected.to contain_file("/etc/apache2/apache2.conf").with_content %r{^LogFormat "%v %h %l %u %t \"%r\" %>s %b" common\n} } - it { is_expected.to contain_file("/etc/apache2/apache2.conf").without_content %r{^LogFormat "%h %l %u %t \"%r\" %>s %b \"%\{Referer\}i\" \"%\{User-agent\}i\"" combined\n} } - it { is_expected.to contain_file("/etc/apache2/apache2.conf").with_content %r{^LogFormat "%v %h %l %u %t \"%r\" %>s %b" common\n} } - it { is_expected.to contain_file("/etc/apache2/apache2.conf").with_content %r{^LogFormat "%v %h %l %u %t \"%r\" %>s %b \"%\{Referer\}i\" \"%\{User-agent\}i\"" combined\n} } - it { is_expected.to contain_file("/etc/apache2/apache2.conf").without_content %r{^LogFormat "%h %l %u %t \"%r\" %>s %b \"%\{Referer\}i\" \"%\{User-agent\}i\"" combined\n} } - end - end - - context "8" do - let :facts do - super().merge({ - :lsbdistcodename => 'jessie', - :operatingsystemrelease => '8' - }) - end - it { is_expected.to contain_file("/var/www/html").with( - 'ensure' => 'directory' - ) - } - end - context "on Ubuntu" do - let :facts do - super().merge({ - :operatingsystem => 'Ubuntu' - }) - end - - context "14.04" do - let :facts do - super().merge({ - :lsbdistrelease => '14.04', - :operatingsystemrelease => '14.04' - }) - end - it { is_expected.to contain_file("/var/www/html").with( - 'ensure' => 'directory' - ) - } - end - context "13.10" do - let :facts do - super().merge({ - :lsbdistrelease => '13.10', - :operatingsystemrelease => '13.10' - }) - end - it { is_expected.to contain_class('apache').with_apache_version('2.4') } - end - context "12.04" do - let :facts do - super().merge({ - :lsbdistrelease => '12.04', - :operatingsystemrelease => '12.04' - }) - end - it { is_expected.to contain_class('apache').with_apache_version('2.2') } - end - context "13.04" do - let :facts do - super().merge({ - :lsbdistrelease => '13.04', - :operatingsystemrelease => '13.04' - }) - end - it { is_expected.to contain_class('apache').with_apache_version('2.2') } - end - end - end - context "on a RedHat 5 OS" do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '5', - :concat_basedir => '/dne', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_package("httpd").with( - 'notify' => 'Class[Apache::Service]', - 'ensure' => 'installed' - ) - } - it { is_expected.to contain_user("apache") } - it { is_expected.to contain_group("apache") } - it { is_expected.to contain_class("apache::service") } - it { is_expected.to contain_file("/var/www/html").with( - 'ensure' => 'directory' - ) - } - it { is_expected.to contain_file("/etc/httpd/conf.d").with( - 'ensure' => 'directory', - 'recurse' => 'true', - 'purge' => 'true', - 'notify' => 'Class[Apache::Service]', - 'require' => 'Package[httpd]' - ) - } - it { is_expected.to contain_concat("/etc/httpd/conf/ports.conf").with( - 'owner' => 'root', - 'group' => 'root', - 'mode' => '0644', - 'notify' => 'Class[Apache::Service]' - ) - } - describe "Alternate confd/mod/vhosts directory" do - let :params do - { - :vhost_dir => '/etc/httpd/site.d', - :confd_dir => '/etc/httpd/conf.d', - :mod_dir => '/etc/httpd/mod.d', - } - end - - ['mod.d','site.d','conf.d'].each do |dir| - it { is_expected.to contain_file("/etc/httpd/#{dir}").with( - 'ensure' => 'directory', - 'recurse' => 'true', - 'purge' => 'true', - 'notify' => 'Class[Apache::Service]', - 'require' => 'Package[httpd]' - ) } - end - - # Assert that load files are placed for these mods, but no conf file. - [ - 'auth_basic', - 'authn_file', - 'authz_default', - 'authz_groupfile', - 'authz_host', - 'authz_user', - 'dav', - 'env', - ].each do |modname| - it { is_expected.to contain_file("#{modname}.load").with_path( - "/etc/httpd/mod.d/#{modname}.load" - ) } - it { is_expected.not_to contain_file("#{modname}.conf").with_path( - "/etc/httpd/mod.d/#{modname}.conf" - ) } - end - - # Assert that both load files and conf files are placed for these mods - [ - 'alias', - 'autoindex', - 'dav_fs', - 'deflate', - 'dir', - 'mime', - 'negotiation', - 'setenvif', - ].each do |modname| - it { is_expected.to contain_file("#{modname}.load").with_path( - "/etc/httpd/mod.d/#{modname}.load" - ) } - it { is_expected.to contain_file("#{modname}.conf").with_path( - "/etc/httpd/mod.d/#{modname}.conf" - ) } - end - - context "with Apache version < 2.4" do - let :params do - { :apache_version => '2.2' } - end - - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^Include "/etc/httpd/conf\.d/\*\.conf"$} } - end - - context "with Apache version >= 2.4" do - let :params do - { - :apache_version => '2.4', - :use_optional_includes => true - } - end - - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^IncludeOptional "/etc/httpd/conf\.d/\*\.conf"$} } - end - - context "with Apache version < 2.4" do - let :params do - { - :apache_version => '2.2', - :rewrite_lock => '/var/lock/subsys/rewrite-lock' - } - end - - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^RewriteLock /var/lock/subsys/rewrite-lock$} } - end - - context "with Apache version < 2.4" do - let :params do - { - :apache_version => '2.2' - } - end - - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").without_content %r{^RewriteLock [.]*$} } - end - - context "with Apache version >= 2.4" do - let :params do - { - :apache_version => '2.4', - :rewrite_lock => '/var/lock/subsys/rewrite-lock' - } - end - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").without_content %r{^RewriteLock [.]*$} } - end - - context "when specifying slash encoding behaviour" do - let :params do - { :allow_encoded_slashes => 'nodecode' } - end - - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^AllowEncodedSlashes nodecode$} } - end - - context "when specifying default character set" do - let :params do - { :default_charset => 'none' } - end - - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^AddDefaultCharset none$} } - end - - context "with Apache version < 2.4" do - let :params do - { - :apache_version => '2.2', - } - end - - context "when default_type => 'none'" do - let :params do - { :default_type => 'none' } - end - - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^DefaultType none$} } - end - context "when default_type => 'text/plain'" do - let :params do - { :default_type => 'text/plain' } - end - - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^DefaultType text/plain$} } - end - end - - context "with Apache version >= 2.4" do - let :params do - { - :apache_version => '2.4', - } - end - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").without_content %r{^DefaultType [.]*$} } - end - - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^Include "/etc/httpd/site\.d/\*"$} } - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^Include "/etc/httpd/mod\.d/\*\.conf"$} } - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^Include "/etc/httpd/mod\.d/\*\.load"$} } - end - - describe "Alternate conf directory" do - let :params do - { :conf_dir => '/opt/rh/root/etc/httpd/conf' } - end - - it { is_expected.to contain_file("/opt/rh/root/etc/httpd/conf/httpd.conf").with( - 'ensure' => 'file', - 'notify' => 'Class[Apache::Service]', - 'require' => ['Package[httpd]', 'Concat[/etc/httpd/conf/ports.conf]'], - ) } - end - - describe "Alternate conf.d directory" do - let :params do - { :confd_dir => '/etc/httpd/special_conf.d' } - end - - it { is_expected.to contain_file("/etc/httpd/special_conf.d").with( - 'ensure' => 'directory', - 'recurse' => 'true', - 'purge' => 'true', - 'notify' => 'Class[Apache::Service]', - 'require' => 'Package[httpd]' - ) } - end - - describe "Alternate mpm_modules" do - context "when declaring mpm_module is false" do - let :params do - { :mpm_module => false } - end - it 'should not declare mpm modules' do - is_expected.not_to contain_class('apache::mod::event') - is_expected.not_to contain_class('apache::mod::itk') - is_expected.not_to contain_class('apache::mod::peruser') - is_expected.not_to contain_class('apache::mod::prefork') - is_expected.not_to contain_class('apache::mod::worker') - end - end - context "when declaring mpm_module => prefork" do - let :params do - { :mpm_module => 'prefork' } - end - it { is_expected.to contain_class('apache::mod::prefork') } - it { is_expected.not_to contain_class('apache::mod::event') } - it { is_expected.not_to contain_class('apache::mod::itk') } - it { is_expected.not_to contain_class('apache::mod::peruser') } - it { is_expected.not_to contain_class('apache::mod::worker') } - end - context "when declaring mpm_module => worker" do - let :params do - { :mpm_module => 'worker' } - end - it { is_expected.to contain_class('apache::mod::worker') } - it { is_expected.not_to contain_class('apache::mod::event') } - it { is_expected.not_to contain_class('apache::mod::itk') } - it { is_expected.not_to contain_class('apache::mod::peruser') } - it { is_expected.not_to contain_class('apache::mod::prefork') } - end - end - - describe "different templates for httpd.conf" do - context "with default" do - let :params do - { :conf_template => 'apache/httpd.conf.erb' } - end - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^# Security\n} } - end - context "with non-default" do - let :params do - { :conf_template => 'site_apache/fake.conf.erb' } - end - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^Fake template for rspec.$} } - end - end - - describe "default mods" do - context "without" do - let :params do - { :default_mods => false } - end - - it { is_expected.to contain_apache__mod('authz_host') } - it { is_expected.not_to contain_apache__mod('env') } - end - context "custom" do - let :params do - { :default_mods => [ - 'info', - 'alias', - 'mime', - 'env', - 'setenv', - 'expires', - ]} - end - - it { is_expected.to contain_apache__mod('authz_host') } - it { is_expected.to contain_apache__mod('env') } - it { is_expected.to contain_class('apache::mod::info') } - it { is_expected.to contain_class('apache::mod::mime') } - end - end - describe "Don't create user resource" do - context "when parameter manage_user is false" do - let :params do - { :manage_user => false } - end - - it { is_expected.not_to contain_user('apache') } - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^User apache\n} } - end - end - describe "Don't create group resource" do - context "when parameter manage_group is false" do - let :params do - { :manage_group => false } - end - - it { is_expected.not_to contain_group('apache') } - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^Group apache\n} } - - end - end - describe "sendfile" do - context "with invalid value" do - let :params do - { :sendfile => 'foo' } - end - it "should fail" do - expect do - catalogue - end.to raise_error(Puppet::Error, /"foo" does not match/) - end - end - context "On" do - let :params do - { :sendfile => 'On' } - end - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^EnableSendfile On\n} } - end - context "Off" do - let :params do - { :sendfile => 'Off' } - end - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{^EnableSendfile Off\n} } - end - end - context "on Fedora" do - let :facts do - super().merge({ - :operatingsystem => 'Fedora' - }) - end - - context "21" do - let :facts do - super().merge({ - :lsbdistrelease => '21', - :operatingsystemrelease => '21' - }) - end - it { is_expected.to contain_class('apache').with_apache_version('2.4') } - end - context "Rawhide" do - let :facts do - super().merge({ - :lsbdistrelease => 'Rawhide', - :operatingsystemrelease => 'Rawhide' - }) - end - it { is_expected.to contain_class('apache').with_apache_version('2.4') } - end - # kinda obsolete - context "17" do - let :facts do - super().merge({ - :lsbdistrelease => '17', - :operatingsystemrelease => '17' - }) - end - it { is_expected.to contain_class('apache').with_apache_version('2.2') } - end - end - end - context "on a FreeBSD OS" do - let :facts do - { - :id => 'root', - :kernel => 'FreeBSD', - :osfamily => 'FreeBSD', - :operatingsystem => 'FreeBSD', - :operatingsystemrelease => '10', - :concat_basedir => '/dne', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_class("apache::package").with({'ensure' => 'present'}) } - it { is_expected.to contain_user("www") } - it { is_expected.to contain_group("www") } - it { is_expected.to contain_class("apache::service") } - it { is_expected.to contain_file("/usr/local/www/apache24/data").with( - 'ensure' => 'directory' - ) - } - it { is_expected.to contain_file("/usr/local/etc/apache24/Vhosts").with( - 'ensure' => 'directory', - 'recurse' => 'true', - 'purge' => 'true', - 'notify' => 'Class[Apache::Service]', - 'require' => 'Package[httpd]' - ) } - it { is_expected.to contain_file("/usr/local/etc/apache24/Modules").with( - 'ensure' => 'directory', - 'recurse' => 'true', - 'purge' => 'true', - 'notify' => 'Class[Apache::Service]', - 'require' => 'Package[httpd]' - ) } - it { is_expected.to contain_concat("/usr/local/etc/apache24/ports.conf").with( - 'owner' => 'root', - 'group' => 'wheel', - 'mode' => '0644', - 'notify' => 'Class[Apache::Service]' - ) } - # Assert that load files are placed for these mods, but no conf file. - [ - 'auth_basic', - 'authn_core', - 'authn_file', - 'authz_groupfile', - 'authz_host', - 'authz_user', - 'dav', - 'env' - ].each do |modname| - it { is_expected.to contain_file("#{modname}.load").with( - 'path' => "/usr/local/etc/apache24/Modules/#{modname}.load", - 'ensure' => 'file' - ) } - it { is_expected.not_to contain_file("#{modname}.conf") } - end - - # Assert that both load files and conf files are placed for these mods - [ - 'alias', - 'autoindex', - 'dav_fs', - 'deflate', - 'dir', - 'mime', - 'negotiation', - 'setenvif', - ].each do |modname| - it { is_expected.to contain_file("#{modname}.load").with( - 'path' => "/usr/local/etc/apache24/Modules/#{modname}.load", - 'ensure' => 'file' - ) } - it { is_expected.to contain_file("#{modname}.conf").with( - 'path' => "/usr/local/etc/apache24/Modules/#{modname}.conf", - 'ensure' => 'file' - ) } - end - end - context "on a Gentoo OS" do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_user("apache") } - it { is_expected.to contain_group("apache") } - it { is_expected.to contain_class("apache::service") } - it { is_expected.to contain_file("/var/www/localhost/htdocs").with( - 'ensure' => 'directory' - ) - } - it { is_expected.to contain_file("/etc/apache2/vhosts.d").with( - 'ensure' => 'directory', - 'recurse' => 'true', - 'purge' => 'true', - 'notify' => 'Class[Apache::Service]', - 'require' => 'Package[httpd]' - ) } - it { is_expected.to contain_file("/etc/apache2/modules.d").with( - 'ensure' => 'directory', - 'recurse' => 'true', - 'purge' => 'true', - 'notify' => 'Class[Apache::Service]', - 'require' => 'Package[httpd]' - ) } - it { is_expected.to contain_concat("/etc/apache2/ports.conf").with( - 'owner' => 'root', - 'group' => 'wheel', - 'mode' => '0644', - 'notify' => 'Class[Apache::Service]' - ) } - end - context 'on all OSes' do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context 'with a custom apache_name parameter' do - let :params do { - :apache_name => 'httpd24-httpd' - } - end - it { is_expected.to contain_package("httpd").with( - 'notify' => 'Class[Apache::Service]', - 'ensure' => 'installed', - 'name' => 'httpd24-httpd' - ) - } - end - context 'with a custom file_mode parameter' do - let :params do { - :file_mode => '0640' - } - end - it { is_expected.to contain_concat("/etc/httpd/conf/ports.conf").with( - 'mode' => '0640', - ) - } - end - context 'with a custom root_directory_options parameter' do - let :params do { - :root_directory_options => ['-Indexes', '-FollowSymLinks'] - } - end - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{Options -Indexes -FollowSymLinks} } - end - context 'with a custom root_directory_secured parameter and Apache < 2.4' do - let :params do { - :apache_version => '2.2', - :root_directory_secured => true - } - end - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{Options FollowSymLinks\n\s+AllowOverride None\n\s+Order deny,allow\n\s+Deny from all} } - end - context 'with a custom root_directory_secured parameter and Apache >= 2.4' do - let :params do { - :apache_version => '2.4', - :root_directory_secured => true - } - end - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{Options FollowSymLinks\n\s+AllowOverride None\n\s+Require all denied} } - end - context 'default vhost defaults' do - it { is_expected.to contain_apache__vhost('default').with_ensure('present') } - it { is_expected.to contain_apache__vhost('default-ssl').with_ensure('absent') } - it { is_expected.to contain_file("/etc/httpd/conf/httpd.conf").with_content %r{Options FollowSymLinks} } - end - context 'without default non-ssl vhost' do - let :params do { - :default_vhost => false - } - end - it { is_expected.to contain_apache__vhost('default').with_ensure('absent') } - it { is_expected.not_to contain_file('/var/www/html') } - end - context 'with default ssl vhost' do - let :params do { - :default_ssl_vhost => true - } - end - it { is_expected.to contain_apache__vhost('default-ssl').with_ensure('present') } - it { is_expected.to contain_file('/var/www/html') } - end - end - context 'with unsupported osfamily' do - let :facts do - { :osfamily => 'Darwin', - :operatingsystemrelease => '13.1.0', - :concat_basedir => '/dne', - :is_pe => false, - } - end - - it do - expect { - catalogue - }.to raise_error(Puppet::Error, /Unsupported osfamily/) - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/dev_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/dev_spec.rb deleted file mode 100644 index 933d67703..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/dev_spec.rb +++ /dev/null @@ -1,89 +0,0 @@ -require 'spec_helper' - -describe 'apache::dev', :type => :class do - let(:pre_condition) {[ - 'include apache' - ]} - context "on a Debian OS" do - let :facts do - { - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :is_pe => false, - :concat_basedir => '/foo', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin', - :kernel => 'Linux' - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_package("libaprutil1-dev") } - it { is_expected.to contain_package("libapr1-dev") } - it { is_expected.to contain_package("apache2-prefork-dev") } - end - context "on an Ubuntu 14 OS" do - let :facts do - { - :lsbdistrelease => '14.04', - :lsbdistcodename => 'trusty', - :osfamily => 'Debian', - :operatingsystem => 'Ubuntu', - :operatingsystemrelease => '14.04', - :is_pe => false, - :concat_basedir => '/foo', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin', - :kernel => 'Linux' - } - end - it { is_expected.to contain_package("apache2-dev") } - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '6', - :is_pe => false, - :concat_basedir => '/foo', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin', - :kernel => 'Linux' - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_package("httpd-devel") } - end - context "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystem => 'FreeBSD', - :operatingsystemrelease => '9', - :is_pe => false, - :concat_basedir => '/foo', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin', - :kernel => 'FreeBSD' - } - end - it { is_expected.to contain_class("apache::params") } - end - context "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :is_pe => false, - :concat_basedir => '/foo', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin', - :kernel => 'Linux' - } - end - it { is_expected.to contain_class("apache::params") } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/alias_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/alias_spec.rb deleted file mode 100644 index 99854e818..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/alias_spec.rb +++ /dev/null @@ -1,97 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::alias', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "default configuration with parameters" do - context "on a Debian OS", :compile do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - it { is_expected.to contain_apache__mod("alias") } - it { is_expected.to contain_file("alias.conf").with(:content => /Alias \/icons\/ "\/usr\/share\/apache2\/icons\/"/) } - end - context "on a RedHat 6-based OS", :compile do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - it { is_expected.to contain_apache__mod("alias") } - it { is_expected.to contain_file("alias.conf").with(:content => /Alias \/icons\/ "\/var\/www\/icons\/"/) } - end - context "on a RedHat 7-based OS", :compile do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '7', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - it { is_expected.to contain_apache__mod("alias") } - it { is_expected.to contain_file("alias.conf").with(:content => /Alias \/icons\/ "\/usr\/share\/httpd\/icons\/"/) } - end - context "with icons options", :compile do - let :pre_condition do - 'class { apache: default_mods => false }' - end - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '7', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - let :params do - { - 'icons_options' => 'foo' - } - end - it { is_expected.to contain_apache__mod("alias") } - it { is_expected.to contain_file("alias.conf").with(:content => /Options foo/) } - end - context "on a FreeBSD OS", :compile do - let :facts do - { - :id => 'root', - :kernel => 'FreeBSD', - :osfamily => 'FreeBSD', - :operatingsystem => 'FreeBSD', - :operatingsystemrelease => '10', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - it { is_expected.to contain_apache__mod("alias") } - it { is_expected.to contain_file("alias.conf").with(:content => /Alias \/icons\/ "\/usr\/local\/www\/apache24\/icons\/"/) } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/auth_cas_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/auth_cas_spec.rb deleted file mode 100644 index aee3f8c29..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/auth_cas_spec.rb +++ /dev/null @@ -1,64 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::auth_cas', :type => :class do - context "default params" do - let :params do - { - :cas_login_url => 'https://cas.example.com/login', - :cas_validate_url => 'https://cas.example.com/validate', - :cas_cookie_path => '/var/cache/apache2/mod_auth_cas/' - } - end - - it_behaves_like "a mod class, without including apache" - end - - context "default configuration with parameters" do - let :params do - { - :cas_login_url => 'https://cas.example.com/login', - :cas_validate_url => 'https://cas.example.com/validate', - } - end - - context "on a Debian OS", :compile do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod("auth_cas") } - it { is_expected.to contain_package("libapache2-mod-auth-cas") } - it { is_expected.to contain_file("auth_cas.conf").with_path('/etc/apache2/mods-available/auth_cas.conf') } - it { is_expected.to contain_file("/var/cache/apache2/mod_auth_cas/").with_owner('www-data') } - end - context "on a RedHat OS", :compile do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod("auth_cas") } - it { is_expected.to contain_package("mod_auth_cas") } - it { is_expected.to contain_file("auth_cas.conf").with_path('/etc/httpd/conf.d/auth_cas.conf') } - it { is_expected.to contain_file("/var/cache/mod_auth_cas/").with_owner('apache') } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/auth_kerb_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/auth_kerb_spec.rb deleted file mode 100644 index 0f77a627e..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/auth_kerb_spec.rb +++ /dev/null @@ -1,106 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::auth_kerb', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "default configuration with parameters" do - context "on a Debian OS", :compile do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod("auth_kerb") } - it { is_expected.to contain_package("libapache2-mod-auth-kerb") } - end - context "on a RedHat OS", :compile do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod("auth_kerb") } - it { is_expected.to contain_package("mod_auth_kerb") } - end - context "on a FreeBSD OS", :compile do - let :facts do - { - :id => 'root', - :kernel => 'FreeBSD', - :osfamily => 'FreeBSD', - :operatingsystem => 'FreeBSD', - :operatingsystemrelease => '9', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod("auth_kerb") } - it { is_expected.to contain_package("www/mod_auth_kerb2") } - end - context "on a Gentoo OS", :compile do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod("auth_kerb") } - it { is_expected.to contain_package("www-apache/mod_auth_kerb") } - end - end - context "overriding mod_packages" do - context "on a RedHat OS", :compile do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - let :pre_condition do - <<-EOS - include apache::params - class { 'apache': - mod_packages => merge($::apache::params::mod_packages, { - 'auth_kerb' => 'httpd24-mod_auth_kerb', - }) - } - EOS - end - it { is_expected.to contain_apache__mod("auth_kerb") } - it { is_expected.to contain_package("httpd24-mod_auth_kerb") } - it { is_expected.to_not contain_package("mod_auth_kerb") } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/auth_mellon_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/auth_mellon_spec.rb deleted file mode 100644 index 7d0826ff7..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/auth_mellon_spec.rb +++ /dev/null @@ -1,90 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::auth_mellon', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "default configuration with parameters" do - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :fqdn => 'test.example.com', - :is_pe => false, - } - end - describe 'with no parameters' do - it { should contain_apache__mod('auth_mellon') } - it { should contain_package('libapache2-mod-auth-mellon') } - it { should contain_file('auth_mellon.conf').with_path('/etc/apache2/mods-available/auth_mellon.conf') } - it { should contain_file('auth_mellon.conf').with_content("MellonPostDirectory \"\/var\/cache\/apache2\/mod_auth_mellon\/\"\n") } - end - describe 'with parameters' do - let :params do - { :mellon_cache_size => '200', - :mellon_cache_entry_size => '2010', - :mellon_lock_file => '/tmp/junk', - :mellon_post_directory => '/tmp/post', - :mellon_post_ttl => '5', - :mellon_post_size => '8', - :mellon_post_count => '10' - } - end - it { should contain_file('auth_mellon.conf').with_content(/^MellonCacheSize\s+200$/) } - it { should contain_file('auth_mellon.conf').with_content(/^MellonCacheEntrySize\s+2010$/) } - it { should contain_file('auth_mellon.conf').with_content(/^MellonLockFile\s+"\/tmp\/junk"$/) } - it { should contain_file('auth_mellon.conf').with_content(/^MellonPostDirectory\s+"\/tmp\/post"$/) } - it { should contain_file('auth_mellon.conf').with_content(/^MellonPostTTL\s+5$/) } - it { should contain_file('auth_mellon.conf').with_content(/^MellonPostSize\s+8$/) } - it { should contain_file('auth_mellon.conf').with_content(/^MellonPostCount\s+10$/) } - end - - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :fqdn => 'test.example.com', - :is_pe => false, - } - end - describe 'with no parameters' do - it { should contain_apache__mod('auth_mellon') } - it { should contain_package('mod_auth_mellon') } - it { should contain_file('auth_mellon.conf').with_path('/etc/httpd/conf.d/auth_mellon.conf') } - it { should contain_file('auth_mellon.conf').with_content("MellonCacheSize 100\nMellonLockFile \"/run/mod_auth_mellon/lock\"\n") } - end - describe 'with parameters' do - let :params do - { :mellon_cache_size => '200', - :mellon_cache_entry_size => '2010', - :mellon_lock_file => '/tmp/junk', - :mellon_post_directory => '/tmp/post', - :mellon_post_ttl => '5', - :mellon_post_size => '8', - :mellon_post_count => '10' - } - end - it { should contain_file('auth_mellon.conf').with_content(/^MellonCacheSize\s+200$/) } - it { should contain_file('auth_mellon.conf').with_content(/^MellonCacheEntrySize\s+2010$/) } - it { should contain_file('auth_mellon.conf').with_content(/^MellonLockFile\s+"\/tmp\/junk"$/) } - it { should contain_file('auth_mellon.conf').with_content(/^MellonPostDirectory\s+"\/tmp\/post"$/) } - it { should contain_file('auth_mellon.conf').with_content(/^MellonPostTTL\s+5$/) } - it { should contain_file('auth_mellon.conf').with_content(/^MellonPostSize\s+8$/) } - it { should contain_file('auth_mellon.conf').with_content(/^MellonPostCount\s+10$/) } - end - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/authn_dbd_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/authn_dbd_spec.rb deleted file mode 100644 index 4e101d1b5..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/authn_dbd_spec.rb +++ /dev/null @@ -1,62 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::authn_dbd', :type => :class do - context "default params" do - let :params do - { - :authn_dbd_params => 'host=db_host port=3306 user=apache password=###### dbname=apache_auth', - } - end - - it_behaves_like "a mod class, without including apache" - end - - context "default configuration with parameters" do - let :params do - { - :authn_dbd_params => 'host=db_host port=3306 user=apache password=###### dbname=apache_auth', - :authn_dbd_alias => 'db_authn', - :authn_dbd_query => 'SELECT password FROM authn WHERE username = %s' - } - end - - context "on a Debian OS", :compile do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod("authn_dbd") } - it { is_expected.to contain_apache__mod("dbd") } - it { is_expected.to contain_file("authn_dbd.conf").with_path('/etc/apache2/mods-available/authn_dbd.conf') } - end - - context "on a RedHat OS", :compile do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod("authn_dbd") } - it { is_expected.to contain_apache__mod("dbd") } - it { is_expected.to contain_file("authn_dbd.conf").with_path('/etc/httpd/conf.d/authn_dbd.conf') } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/authnz_ldap_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/authnz_ldap_spec.rb deleted file mode 100644 index 7469d165e..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/authnz_ldap_spec.rb +++ /dev/null @@ -1,76 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::authnz_ldap', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "default configuration with parameters" do - context "on a Debian OS" do - let :facts do - { - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :operatingsystem => 'Debian', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_class("apache::mod::ldap") } - it { is_expected.to contain_apache__mod('authnz_ldap') } - - context 'default verify_server_cert' do - it { is_expected.to contain_file('authnz_ldap.conf').with_content(/^LDAPVerifyServerCert On$/) } - end - - context 'verify_server_cert = false' do - let(:params) { { :verify_server_cert => false } } - it { is_expected.to contain_file('authnz_ldap.conf').with_content(/^LDAPVerifyServerCert Off$/) } - end - - context 'verify_server_cert = wrong' do - let(:params) { { :verify_server_cert => 'wrong' } } - it 'should raise an error' do - expect { is_expected.to raise_error Puppet::Error } - end - end - end #Debian - - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :operatingsystem => 'RedHat', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_class("apache::mod::ldap") } - it { is_expected.to contain_apache__mod('authnz_ldap') } - - context 'default verify_server_cert' do - it { is_expected.to contain_file('authnz_ldap.conf').with_content(/^LDAPVerifyServerCert On$/) } - end - - context 'verify_server_cert = false' do - let(:params) { { :verify_server_cert => false } } - it { is_expected.to contain_file('authnz_ldap.conf').with_content(/^LDAPVerifyServerCert Off$/) } - end - - context 'verify_server_cert = wrong' do - let(:params) { { :verify_server_cert => 'wrong' } } - it 'should raise an error' do - expect { is_expected.to raise_error Puppet::Error } - end - end - end # Redhat - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/authnz_pam_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/authnz_pam_spec.rb deleted file mode 100644 index 4bceeab85..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/authnz_pam_spec.rb +++ /dev/null @@ -1,44 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::authnz_pam', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "default configuration with parameters" do - context "on a Debian OS" do - let :facts do - { - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :operatingsystem => 'Debian', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache") } - it { is_expected.to contain_package("libapache2-mod-authnz-pam") } - it { is_expected.to contain_apache__mod('authnz_pam') } - end #Debian - - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :operatingsystem => 'RedHat', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache") } - it { is_expected.to contain_package("mod_authnz_pam") } - it { is_expected.to contain_apache__mod('authnz_pam') } - end # Redhat - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/cluster_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/cluster_spec.rb deleted file mode 100644 index b5f74bac7..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/cluster_spec.rb +++ /dev/null @@ -1,105 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::cluster', :type => :class do - context 'on a RedHat OS Release 7 with mod version = 1.3.0' do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '7', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - let(:params) { - { - :allowed_network => '172.17.0', - :balancer_name => 'mycluster', - :ip => '172.17.0.1', - :version => '1.3.0' - } - } - - it { is_expected.to contain_class("apache") } - it { is_expected.to contain_apache__mod('proxy') } - it { is_expected.to contain_apache__mod('proxy_ajp') } - it { is_expected.to contain_apache__mod('manager') } - it { is_expected.to contain_apache__mod('proxy_cluster') } - it { is_expected.to contain_apache__mod('advertise') } - it { is_expected.to contain_apache__mod('cluster_slotmem') } - - it { is_expected.to contain_file('cluster.conf') } - end - - context 'on a RedHat OS Release 7 with mod version > 1.3.0' do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '7', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - let(:params) { - { - :allowed_network => '172.17.0', - :balancer_name => 'mycluster', - :ip => '172.17.0.1', - :version => '1.3.1' - } - } - - it { is_expected.to contain_class('apache') } - it { is_expected.to contain_apache__mod('proxy') } - it { is_expected.to contain_apache__mod('proxy_ajp') } - it { is_expected.to contain_apache__mod('manager') } - it { is_expected.to contain_apache__mod('proxy_cluster') } - it { is_expected.to contain_apache__mod('advertise') } - it { is_expected.to contain_apache__mod('cluster_slotmem') } - - it { is_expected.to contain_file('cluster.conf') } - end - - context 'on a RedHat OS Release 6 with mod version < 1.3.0' do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - let(:params) { - { - :allowed_network => '172.17.0', - :balancer_name => 'mycluster', - :ip => '172.17.0.1', - :version => '1.2.0' - } - } - - it { is_expected.to contain_class('apache') } - it { is_expected.to contain_apache__mod('proxy') } - it { is_expected.to contain_apache__mod('proxy_ajp') } - it { is_expected.to contain_apache__mod('manager') } - it { is_expected.to contain_apache__mod('proxy_cluster') } - it { is_expected.to contain_apache__mod('advertise') } - it { is_expected.to contain_apache__mod('slotmem') } - - it { is_expected.to contain_file('cluster.conf') } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/dav_svn_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/dav_svn_spec.rb deleted file mode 100644 index 426b547f2..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/dav_svn_spec.rb +++ /dev/null @@ -1,80 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::dav_svn', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "default configuration with parameters" do - context "on a Debian OS" do - let :facts do - { - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :operatingsystemmajrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('dav_svn') } - it { is_expected.to contain_package("libapache2-svn") } - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :operatingsystemmajrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('dav_svn') } - it { is_expected.to contain_package("mod_dav_svn") } - end - context "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :operatingsystemmajrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('dav_svn') } - it { is_expected.to contain_package("devel/subversion") } - end - context "on a Gentoo OS", :compile do - let :facts do - { - :id => 'root', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :kernel => 'Linux', - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('dav_svn') } - it { is_expected.to contain_package("dev-vcs/subversion") } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/deflate_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/deflate_spec.rb deleted file mode 100644 index 264c70f36..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/deflate_spec.rb +++ /dev/null @@ -1,127 +0,0 @@ -require 'spec_helper' - -# This function is called inside the OS specific contexts -def general_deflate_specs - it { is_expected.to contain_apache__mod("deflate") } - - it do - is_expected.to contain_file("deflate.conf").with_content( - "AddOutputFilterByType DEFLATE text/css\n"\ - "AddOutputFilterByType DEFLATE text/html\n"\ - "\n"\ - "DeflateFilterNote Input instream\n"\ - "DeflateFilterNote Ratio ratio\n" - ) - end -end - -describe 'apache::mod::deflate', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "default configuration with parameters" do - let :pre_condition do - 'class { "apache::mod::deflate": - types => [ "text/html", "text/css" ], - notes => { - "Input" => "instream", - "Ratio" => "ratio", - } - } - ' - end - - context "On a Debian OS with default params" do - let :facts do - { - :id => 'root', - :lsbdistcodename => 'squeeze', - :kernel => 'Linux', - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - - # Load the more generic tests for this context - general_deflate_specs() - - it { is_expected.to contain_file("deflate.conf").with({ - :ensure => 'file', - :path => '/etc/apache2/mods-available/deflate.conf', - } ) } - it { is_expected.to contain_file("deflate.conf symlink").with({ - :ensure => 'link', - :path => '/etc/apache2/mods-enabled/deflate.conf', - } ) } - end - - context "on a RedHat OS with default params" do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - - # Load the more generic tests for this context - general_deflate_specs() - - it { is_expected.to contain_file("deflate.conf").with_path("/etc/httpd/conf.d/deflate.conf") } - end - - context "On a FreeBSD OS with default params" do - let :facts do - { - :id => 'root', - :kernel => 'FreeBSD', - :osfamily => 'FreeBSD', - :operatingsystem => 'FreeBSD', - :operatingsystemrelease => '9', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - - # Load the more generic tests for this context - general_deflate_specs() - - it { is_expected.to contain_file("deflate.conf").with({ - :ensure => 'file', - :path => '/usr/local/etc/apache24/Modules/deflate.conf', - } ) } - end - - context "On a Gentoo OS with default params" do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :is_pe => false, - } - end - - # Load the more generic tests for this context - general_deflate_specs() - - it { is_expected.to contain_file("deflate.conf").with({ - :ensure => 'file', - :path => '/etc/apache2/modules.d/deflate.conf', - } ) } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/dev_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/dev_spec.rb deleted file mode 100644 index 4c9f324b3..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/dev_spec.rb +++ /dev/null @@ -1,32 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::dev', :type => :class do - let(:pre_condition) {[ - 'include apache' - ]} - - it_behaves_like "a mod class, without including apache" - - [ - ['RedHat', '6', 'Santiago', 'Linux'], - ['Debian', '6', 'squeeze', 'Linux'], - ['FreeBSD', '9', 'FreeBSD', 'FreeBSD'], - ].each do |osfamily, operatingsystemrelease, lsbdistcodename, kernel| - context "on a #{osfamily} OS" do - let :facts do - { - :lsbdistcodename => lsbdistcodename, - :osfamily => osfamily, - :operatingsystem => osfamily, - :operatingsystemrelease => operatingsystemrelease, - :is_pe => false, - :concat_basedir => '/foo', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin', - :kernel => kernel - } - end - it { is_expected.to contain_class('apache::dev') } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/dir_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/dir_spec.rb deleted file mode 100644 index 9aad0d3ff..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/dir_spec.rb +++ /dev/null @@ -1,137 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::dir', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "default configuration with parameters" do - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :lsbdistcodename => 'squeeze', - :is_pe => false, - } - end - context "passing no parameters" do - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('dir') } - it { is_expected.to contain_file('dir.conf').with_content(/^DirectoryIndex /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.html /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.html\.var /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.cgi /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.pl /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.php /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.xhtml$/) } - end - context "passing indexes => ['example.txt','fearsome.aspx']" do - let :params do - {:indexes => ['example.txt','fearsome.aspx']} - end - it { is_expected.to contain_file('dir.conf').with_content(/ example\.txt /) } - it { is_expected.to contain_file('dir.conf').with_content(/ fearsome\.aspx$/) } - end - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'Redhat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context "passing no parameters" do - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('dir') } - it { is_expected.to contain_file('dir.conf').with_content(/^DirectoryIndex /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.html /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.html\.var /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.cgi /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.pl /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.php /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.xhtml$/) } - end - context "passing indexes => ['example.txt','fearsome.aspx']" do - let :params do - {:indexes => ['example.txt','fearsome.aspx']} - end - it { is_expected.to contain_file('dir.conf').with_content(/ example\.txt /) } - it { is_expected.to contain_file('dir.conf').with_content(/ fearsome\.aspx$/) } - end - end - context "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context "passing no parameters" do - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('dir') } - it { is_expected.to contain_file('dir.conf').with_content(/^DirectoryIndex /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.html /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.html\.var /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.cgi /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.pl /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.php /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.xhtml$/) } - end - context "passing indexes => ['example.txt','fearsome.aspx']" do - let :params do - {:indexes => ['example.txt','fearsome.aspx']} - end - it { is_expected.to contain_file('dir.conf').with_content(/ example\.txt /) } - it { is_expected.to contain_file('dir.conf').with_content(/ fearsome\.aspx$/) } - end - end - context "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - context "passing no parameters" do - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('dir') } - it { is_expected.to contain_file('dir.conf').with_content(/^DirectoryIndex /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.html /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.html\.var /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.cgi /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.pl /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.php /) } - it { is_expected.to contain_file('dir.conf').with_content(/ index\.xhtml$/) } - end - context "passing indexes => ['example.txt','fearsome.aspx']" do - let :params do - {:indexes => ['example.txt','fearsome.aspx']} - end - it { is_expected.to contain_file('dir.conf').with_content(/ example\.txt /) } - it { is_expected.to contain_file('dir.conf').with_content(/ fearsome\.aspx$/) } - end - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/disk_cache_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/disk_cache_spec.rb deleted file mode 100644 index ebb5ef6a9..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/disk_cache_spec.rb +++ /dev/null @@ -1,125 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::disk_cache', :type => :class do - context "on a Debian OS" do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - context "with Apache version < 2.4" do - let :pre_condition do - 'class{ "apache": - apache_version => "2.2", - default_mods => ["cache"], - mod_dir => "/tmp/junk", - }' - end - it { should compile } - it { should contain_class('apache::mod::disk_cache') } - it { is_expected.to contain_apache__mod("disk_cache") } - it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/apache2\/mod_disk_cache\"\nCacheDirLevels 2\nCacheDirLength 1/) } - end - context "with Apache version >= 2.4" do - let :pre_condition do - 'class{ "apache": - apache_version => "2.4", - default_mods => ["cache"], - mod_dir => "/tmp/junk", - }' - end - it { should compile } - it { should contain_class('apache::mod::disk_cache') } - it { should contain_class('apache::mod::cache').that_comes_before('Class[Apache::Mod::Disk_cache]') } - it { is_expected.to contain_apache__mod("cache_disk") } - it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/apache2\/mod_cache_disk\"\nCacheDirLevels 2\nCacheDirLength 1/) } - end - end - - context "on a RedHat 6-based OS" do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - context "with Apache version < 2.4" do - let :pre_condition do - 'class{ "apache": - apache_version => "2.2", - default_mods => ["cache"], - mod_dir => "/tmp/junk", - }' - end - it { is_expected.to contain_apache__mod("disk_cache") } - it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/mod_proxy\"\nCacheDirLevels 2\nCacheDirLength 1/) } - end - context "with Apache version >= 2.4" do - let :pre_condition do - 'class{ "apache": - apache_version => "2.4", - default_mods => ["cache"], - mod_dir => "/tmp/junk", - }' - end - it { is_expected.to contain_apache__mod("cache_disk") } - it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/httpd\/proxy\"\nCacheDirLevels 2\nCacheDirLength 1/) } - end - end - context "on a FreeBSD OS" do - let :facts do - { - :id => 'root', - :kernel => 'FreeBSD', - :osfamily => 'FreeBSD', - :operatingsystem => 'FreeBSD', - :operatingsystemrelease => '10', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - context "with Apache version < 2.4" do - let :pre_condition do - 'class{ "apache": - apache_version => "2.2", - default_mods => ["cache"], - mod_dir => "/tmp/junk", - }' - end - it { should compile } - it { should contain_class('apache::mod::disk_cache') } - it { should contain_class('apache::mod::cache').that_comes_before('Class[Apache::Mod::Disk_cache]') } - it { is_expected.to contain_apache__mod("disk_cache") } - it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/mod_disk_cache\"\nCacheDirLevels 2\nCacheDirLength 1/) } - end - context "with Apache version >= 2.4" do - let :pre_condition do - 'class{ "apache": - apache_version => "2.4", - default_mods => ["cache"], - mod_dir => "/tmp/junk", - }' - end - it { should compile } - it { should contain_class('apache::mod::disk_cache') } - it { should contain_class('apache::mod::cache').that_comes_before('Class[Apache::Mod::Disk_cache]') } - it { is_expected.to contain_apache__mod("cache_disk") } - it { is_expected.to contain_file("disk_cache.conf").with(:content => /CacheEnable disk \/\nCacheRoot \"\/var\/cache\/mod_cache_disk\"\nCacheDirLevels 2\nCacheDirLength 1/) } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/dumpio_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/dumpio_spec.rb deleted file mode 100644 index 106b23af0..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/dumpio_spec.rb +++ /dev/null @@ -1,51 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::dumpio', :type => :class do - context "on a Debian OS" do - let :pre_condition do - 'class{"apache": - default_mods => false, - mod_dir => "/tmp/junk", - }' - end - let :facts do - { - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :operatingsystemmajrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context "default configuration fore parameters" do - it { should compile } - it { should contain_class('apache::mod::dumpio') } - it { should contain_file("dumpio.conf").with_path("/tmp/junk/dumpio.conf") } - it { should contain_file("dumpio.conf").with_content(/^\s*DumpIOInput\s+"Off"$/)} - it { should contain_file("dumpio.conf").with_content(/^\s*DumpIOOutput\s+"Off"$/)} - end - context "with dumpio_input set to On" do - let :params do - { - :dump_io_input => 'On', - } - end - it { should contain_file("dumpio.conf").with_content(/^\s*DumpIOInput\s+"On"$/)} - it { should contain_file("dumpio.conf").with_content(/^\s*DumpIOOutput\s+"Off"$/)} - end - context "with dumpio_ouput set to On" do - let :params do - { - :dump_io_output => 'On', - } - end - it { should contain_file("dumpio.conf").with_content(/^\s*DumpIOInput\s+"Off"$/)} - it { should contain_file("dumpio.conf").with_content(/^\s*DumpIOOutput\s+"On"$/)} - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/event_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/event_spec.rb deleted file mode 100644 index b010d4c02..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/event_spec.rb +++ /dev/null @@ -1,214 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::event', :type => :class do - let :pre_condition do - 'class { "apache": mpm_module => false, }' - end - context "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('event') } - it { is_expected.to contain_file("/usr/local/etc/apache24/Modules/event.conf").with_ensure('file') } - end - context "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('event') } - it { is_expected.to contain_file("/etc/apache2/modules.d/event.conf").with_ensure('file') } - end - context "on a Debian OS" do - let :facts do - { - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('event') } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file') } - it { is_expected.to contain_file("/etc/apache2/mods-enabled/event.conf").with_ensure('link') } - - context "Test mpm_event new params" do - let :params do - { - :serverlimit => '0', - :startservers => '1', - :maxclients => '2', - :minsparethreads => '3', - :maxsparethreads => '4', - :threadsperchild => '5', - :maxrequestsperchild => '6', - :threadlimit => '7', - :listenbacklog => '8', - :maxrequestworkers => '9', - :maxconnectionsperchild => '10', - } - end - - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*ServerLimit\s*0/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*StartServers\s*1/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*MaxClients/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*MinSpareThreads\s*3/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*MaxSpareThreads\s*4/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*ThreadsPerChild\s*5/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*MaxRequestsPerChild/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*ThreadLimit\s*7/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*ListenBacklog\s*8/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*MaxRequestWorkers\s*9/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*MaxConnectionsPerChild\s*10/) } - end - - context "Test mpm_event old style params" do - let :params do - { - :serverlimit => '0', - :startservers => '1', - :maxclients => '2', - :minsparethreads => '3', - :maxsparethreads => '4', - :threadsperchild => '5', - :maxrequestsperchild => '6', - :threadlimit => '7', - :listenbacklog => '8', - :maxrequestworkers => :undef, - :maxconnectionsperchild => :undef, - } - end - - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*ServerLimit\s*0/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*StartServers\s*1/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*MaxClients\s*2/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*MinSpareThreads\s*3/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*MaxSpareThreads\s*4/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*ThreadsPerChild\s*5/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*MaxRequestsPerChild\s*6/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*ThreadLimit\s*7/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').with_content(/^\s*ListenBacklog\s*8/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*MaxRequestWorkers/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*MaxConnectionsPerChild/) } - end - - context "Test mpm_event false params" do - let :params do - { - :serverlimit => false, - :startservers => false, - :maxclients => false, - :minsparethreads => false, - :maxsparethreads => false, - :threadsperchild => false, - :maxrequestsperchild => false, - :threadlimit => false, - :listenbacklog => false, - :maxrequestworkers => false, - :maxconnectionsperchild => false, - } - end - - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*ServerLimit/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*StartServers/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*MaxClients/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*MinSpareThreads/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*MaxSpareThreads/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*ThreadsPerChild/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*MaxRequestsPerChild/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*ThreadLimit/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*ListenBacklog/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*MaxRequestWorkers/) } - it { is_expected.to contain_file("/etc/apache2/mods-available/event.conf").with_ensure('file').without_content(/^\s*MaxConnectionsPerChild/) } - end - - context "with Apache version < 2.4" do - let :params do - { - :apache_version => '2.2', - } - end - - it { is_expected.not_to contain_file("/etc/apache2/mods-available/event.load") } - it { is_expected.not_to contain_file("/etc/apache2/mods-enabled/event.load") } - - it { is_expected.to contain_package("apache2-mpm-event") } - end - - context "with Apache version >= 2.4" do - let :params do - { - :apache_version => '2.4', - } - end - - it { is_expected.to contain_file("/etc/apache2/mods-available/event.load").with({ - 'ensure' => 'file', - 'content' => "LoadModule mpm_event_module /usr/lib/apache2/modules/mod_mpm_event.so\n" - }) - } - it { is_expected.to contain_file("/etc/apache2/mods-enabled/event.load").with_ensure('link') } - end - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - context "with Apache version >= 2.4" do - let :params do - { - :apache_version => '2.4', - } - end - - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('worker') } - it { is_expected.not_to contain_apache__mod('prefork') } - - it { is_expected.to contain_file("/etc/httpd/conf.d/event.conf").with_ensure('file') } - - it { is_expected.to contain_file("/etc/httpd/conf.d/event.load").with({ - 'ensure' => 'file', - 'content' => "LoadModule mpm_event_module modules/mod_mpm_event.so\n", - }) - } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/expires_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/expires_spec.rb deleted file mode 100644 index 397fee024..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/expires_spec.rb +++ /dev/null @@ -1,83 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::expires', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "with expires active", :compile do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - it { is_expected.to contain_apache__mod("expires") } - it { is_expected.to contain_file("expires.conf").with(:content => /ExpiresActive On\n/) } - end - context "with expires default", :compile do - let :pre_condition do - 'class { apache: default_mods => false }' - end - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '7', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - let :params do - { - 'expires_default' => 'access plus 1 month' - } - end - it { is_expected.to contain_apache__mod("expires") } - it { is_expected.to contain_file("expires.conf").with_content( - "ExpiresActive On\n" \ - "ExpiresDefault \"access plus 1 month\"\n" - ) - } - end - context "with expires by type", :compile do - let :pre_condition do - 'class { apache: default_mods => false }' - end - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '7', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - } - end - let :params do - { - 'expires_by_type' => [ - { 'text/json' => 'mod plus 1 day' }, - { 'text/html' => 'access plus 1 year' }, - ] - } - end - it { is_expected.to contain_apache__mod("expires") } - it { is_expected.to contain_file("expires.conf").with_content( - "ExpiresActive On\n" \ - "ExpiresByType text/json \"mod plus 1 day\"\n" \ - "ExpiresByType text/html \"access plus 1 year\"\n" - ) - } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/ext_filter_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/ext_filter_spec.rb deleted file mode 100644 index a0cf37cec..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/ext_filter_spec.rb +++ /dev/null @@ -1,64 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::ext_filter', :type => :class do - it_behaves_like "a mod class, without including apache" - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :fqdn => 'test.example.com', - :is_pe => false, - } - end - describe 'with no parameters' do - it { is_expected.to contain_apache__mod('ext_filter') } - it { is_expected.not_to contain_file('ext_filter.conf') } - end - describe 'with parameters' do - let :params do - { :ext_filter_define => {'filtA' => 'input=A output=B', - 'filtB' => 'input=C cmd="C"' }, - } - end - it { is_expected.to contain_file('ext_filter.conf').with_content(/^ExtFilterDefine\s+filtA\s+input=A output=B$/) } - it { is_expected.to contain_file('ext_filter.conf').with_content(/^ExtFilterDefine\s+filtB\s+input=C cmd="C"$/) } - end - - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :fqdn => 'test.example.com', - :is_pe => false, - } - end - describe 'with no parameters' do - it { is_expected.to contain_apache__mod('ext_filter') } - it { is_expected.not_to contain_file('ext_filter.conf') } - end - describe 'with parameters' do - let :params do - { :ext_filter_define => {'filtA' => 'input=A output=B', - 'filtB' => 'input=C cmd="C"' }, - } - end - it { is_expected.to contain_file('ext_filter.conf').with_path('/etc/httpd/conf.d/ext_filter.conf') } - it { is_expected.to contain_file('ext_filter.conf').with_content(/^ExtFilterDefine\s+filtA\s+input=A output=B$/) } - it { is_expected.to contain_file('ext_filter.conf').with_content(/^ExtFilterDefine\s+filtB\s+input=C cmd="C"$/) } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/fastcgi_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/fastcgi_spec.rb deleted file mode 100644 index 778d27cff..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/fastcgi_spec.rb +++ /dev/null @@ -1,43 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::fastcgi', :type => :class do - it_behaves_like "a mod class, without including apache" - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('fastcgi') } - it { is_expected.to contain_package("libapache2-mod-fastcgi") } - it { is_expected.to contain_file('fastcgi.conf') } - end - - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('fastcgi') } - it { is_expected.to contain_package("mod_fastcgi") } - it { is_expected.not_to contain_file('fastcgi.conf') } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/fcgid_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/fcgid_spec.rb deleted file mode 100644 index f08596be6..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/fcgid_spec.rb +++ /dev/null @@ -1,141 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::fcgid', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :operatingsystemmajrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('fcgid').with({ - 'loadfile_name' => nil - }) } - it { is_expected.to contain_package("libapache2-mod-fcgid") } - end - - context "on a RHEL6" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :operatingsystemmajrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - describe 'without parameters' do - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('fcgid').with({ - 'loadfile_name' => nil - }) } - it { is_expected.to contain_package("mod_fcgid") } - end - - describe 'with parameters' do - let :params do { - :options => { - 'FcgidIPCDir' => '/var/run/fcgidsock', - 'SharememPath' => '/var/run/fcgid_shm', - 'FcgidMinProcessesPerClass' => '0', - 'AddHandler' => 'fcgid-script .fcgi', - } - } end - - it 'should contain the correct config' do - content = catalogue.resource('file', 'fcgid.conf').send(:parameters)[:content] - expect(content.split("\n").reject { |c| c =~ /(^#|^$)/ }).to eq([ - '', - ' AddHandler fcgid-script .fcgi', - ' FcgidIPCDir /var/run/fcgidsock', - ' FcgidMinProcessesPerClass 0', - ' SharememPath /var/run/fcgid_shm', - '', - ]) - end - end - end - - context "on RHEL7" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '7', - :operatingsystemmajrelease => '7', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - describe 'without parameters' do - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('fcgid').with({ - 'loadfile_name' => 'unixd_fcgid.load' - }) } - it { is_expected.to contain_package("mod_fcgid") } - end - end - - context "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '10', - :operatingsystemmajrelease => '10', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('fcgid').with({ - 'loadfile_name' => 'unixd_fcgid.load' - }) } - it { is_expected.to contain_package("www/mod_fcgid") } - end - - context "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('fcgid').with({ - 'loadfile_name' => nil, - }) } - it { is_expected.to contain_package("www-apache/mod_fcgid") } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/info_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/info_spec.rb deleted file mode 100644 index 766a9e4fd..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/info_spec.rb +++ /dev/null @@ -1,222 +0,0 @@ -require 'spec_helper' - -# This function is called inside the OS specific contexts -def general_info_specs_22 - it { is_expected.to contain_apache__mod('info') } - - context 'passing no parameters' do - it { - is_expected.to contain_file('info.conf').with_content( - "\n"\ - " SetHandler server-info\n"\ - " Order deny,allow\n"\ - " Deny from all\n"\ - " Allow from 127.0.0.1\n"\ - " Allow from ::1\n"\ - "\n" - ) - } - end - context 'passing restrict_access => false' do - let :params do { - :restrict_access => false - } - end - it { - is_expected.to contain_file('info.conf').with_content( - "\n"\ - " SetHandler server-info\n"\ - "\n" - ) - } - end - context "passing allow_from => ['10.10.1.2', '192.168.1.2', '127.0.0.1']" do - let :params do - {:allow_from => ['10.10.1.2', '192.168.1.2', '127.0.0.1']} - end - it { - is_expected.to contain_file('info.conf').with_content( - "\n"\ - " SetHandler server-info\n"\ - " Order deny,allow\n"\ - " Deny from all\n"\ - " Allow from 10.10.1.2\n"\ - " Allow from 192.168.1.2\n"\ - " Allow from 127.0.0.1\n"\ - "\n" - ) - } - end - context 'passing both restrict_access and allow_from' do - let :params do - { - :restrict_access => false, - :allow_from => ['10.10.1.2', '192.168.1.2', '127.0.0.1'] - } - end - it { - is_expected.to contain_file('info.conf').with_content( - "\n"\ - " SetHandler server-info\n"\ - "\n" - ) - } - end -end - -def general_info_specs_24 - it { is_expected.to contain_apache__mod('info') } - - context 'passing no parameters' do - it { - is_expected.to contain_file('info.conf').with_content( - "\n"\ - " SetHandler server-info\n"\ - " Require ip 127.0.0.1 ::1\n"\ - "\n" - ) - } - end - context 'passing restrict_access => false' do - let :params do { - :restrict_access => false - } - end - it { - is_expected.to contain_file('info.conf').with_content( - "\n"\ - " SetHandler server-info\n"\ - "\n" - ) - } - end - context "passing allow_from => ['10.10.1.2', '192.168.1.2', '127.0.0.1']" do - let :params do - {:allow_from => ['10.10.1.2', '192.168.1.2', '127.0.0.1']} - end - it { - is_expected.to contain_file('info.conf').with_content( - "\n"\ - " SetHandler server-info\n"\ - " Require ip 10.10.1.2 192.168.1.2 127.0.0.1\n"\ - "\n" - ) - } - end - context 'passing both restrict_access and allow_from' do - let :params do - { - :restrict_access => false, - :allow_from => ['10.10.1.2', '192.168.1.2', '127.0.0.1'] - } - end - it { - is_expected.to contain_file('info.conf').with_content( - "\n"\ - " SetHandler server-info\n"\ - "\n" - ) - } - end -end - -describe 'apache::mod::info', :type => :class do - it_behaves_like "a mod class, without including apache" - - context 'On a Debian OS' do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - # Load the more generic tests for this context - general_info_specs_22() - - it { is_expected.to contain_file('info.conf').with({ - :ensure => 'file', - :path => '/etc/apache2/mods-available/info.conf', - } ) } - it { is_expected.to contain_file('info.conf symlink').with({ - :ensure => 'link', - :path => '/etc/apache2/mods-enabled/info.conf', - } ) } - end - - context 'on a RedHat OS' do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - # Load the more generic tests for this context - general_info_specs_22() - - it { is_expected.to contain_file('info.conf').with({ - :ensure => 'file', - :path => '/etc/httpd/conf.d/info.conf', - } ) } - end - - context 'on a FreeBSD OS' do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '10', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - # Load the more generic tests for this context - general_info_specs_24() - - it { is_expected.to contain_file('info.conf').with({ - :ensure => 'file', - :path => '/usr/local/etc/apache24/Modules/info.conf', - } ) } - end - - context 'on a Gentoo OS' do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - - # Load the more generic tests for this context - general_info_specs_24() - - it { is_expected.to contain_file('info.conf').with({ - :ensure => 'file', - :path => '/etc/apache2/modules.d/info.conf', - } ) } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/intercept_form_submit_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/intercept_form_submit_spec.rb deleted file mode 100644 index 14a91fcee..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/intercept_form_submit_spec.rb +++ /dev/null @@ -1,44 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::intercept_form_submit', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "default configuration with parameters" do - context "on a Debian OS" do - let :facts do - { - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :operatingsystem => 'Debian', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache") } - it { is_expected.to contain_package("libapache2-mod-intercept-form-submit") } - it { is_expected.to contain_apache__mod('intercept_form_submit') } - end #Debian - - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :operatingsystem => 'RedHat', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache") } - it { is_expected.to contain_package("mod_intercept_form_submit") } - it { is_expected.to contain_apache__mod('intercept_form_submit') } - end # Redhat - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/itk_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/itk_spec.rb deleted file mode 100644 index 27369f144..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/itk_spec.rb +++ /dev/null @@ -1,130 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::itk', :type => :class do - let :pre_condition do - 'class { "apache": mpm_module => false, }' - end - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('itk') } - it { is_expected.to contain_file("/etc/apache2/mods-available/itk.conf").with_ensure('file') } - it { is_expected.to contain_file("/etc/apache2/mods-enabled/itk.conf").with_ensure('link') } - - context "with Apache version < 2.4" do - let :params do - { - :apache_version => '2.2', - } - end - - it { is_expected.not_to contain_file("/etc/apache2/mods-available/itk.load") } - it { is_expected.not_to contain_file("/etc/apache2/mods-enabled/itk.load") } - - it { is_expected.to contain_package("apache2-mpm-itk") } - end - - context "with Apache version >= 2.4" do - let :pre_condition do - 'class { "apache": mpm_module => prefork, }' - end - - let :params do - { - :apache_version => '2.4', - } - end - - it { is_expected.to contain_file("/etc/apache2/mods-available/itk.load").with({ - 'ensure' => 'file', - 'content' => "LoadModule mpm_itk_module /usr/lib/apache2/modules/mod_mpm_itk.so\n" - }) - } - it { is_expected.to contain_file("/etc/apache2/mods-enabled/itk.load").with_ensure('link') } - end - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('itk') } - it { is_expected.to contain_file("/etc/httpd/conf.d/itk.conf").with_ensure('file') } - it { is_expected.to contain_package("httpd-itk") } - - context "with Apache version < 2.4" do - let :params do - { - :apache_version => '2.2', - } - end - - it { is_expected.to contain_file_line("/etc/sysconfig/httpd itk enable").with({ - 'require' => 'Package[httpd]', - }) - } - end - - context "with Apache version >= 2.4" do - let :pre_condition do - 'class { "apache": mpm_module => prefork, }' - end - - let :params do - { - :apache_version => '2.4', - } - end - - it { is_expected.to contain_file("/etc/httpd/conf.d/itk.load").with({ - 'ensure' => 'file', - 'content' => "LoadModule mpm_itk_module modules/mod_mpm_itk.so\n" - }) - } - end - end - context "on a FreeBSD OS" do - let :pre_condition do - 'class { "apache": mpm_module => false, }' - end - - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '10', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - :mpm_module => 'itk', - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('itk') } - it { is_expected.to contain_file("/usr/local/etc/apache24/Modules/itk.conf").with_ensure('file') } - it { is_expected.to contain_package("www/mod_mpm_itk") } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/ldap_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/ldap_spec.rb deleted file mode 100644 index 73c51adf2..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/ldap_spec.rb +++ /dev/null @@ -1,86 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::ldap', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "on a Debian OS" do - let :facts do - { - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :operatingsystem => 'Debian', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_class("apache::mod::ldap") } - it { is_expected.to contain_apache__mod('ldap') } - - context 'default ldap_trusted_global_cert_file' do - it { is_expected.to contain_file('ldap.conf').without_content(/^LDAPTrustedGlobalCert/) } - end - - context 'ldap_trusted_global_cert_file param' do - let(:params) { { :ldap_trusted_global_cert_file => 'ca.pem' } } - it { is_expected.to contain_file('ldap.conf').with_content(/^LDAPTrustedGlobalCert CA_BASE64 ca\.pem$/) } - end - - context 'set multiple ldap params' do - let(:params) {{ - :ldap_trusted_global_cert_file => 'ca.pem', - :ldap_trusted_global_cert_type => 'CA_DER', - :ldap_shared_cache_size => '500000', - :ldap_cache_entries => '1024', - :ldap_cache_ttl => '600', - :ldap_opcache_entries => '1024', - :ldap_opcache_ttl => '600' - }} - it { is_expected.to contain_file('ldap.conf').with_content(/^LDAPTrustedGlobalCert CA_DER ca\.pem$/) } - it { is_expected.to contain_file('ldap.conf').with_content(/^LDAPSharedCacheSize 500000$/) } - it { is_expected.to contain_file('ldap.conf').with_content(/^LDAPCacheEntries 1024$/) } - it { is_expected.to contain_file('ldap.conf').with_content(/^LDAPCacheTTL 600$/) } - it { is_expected.to contain_file('ldap.conf').with_content(/^LDAPOpCacheEntries 1024$/) } - it { is_expected.to contain_file('ldap.conf').with_content(/^LDAPOpCacheTTL 600$/) } - end - end #Debian - - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :operatingsystem => 'RedHat', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_class("apache::mod::ldap") } - it { is_expected.to contain_apache__mod('ldap') } - - context 'default ldap_trusted_global_cert_file' do - it { is_expected.to contain_file('ldap.conf').without_content(/^LDAPTrustedGlobalCert/) } - end - - context 'ldap_trusted_global_cert_file param' do - let(:params) { { :ldap_trusted_global_cert_file => 'ca.pem' } } - it { is_expected.to contain_file('ldap.conf').with_content(/^LDAPTrustedGlobalCert CA_BASE64 ca\.pem$/) } - end - - context 'ldap_trusted_global_cert_file and ldap_trusted_global_cert_type params' do - let(:params) {{ - :ldap_trusted_global_cert_file => 'ca.pem', - :ldap_trusted_global_cert_type => 'CA_DER' - }} - it { is_expected.to contain_file('ldap.conf').with_content(/^LDAPTrustedGlobalCert CA_DER ca\.pem$/) } - end - end # Redhat -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/lookup_identity.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/lookup_identity.rb deleted file mode 100644 index a04e2e88e..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/lookup_identity.rb +++ /dev/null @@ -1,44 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::lookup_identity', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "default configuration with parameters" do - context "on a Debian OS" do - let :facts do - { - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :operatingsystem => 'Debian', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache") } - it { is_expected.to contain_package("libapache2-mod-lookup-identity") } - it { is_expected.to contain_apache__mod('lookup_identity') } - end #Debian - - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :operatingsystem => 'RedHat', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache") } - it { is_expected.to contain_package("mod_lookup_identity") } - it { is_expected.to contain_apache__mod('lookup_identity') } - end # Redhat - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/mime_magic_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/mime_magic_spec.rb deleted file mode 100644 index cf8f898aa..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/mime_magic_spec.rb +++ /dev/null @@ -1,110 +0,0 @@ -require 'spec_helper' - -# This function is called inside the OS specific contexts -def general_mime_magic_specs - it { is_expected.to contain_apache__mod("mime_magic") } -end - -describe 'apache::mod::mime_magic', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "On a Debian OS with default params" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - general_mime_magic_specs() - - it do - is_expected.to contain_file("mime_magic.conf").with_content( - "MIMEMagicFile \"/etc/apache2/magic\"\n" - ) - end - - it { is_expected.to contain_file("mime_magic.conf").with({ - :ensure => 'file', - :path => '/etc/apache2/mods-available/mime_magic.conf', - } ) } - it { is_expected.to contain_file("mime_magic.conf symlink").with({ - :ensure => 'link', - :path => '/etc/apache2/mods-enabled/mime_magic.conf', - } ) } - - context "with magic_file => /tmp/Debian_magic" do - let :params do - { :magic_file => "/tmp/Debian_magic" } - end - - it do - is_expected.to contain_file("mime_magic.conf").with_content( - "MIMEMagicFile \"/tmp/Debian_magic\"\n" - ) - end - end - - end - - context "on a RedHat OS with default params" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - general_mime_magic_specs() - - it do - is_expected.to contain_file("mime_magic.conf").with_content( - "MIMEMagicFile \"/etc/httpd/conf/magic\"\n" - ) - end - - it { is_expected.to contain_file("mime_magic.conf").with_path("/etc/httpd/conf.d/mime_magic.conf") } - - end - - context "with magic_file => /tmp/magic" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - let :params do - { :magic_file => "/tmp/magic" } - end - - it do - is_expected.to contain_file("mime_magic.conf").with_content( - "MIMEMagicFile \"/tmp/magic\"\n" - ) - end - end - - -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/mime_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/mime_spec.rb deleted file mode 100644 index b0675a3c0..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/mime_spec.rb +++ /dev/null @@ -1,52 +0,0 @@ -require 'spec_helper' - -# This function is called inside the OS specific conte, :compilexts -def general_mime_specs - it { is_expected.to contain_apache__mod("mime") } -end - -describe 'apache::mod::mime', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "On a Debian OS with default params", :compile do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - general_mime_specs() - - it { is_expected.to contain_file("mime.conf").with_path('/etc/apache2/mods-available/mime.conf') } - - end - - context "on a RedHat OS with default params", :compile do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - general_mime_specs() - - it { is_expected.to contain_file("mime.conf").with_path("/etc/httpd/conf.d/mime.conf") } - - end - -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/negotiation_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/negotiation_spec.rb deleted file mode 100644 index 9dadb7651..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/negotiation_spec.rb +++ /dev/null @@ -1,56 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::negotiation', :type => :class do - it_behaves_like "a mod class, without including apache" - describe "OS independent tests" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :kernel => 'Linux', - :lsbdistcodename => 'squeeze', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - context "default params" do - it { should contain_class("apache") } - it do - should contain_file('negotiation.conf').with( { - :ensure => 'file', - :content => 'LanguagePriority en ca cs da de el eo es et fr he hr it ja ko ltz nl nn no pl pt pt-BR ru sv zh-CN zh-TW -ForceLanguagePriority Prefer Fallback -', - } ) - end - end - - context 'with force_language_priority parameter' do - let :params do - { :force_language_priority => 'Prefer' } - end - it do - should contain_file('negotiation.conf').with( { - :ensure => 'file', - :content => /^ForceLanguagePriority Prefer$/, - } ) - end - end - - context 'with language_priority parameter' do - let :params do - { :language_priority => [ 'en', 'es' ] } - end - it do - should contain_file('negotiation.conf').with( { - :ensure => 'file', - :content => /^LanguagePriority en es$/, - } ) - end - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/pagespeed_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/pagespeed_spec.rb deleted file mode 100644 index 2cbc3d170..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/pagespeed_spec.rb +++ /dev/null @@ -1,51 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::pagespeed', :type => :class do - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('pagespeed') } - it { is_expected.to contain_package("mod-pagespeed-stable") } - - context "when setting additional_configuration to a Hash" do - let :params do { :additional_configuration => { 'Key' => 'Value' } } end - it { is_expected.to contain_file('pagespeed.conf').with_content /Key Value/ } - end - - context "when setting additional_configuration to an Array" do - let :params do { :additional_configuration => [ 'Key Value' ] } end - it { is_expected.to contain_file('pagespeed.conf').with_content /Key Value/ } - end - end - - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('pagespeed') } - it { is_expected.to contain_package("mod-pagespeed-stable") } - it { is_expected.to contain_file('pagespeed.conf') } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/passenger_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/passenger_spec.rb deleted file mode 100644 index 200d45706..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/passenger_spec.rb +++ /dev/null @@ -1,331 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::passenger', :type => :class do - it_behaves_like "a mod class, without including apache" - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :kernel => 'Linux', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('passenger') } - it { is_expected.to contain_package("libapache2-mod-passenger") } - it { is_expected.to contain_file('zpassenger.load').with({ - 'path' => '/etc/apache2/mods-available/zpassenger.load', - }) } - it { is_expected.to contain_file('passenger.conf').with({ - 'path' => '/etc/apache2/mods-available/passenger.conf', - }) } - describe "with passenger_root => '/usr/lib/example'" do - let :params do - { :passenger_root => '/usr/lib/example' } - end - it { is_expected.to contain_file('passenger.conf').with_content(%r{PassengerRoot "/usr/lib/example"}) } - end - describe "with passenger_ruby => /usr/lib/example/ruby" do - let :params do - { :passenger_ruby => '/usr/lib/example/ruby' } - end - it { is_expected.to contain_file('passenger.conf').with_content(%r{PassengerRuby "/usr/lib/example/ruby"}) } - end - describe "with passenger_default_ruby => /usr/lib/example/ruby1.9.3" do - let :params do - { :passenger_ruby => '/usr/lib/example/ruby1.9.3' } - end - it { is_expected.to contain_file('passenger.conf').with_content(%r{PassengerRuby "/usr/lib/example/ruby1.9.3"}) } - end - describe "with passenger_high_performance => on" do - let :params do - { :passenger_high_performance => 'on' } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ PassengerHighPerformance on$/) } - end - describe "with passenger_pool_idle_time => 1200" do - let :params do - { :passenger_pool_idle_time => 1200 } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ PassengerPoolIdleTime 1200$/) } - end - describe "with passenger_max_request_queue_size => 100" do - let :params do - { :passenger_max_request_queue_size => 100 } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ PassengerMaxRequestQueueSize 100$/) } - end - - describe "with passenger_max_requests => 20" do - let :params do - { :passenger_max_requests => 20 } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ PassengerMaxRequests 20$/) } - end - describe "with passenger_spawn_method => direct" do - let :params do - { :passenger_spawn_method => 'direct' } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ PassengerSpawnMethod direct$/) } - end - describe "with passenger_stat_throttle_rate => 10" do - let :params do - { :passenger_stat_throttle_rate => 10 } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ PassengerStatThrottleRate 10$/) } - end - describe "with passenger_max_pool_size => 16" do - let :params do - { :passenger_max_pool_size => 16 } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ PassengerMaxPoolSize 16$/) } - end - describe "with passenger_min_instances => 5" do - let :params do - { :passenger_min_instances => 5 } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ PassengerMinInstances 5$/) } - end - describe "with passenger_max_instances_per_app => 8" do - let :params do - { :passenger_max_instances_per_app => 8 } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ PassengerMaxInstancesPerApp 8$/) } - end - describe "with rack_autodetect => on" do - let :params do - { :rack_autodetect => 'on' } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ RackAutoDetect on$/) } - end - describe "with rails_autodetect => on" do - let :params do - { :rails_autodetect => 'on' } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ RailsAutoDetect on$/) } - end - describe "with passenger_use_global_queue => on" do - let :params do - { :passenger_use_global_queue => 'on' } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ PassengerUseGlobalQueue on$/) } - end - describe "with passenger_app_env => 'foo'" do - let :params do - { :passenger_app_env => 'foo' } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ PassengerAppEnv foo$/) } - end - describe "with passenger_log_file => '/var/log/apache2/passenger.log'" do - let :params do - { :passenger_log_file => '/var/log/apache2/passenger.log' } - end - it { is_expected.to contain_file('passenger.conf').with_content(%r{^ PassengerLogFile /var/log/apache2/passenger.log$}) } - end - describe "with passenger_log_level => 3" do - let :params do - { :passenger_log_level => 3 } - end - it { is_expected.to contain_file('passenger.conf').with_content(%r{^ PassengerLogLevel 3$}) } - end - describe "with mod_path => '/usr/lib/foo/mod_foo.so'" do - let :params do - { :mod_path => '/usr/lib/foo/mod_foo.so' } - end - it { is_expected.to contain_file('zpassenger.load').with_content(/^LoadModule passenger_module \/usr\/lib\/foo\/mod_foo\.so$/) } - end - describe "with mod_lib_path => '/usr/lib/foo'" do - let :params do - { :mod_lib_path => '/usr/lib/foo' } - end - it { is_expected.to contain_file('zpassenger.load').with_content(/^LoadModule passenger_module \/usr\/lib\/foo\/mod_passenger\.so$/) } - end - describe "with mod_lib => 'mod_foo.so'" do - let :params do - { :mod_lib => 'mod_foo.so' } - end - it { is_expected.to contain_file('zpassenger.load').with_content(/^LoadModule passenger_module \/usr\/lib\/apache2\/modules\/mod_foo\.so$/) } - end - describe "with mod_id => 'mod_foo'" do - let :params do - { :mod_id => 'mod_foo' } - end - it { is_expected.to contain_file('zpassenger.load').with_content(/^LoadModule mod_foo \/usr\/lib\/apache2\/modules\/mod_passenger\.so$/) } - end - - context "with Ubuntu 12.04 defaults" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '12.04', - :kernel => 'Linux', - :operatingsystem => 'Ubuntu', - :lsbdistrelease => '12.04', - :concat_basedir => '/dne', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - it { is_expected.to contain_file('passenger.conf').with_content(%r{PassengerRoot "/usr"}) } - it { is_expected.to contain_file('passenger.conf').with_content(%r{PassengerRuby "/usr/bin/ruby"}) } - it { is_expected.to contain_file('passenger.conf').without_content(/PassengerDefaultRuby/) } - end - - context "with Ubuntu 14.04 defaults" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '14.04', - :operatingsystem => 'Ubuntu', - :kernel => 'Linux', - :lsbdistrelease => '14.04', - :concat_basedir => '/dne', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - it { is_expected.to contain_file('passenger.conf').with_content(%r{PassengerRoot "/usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini"}) } - it { is_expected.to contain_file('passenger.conf').without_content(/PassengerRuby/) } - it { is_expected.to contain_file('passenger.conf').with_content(%r{PassengerDefaultRuby "/usr/bin/ruby"}) } - end - - context "with Debian 7 defaults" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '7.3', - :operatingsystem => 'Debian', - :kernel => 'Linux', - :lsbdistcodename => 'wheezy', - :concat_basedir => '/dne', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - it { is_expected.to contain_file('passenger.conf').with_content(%r{PassengerRoot "/usr"}) } - it { is_expected.to contain_file('passenger.conf').with_content(%r{PassengerRuby "/usr/bin/ruby"}) } - it { is_expected.to contain_file('passenger.conf').without_content(/PassengerDefaultRuby/) } - end - - context "with Debian 8 defaults" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '8.0', - :operatingsystem => 'Debian', - :kernel => 'Linux', - :lsbdistcodename => 'jessie', - :concat_basedir => '/dne', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - it { is_expected.to contain_file('passenger.conf').with_content(%r{PassengerRoot "/usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini"}) } - it { is_expected.to contain_file('passenger.conf').without_content(/PassengerRuby/) } - it { is_expected.to contain_file('passenger.conf').with_content(%r{PassengerDefaultRuby "/usr/bin/ruby"}) } - end - end - - context "on a RedHat OS" do - let :rh_facts do - { - :osfamily => 'RedHat', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - context "on EL6" do - let(:facts) { rh_facts.merge(:operatingsystemrelease => '6') } - - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('passenger') } - it { is_expected.to contain_package("mod_passenger") } - it { is_expected.to contain_file('passenger_package.conf').with({ - 'path' => '/etc/httpd/conf.d/passenger.conf', - }) } - it { is_expected.to contain_file('passenger_package.conf').without_content } - it { is_expected.to contain_file('passenger_package.conf').without_source } - it { is_expected.to contain_file('zpassenger.load').with({ - 'path' => '/etc/httpd/conf.d/zpassenger.load', - }) } - it { is_expected.to contain_file('passenger.conf').without_content(/PassengerRoot/) } - it { is_expected.to contain_file('passenger.conf').without_content(/PassengerRuby/) } - describe "with passenger_root => '/usr/lib/example'" do - let :params do - { :passenger_root => '/usr/lib/example' } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ PassengerRoot "\/usr\/lib\/example"$/) } - end - describe "with passenger_ruby => /usr/lib/example/ruby" do - let :params do - { :passenger_ruby => '/usr/lib/example/ruby' } - end - it { is_expected.to contain_file('passenger.conf').with_content(/^ PassengerRuby "\/usr\/lib\/example\/ruby"$/) } - end - end - - context "on EL7" do - let(:facts) { rh_facts.merge(:operatingsystemrelease => '7') } - - it { is_expected.to contain_file('passenger_package.conf').with({ - 'path' => '/etc/httpd/conf.d/passenger.conf', - }) } - it { is_expected.to contain_file('zpassenger.load').with({ - 'path' => '/etc/httpd/conf.modules.d/zpassenger.load', - }) } - end - end - context "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('passenger') } - it { is_expected.to contain_package("www/rubygem-passenger") } - end - context "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('passenger') } - it { is_expected.to contain_package("www-apache/passenger") } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/perl_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/perl_spec.rb deleted file mode 100644 index f5b61fe0c..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/perl_spec.rb +++ /dev/null @@ -1,74 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::perl', :type => :class do - it_behaves_like "a mod class, without including apache" - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('perl') } - it { is_expected.to contain_package("libapache2-mod-perl2") } - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('perl') } - it { is_expected.to contain_package("mod_perl") } - end - context "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('perl') } - it { is_expected.to contain_package("www/mod_perl2") } - end - context "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :operatingsystem => 'Gentoo', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('perl') } - it { is_expected.to contain_package("www-apache/mod_perl") } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/peruser_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/peruser_spec.rb deleted file mode 100644 index 097a36fff..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/peruser_spec.rb +++ /dev/null @@ -1,43 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::peruser', :type => :class do - let :pre_condition do - 'class { "apache": mpm_module => false, }' - end - context "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '10', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it do - expect { - catalogue - }.to raise_error(Puppet::Error, /Unsupported osfamily FreeBSD/) - end - end - context "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('peruser') } - it { is_expected.to contain_file("/etc/apache2/modules.d/peruser.conf").with_ensure('file') } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/php_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/php_spec.rb deleted file mode 100644 index ad61e897b..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/php_spec.rb +++ /dev/null @@ -1,319 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::php', :type => :class do - describe "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context "with mpm_module => prefork" do - let :pre_condition do - 'class { "apache": mpm_module => prefork, }' - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_class("apache::mod::prefork") } - it { is_expected.to contain_apache__mod('php5') } - it { is_expected.to contain_package("libapache2-mod-php5") } - it { is_expected.to contain_file("php5.load").with( - :content => "LoadModule php5_module /usr/lib/apache2/modules/libphp5.so\n" - ) } - end - context "with mpm_module => itk" do - let :pre_condition do - 'class { "apache": mpm_module => itk, }' - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_class("apache::mod::itk") } - it { is_expected.to contain_apache__mod('php5') } - it { is_expected.to contain_package("libapache2-mod-php5") } - it { is_expected.to contain_file("php5.load").with( - :content => "LoadModule php5_module /usr/lib/apache2/modules/libphp5.so\n" - ) } - end - context "on jessie" do - let :pre_condition do - 'class { "apache": mpm_module => prefork, }' - end - let(:facts) { super().merge({ - :operatingsystemrelease => '8', - :lsbdistcodename => 'jessie', - }) } - it { is_expected.to contain_file("php5.load").with( - :content => "LoadModule php5_module /usr/lib/apache2/modules/libphp5.so\n" - ) } - end - context "on stretch" do - let :pre_condition do - 'class { "apache": mpm_module => prefork, }' - end - let(:facts) { super().merge({ - :operatingsystemrelease => '9', - :lsbdistcodename => 'stretch', - }) } - it { is_expected.to contain_apache__mod('php7.0') } - it { is_expected.to contain_package("libapache2-mod-php7.0") } - it { is_expected.to contain_file("php7.0.load").with( - :content => "LoadModule php7_module /usr/lib/apache2/modules/libphp7.0.so\n" - ) } - end - end - describe "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context "with default params" do - let :pre_condition do - 'class { "apache": }' - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('php5') } - it { is_expected.to contain_package("php") } - it { is_expected.to contain_file("php5.load").with( - :content => "LoadModule php5_module modules/libphp5.so\n" - ) } - end - context "with alternative package name" do let :pre_condition do - 'class { "apache": }' - end - let :params do - { :package_name => 'php54'} - end - it { is_expected.to contain_package("php54") } - end - context "with alternative path" do let :pre_condition do - 'class { "apache": }' - end - let :params do - { :path => 'alternative-path'} - end - it { is_expected.to contain_file("php5.load").with( - :content => "LoadModule php5_module alternative-path\n" - ) } - end - context "with alternative extensions" do let :pre_condition do - 'class { "apache": }' - end - let :params do - { :extensions => ['.php','.php5']} - end - it { is_expected.to contain_file("php5.conf").with_content(Regexp.new(Regexp.escape(''))) } - end - context "with specific version" do - let :pre_condition do - 'class { "apache": }' - end - let :params do - { :package_ensure => '5.3.13'} - end - it { is_expected.to contain_package("php").with( - :ensure => '5.3.13' - ) } - end - context "with mpm_module => prefork" do - let :pre_condition do - 'class { "apache": mpm_module => prefork, }' - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_class("apache::mod::prefork") } - it { is_expected.to contain_apache__mod('php5') } - it { is_expected.to contain_package("php") } - it { is_expected.to contain_file("php5.load").with( - :content => "LoadModule php5_module modules/libphp5.so\n" - ) } - end - context "with mpm_module => itk" do - let :pre_condition do - 'class { "apache": mpm_module => itk, }' - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_class("apache::mod::itk") } - it { is_expected.to contain_apache__mod('php5') } - it { is_expected.to contain_package("php") } - it { is_expected.to contain_file("php5.load").with( - :content => "LoadModule php5_module modules/libphp5.so\n" - ) } - end - end - describe "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '10', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context "with mpm_module => prefork" do - let :pre_condition do - 'class { "apache": mpm_module => prefork, }' - end - it { is_expected.to contain_class('apache::params') } - it { is_expected.to contain_apache__mod('php5') } - it { is_expected.to contain_package("www/mod_php5") } - it { is_expected.to contain_file('php5.load') } - end - context "with mpm_module => itk" do - let :pre_condition do - 'class { "apache": mpm_module => itk, }' - end - it { is_expected.to contain_class('apache::params') } - it { is_expected.to contain_class('apache::mod::itk') } - it { is_expected.to contain_apache__mod('php5') } - it { is_expected.to contain_package("www/mod_php5") } - it { is_expected.to contain_file('php5.load') } - end - end - describe "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - context "with mpm_module => prefork" do - let :pre_condition do - 'class { "apache": mpm_module => prefork, }' - end - it { is_expected.to contain_class('apache::params') } - it { is_expected.to contain_apache__mod('php5') } - it { is_expected.to contain_package("dev-lang/php") } - it { is_expected.to contain_file('php5.load') } - end - context "with mpm_module => itk" do - let :pre_condition do - 'class { "apache": mpm_module => itk, }' - end - it { is_expected.to contain_class('apache::params') } - it { is_expected.to contain_class('apache::mod::itk') } - it { is_expected.to contain_apache__mod('php5') } - it { is_expected.to contain_package("dev-lang/php") } - it { is_expected.to contain_file('php5.load') } - end - end - describe "OS independent tests" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :kernel => 'Linux', - :lsbdistcodename => 'squeeze', - :concat_basedir => '/dne', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context 'with content param' do - let :pre_condition do - 'class { "apache": mpm_module => prefork, }' - end - let :params do - { :content => 'somecontent' } - end - it { should contain_file('php5.conf').with( - :content => 'somecontent' - ) } - end - context 'with template param' do - let :pre_condition do - 'class { "apache": mpm_module => prefork, }' - end - let :params do - { :template => 'apache/mod/php.conf.erb' } - end - it { should contain_file('php5.conf').with( - :content => /^# PHP is an HTML-embedded scripting language which attempts to make it/ - ) } - end - context 'with source param' do - let :pre_condition do - 'class { "apache": mpm_module => prefork, }' - end - let :params do - { :source => 'some-path' } - end - it { should contain_file('php5.conf').with( - :source => 'some-path' - ) } - end - context 'content has priority over template' do - let :pre_condition do - 'class { "apache": mpm_module => prefork, }' - end - let :params do - { - :template => 'apache/mod/php5.conf.erb', - :content => 'somecontent' - } - end - it { should contain_file('php5.conf').with( - :content => 'somecontent' - ) } - end - context 'source has priority over template' do - let :pre_condition do - 'class { "apache": mpm_module => prefork, }' - end - let :params do - { - :template => 'apache/mod/php5.conf.erb', - :source => 'some-path' - } - end - it { should contain_file('php5.conf').with( - :source => 'some-path' - ) } - end - context 'source has priority over content' do - let :pre_condition do - 'class { "apache": mpm_module => prefork, }' - end - let :params do - { - :content => 'somecontent', - :source => 'some-path' - } - end - it { should contain_file('php5.conf').with( - :source => 'some-path' - ) } - end - context 'with mpm_module => worker' do - let :pre_condition do - 'class { "apache": mpm_module => worker, }' - end - it 'should raise an error' do - expect { expect(subject).to contain_apache__mod('php5') }.to raise_error Puppet::Error, /mpm_module => 'prefork' or mpm_module => 'itk'/ - end - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/prefork_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/prefork_spec.rb deleted file mode 100644 index 3e2954fc7..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/prefork_spec.rb +++ /dev/null @@ -1,134 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::prefork', :type => :class do - let :pre_condition do - 'class { "apache": mpm_module => false, }' - end - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('prefork') } - it { is_expected.to contain_file("/etc/apache2/mods-available/prefork.conf").with_ensure('file') } - it { is_expected.to contain_file("/etc/apache2/mods-enabled/prefork.conf").with_ensure('link') } - - context "with Apache version < 2.4" do - let :params do - { - :apache_version => '2.2', - } - end - - it { is_expected.not_to contain_file("/etc/apache2/mods-available/prefork.load") } - it { is_expected.not_to contain_file("/etc/apache2/mods-enabled/prefork.load") } - - it { is_expected.to contain_package("apache2-mpm-prefork") } - end - - context "with Apache version >= 2.4" do - let :params do - { - :apache_version => '2.4', - } - end - - it { is_expected.to contain_file("/etc/apache2/mods-available/prefork.load").with({ - 'ensure' => 'file', - 'content' => "LoadModule mpm_prefork_module /usr/lib/apache2/modules/mod_mpm_prefork.so\n" - }) - } - it { is_expected.to contain_file("/etc/apache2/mods-enabled/prefork.load").with_ensure('link') } - end - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('prefork') } - it { is_expected.to contain_file("/etc/httpd/conf.d/prefork.conf").with_ensure('file') } - - context "with Apache version < 2.4" do - let :params do - { - :apache_version => '2.2', - } - end - - it { is_expected.to contain_file_line("/etc/sysconfig/httpd prefork enable").with({ - 'require' => 'Package[httpd]', - }) - } - end - - context "with Apache version >= 2.4" do - let :params do - { - :apache_version => '2.4', - } - end - - it { is_expected.not_to contain_apache__mod('event') } - - it { is_expected.to contain_file("/etc/httpd/conf.d/prefork.load").with({ - 'ensure' => 'file', - 'content' => "LoadModule mpm_prefork_module modules/mod_mpm_prefork.so\n", - }) - } - end - end - context "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('prefork') } - it { is_expected.to contain_file("/usr/local/etc/apache24/Modules/prefork.conf").with_ensure('file') } - end - context "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('prefork') } - it { is_expected.to contain_file("/etc/apache2/modules.d/prefork.conf").with_ensure('file') } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/proxy_balancer_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/proxy_balancer_spec.rb deleted file mode 100644 index d646ba750..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/proxy_balancer_spec.rb +++ /dev/null @@ -1,95 +0,0 @@ -require 'spec_helper' - -# Helper function for testing the contents of `proxy_balancer.conf` -def balancer_manager_conf_spec(allow_from, manager_path) - it do - is_expected.to contain_file("proxy_balancer.conf").with_content( - "\n"\ - " SetHandler balancer-manager\n"\ - " Require ip #{Array(allow_from).join(' ')}\n"\ - "\n" - ) - end -end - -describe 'apache::mod::proxy_balancer', :type => :class do - let :pre_condition do - [ - 'include apache::mod::proxy', - ] - end - it_behaves_like "a mod class, without including apache" - - context "default configuration with default parameters" do - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '8', - :concat_basedir => '/dne', - :lsbdistcodename => 'jessie', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - it { is_expected.to contain_apache__mod("proxy_balancer") } - - it { is_expected.to_not contain_file("proxy_balancer.conf") } - it { is_expected.to_not contain_file("proxy_balancer.conf symlink") } - - end - - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - it { is_expected.to contain_apache__mod("proxy_balancer") } - - it { is_expected.to_not contain_file("proxy_balancer.conf") } - it { is_expected.to_not contain_file("proxy_balancer.conf symlink") } - - end - end - - context "default configuration with custom parameters $manager => true, $allow_from => ['10.10.10.10','11.11.11.11'], $status_path => '/custom-manager'" do - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '8', - :concat_basedir => '/dne', - :lsbdistcodename => 'jessie', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :params do - { - :manager => true, - :allow_from => ['10.10.10.10','11.11.11.11'], - :manager_path => '/custom-manager', - } - end - - balancer_manager_conf_spec(["10.10.10.10", "11.11.11.11"], "/custom-manager") - - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/proxy_connect_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/proxy_connect_spec.rb deleted file mode 100644 index 33059c07b..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/proxy_connect_spec.rb +++ /dev/null @@ -1,65 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::proxy_connect', :type => :class do - let :pre_condition do - [ - 'include apache::mod::proxy', - ] - end - it_behaves_like "a mod class, without including apache" - context 'on a Debian OS' do - let :facts do - { - :osfamily => 'Debian', - :concat_basedir => '/dne', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context 'with Apache version < 2.2' do - let :facts do - super().merge({ - :operatingsystemrelease => '7.0', - :lsbdistcodename => 'wheezy', - }) - end - let :params do - { - :apache_version => '2.1', - } - end - it { is_expected.not_to contain_apache__mod('proxy_connect') } - end - context 'with Apache version = 2.2' do - let :facts do - super().merge({ - :operatingsystemrelease => '7.0', - :lsbdistcodename => 'wheezy', - }) - end - let :params do - { - :apache_version => '2.2', - } - end - it { is_expected.to contain_apache__mod('proxy_connect') } - end - context 'with Apache version >= 2.4' do - let :facts do - super().merge({ - :operatingsystemrelease => '8.0', - :lsbdistcodename => 'jessie', - }) - end - let :params do - { - :apache_version => '2.4', - } - end - it { is_expected.to contain_apache__mod('proxy_connect') } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/proxy_html_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/proxy_html_spec.rb deleted file mode 100644 index 0d70276c2..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/proxy_html_spec.rb +++ /dev/null @@ -1,128 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::proxy_html', :type => :class do - let :pre_condition do - [ - 'include apache::mod::proxy', - 'include apache::mod::proxy_http', - ] - end - it_behaves_like "a mod class, without including apache" - context "on a Debian OS" do - shared_examples "debian" do |loadfiles| - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('proxy_html').with(:loadfiles => loadfiles) } - it { is_expected.to contain_package("libapache2-mod-proxy-html") } - end - let :facts do - { - :osfamily => 'Debian', - :concat_basedir => '/dne', - :architecture => 'i386', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :hardwaremodel => 'i386', - :is_pe => false, - } - end - - context "on squeeze" do - let(:facts) { super().merge({ :operatingsystemrelease => '6' }) } - it_behaves_like "debian", ['/usr/lib/libxml2.so.2'] - it { is_expected.to_not contain_apache__mod('xml2enc') } - end - context "on wheezy" do - let(:facts) { super().merge({ :operatingsystemrelease => '7' }) } - it { is_expected.to_not contain_apache__mod('xml2enc') } - context "i386" do - let(:facts) { super().merge({ - :hardwaremodel => 'i686', - :architecture => 'i386' - })} - it_behaves_like "debian", ["/usr/lib/i386-linux-gnu/libxml2.so.2"] - end - context "x64" do - let(:facts) { super().merge({ - :hardwaremodel => 'x86_64', - :architecture => 'amd64' - })} - it_behaves_like "debian", ["/usr/lib/x86_64-linux-gnu/libxml2.so.2"] - end - end - context "on jessie" do - let(:facts) { super().merge({ :operatingsystemrelease => '8' }) } - it { is_expected.to contain_apache__mod('xml2enc').with(:loadfiles => nil) } - context "i386" do - let(:facts) { super().merge({ - :hardwaremodel => 'i686', - :architecture => 'i386' - })} - it_behaves_like "debian", ["/usr/lib/i386-linux-gnu/libxml2.so.2"] - end - context "x64" do - let(:facts) { super().merge({ - :hardwaremodel => 'x86_64', - :architecture => 'amd64' - })} - it_behaves_like "debian", ["/usr/lib/x86_64-linux-gnu/libxml2.so.2"] - end - end - end - context "on a RedHat OS", :compile do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('proxy_html').with(:loadfiles => nil) } - it { is_expected.to contain_package("mod_proxy_html") } - it { is_expected.to contain_apache__mod('xml2enc').with(:loadfiles => nil) } - end - context "on a FreeBSD OS", :compile do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('proxy_html').with(:loadfiles => nil) } - it { is_expected.to contain_apache__mod('xml2enc').with(:loadfiles => nil) } - it { is_expected.to contain_package("www/mod_proxy_html") } - end - context "on a Gentoo OS", :compile do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('proxy_html').with(:loadfiles => nil) } - it { is_expected.to contain_apache__mod('xml2enc').with(:loadfiles => nil) } - it { is_expected.to contain_package("www-apache/mod_proxy_html") } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/proxy_wstunnel.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/proxy_wstunnel.rb deleted file mode 100644 index 5af217a05..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/proxy_wstunnel.rb +++ /dev/null @@ -1,5 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::proxy_wstunnel', :type => :class do - it_behaves_like "a mod class, without including apache" -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/python_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/python_spec.rb deleted file mode 100644 index 1393293a9..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/python_spec.rb +++ /dev/null @@ -1,75 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::python', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod("python") } - it { is_expected.to contain_package("libapache2-mod-python") } - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod("python") } - it { is_expected.to contain_package("mod_python") } - end - context "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod("python") } - it { is_expected.to contain_package("www/mod_python3") } - end - context "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod("python") } - it { is_expected.to contain_package("www-apache/mod_python") } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/remoteip_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/remoteip_spec.rb deleted file mode 100644 index d75ea5603..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/remoteip_spec.rb +++ /dev/null @@ -1,48 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::remoteip', :type => :class do - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '8', - :concat_basedir => '/dne', - :lsbdistcodename => 'jessie', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - } - end - let :params do - { :apache_version => '2.4' } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('remoteip') } - it { is_expected.to contain_file('remoteip.conf').with({ - 'path' => '/etc/apache2/mods-available/remoteip.conf', - }) } - - describe "with header X-Forwarded-For" do - let :params do - { :header => 'X-Forwarded-For' } - end - it { is_expected.to contain_file('remoteip.conf').with_content(/^RemoteIPHeader X-Forwarded-For$/) } - end - describe "with proxy_ips => [ 10.42.17.8, 10.42.18.99 ]" do - let :params do - { :proxy_ips => [ '10.42.17.8', '10.42.18.99' ] } - end - it { is_expected.to contain_file('remoteip.conf').with_content(/^RemoteIPInternalProxy 10.42.17.8$/) } - it { is_expected.to contain_file('remoteip.conf').with_content(/^RemoteIPInternalProxy 10.42.18.99$/) } - end - describe "with Apache version < 2.4" do - let :params do - { :apache_version => '2.2' } - end - it 'should fail' do - expect { catalogue }.to raise_error(Puppet::Error, /mod_remoteip is only available in Apache 2.4/) - end - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/reqtimeout_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/reqtimeout_spec.rb deleted file mode 100644 index c3a09777c..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/reqtimeout_spec.rb +++ /dev/null @@ -1,146 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::reqtimeout', :type => :class do - it_behaves_like "a mod class, without including apache" - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :lsbdistcodename => 'squeeze', - :is_pe => false, - } - end - context "passing no parameters" do - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('reqtimeout') } - it { is_expected.to contain_file('reqtimeout.conf').with_content(/^RequestReadTimeout header=20-40,minrate=500\nRequestReadTimeout body=10,minrate=500$/) } - end - context "passing timeouts => ['header=20-60,minrate=600', 'body=60,minrate=600']" do - let :params do - {:timeouts => ['header=20-60,minrate=600', 'body=60,minrate=600']} - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('reqtimeout') } - it { is_expected.to contain_file('reqtimeout.conf').with_content(/^RequestReadTimeout header=20-60,minrate=600\nRequestReadTimeout body=60,minrate=600$/) } - end - context "passing timeouts => 'header=20-60,minrate=600'" do - let :params do - {:timeouts => 'header=20-60,minrate=600'} - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('reqtimeout') } - it { is_expected.to contain_file('reqtimeout.conf').with_content(/^RequestReadTimeout header=20-60,minrate=600$/) } - end - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'Redhat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context "passing no parameters" do - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('reqtimeout') } - it { is_expected.to contain_file('reqtimeout.conf').with_content(/^RequestReadTimeout header=20-40,minrate=500\nRequestReadTimeout body=10,minrate=500$/) } - end - context "passing timeouts => ['header=20-60,minrate=600', 'body=60,minrate=600']" do - let :params do - {:timeouts => ['header=20-60,minrate=600', 'body=60,minrate=600']} - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('reqtimeout') } - it { is_expected.to contain_file('reqtimeout.conf').with_content(/^RequestReadTimeout header=20-60,minrate=600\nRequestReadTimeout body=60,minrate=600$/) } - end - context "passing timeouts => 'header=20-60,minrate=600'" do - let :params do - {:timeouts => 'header=20-60,minrate=600'} - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('reqtimeout') } - it { is_expected.to contain_file('reqtimeout.conf').with_content(/^RequestReadTimeout header=20-60,minrate=600$/) } - end - end - context "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context "passing no parameters" do - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('reqtimeout') } - it { is_expected.to contain_file('reqtimeout.conf').with_content(/^RequestReadTimeout header=20-40,minrate=500\nRequestReadTimeout body=10,minrate=500$/) } - end - context "passing timeouts => ['header=20-60,minrate=600', 'body=60,minrate=600']" do - let :params do - {:timeouts => ['header=20-60,minrate=600', 'body=60,minrate=600']} - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('reqtimeout') } - it { is_expected.to contain_file('reqtimeout.conf').with_content(/^RequestReadTimeout header=20-60,minrate=600\nRequestReadTimeout body=60,minrate=600$/) } - end - context "passing timeouts => 'header=20-60,minrate=600'" do - let :params do - {:timeouts => 'header=20-60,minrate=600'} - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('reqtimeout') } - it { is_expected.to contain_file('reqtimeout.conf').with_content(/^RequestReadTimeout header=20-60,minrate=600$/) } - end - end - context "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - context "passing no parameters" do - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('reqtimeout') } - it { is_expected.to contain_file('reqtimeout.conf').with_content(/^RequestReadTimeout header=20-40,minrate=500\nRequestReadTimeout body=10,minrate=500$/) } - end - context "passing timeouts => ['header=20-60,minrate=600', 'body=60,minrate=600']" do - let :params do - {:timeouts => ['header=20-60,minrate=600', 'body=60,minrate=600']} - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('reqtimeout') } - it { is_expected.to contain_file('reqtimeout.conf').with_content(/^RequestReadTimeout header=20-60,minrate=600\nRequestReadTimeout body=60,minrate=600$/) } - end - context "passing timeouts => 'header=20-60,minrate=600'" do - let :params do - {:timeouts => 'header=20-60,minrate=600'} - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('reqtimeout') } - it { is_expected.to contain_file('reqtimeout.conf').with_content(/^RequestReadTimeout header=20-60,minrate=600$/) } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/rpaf_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/rpaf_spec.rb deleted file mode 100644 index 13f0e6c8c..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/rpaf_spec.rb +++ /dev/null @@ -1,126 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::rpaf', :type => :class do - it_behaves_like "a mod class, without including apache" - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('rpaf') } - it { is_expected.to contain_package("libapache2-mod-rpaf") } - it { is_expected.to contain_file('rpaf.conf').with({ - 'path' => '/etc/apache2/mods-available/rpaf.conf', - }) } - it { is_expected.to contain_file('rpaf.conf').with_content(/^RPAFenable On$/) } - - describe "with sethostname => true" do - let :params do - { :sethostname => 'true' } - end - it { is_expected.to contain_file('rpaf.conf').with_content(/^RPAFsethostname On$/) } - end - describe "with proxy_ips => [ 10.42.17.8, 10.42.18.99 ]" do - let :params do - { :proxy_ips => [ '10.42.17.8', '10.42.18.99' ] } - end - it { is_expected.to contain_file('rpaf.conf').with_content(/^RPAFproxy_ips 10.42.17.8 10.42.18.99$/) } - end - describe "with header => X-Real-IP" do - let :params do - { :header => 'X-Real-IP' } - end - it { is_expected.to contain_file('rpaf.conf').with_content(/^RPAFheader X-Real-IP$/) } - end - end - context "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('rpaf') } - it { is_expected.to contain_package("www/mod_rpaf2") } - it { is_expected.to contain_file('rpaf.conf').with({ - 'path' => '/usr/local/etc/apache24/Modules/rpaf.conf', - }) } - it { is_expected.to contain_file('rpaf.conf').with_content(/^RPAFenable On$/) } - - describe "with sethostname => true" do - let :params do - { :sethostname => 'true' } - end - it { is_expected.to contain_file('rpaf.conf').with_content(/^RPAFsethostname On$/) } - end - describe "with proxy_ips => [ 10.42.17.8, 10.42.18.99 ]" do - let :params do - { :proxy_ips => [ '10.42.17.8', '10.42.18.99' ] } - end - it { is_expected.to contain_file('rpaf.conf').with_content(/^RPAFproxy_ips 10.42.17.8 10.42.18.99$/) } - end - describe "with header => X-Real-IP" do - let :params do - { :header => 'X-Real-IP' } - end - it { is_expected.to contain_file('rpaf.conf').with_content(/^RPAFheader X-Real-IP$/) } - end - end - context "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__mod('rpaf') } - it { is_expected.to contain_package("www-apache/mod_rpaf") } - it { is_expected.to contain_file('rpaf.conf').with({ - 'path' => '/etc/apache2/modules.d/rpaf.conf', - }) } - it { is_expected.to contain_file('rpaf.conf').with_content(/^RPAFenable On$/) } - - describe "with sethostname => true" do - let :params do - { :sethostname => 'true' } - end - it { is_expected.to contain_file('rpaf.conf').with_content(/^RPAFsethostname On$/) } - end - describe "with proxy_ips => [ 10.42.17.8, 10.42.18.99 ]" do - let :params do - { :proxy_ips => [ '10.42.17.8', '10.42.18.99' ] } - end - it { is_expected.to contain_file('rpaf.conf').with_content(/^RPAFproxy_ips 10.42.17.8 10.42.18.99$/) } - end - describe "with header => X-Real-IP" do - let :params do - { :header => 'X-Real-IP' } - end - it { is_expected.to contain_file('rpaf.conf').with_content(/^RPAFheader X-Real-IP$/) } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/security_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/security_spec.rb deleted file mode 100644 index e30f7214f..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/security_spec.rb +++ /dev/null @@ -1,162 +0,0 @@ - -require 'spec_helper' - -describe 'apache::mod::security', :type => :class do - it_behaves_like "a mod class, without including apache" - context "on RedHat based systems" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystem => 'CentOS', - :operatingsystemrelease => '7', - :kernel => 'Linux', - :id => 'root', - :concat_basedir => '/', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { should contain_apache__mod('security').with( - :id => 'security2_module', - :lib => 'mod_security2.so' - ) } - it { should contain_apache__mod('unique_id_module').with( - :id => 'unique_id_module', - :lib => 'mod_unique_id.so' - ) } - it { should contain_package('mod_security_crs') } - it { should contain_file('security.conf').with( - :path => '/etc/httpd/conf.modules.d/security.conf' - ) } - it { should contain_file('security.conf') - .with_content(%r{^\s+SecAuditLogRelevantStatus "\^\(\?:5\|4\(\?!04\)\)"$}) - .with_content(%r{^\s+SecAuditLogParts ABIJDEFHZ$}) - .with_content(%r{^\s+SecDebugLog /var/log/httpd/modsec_debug.log$}) - .with_content(%r{^\s+SecAuditLog /var/log/httpd/modsec_audit.log$}) - } - it { should contain_file('/etc/httpd/modsecurity.d').with( - :ensure => 'directory', - :path => '/etc/httpd/modsecurity.d', - :owner => 'root', - :group => 'root', - :mode => '0755', - ) } - it { should contain_file('/etc/httpd/modsecurity.d/activated_rules').with( - :ensure => 'directory', - :path => '/etc/httpd/modsecurity.d/activated_rules', - :owner => 'apache', - :group => 'apache' - ) } - it { should contain_file('/etc/httpd/modsecurity.d/security_crs.conf').with( - :path => '/etc/httpd/modsecurity.d/security_crs.conf' - ) } - it { should contain_apache__security__rule_link('base_rules/modsecurity_35_bad_robots.data') } - it { should contain_file('modsecurity_35_bad_robots.data').with( - :path => '/etc/httpd/modsecurity.d/activated_rules/modsecurity_35_bad_robots.data', - :target => '/usr/lib/modsecurity.d/base_rules/modsecurity_35_bad_robots.data', - ) } - - describe 'with parameters' do - let :params do - { - :activated_rules => [ - '/tmp/foo/bar.conf', - ], - :audit_log_relevant_status => "^(?:5|4(?!01|04))", - :audit_log_parts => "ABCDZ", - :secdefaultaction => "deny,status:406,nolog,auditlog", - } - end - it { should contain_file('security.conf').with_content %r{^\s+SecAuditLogRelevantStatus "\^\(\?:5\|4\(\?!01\|04\)\)"$} } - it { should contain_file('security.conf').with_content %r{^\s+SecAuditLogParts ABCDZ$} } - it { should contain_file('/etc/httpd/modsecurity.d/security_crs.conf').with_content %r{^\s*SecDefaultAction "phase:2,deny,status:406,nolog,auditlog"$} } - it { should contain_file('bar.conf').with( - :path => '/etc/httpd/modsecurity.d/activated_rules/bar.conf', - :target => '/tmp/foo/bar.conf', - ) } - end - describe 'with other modsec parameters' do - let :params do - { - :manage_security_crs => false - } - end - it { should_not contain_file('/etc/httpd/modsecurity.d/security_crs.conf') } - end - end - context "on Debian based systems" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/', - :lsbdistcodename => 'squeeze', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :kernel => 'Linux', - :is_pe => false, - } - end - it { should contain_apache__mod('security').with( - :id => 'security2_module', - :lib => 'mod_security2.so' - ) } - it { should contain_apache__mod('unique_id_module').with( - :id => 'unique_id_module', - :lib => 'mod_unique_id.so' - ) } - it { should contain_package('modsecurity-crs') } - it { should contain_file('security.conf').with( - :path => '/etc/apache2/mods-available/security.conf' - ) } - it { should contain_file('security.conf') - .with_content(%r{^\s+SecAuditLogRelevantStatus "\^\(\?:5\|4\(\?!04\)\)"$}) - .with_content(%r{^\s+SecAuditLogParts ABIJDEFHZ$}) - .with_content(%r{^\s+SecDebugLog /var/log/apache2/modsec_debug.log$}) - .with_content(%r{^\s+SecAuditLog /var/log/apache2/modsec_audit.log$}) - } - it { should contain_file('/etc/modsecurity').with( - :ensure => 'directory', - :path => '/etc/modsecurity', - :owner => 'root', - :group => 'root', - :mode => '0755', - ) } - it { should contain_file('/etc/modsecurity/activated_rules').with( - :ensure => 'directory', - :path => '/etc/modsecurity/activated_rules', - :owner => 'www-data', - :group => 'www-data' - ) } - it { should contain_file('/etc/modsecurity/security_crs.conf').with( - :path => '/etc/modsecurity/security_crs.conf' - ) } - it { should contain_apache__security__rule_link('base_rules/modsecurity_35_bad_robots.data') } - it { should contain_file('modsecurity_35_bad_robots.data').with( - :path => '/etc/modsecurity/activated_rules/modsecurity_35_bad_robots.data', - :target => '/usr/share/modsecurity-crs/base_rules/modsecurity_35_bad_robots.data', - ) } - - describe 'with parameters' do - let :params do - { - :activated_rules => [ - '/tmp/foo/bar.conf', - ], - :audit_log_relevant_status => "^(?:5|4(?!01|04))", - :audit_log_parts => "ABCDZ", - :secdefaultaction => "deny,status:406,nolog,auditlog", - } - end - it { should contain_file('security.conf').with_content %r{^\s+SecAuditLogRelevantStatus "\^\(\?:5\|4\(\?!01\|04\)\)"$} } - it { should contain_file('security.conf').with_content %r{^\s+SecAuditLogParts ABCDZ$} } - it { should contain_file('/etc/modsecurity/security_crs.conf').with_content %r{^\s*SecDefaultAction "phase:2,deny,status:406,nolog,auditlog"$} } - it { should contain_file('bar.conf').with( - :path => '/etc/modsecurity/activated_rules/bar.conf', - :target => '/tmp/foo/bar.conf', - ) } - end - end - -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/shib_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/shib_spec.rb deleted file mode 100644 index a651c280a..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/shib_spec.rb +++ /dev/null @@ -1,42 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::shib', :type => :class do - it_behaves_like "a mod class, without including apache" - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :fqdn => 'test.example.com', - :is_pe => false, - } - end - describe 'with no parameters' do - it { should contain_apache__mod('shib2').with_id('mod_shib') } - end - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :fqdn => 'test.example.com', - :is_pe => false, - } - end - describe 'with no parameters' do - it { should contain_apache__mod('shib2').with_id('mod_shib') } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/speling_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/speling_spec.rb deleted file mode 100644 index b4844ec74..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/speling_spec.rb +++ /dev/null @@ -1,37 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::speling', :type => :class do - it_behaves_like "a mod class, without including apache" - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_apache__mod('speling') } - end - - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_apache__mod('speling') } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/ssl_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/ssl_spec.rb deleted file mode 100644 index 18816bbd9..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/ssl_spec.rb +++ /dev/null @@ -1,293 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::ssl', :type => :class do - it_behaves_like "a mod class, without including apache" - context 'on an unsupported OS' do - let :facts do - { - :osfamily => 'Magic', - :operatingsystemrelease => '0', - :concat_basedir => '/dne', - :operatingsystem => 'Magic', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { expect { catalogue }.to raise_error(Puppet::Error, /Unsupported osfamily:/) } - end - - context 'on a RedHat' do - context '6 OS' do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class('apache::params') } - it { is_expected.to contain_apache__mod('ssl') } - it { is_expected.to contain_package('mod_ssl') } - it { is_expected.to contain_file('ssl.conf').with_path('/etc/httpd/conf.d/ssl.conf') } - context 'with a custom package_name parameter' do - let :params do - { :package_name => 'httpd24-mod_ssl' } - end - it { is_expected.to contain_class('apache::params') } - it { is_expected.to contain_apache__mod('ssl') } - it { is_expected.to contain_package('httpd24-mod_ssl') } - it { is_expected.not_to contain_package('mod_ssl') } - it { is_expected.to contain_file('ssl.conf').with_content(%r{^ SSLSessionCache "shmcb:/var/cache/mod_ssl/scache\(512000\)"$})} - end - end - context '7 OS with custom directories for PR#1635' do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '7', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :pre_condition do - "class { 'apache': - confd_dir => '/etc/httpd/conf.puppet.d', - default_mods => false, - default_vhost => false, - mod_dir => '/etc/httpd/conf.modules.puppet.d', - vhost_dir => '/etc/httpd/conf.puppet.d', - }" - end - it { is_expected.to contain_package('mod_ssl') } - it { is_expected.to contain_file('ssl.conf').with_path('/etc/httpd/conf.puppet.d/ssl.conf') } - end - end - - context 'on a Debian OS' do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class('apache::params') } - it { is_expected.to contain_apache__mod('ssl') } - it { is_expected.not_to contain_package('libapache2-mod-ssl') } - end - - context 'on a FreeBSD OS' do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class('apache::params') } - it { is_expected.to contain_apache__mod('ssl') } - end - - context 'on a Gentoo OS' do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class('apache::params') } - it { is_expected.to contain_apache__mod('ssl') } - it { is_expected.to contain_file('ssl.conf').with_content(%r{^ SSLSessionCache "shmcb:/var/run/ssl_scache\(512000\)"$})} - end - - context 'on a Suse OS' do - let :facts do - { - :osfamily => 'Suse', - :operatingsystem => 'SLES', - :operatingsystemrelease => '12', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class('apache::params') } - it { is_expected.to contain_apache__mod('ssl') } - it { is_expected.to contain_file('ssl.conf').with_content(%r{^ SSLSessionCache "shmcb:/var/lib/apache2/ssl_scache\(512000\)"$})} - end - # Template config doesn't vary by distro - context "on all distros" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystem => 'CentOS', - :operatingsystemrelease => '6', - :kernel => 'Linux', - :id => 'root', - :concat_basedir => '/dne', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - context 'not setting ssl_pass_phrase_dialog' do - it { is_expected.to contain_file('ssl.conf').with_content(/^ SSLPassPhraseDialog builtin$/)} - end - - context 'setting ssl_ca to a path' do - let :params do - { - :ssl_ca => '/etc/pki/some/path/ca.crt', - } - end - it { is_expected.to contain_file('ssl.conf').with_content(/^ SSLCACertificateFile/)} - end - context "with Apache version < 2.4" do - let :params do - { - :apache_version => '2.2', - } - end - context 'ssl_compression with default value' do - it { is_expected.not_to contain_file('ssl.conf').with_content(/^ SSLCompression Off$/)} - end - - context 'setting ssl_compression to true' do - let :params do - { - :ssl_compression => true, - } - end - it { is_expected.not_to contain_file('ssl.conf').with_content(/^ SSLCompression On$/)} - end - context 'setting ssl_stapling to true' do - let :params do - { - :ssl_stapling => true, - } - end - it { is_expected.not_to contain_file('ssl.conf').with_content(/^ SSLUseStapling/)} - end - end - context "with Apache version >= 2.4" do - let :params do - { - :apache_version => '2.4', - } - end - context 'ssl_compression with default value' do - it { is_expected.not_to contain_file('ssl.conf').with_content(/^ SSLCompression Off$/)} - end - - context 'setting ssl_compression to true' do - let :params do - { - :apache_version => '2.4', - :ssl_compression => true, - } - end - it { is_expected.to contain_file('ssl.conf').with_content(/^ SSLCompression On$/)} - end - context 'setting ssl_stapling to true' do - let :params do - { - :apache_version => '2.4', - :ssl_stapling => true, - } - end - it { is_expected.to contain_file('ssl.conf').with_content(/^ SSLUseStapling On$/)} - end - context 'setting ssl_stapling_return_errors to true' do - let :params do - { - :apache_version => '2.4', - :ssl_stapling_return_errors => true, - } - end - it { is_expected.to contain_file('ssl.conf').with_content(/^ SSLStaplingReturnResponderErrors On$/)} - end - end - - context 'setting ssl_pass_phrase_dialog' do - let :params do - { - :ssl_pass_phrase_dialog => 'exec:/path/to/program', - } - end - it { is_expected.to contain_file('ssl.conf').with_content(/^ SSLPassPhraseDialog exec:\/path\/to\/program$/)} - end - - context 'setting ssl_random_seed_bytes' do - let :params do - { - :ssl_random_seed_bytes => '1024', - } - end - it { is_expected.to contain_file('ssl.conf').with_content(%r{^ SSLRandomSeed startup file:/dev/urandom 1024$})} - end - - context 'setting ssl_openssl_conf_cmd' do - let :params do - { - :ssl_openssl_conf_cmd => 'DHParameters "foo.pem"', - } - end - it { is_expected.to contain_file('ssl.conf').with_content(/^\s+SSLOpenSSLConfCmd DHParameters "foo.pem"$/)} - end - - context 'setting ssl_mutex' do - let :params do - { - :ssl_mutex => 'posixsem', - } - end - it { is_expected.to contain_file('ssl.conf').with_content(%r{^ SSLMutex posixsem$})} - end - context 'setting ssl_sessioncache' do - let :params do - { - :ssl_sessioncache => '/tmp/customsessioncache(51200)', - } - end - it { is_expected.to contain_file('ssl.conf').with_content(%r{^ SSLSessionCache "shmcb:/tmp/customsessioncache\(51200\)"$})} - end - context 'setting ssl_proxy_protocol' do - let :params do - { - :ssl_proxy_protocol => [ '-ALL', '+TLSv1'], - } - end - it { is_expected.to contain_file('ssl.conf').with_content(%r{^ SSLProxyProtocol -ALL \+TLSv1$})} - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/status_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/status_spec.rb deleted file mode 100644 index 7bc7831fb..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/status_spec.rb +++ /dev/null @@ -1,205 +0,0 @@ -require 'spec_helper' - -# Helper function for testing the contents of `status.conf` -def status_conf_spec(allow_from, extended_status, status_path) - it do - is_expected.to contain_file("status.conf").with_content( - "\n"\ - " SetHandler server-status\n"\ - " Order deny,allow\n"\ - " Deny from all\n"\ - " Allow from #{Array(allow_from).join(' ')}\n"\ - "\n"\ - "ExtendedStatus #{extended_status}\n"\ - "\n"\ - "\n"\ - " # Show Proxy LoadBalancer status in mod_status\n"\ - " ProxyStatus On\n"\ - "\n" - ) - end -end - -describe 'apache::mod::status', :type => :class do - it_behaves_like "a mod class, without including apache" - - context "default configuration with parameters" do - context "on a Debian OS with default params" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - it { is_expected.to contain_apache__mod("status") } - - status_conf_spec(["127.0.0.1", "::1"], "On", "/server-status") - - it { is_expected.to contain_file("status.conf").with({ - :ensure => 'file', - :path => '/etc/apache2/mods-available/status.conf', - } ) } - - it { is_expected.to contain_file("status.conf symlink").with({ - :ensure => 'link', - :path => '/etc/apache2/mods-enabled/status.conf', - } ) } - - end - - context "on a RedHat OS with default params" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - it { is_expected.to contain_apache__mod("status") } - - status_conf_spec(["127.0.0.1", "::1"], "On", "/server-status") - - it { is_expected.to contain_file("status.conf").with_path("/etc/httpd/conf.d/status.conf") } - - end - - context "with custom parameters $allow_from => ['10.10.10.10','11.11.11.11'], $extended_status => 'Off', $status_path => '/custom-status'" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :params do - { - :allow_from => ['10.10.10.10','11.11.11.11'], - :extended_status => 'Off', - :status_path => '/custom-status', - } - end - - status_conf_spec(["10.10.10.10", "11.11.11.11"], "Off", "/custom-status") - - end - - context "with valid parameter type $allow_from => ['10.10.10.10']" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :params do - { :allow_from => ['10.10.10.10'] } - end - it 'should expect to succeed array validation' do - expect { - is_expected.to contain_file("status.conf") - }.not_to raise_error() - end - end - - context "with invalid parameter type $allow_from => '10.10.10.10'" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :params do - { :allow_from => '10.10.10.10' } - end - it 'should expect to fail array validation' do - expect { - is_expected.to contain_file("status.conf") - }.to raise_error(Puppet::Error) - end - end - - # Only On or Off are valid options - ['On', 'Off'].each do |valid_param| - context "with valid value $extended_status => '#{valid_param}'" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :params do - { :extended_status => valid_param } - end - it 'should expect to succeed regular expression validation' do - expect { - is_expected.to contain_file("status.conf") - }.not_to raise_error() - end - end - end - - ['Yes', 'No'].each do |invalid_param| - context "with invalid value $extended_status => '#{invalid_param}'" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :params do - { :extended_status => invalid_param } - end - it 'should expect to fail regular expression validation' do - expect { - is_expected.to contain_file("status.conf") - }.to raise_error(Puppet::Error) - end - end - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/suphp_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/suphp_spec.rb deleted file mode 100644 index 71dbab30e..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/suphp_spec.rb +++ /dev/null @@ -1,38 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::suphp', :type => :class do - it_behaves_like "a mod class, without including apache" - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_package("libapache2-mod-suphp") } - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_package("mod_suphp") } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/userdir_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/userdir_spec.rb deleted file mode 100644 index 9f23ba274..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/userdir_spec.rb +++ /dev/null @@ -1,53 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::userdir', :type => :class do - context "on a Debian OS" do - let :pre_condition do - 'class { "apache": - default_mods => false, - mod_dir => "/tmp/junk", - }' - end - let :facts do - { - :lsbdistcodename => 'squeeze', - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :operatingsystemmajrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context "default parameters" do - it { should compile } - end - context "with dir set to something" do - let :params do - { - :dir => 'hi', - } - end - it { should contain_file("userdir.conf").with_content(%r{^\s*UserDir\s+/home/\*/hi$})} - end - context "with home set to something" do - let :params do - { - :home => '/u', - } - end - it { should contain_file("userdir.conf").with_content(%r{^\s*UserDir\s+/u/\*/public_html$})} - end - context "with path set to something" do - let :params do - { - :path => 'public_html /usr/web http://www.example.com/', - } - end - it { should contain_file("userdir.conf").with_content(%r{^\s*UserDir\s+public_html /usr/web http://www\.example\.com/$})} - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/worker_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/worker_spec.rb deleted file mode 100644 index 9d0d8e5e0..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/worker_spec.rb +++ /dev/null @@ -1,189 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::worker', :type => :class do - let :pre_condition do - 'class { "apache": mpm_module => false, }' - end - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('worker') } - it { is_expected.to contain_file("/etc/apache2/mods-available/worker.conf").with_ensure('file') } - it { is_expected.to contain_file("/etc/apache2/mods-enabled/worker.conf").with_ensure('link') } - - context "with Apache version < 2.4" do - let :params do - { - :apache_version => '2.2', - } - end - - it { is_expected.not_to contain_file("/etc/apache2/mods-available/worker.load") } - it { is_expected.not_to contain_file("/etc/apache2/mods-enabled/worker.load") } - - it { is_expected.to contain_package("apache2-mpm-worker") } - end - - context "with Apache version >= 2.4" do - let :params do - { - :apache_version => '2.4', - } - end - - it { is_expected.to contain_file("/etc/apache2/mods-available/worker.load").with({ - 'ensure' => 'file', - 'content' => "LoadModule mpm_worker_module /usr/lib/apache2/modules/mod_mpm_worker.so\n" - }) - } - it { is_expected.to contain_file("/etc/apache2/mods-enabled/worker.load").with_ensure('link') } - end - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('worker') } - it { is_expected.to contain_file("/etc/httpd/conf.d/worker.conf").with_ensure('file') } - - context "with Apache version < 2.4" do - let :params do - { - :apache_version => '2.2', - } - end - - it { is_expected.to contain_file_line("/etc/sysconfig/httpd worker enable").with({ - 'require' => 'Package[httpd]', - }) - } - end - - context "with Apache version >= 2.4" do - let :params do - { - :apache_version => '2.4', - } - end - - it { is_expected.not_to contain_apache__mod('event') } - - it { is_expected.to contain_file("/etc/httpd/conf.d/worker.load").with({ - 'ensure' => 'file', - 'content' => "LoadModule mpm_worker_module modules/mod_mpm_worker.so\n", - }) - } - end - end - context "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('worker') } - it { is_expected.to contain_file("/usr/local/etc/apache24/Modules/worker.conf").with_ensure('file') } - end - context "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.not_to contain_apache__mod('worker') } - it { is_expected.to contain_file("/etc/apache2/modules.d/worker.conf").with_ensure('file') } - end - - # Template config doesn't vary by distro - context "on all distros" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystem => 'CentOS', - :operatingsystemrelease => '6', - :kernel => 'Linux', - :id => 'root', - :concat_basedir => '/dne', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - context 'defaults' do - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+ServerLimit\s+25$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+StartServers\s+2$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+MaxClients\s+150$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+MinSpareThreads\s+25$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+MaxSpareThreads\s+75$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+ThreadsPerChild\s+25$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+MaxRequestsPerChild\s+0$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+ThreadLimit\s+64$/) } - it { should contain_file("/etc/httpd/conf.d/worker.conf").with(:content => /^\s*ListenBacklog\s*511/) } - end - - context 'setting params' do - let :params do - { - :serverlimit => 10, - :startservers => 11, - :maxclients => 12, - :minsparethreads => 13, - :maxsparethreads => 14, - :threadsperchild => 15, - :maxrequestsperchild => 16, - :threadlimit => 17, - :listenbacklog => 8, - } - end - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+ServerLimit\s+10$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+StartServers\s+11$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+MaxClients\s+12$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+MinSpareThreads\s+13$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+MaxSpareThreads\s+14$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+ThreadsPerChild\s+15$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+MaxRequestsPerChild\s+16$/) } - it { should contain_file('/etc/httpd/conf.d/worker.conf').with(:content => /^\s+ThreadLimit\s+17$/) } - it { should contain_file("/etc/httpd/conf.d/worker.conf").with(:content => /^\s*ListenBacklog\s*8/) } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/wsgi_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/wsgi_spec.rb deleted file mode 100644 index 6261a9590..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/mod/wsgi_spec.rb +++ /dev/null @@ -1,151 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod::wsgi', :type => :class do - it_behaves_like "a mod class, without including apache" - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_class('apache::mod::wsgi').with( - 'wsgi_socket_prefix' => nil - ) - } - it { is_expected.to contain_package("libapache2-mod-wsgi") } - end - context "on a RedHat OS" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_class('apache::mod::wsgi').with( - 'wsgi_socket_prefix' => '/var/run/wsgi' - ) - } - it { is_expected.to contain_package("mod_wsgi") } - - describe "with WSGIRestrictEmbedded enabled" do - let :params do - { :wsgi_restrict_embedded => 'On' } - end - it {is_expected.to contain_file('wsgi.conf').with_content(/^ WSGIRestrictEmbedded On$/)} - end - describe "with custom WSGISocketPrefix" do - let :params do - { :wsgi_socket_prefix => 'run/wsgi' } - end - it {is_expected.to contain_file('wsgi.conf').with_content(/^ WSGISocketPrefix run\/wsgi$/)} - end - describe "with custom WSGIPythonHome" do - let :params do - { :wsgi_python_home => '/path/to/virtenv' } - end - it {is_expected.to contain_file('wsgi.conf').with_content(/^ WSGIPythonHome "\/path\/to\/virtenv"$/)} - end - describe "with custom package_name and mod_path" do - let :params do - { - :package_name => 'mod_wsgi_package', - :mod_path => '/foo/bar/baz', - } - end - it { is_expected.to contain_apache__mod('wsgi').with({ - 'package' => 'mod_wsgi_package', - 'path' => '/foo/bar/baz', - }) - } - it { is_expected.to contain_package("mod_wsgi_package") } - it { is_expected.to contain_file('wsgi.load').with_content(%r"LoadModule wsgi_module /foo/bar/baz") } - end - describe "with custom mod_path not containing /" do - let :params do - { - :package_name => 'mod_wsgi_package', - :mod_path => 'wsgi_mod_name.so', - } - end - it { is_expected.to contain_apache__mod('wsgi').with({ - 'path' => 'modules/wsgi_mod_name.so', - 'package' => 'mod_wsgi_package', - }) - } - it { is_expected.to contain_file('wsgi.load').with_content(%r"LoadModule wsgi_module modules/wsgi_mod_name.so") } - - end - describe "with package_name but no mod_path" do - let :params do - { - :mod_path => '/foo/bar/baz', - } - end - it { expect { catalogue }.to raise_error Puppet::Error, /apache::mod::wsgi - both package_name and mod_path must be specified!/ } - end - describe "with mod_path but no package_name" do - let :params do - { - :package_name => '/foo/bar/baz', - } - end - it { expect { catalogue }.to raise_error Puppet::Error, /apache::mod::wsgi - both package_name and mod_path must be specified!/ } - end - end - context "on a FreeBSD OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_class('apache::mod::wsgi').with( - 'wsgi_socket_prefix' => nil - ) - } - it { is_expected.to contain_package("www/mod_wsgi") } - end - context "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_class('apache::mod::wsgi').with( - 'wsgi_socket_prefix' => nil - ) - } - it { is_expected.to contain_package("www-apache/mod_wsgi") } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/params_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/params_spec.rb deleted file mode 100644 index 32ccd313c..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/params_spec.rb +++ /dev/null @@ -1,22 +0,0 @@ -require 'spec_helper' - -describe 'apache::params', :type => :class do - context "On a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - it { is_expected.to compile.with_all_deps } - it { is_expected.to have_resource_count(0) } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/service_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/service_spec.rb deleted file mode 100644 index a065abc2f..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/service_spec.rb +++ /dev/null @@ -1,157 +0,0 @@ -require 'spec_helper' - -describe 'apache::service', :type => :class do - let :pre_condition do - 'include apache::params' - end - context "on a Debian OS" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_service("httpd").with( - 'name' => 'apache2', - 'ensure' => 'running', - 'enable' => 'true' - ) - } - - context "with $service_name => 'foo'" do - let (:params) {{ :service_name => 'foo' }} - it { is_expected.to contain_service("httpd").with( - 'name' => 'foo' - ) - } - end - - context "with $service_enable => true" do - let (:params) {{ :service_enable => true }} - it { is_expected.to contain_service("httpd").with( - 'name' => 'apache2', - 'ensure' => 'running', - 'enable' => 'true' - ) - } - end - - context "with $service_enable => false" do - let (:params) {{ :service_enable => false }} - it { is_expected.to contain_service("httpd").with( - 'name' => 'apache2', - 'ensure' => 'running', - 'enable' => 'false' - ) - } - end - - context "with $service_ensure => 'running'" do - let (:params) {{ :service_ensure => 'running', }} - it { is_expected.to contain_service("httpd").with( - 'ensure' => 'running', - 'enable' => 'true' - ) - } - end - - context "with $service_ensure => 'stopped'" do - let (:params) {{ :service_ensure => 'stopped', }} - it { is_expected.to contain_service("httpd").with( - 'ensure' => 'stopped', - 'enable' => 'true' - ) - } - end - - context "with $service_ensure => 'UNDEF'" do - let (:params) {{ :service_ensure => 'UNDEF' }} - it { is_expected.to contain_service("httpd").without_ensure } - end - - context "with $service_restart unset" do - it { is_expected.to contain_service("httpd").without_restart } - end - - context "with $service_restart => '/usr/sbin/apachectl graceful'" do - let (:params) {{ :service_restart => '/usr/sbin/apachectl graceful' }} - it { is_expected.to contain_service("httpd").with( - 'restart' => '/usr/sbin/apachectl graceful' - ) - } - end - end - - - context "on a RedHat 5 OS, do not manage service" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '5', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let(:params) do - { - 'service_ensure' => 'running', - 'service_name' => 'httpd', - 'service_manage' => false - } - end - it { is_expected.not_to contain_service('httpd') } - end - - context "on a FreeBSD 5 OS" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { is_expected.to contain_service("httpd").with( - 'name' => 'apache24', - 'ensure' => 'running', - 'enable' => 'true' - ) - } - end - - context "on a Gentoo OS" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - it { is_expected.to contain_service("httpd").with( - 'name' => 'apache2', - 'ensure' => 'running', - 'enable' => 'true' - ) - } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/vhosts_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/vhosts_spec.rb deleted file mode 100644 index 322007940..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/classes/vhosts_spec.rb +++ /dev/null @@ -1,35 +0,0 @@ -require 'spec_helper' - -describe 'apache::vhosts', :type => :class do - context 'on all OSes' do - let :facts do - { - :id => 'root', - :kernel => 'Linux', - :osfamily => 'RedHat', - :operatingsystem => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context 'with custom vhosts parameter' do - let :params do { - :vhosts => { - 'custom_vhost_1' => { - 'docroot' => '/var/www/custom_vhost_1', - 'port' => '81', - }, - 'custom_vhost_2' => { - 'docroot' => '/var/www/custom_vhost_2', - 'port' => '82', - }, - }, - } - end - it { is_expected.to contain_apache__vhost('custom_vhost_1') } - it { is_expected.to contain_apache__vhost('custom_vhost_2') } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/balancer_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/balancer_spec.rb deleted file mode 100644 index 3b43e3fd7..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/balancer_spec.rb +++ /dev/null @@ -1,72 +0,0 @@ -require 'spec_helper' - -describe 'apache::balancer', :type => :define do - let :title do - 'myapp' - end - let :facts do - { - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :lsbdistcodename => 'squeeze', - :id => 'root', - :concat_basedir => '/dne', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :kernel => 'Linux', - :is_pe => false, - } - end - describe 'apache pre_condition with defaults' do - let :pre_condition do - 'include apache' - end - describe "accept a target parameter and use it" do - let :params do - { - :target => '/tmp/myapp.conf' - } - end - it { should contain_concat('apache_balancer_myapp').with({ - :path => "/tmp/myapp.conf", - })} - it { should_not contain_apache__mod('slotmem_shm') } - it { should_not contain_apache__mod('lbmethod_byrequests') } - end - context "on jessie" do - let(:facts) { super().merge({ - :operatingsystemrelease => '8', - :lsbdistcodename => 'jessie', - }) } - it { should contain_apache__mod('slotmem_shm') } - it { should contain_apache__mod('lbmethod_byrequests') } - end - end - describe 'apache pre_condition with conf_dir set' do - let :pre_condition do - 'class{"apache": - confd_dir => "/junk/path" - }' - end - it { should contain_concat('apache_balancer_myapp').with({ - :path => "/junk/path/balancer_myapp.conf", - })} - end - - describe 'with lbmethod and with apache::mod::proxy_balancer::apache_version set' do - let :pre_condition do - 'class{"apache::mod::proxy_balancer": - apache_version => "2.4" - }' - end - let :params do - { - :proxy_set => { - 'lbmethod' => 'bytraffic', - }, - } - end - it { should contain_apache__mod('slotmem_shm') } - it { should contain_apache__mod('lbmethod_bytraffic') } - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/balancermember_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/balancermember_spec.rb deleted file mode 100644 index 6221290a2..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/balancermember_spec.rb +++ /dev/null @@ -1,61 +0,0 @@ -require 'spec_helper' - -describe 'apache::balancermember', :type => :define do - let :pre_condition do - 'include apache' - end - let :facts do - { - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :lsbdistcodename => 'squeeze', - :id => 'root', - :concat_basedir => '/dne', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :kernel => 'Linux', - :is_pe => false, - } - end - describe "allows multiple balancermembers with the same url" do - let :pre_condition do - 'include apache - apache::balancer {"balancer":} - apache::balancer {"balancer-external":} - apache::balancermember {"http://127.0.0.1:8080-external": url => "http://127.0.0.1:8080/", balancer_cluster => "balancer-external"} - ' - end - let :title do - 'http://127.0.0.1:8080/' - end - let :params do - { - :options => [], - :url => 'http://127.0.0.1:8080/', - :balancer_cluster => 'balancer-internal' - } - end - it { should contain_concat__fragment('BalancerMember http://127.0.0.1:8080/') } - end - describe "allows balancermember with a different target" do - let :pre_condition do - 'include apache - apache::balancer {"balancername": target => "/etc/apache/balancer.conf"} - apache::balancermember {"http://127.0.0.1:8080-external": url => "http://127.0.0.1:8080/", balancer_cluster => "balancername"} - ' - end - let :title do - 'http://127.0.0.1:8080/' - end - let :params do - { - :options => [], - :url => 'http://127.0.0.1:8080/', - :balancer_cluster => 'balancername' - } - end - it { should contain_concat__fragment('BalancerMember http://127.0.0.1:8080/').with({ - :target => "apache_balancer_balancername", - })} - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/custom_config_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/custom_config_spec.rb deleted file mode 100644 index 5f996fd6d..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/custom_config_spec.rb +++ /dev/null @@ -1,125 +0,0 @@ -require 'spec_helper' - -describe 'apache::custom_config', :type => :define do - let :pre_condition do - 'class { "apache": }' - end - let :title do - 'rspec' - end - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context 'defaults with content' do - let :params do - { - 'content' => '# Test', - } - end - it { is_expected.to contain_exec("syntax verification for rspec").with({ - 'refreshonly' => 'true', - 'subscribe' => 'File[apache_rspec]', - 'command' => '/usr/sbin/apachectl -t', - 'notify' => 'Class[Apache::Service]', - 'before' => 'Exec[remove rspec if invalid]', - }) - } - it { is_expected.to contain_exec("remove rspec if invalid").with({ - 'unless' => '/usr/sbin/apachectl -t', - 'subscribe' => 'File[apache_rspec]', - 'refreshonly' => 'true', - }) - } - it { is_expected.to contain_file("apache_rspec").with({ - 'ensure' => 'present', - 'content' => '# Test', - 'require' => 'Package[httpd]', - }) - } - end - context 'set everything with source' do - let :params do - { - 'confdir' => '/dne', - 'priority' => '30', - 'source' => 'puppet:///modules/apache/test', - 'verify_command' => '/bin/true', - } - end - it { is_expected.to contain_exec("syntax verification for rspec").with({ - 'command' => '/bin/true', - }) - } - it { is_expected.to contain_exec("remove rspec if invalid").with({ - 'command' => '/bin/rm /dne/30-rspec.conf', - 'unless' => '/bin/true', - }) - } - it { is_expected.to contain_file("apache_rspec").with({ - 'path' => '/dne/30-rspec.conf', - 'ensure' => 'present', - 'source' => 'puppet:///modules/apache/test', - 'require' => 'Package[httpd]', - }) - } - end - context 'verify_config => false' do - let :params do - { - 'content' => '# test', - 'verify_config' => false, - } - end - it { is_expected.to_not contain_exec('syntax verification for rspec') } - it { is_expected.to_not contain_exec('remove rspec if invalid') } - it { is_expected.to contain_file('apache_rspec').with({ - 'notify' => 'Class[Apache::Service]' - }) - } - end - context 'ensure => absent' do - let :params do - { - 'ensure' => 'absent' - } - end - it { is_expected.to_not contain_exec('syntax verification for rspec') } - it { is_expected.to_not contain_exec('remove rspec if invalid') } - it { is_expected.to contain_file('apache_rspec').with({ - 'ensure' => 'absent', - }) - } - end - describe 'validation' do - context 'both content and source' do - let :params do - { - 'content' => 'foo', - 'source' => 'bar', - } - end - it do - expect { - catalogue - }.to raise_error(Puppet::Error, /Only one of \$content and \$source can be specified\./) - end - end - context 'neither content nor source' do - it do - expect { - catalogue - }.to raise_error(Puppet::Error, /One of \$content and \$source must be specified\./) - end - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/fastcgi_server_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/fastcgi_server_spec.rb deleted file mode 100644 index e415461cc..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/fastcgi_server_spec.rb +++ /dev/null @@ -1,156 +0,0 @@ -require 'spec_helper' - -describe 'apache::fastcgi::server', :type => :define do - let :pre_condition do - 'include apache' - end - let :title do - 'www' - end - describe 'os-dependent items' do - context "on RedHat based systems" do - let :default_facts do - { - :osfamily => 'RedHat', - :operatingsystem => 'CentOS', - :operatingsystemrelease => '6', - :kernel => 'Linux', - :id => 'root', - :concat_basedir => '/dne', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :facts do default_facts end - it { should contain_class("apache") } - it { should contain_class("apache::mod::fastcgi") } - it { should contain_file("fastcgi-pool-#{title}.conf").with( - :ensure => 'present', - :path => "/etc/httpd/conf.d/fastcgi-pool-#{title}.conf" - ) } - end - context "on Debian based systems" do - let :default_facts do - { - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :lsbdistcodename => 'squeeze', - :kernel => 'Linux', - :id => 'root', - :concat_basedir => '/dne', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :facts do default_facts end - it { should contain_class("apache") } - it { should contain_class("apache::mod::fastcgi") } - it { should contain_file("fastcgi-pool-#{title}.conf").with( - :ensure => 'present', - :path => "/etc/apache2/conf.d/fastcgi-pool-#{title}.conf" - ) } - end - context "on FreeBSD systems" do - let :default_facts do - { - :osfamily => 'FreeBSD', - :operatingsystem => 'FreeBSD', - :operatingsystemrelease => '9', - :kernel => 'FreeBSD', - :id => 'root', - :concat_basedir => '/dne', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :facts do default_facts end - it { should contain_class("apache") } - it { should contain_class("apache::mod::fastcgi") } - it { should contain_file("fastcgi-pool-#{title}.conf").with( - :ensure => 'present', - :path => "/usr/local/etc/apache24/Includes/fastcgi-pool-#{title}.conf" - ) } - end - context "on Gentoo systems" do - let :default_facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :kernel => 'Linux', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - let :facts do default_facts end - it { should contain_class("apache") } - it { should contain_class("apache::mod::fastcgi") } - it { should contain_file("fastcgi-pool-#{title}.conf").with( - :ensure => 'present', - :path => "/etc/apache2/conf.d/fastcgi-pool-#{title}.conf" - ) } - end - end - describe 'os-independent items' do - let :facts do - { - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :lsbdistcodename => 'squeeze', - :kernel => 'Linux', - :id => 'root', - :concat_basedir => '/dne', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - describe ".conf content using TCP communication" do - let :params do - { - :host => '127.0.0.1:9001', - :timeout => 30, - :flush => true, - :faux_path => '/var/www/php-www.fcgi', - :fcgi_alias => '/php-www.fcgi', - :file_type => 'application/x-httpd-php', - :pass_header => 'Authorization' - } - end - let :expected do -'FastCGIExternalServer /var/www/php-www.fcgi -idle-timeout 30 -flush -host 127.0.0.1:9001 -pass-header Authorization -Alias /php-www.fcgi /var/www/php-www.fcgi -Action application/x-httpd-php /php-www.fcgi -' - end - it do - should contain_file("fastcgi-pool-www.conf").with_content(expected) - end - end - describe ".conf content using socket communication" do - let :params do - { - :host => '/var/run/fcgi.sock', - :timeout => 30, - :flush => true, - :faux_path => '/var/www/php-www.fcgi', - :fcgi_alias => '/php-www.fcgi', - :file_type => 'application/x-httpd-php' - } - end - let :expected do -'FastCGIExternalServer /var/www/php-www.fcgi -idle-timeout 30 -flush -socket /var/run/fcgi.sock -Alias /php-www.fcgi /var/www/php-www.fcgi -Action application/x-httpd-php /php-www.fcgi -' - end - it do - should contain_file("fastcgi-pool-www.conf").with_content(expected) - end - end - - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/mod_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/mod_spec.rb deleted file mode 100644 index 1697190a3..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/mod_spec.rb +++ /dev/null @@ -1,166 +0,0 @@ -require 'spec_helper' - -describe 'apache::mod', :type => :define do - let :pre_condition do - 'include apache' - end - context "on a RedHat osfamily" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - describe "for non-special modules" do - let :title do - 'spec_m' - end - it { is_expected.to contain_class("apache::params") } - it "should manage the module load file" do - is_expected.to contain_file('spec_m.load').with({ - :path => '/etc/httpd/conf.d/spec_m.load', - :content => "LoadModule spec_m_module modules/mod_spec_m.so\n", - :owner => 'root', - :group => 'root', - :mode => '0644', - } ) - end - end - - describe "with file_mode set" do - let :pre_condition do - "class {'::apache': file_mode => '0640'}" - end - let :title do - 'spec_m' - end - it "should manage the module load file" do - is_expected.to contain_file('spec_m.load').with({ - :mode => '0640', - } ) - end - end - - describe "with shibboleth module and package param passed" do - # name/title for the apache::mod define - let :title do - 'xsendfile' - end - # parameters - let(:params) { {:package => 'mod_xsendfile'} } - - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_package('mod_xsendfile') } - end - end - - context "on a Debian osfamily" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - describe "for non-special modules" do - let :title do - 'spec_m' - end - it { is_expected.to contain_class("apache::params") } - it "should manage the module load file" do - is_expected.to contain_file('spec_m.load').with({ - :path => '/etc/apache2/mods-available/spec_m.load', - :content => "LoadModule spec_m_module /usr/lib/apache2/modules/mod_spec_m.so\n", - :owner => 'root', - :group => 'root', - :mode => '0644', - } ) - end - it "should link the module load file" do - is_expected.to contain_file('spec_m.load symlink').with({ - :path => '/etc/apache2/mods-enabled/spec_m.load', - :target => '/etc/apache2/mods-available/spec_m.load', - :owner => 'root', - :group => 'root', - :mode => '0644', - } ) - end - end - end - - context "on a FreeBSD osfamily" do - let :facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - - describe "for non-special modules" do - let :title do - 'spec_m' - end - it { is_expected.to contain_class("apache::params") } - it "should manage the module load file" do - is_expected.to contain_file('spec_m.load').with({ - :path => '/usr/local/etc/apache24/Modules/spec_m.load', - :content => "LoadModule spec_m_module /usr/local/libexec/apache24/mod_spec_m.so\n", - :owner => 'root', - :group => 'wheel', - :mode => '0644', - } ) - end - end - end - - context "on a Gentoo osfamily" do - let :facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - - describe "for non-special modules" do - let :title do - 'spec_m' - end - it { is_expected.to contain_class("apache::params") } - it "should manage the module load file" do - is_expected.to contain_file('spec_m.load').with({ - :path => '/etc/apache2/modules.d/spec_m.load', - :content => "LoadModule spec_m_module /usr/lib/apache2/modules/mod_spec_m.so\n", - :owner => 'root', - :group => 'wheel', - :mode => '0644', - } ) - end - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/modsec_link_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/modsec_link_spec.rb deleted file mode 100644 index a5b4c5390..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/modsec_link_spec.rb +++ /dev/null @@ -1,53 +0,0 @@ -require 'spec_helper' - -describe 'apache::security::rule_link', :type => :define do - let :pre_condition do - 'class { "apache": } - class { "apache::mod::security": activated_rules => [] } - ' - end - - let :title do - 'base_rules/modsecurity_35_bad_robots.data' - end - - context "on RedHat based systems" do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystem => 'CentOS', - :operatingsystemrelease => '7', - :kernel => 'Linux', - :id => 'root', - :concat_basedir => '/', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - it { should contain_file('modsecurity_35_bad_robots.data').with( - :path => '/etc/httpd/modsecurity.d/activated_rules/modsecurity_35_bad_robots.data', - :target => '/usr/lib/modsecurity.d/base_rules/modsecurity_35_bad_robots.data' - ) } - end - - context "on Debian based systems" do - let :facts do - { - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/', - :lsbdistcodename => 'squeeze', - :id => 'root', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :kernel => 'Linux', - :is_pe => false, - } - end - it { should contain_file('modsecurity_35_bad_robots.data').with( - :path => '/etc/modsecurity/activated_rules/modsecurity_35_bad_robots.data', - :target => '/usr/share/modsecurity-crs/base_rules/modsecurity_35_bad_robots.data' - ) } - end - -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/vhost_custom_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/vhost_custom_spec.rb deleted file mode 100644 index 804be86b8..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/vhost_custom_spec.rb +++ /dev/null @@ -1,99 +0,0 @@ -require 'spec_helper' - -describe 'apache::vhost::custom', :type => :define do - let :title do - 'rspec.example.com' - end - let :default_params do - { - :content => 'foobar' - } - end - describe 'os-dependent items' do - context "on RedHat based systems" do - let :default_facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :operatingsystem => 'RedHat', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :params do default_params end - let :facts do default_facts end - end - context "on Debian based systems" do - let :default_facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :params do default_params end - let :facts do default_facts end - it { is_expected.to contain_file("apache_rspec.example.com").with( - :ensure => 'present', - :content => 'foobar', - :path => '/etc/apache2/sites-available/25-rspec.example.com.conf', - ) } - it { is_expected.to contain_file("25-rspec.example.com.conf symlink").with( - :ensure => 'link', - :path => '/etc/apache2/sites-enabled/25-rspec.example.com.conf', - :target => '/etc/apache2/sites-available/25-rspec.example.com.conf' - ) } - end - context "on FreeBSD systems" do - let :default_facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :operatingsystem => 'FreeBSD', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :params do default_params end - let :facts do default_facts end - it { is_expected.to contain_file("apache_rspec.example.com").with( - :ensure => 'present', - :content => 'foobar', - :path => '/usr/local/etc/apache24/Vhosts/25-rspec.example.com.conf', - ) } - end - context "on Gentoo systems" do - let :default_facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - let :params do default_params end - let :facts do default_facts end - it { is_expected.to contain_file("apache_rspec.example.com").with( - :ensure => 'present', - :content => 'foobar', - :path => '/etc/apache2/vhosts.d/25-rspec.example.com.conf', - ) } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/vhost_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/vhost_spec.rb deleted file mode 100644 index bb447247b..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/defines/vhost_spec.rb +++ /dev/null @@ -1,1401 +0,0 @@ -require 'spec_helper' - -describe 'apache::vhost', :type => :define do - let :pre_condition do - 'class { "apache": default_vhost => false, default_mods => false, vhost_enable_dir => "/etc/apache2/sites-enabled"}' - end - let :title do - 'rspec.example.com' - end - let :default_params do - { - :docroot => '/rspec/docroot', - :port => '84', - } - end - describe 'os-dependent items' do - context "on RedHat based systems" do - let :default_facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :params do default_params end - let :facts do default_facts end - it { is_expected.to contain_class("apache") } - it { is_expected.to contain_class("apache::params") } - end - context "on Debian based systems" do - let :default_facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :params do default_params end - let :facts do default_facts end - it { is_expected.to contain_class("apache") } - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_concat("25-rspec.example.com.conf").with( - :ensure => 'present', - :path => '/etc/apache2/sites-available/25-rspec.example.com.conf' - ) } - it { is_expected.to contain_file("25-rspec.example.com.conf symlink").with( - :ensure => 'link', - :path => '/etc/apache2/sites-enabled/25-rspec.example.com.conf', - :target => '/etc/apache2/sites-available/25-rspec.example.com.conf' - ) } - end - context "on FreeBSD systems" do - let :default_facts do - { - :osfamily => 'FreeBSD', - :operatingsystemrelease => '9', - :concat_basedir => '/dne', - :operatingsystem => 'FreeBSD', - :id => 'root', - :kernel => 'FreeBSD', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - let :params do default_params end - let :facts do default_facts end - it { is_expected.to contain_class("apache") } - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_concat("25-rspec.example.com.conf").with( - :ensure => 'present', - :path => '/usr/local/etc/apache24/Vhosts/25-rspec.example.com.conf' - ) } - end - context "on Gentoo systems" do - let :default_facts do - { - :osfamily => 'Gentoo', - :operatingsystem => 'Gentoo', - :operatingsystemrelease => '3.16.1-gentoo', - :concat_basedir => '/dne', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/bin', - :is_pe => false, - } - end - let :params do default_params end - let :facts do default_facts end - it { is_expected.to contain_class("apache") } - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_concat("25-rspec.example.com.conf").with( - :ensure => 'present', - :path => '/etc/apache2/vhosts.d/25-rspec.example.com.conf' - ) } - end - end - describe 'os-independent items' do - let :facts do - { - :osfamily => 'Debian', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :lsbdistcodename => 'squeeze', - :operatingsystem => 'Debian', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - describe 'basic assumptions' do - let :params do default_params end - it { is_expected.to contain_class("apache") } - it { is_expected.to contain_class("apache::params") } - it { is_expected.to contain_apache__listen(params[:port]) } - it { is_expected.to contain_apache__namevirtualhost("*:#{params[:port]}") } - end - context 'set everything!' do - let :params do - { - 'docroot' => '/var/www/foo', - 'manage_docroot' => false, - 'virtual_docroot' => true, - 'port' => '8080', - 'ip' => '127.0.0.1', - 'ip_based' => true, - 'add_listen' => false, - 'docroot_owner' => 'user', - 'docroot_group' => 'wheel', - 'docroot_mode' => '0664', - 'serveradmin' => 'foo@localhost', - 'ssl' => true, - 'ssl_cert' => '/ssl/cert', - 'ssl_key' => '/ssl/key', - 'ssl_chain' => '/ssl/chain', - 'ssl_crl_path' => '/ssl/crl', - 'ssl_crl' => 'foo.crl', - 'ssl_certs_dir' => '/ssl/certs', - 'ssl_protocol' => 'SSLv2', - 'ssl_cipher' => 'HIGH', - 'ssl_honorcipherorder' => 'Off', - 'ssl_verify_client' => 'optional', - 'ssl_verify_depth' => '3', - 'ssl_options' => '+ExportCertData', - 'ssl_openssl_conf_cmd' => 'DHParameters "foo.pem"', - 'ssl_proxy_verify' => 'require', - 'ssl_proxy_check_peer_cn' => 'on', - 'ssl_proxy_check_peer_name' => 'on', - 'ssl_proxy_check_peer_expire' => 'on', - 'ssl_proxyengine' => true, - 'ssl_proxy_protocol' => 'TLSv1.2', - - 'priority' => '30', - 'default_vhost' => true, - 'servername' => 'example.com', - 'serveraliases' => ['test-example.com'], - 'options' => ['MultiView'], - 'override' => ['All'], - 'directoryindex' => 'index.html', - 'vhost_name' => 'test', - 'logroot' => '/var/www/logs', - 'logroot_ensure' => 'directory', - 'logroot_mode' => '0600', - 'logroot_owner' => 'root', - 'logroot_group' => 'root', - 'log_level' => 'crit', - 'access_log' => false, - 'access_log_file' => 'httpd_access_log', - 'access_log_syslog' => true, - 'access_log_format' => '%h %l %u %t \"%r\" %>s %b', - 'access_log_env_var' => '', - 'aliases' => '/image', - 'directories' => [ - { - 'path' => '/var/www/files', - 'provider' => 'files', - 'require' => [ 'valid-user', 'all denied', ], - }, - { - 'path' => '/var/www/files', - 'provider' => 'files', - 'additional_includes' => [ '/custom/path/includes', '/custom/path/another_includes', ], - }, - { - 'path' => '/var/www/files', - 'provider' => 'files', - 'require' => 'all granted', - }, - { - 'path' => '/var/www/files', - 'provider' => 'files', - 'require' => - { - 'enforce' => 'all', - 'requires' => ['all-valid1', 'all-valid2'], - }, - }, - { - 'path' => '/var/www/files', - 'provider' => 'files', - 'require' => - { - 'enforce' => 'none', - 'requires' => ['none-valid1', 'none-valid2'], - }, - }, - { - 'path' => '/var/www/files', - 'provider' => 'files', - 'require' => - { - 'enforce' => 'any', - 'requires' => ['any-valid1', 'any-valid2'], - }, - }, - { - 'path' => '*', - 'provider' => 'proxy', - }, - { 'path' => '/var/www/files/indexed_directory', - 'directoryindex' => 'disabled', - 'options' => ['Indexes','FollowSymLinks','MultiViews'], - 'index_options' => ['FancyIndexing'], - 'index_style_sheet' => '/styles/style.css', - }, - { 'path' => '/var/www/files/output_filtered', - 'set_output_filter' => 'output_filter', - }, - { 'path' => '/var/www/files', - 'provider' => 'location', - 'limit' => [ - { 'methods' => 'GET HEAD', - 'require' => ['valid-user'] - }, - ], - }, - { 'path' => '/var/www/files', - 'provider' => 'location', - 'limit_except' => [ - { 'methods' => 'GET HEAD', - 'require' => ['valid-user'] - }, - ], - }, - { 'path' => '/var/www/dav', - 'dav' => 'filesystem', - 'dav_depth_infinity' => true, - 'dav_min_timeout' => '600', - }, - ], - 'error_log' => false, - 'error_log_file' => 'httpd_error_log', - 'error_log_syslog' => true, - 'error_documents' => 'true', - 'fallbackresource' => '/index.php', - 'scriptalias' => '/usr/lib/cgi-bin', - 'scriptaliases' => [ - { - 'alias' => '/myscript', - 'path' => '/usr/share/myscript', - }, - { - 'aliasmatch' => '^/foo(.*)', - 'path' => '/usr/share/fooscripts$1', - }, - ], - 'proxy_dest' => '/', - 'proxy_pass' => [ - { - 'path' => '/a', - 'url' => 'http://backend-a/', - 'keywords' => ['noquery', 'interpolate'], - 'no_proxy_uris' => ['/a/foo', '/a/bar'], - 'no_proxy_uris_match' => ['/a/foomatch'], - 'reverse_cookies' => [ - { - 'path' => '/a', - 'url' => 'http://backend-a/', - }, - { - 'domain' => 'foo', - 'url' => 'http://foo', - } - ], - 'params' => { - 'retry' => '0', - 'timeout' => '5' - }, - 'setenv' => ['proxy-nokeepalive 1','force-proxy-request-1.0 1'], - } - ], - 'proxy_pass_match' => [ - { - 'path' => '/a', - 'url' => 'http://backend-a/', - 'keywords' => ['noquery', 'interpolate'], - 'no_proxy_uris' => ['/a/foo', '/a/bar'], - 'no_proxy_uris_match' => ['/a/foomatch'], - 'params' => { - 'retry' => '0', - 'timeout' => '5' - }, - 'setenv' => ['proxy-nokeepalive 1','force-proxy-request-1.0 1'], - } - ], - 'suphp_addhandler' => 'foo', - 'suphp_engine' => 'on', - 'suphp_configpath' => '/var/www/html', - 'php_admin_flags' => ['foo', 'bar'], - 'php_admin_values' => ['true', 'false'], - 'no_proxy_uris' => '/foo', - 'no_proxy_uris_match' => '/foomatch', - 'proxy_preserve_host' => true, - 'proxy_add_headers' => true, - 'proxy_error_override' => true, - 'redirect_source' => '/bar', - 'redirect_dest' => '/', - 'redirect_status' => 'temp', - 'redirectmatch_status' => ['404'], - 'redirectmatch_regexp' => ['\.git$'], - 'redirectmatch_dest' => ['http://www.example.com'], - 'rack_base_uris' => ['/rackapp1'], - 'passenger_base_uris' => ['/passengerapp1'], - 'headers' => 'Set X-Robots-Tag "noindex, noarchive, nosnippet"', - 'request_headers' => ['append MirrorID "mirror 12"'], - 'rewrites' => [ - { - 'rewrite_rule' => ['^index\.html$ welcome.html'] - } - ], - 'filters' => [ - 'FilterDeclare COMPRESS', - 'FilterProvider COMPRESS DEFLATE resp=Content-Type $text/html', - 'FilterProvider COMPRESS DEFLATE resp=Content-Type $text/css', - 'FilterProvider COMPRESS DEFLATE resp=Content-Type $text/plain', - 'FilterProvider COMPRESS DEFLATE resp=Content-Type $text/xml', - 'FilterChain COMPRESS', - 'FilterProtocol COMPRESS DEFLATE change=yes;byteranges=no', - ], - 'rewrite_base' => '/', - 'rewrite_rule' => '^index\.html$ welcome.html', - 'rewrite_cond' => '%{HTTP_USER_AGENT} ^MSIE', - 'rewrite_inherit' => true, - 'setenv' => ['FOO=/bin/true'], - 'setenvif' => 'Request_URI "\.gif$" object_is_image=gif', - 'setenvifnocase' => 'REMOTE_ADDR ^127.0.0.1 localhost=true', - 'block' => 'scm', - 'wsgi_application_group' => '%{GLOBAL}', - 'wsgi_daemon_process' => 'wsgi', - 'wsgi_daemon_process_options' => { - 'processes' => '2', - 'threads' => '15', - 'display-name' => '%{GROUP}', - }, - 'wsgi_import_script' => '/var/www/demo.wsgi', - 'wsgi_import_script_options' => { - 'process-group' => 'wsgi', - 'application-group' => '%{GLOBAL}' - }, - 'wsgi_process_group' => 'wsgi', - 'wsgi_script_aliases' => { - '/' => '/var/www/demo.wsgi' - }, - 'wsgi_script_aliases_match' => { - '^/test/(^[/*)' => '/var/www/demo.wsgi' - }, - 'wsgi_pass_authorization' => 'On', - 'custom_fragment' => '#custom string', - 'itk' => { - 'user' => 'someuser', - 'group' => 'somegroup' - }, - 'wsgi_chunked_request' => 'On', - 'action' => 'foo', - 'fastcgi_server' => 'localhost', - 'fastcgi_socket' => '/tmp/fastcgi.socket', - 'fastcgi_dir' => '/tmp', - 'fastcgi_idle_timeout' => '120', - 'additional_includes' => '/custom/path/includes', - 'apache_version' => '2.4', - 'use_optional_includes' => true, - 'suexec_user_group' => 'root root', - 'allow_encoded_slashes' => 'nodecode', - 'passenger_app_root' => '/usr/share/myapp', - 'passenger_app_env' => 'test', - 'passenger_ruby' => '/usr/bin/ruby1.9.1', - 'passenger_min_instances' => '1', - 'passenger_max_requests' => '1000', - 'passenger_start_timeout' => '600', - 'passenger_pre_start' => 'http://localhost/myapp', - 'passenger_high_performance' => true, - 'passenger_user' => 'sandbox', - 'passenger_nodejs' => '/usr/bin/node', - 'passenger_sticky_sessions' => true, - 'passenger_startup_file' => 'bin/www', - 'add_default_charset' => 'UTF-8', - 'jk_mounts' => [ - { 'mount' => '/*', 'worker' => 'tcnode1', }, - { 'unmount' => '/*.jpg', 'worker' => 'tcnode1', }, - ], - 'auth_kerb' => true, - 'krb_method_negotiate' => 'off', - 'krb_method_k5passwd' => 'off', - 'krb_authoritative' => 'off', - 'krb_auth_realms' => ['EXAMPLE.ORG','EXAMPLE.NET'], - 'krb_5keytab' => '/tmp/keytab5', - 'krb_local_user_mapping' => 'off', - 'http_protocol_options' => 'Strict LenientMethods Allow0.9', - 'keepalive' => 'on', - 'keepalive_timeout' => '100', - 'max_keepalive_requests' => '1000', - } - end - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '7', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :kernelversion => '3.6.2', - :is_pe => false, - } - end - - it { is_expected.to compile } - it { is_expected.to_not contain_file('/var/www/foo') } - it { is_expected.to contain_class('apache::mod::ssl') } - it { is_expected.to contain_file('ssl.conf').with( - :content => /^\s+SSLHonorCipherOrder On$/ ) } - it { is_expected.to contain_file('ssl.conf').with( - :content => /^\s+SSLPassPhraseDialog builtin$/ ) } - it { is_expected.to contain_file('ssl.conf').with( - :content => /^\s+SSLSessionCacheTimeout 300$/ ) } - it { is_expected.to contain_class('apache::mod::mime') } - it { is_expected.to contain_class('apache::mod::vhost_alias') } - it { is_expected.to contain_class('apache::mod::wsgi') } - it { is_expected.to contain_class('apache::mod::suexec') } - it { is_expected.to contain_class('apache::mod::passenger') } - it { is_expected.to contain_file('/var/www/logs').with({ - 'ensure' => 'directory', - 'mode' => '0600', - }) - } - it { is_expected.to contain_class('apache::mod::rewrite') } - it { is_expected.to contain_class('apache::mod::alias') } - it { is_expected.to contain_class('apache::mod::proxy') } - it { is_expected.to contain_class('apache::mod::proxy_http') } - it { is_expected.to contain_class('apache::mod::passenger') } - it { is_expected.to contain_class('apache::mod::passenger') } - it { is_expected.to contain_class('apache::mod::fastcgi') } - it { is_expected.to contain_class('apache::mod::headers') } - it { is_expected.to contain_class('apache::mod::filter') } - it { is_expected.to contain_class('apache::mod::env') } - it { is_expected.to contain_class('apache::mod::setenvif') } - it { is_expected.to contain_concat('30-rspec.example.com.conf').with({ - 'owner' => 'root', - 'mode' => '0644', - 'require' => 'Package[httpd]', - 'notify' => 'Class[Apache::Service]', - }) - } - it { is_expected.to contain_file('30-rspec.example.com.conf symlink').with({ - 'ensure' => 'link', - 'path' => '/etc/apache2/sites-enabled/30-rspec.example.com.conf', - }) - } - it { is_expected.to contain_concat__fragment('rspec.example.com-apache-header') } - it { is_expected.to contain_concat__fragment('rspec.example.com-docroot') } - it { is_expected.to contain_concat__fragment('rspec.example.com-aliases') } - it { is_expected.to contain_concat__fragment('rspec.example.com-itk') } - it { is_expected.to contain_concat__fragment('rspec.example.com-fallbackresource') } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories') } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Include\s'\/custom\/path\/includes'$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Include\s'\/custom\/path\/another_includes'$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Require valid-user$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Require all denied$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Require all granted$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+<\/RequireAll>$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Require all-valid1$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Require all-valid2$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+<\/RequireNone>$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Require none-valid1$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Require none-valid2$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+<\/RequireAny>$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Require any-valid1$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Require any-valid2$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Options\sIndexes\sFollowSymLinks\sMultiViews$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+IndexOptions\sFancyIndexing$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+IndexStyleSheet\s'\/styles\/style\.css'$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+DirectoryIndex\sdisabled$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+SetOutputFilter\soutput_filter$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /\s+\s*Require valid-user\s*<\/Limit>/m ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /\s+\s*Require valid-user\s*<\/LimitExcept>/m ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Dav\sfilesystem$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+DavDepthInfinity\sOn$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+DavMinTimeout\s600$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-additional_includes') } - it { is_expected.to contain_concat__fragment('rspec.example.com-logging') } - it { is_expected.to contain_concat__fragment('rspec.example.com-serversignature') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-access_log') } - it { is_expected.to contain_concat__fragment('rspec.example.com-action') } - it { is_expected.to contain_concat__fragment('rspec.example.com-block') } - it { is_expected.to contain_concat__fragment('rspec.example.com-error_document') } - it { is_expected.to contain_concat__fragment('rspec.example.com-proxy').with_content( - /retry=0/) } - it { is_expected.to contain_concat__fragment('rspec.example.com-proxy').with_content( - /timeout=5/) } - it { is_expected.to contain_concat__fragment('rspec.example.com-proxy').with_content( - /SetEnv force-proxy-request-1.0 1/) } - it { is_expected.to contain_concat__fragment('rspec.example.com-proxy').with_content( - /SetEnv proxy-nokeepalive 1/) } - it { is_expected.to contain_concat__fragment('rspec.example.com-proxy').with_content( - /noquery interpolate/) } - it { is_expected.to contain_concat__fragment('rspec.example.com-proxy').with_content( - /ProxyPreserveHost On/) } - it { is_expected.to contain_concat__fragment('rspec.example.com-proxy').with_content( - /ProxyAddHeaders On/) } - it { is_expected.to contain_concat__fragment('rspec.example.com-proxy').with_content( - /ProxyPassReverseCookiePath\s+\/a\s+http:\/\//) } - it { is_expected.to contain_concat__fragment('rspec.example.com-proxy').with_content( - /ProxyPassReverseCookieDomain\s+foo\s+http:\/\/foo/) } - it { is_expected.to contain_concat__fragment('rspec.example.com-rack') } - it { is_expected.to contain_concat__fragment('rspec.example.com-redirect') } - it { is_expected.to contain_concat__fragment('rspec.example.com-rewrite') } - it { is_expected.to contain_concat__fragment('rspec.example.com-rewrite').with( - :content => /^\s+RewriteOptions Inherit$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-scriptalias') } - it { is_expected.to contain_concat__fragment('rspec.example.com-serveralias') } - it { is_expected.to contain_concat__fragment('rspec.example.com-setenv').with_content( - %r{SetEnv FOO=/bin/true}) } - it { is_expected.to contain_concat__fragment('rspec.example.com-setenv').with_content( - %r{SetEnvIf Request_URI "\\.gif\$" object_is_image=gif}) } - it { is_expected.to contain_concat__fragment('rspec.example.com-setenv').with_content( - %r{SetEnvIfNoCase REMOTE_ADDR \^127.0.0.1 localhost=true}) } - it { is_expected.to contain_concat__fragment('rspec.example.com-ssl') } - it { is_expected.to contain_concat__fragment('rspec.example.com-ssl').with( - :content => /^\s+SSLOpenSSLConfCmd\s+DHParameters "foo.pem"$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-sslproxy') } - it { is_expected.to contain_concat__fragment('rspec.example.com-sslproxy').with( - :content => /^\s+SSLProxyEngine On$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-sslproxy').with( - :content => /^\s+SSLProxyCheckPeerCN\s+on$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-sslproxy').with( - :content => /^\s+SSLProxyCheckPeerName\s+on$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-sslproxy').with( - :content => /^\s+SSLProxyCheckPeerExpire\s+on$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-sslproxy').with( - :content => /^\s+SSLProxyProtocol\s+TLSv1.2$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-suphp') } - it { is_expected.to contain_concat__fragment('rspec.example.com-php_admin') } - it { is_expected.to contain_concat__fragment('rspec.example.com-header') } - it { is_expected.to contain_concat__fragment('rspec.example.com-filters').with( - :content => /^\s+FilterDeclare COMPRESS$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-requestheader') } - it { is_expected.to contain_concat__fragment('rspec.example.com-wsgi') } - it { is_expected.to contain_concat__fragment('rspec.example.com-custom_fragment') } - it { is_expected.to contain_concat__fragment('rspec.example.com-fastcgi') } - it { is_expected.to contain_concat__fragment('rspec.example.com-suexec') } - it { is_expected.to contain_concat__fragment('rspec.example.com-allow_encoded_slashes') } - it { is_expected.to contain_concat__fragment('rspec.example.com-passenger') } - it { is_expected.to contain_concat__fragment('rspec.example.com-charsets') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-security') } - it { is_expected.to contain_concat__fragment('rspec.example.com-file_footer') } - it { is_expected.to contain_concat__fragment('rspec.example.com-jk_mounts').with( - :content => /^\s+JkMount\s+\/\*\s+tcnode1$/)} - it { is_expected.to contain_concat__fragment('rspec.example.com-jk_mounts').with( - :content => /^\s+JkUnMount\s+\/\*\.jpg\s+tcnode1$/)} - it { is_expected.to contain_concat__fragment('rspec.example.com-auth_kerb').with( - :content => /^\s+KrbMethodNegotiate\soff$/)} - it { is_expected.to contain_concat__fragment('rspec.example.com-auth_kerb').with( - :content => /^\s+KrbAuthoritative\soff$/)} - it { is_expected.to contain_concat__fragment('rspec.example.com-auth_kerb').with( - :content => /^\s+KrbAuthRealms\sEXAMPLE.ORG\sEXAMPLE.NET$/)} - it { is_expected.to contain_concat__fragment('rspec.example.com-auth_kerb').with( - :content => /^\s+Krb5Keytab\s\/tmp\/keytab5$/)} - it { is_expected.to contain_concat__fragment('rspec.example.com-auth_kerb').with( - :content => /^\s+KrbLocalUserMapping\soff$/)} - it { is_expected.to contain_concat__fragment('rspec.example.com-auth_kerb').with( - :content => /^\s+KrbServiceName\sHTTP$/)} - it { is_expected.to contain_concat__fragment('rspec.example.com-auth_kerb').with( - :content => /^\s+KrbSaveCredentials\soff$/)} - it { is_expected.to contain_concat__fragment('rspec.example.com-auth_kerb').with( - :content => /^\s+KrbVerifyKDC\son$/)} - it { is_expected.to contain_concat__fragment('rspec.example.com-http_protocol_options').with( - :content => /^\s*HttpProtocolOptions\s+Strict\s+LenientMethods\s+Allow0\.9$/)} - it { is_expected.to contain_concat__fragment('rspec.example.com-keepalive_options').with( - :content => /^\s+KeepAlive\son$/)} - it { is_expected.to contain_concat__fragment('rspec.example.com-keepalive_options').with( - :content => /^\s+KeepAliveTimeout\s100$/)} - it { is_expected.to contain_concat__fragment('rspec.example.com-keepalive_options').with( - :content => /^\s+MaxKeepAliveRequests\s1000$/)} - end - context 'vhost with multiple ip addresses' do - let :params do - { - 'port' => '80', - 'ip' => ['127.0.0.1','::1'], - 'ip_based' => true, - 'servername' => 'example.com', - 'docroot' => '/var/www/html', - 'add_listen' => true, - 'ensure' => 'present' - } - end - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '7', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :kernelversion => '3.6.2', - :is_pe => false, - } - end - - it { is_expected.to compile } - it { is_expected.to contain_concat__fragment('rspec.example.com-apache-header').with( - :content => /[.\/m]*[.\/m]*$/ ) } - it { is_expected.to contain_concat__fragment('Listen 127.0.0.1:80') } - it { is_expected.to contain_concat__fragment('Listen [::1]:80') } - it { is_expected.to_not contain_concat__fragment('NameVirtualHost 127.0.0.1:80') } - it { is_expected.to_not contain_concat__fragment('NameVirtualHost [::1]:80') } - end - - context 'vhost with multiple ports' do - let :params do - { - 'port' => ['80', '8080'], - 'ip' => '127.0.0.1', - 'ip_based' => true, - 'servername' => 'example.com', - 'docroot' => '/var/www/html', - 'add_listen' => true, - 'ensure' => 'present' - } - end - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '7', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :kernelversion => '3.6.2', - :is_pe => false, - } - end - - it { is_expected.to compile } - it { is_expected.to contain_concat__fragment('rspec.example.com-apache-header').with( - :content => /[.\/m]*[.\/m]*$/ ) } - it { is_expected.to contain_concat__fragment('Listen 127.0.0.1:80') } - it { is_expected.to contain_concat__fragment('Listen 127.0.0.1:8080') } - it { is_expected.to_not contain_concat__fragment('NameVirtualHost 127.0.0.1:80') } - it { is_expected.to_not contain_concat__fragment('NameVirtualHost 127.0.0.1:8080') } - end - - context 'vhost with multiple ip addresses, multiple ports' do - let :params do - { - 'port' => ['80', '8080'], - 'ip' => ['127.0.0.1','::1'], - 'ip_based' => true, - 'servername' => 'example.com', - 'docroot' => '/var/www/html', - 'add_listen' => true, - 'ensure' => 'present' - } - end - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '7', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :kernelversion => '3.6.2', - :is_pe => false, - } - end - - it { is_expected.to compile } - it { is_expected.to contain_concat__fragment('rspec.example.com-apache-header').with( - :content => /[.\/m]*[.\/m]*$/ ) } - it { is_expected.to contain_concat__fragment('Listen 127.0.0.1:80') } - it { is_expected.to contain_concat__fragment('Listen 127.0.0.1:8080') } - it { is_expected.to contain_concat__fragment('Listen [::1]:80') } - it { is_expected.to contain_concat__fragment('Listen [::1]:8080') } - it { is_expected.to_not contain_concat__fragment('NameVirtualHost 127.0.0.1:80') } - it { is_expected.to_not contain_concat__fragment('NameVirtualHost 127.0.0.1:8080') } - it { is_expected.to_not contain_concat__fragment('NameVirtualHost [::1]:80') } - it { is_expected.to_not contain_concat__fragment('NameVirtualHost [::1]:8080') } - end - - context 'vhost with ipv6 address' do - let :params do - { - 'port' => '80', - 'ip' => '::1', - 'ip_based' => true, - 'servername' => 'example.com', - 'docroot' => '/var/www/html', - 'add_listen' => true, - 'ensure' => 'present' - } - end - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '7', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :kernelversion => '3.6.2', - :is_pe => false, - } - end - - it { is_expected.to compile } - it { is_expected.to contain_concat__fragment('rspec.example.com-apache-header').with( - :content => /[.\/m]*[.\/m]*$/ ) } - it { is_expected.to contain_concat__fragment('Listen [::1]:80') } - it { is_expected.to_not contain_concat__fragment('NameVirtualHost [::1]:80') } - end - - context 'vhost with wildcard ip address' do - let :params do - { - 'port' => '80', - 'ip' => '*', - 'ip_based' => true, - 'servername' => 'example.com', - 'docroot' => '/var/www/html', - 'add_listen' => true, - 'ensure' => 'present' - } - end - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '7', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :kernelversion => '3.6.2', - :is_pe => false, - } - end - - it { is_expected.to compile } - it { is_expected.to contain_concat__fragment('rspec.example.com-apache-header').with( - :content => /[.\/m]*[.\/m]*$/ ) } - it { is_expected.to contain_concat__fragment('Listen *:80') } - it { is_expected.to_not contain_concat__fragment('NameVirtualHost *:80') } - end - - context 'modsec_audit_log' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'modsec_audit_log' => true, - } - end - it { is_expected.to compile } - it { is_expected.to contain_concat__fragment('rspec.example.com-security').with( - :content => /^\s*SecAuditLog "\/var\/log\/apache2\/rspec\.example\.com_security\.log"$/ ) } - end - context 'modsec_audit_log_file' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'modsec_audit_log_file' => 'foo.log', - } - end - it { is_expected.to compile } - it { is_expected.to contain_concat__fragment('rspec.example.com-security').with( - :content => /\s*SecAuditLog "\/var\/log\/apache2\/foo.log"$/ ) } - end - context 'set only aliases' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'aliases' => [ - { - 'alias' => '/alias', - 'path' => '/rspec/docroot', - }, - ] - } - end - it { is_expected.to contain_class('apache::mod::alias')} - end - context 'proxy_pass_match' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'proxy_pass_match' => [ - { - 'path' => '.*', - 'url' => 'http://backend-a/', - 'params' => { 'timeout' => 300 }, - } - ], - } - end - it { is_expected.to contain_concat__fragment('rspec.example.com-proxy').with_content( - /ProxyPassMatch .* http:\/\/backend-a\/ timeout=300/).with_content(/## Proxy rules/) } - end - context 'proxy_dest_match' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'proxy_dest_match' => '/' - } - end - it { is_expected.to contain_concat__fragment('rspec.example.com-proxy').with_content(/## Proxy rules/) } - end - context 'not everything can be set together...' do - let :params do - { - 'access_log_pipe' => '/dev/null', - 'error_log_pipe' => '/dev/null', - 'docroot' => '/var/www/foo', - 'ensure' => 'absent', - 'manage_docroot' => true, - 'logroot' => '/tmp/logroot', - 'logroot_ensure' => 'absent', - 'directories' => [ - { - 'path' => '/var/www/files', - 'provider' => 'files', - 'allow' => [ 'from 127.0.0.1', 'from 127.0.0.2', ], - 'deny' => [ 'from 127.0.0.3', 'from 127.0.0.4', ], - 'satisfy' => 'any', - }, - { - 'path' => '/var/www/foo', - 'provider' => 'files', - 'allow' => 'from 127.0.0.5', - 'deny' => 'from all', - 'order' => 'deny,allow', - }, - ], - - } - end - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :kernelversion => '3.6.2', - :is_pe => false, - } - end - - it { is_expected.to compile } - it { is_expected.to_not contain_class('apache::mod::ssl') } - it { is_expected.to_not contain_class('apache::mod::mime') } - it { is_expected.to_not contain_class('apache::mod::vhost_alias') } - it { is_expected.to_not contain_class('apache::mod::wsgi') } - it { is_expected.to_not contain_class('apache::mod::passenger') } - it { is_expected.to_not contain_class('apache::mod::suexec') } - it { is_expected.to_not contain_class('apache::mod::rewrite') } - it { is_expected.to_not contain_class('apache::mod::alias') } - it { is_expected.to_not contain_class('apache::mod::proxy') } - it { is_expected.to_not contain_class('apache::mod::proxy_http') } - it { is_expected.to_not contain_class('apache::mod::passenger') } - it { is_expected.to_not contain_class('apache::mod::headers') } - it { is_expected.to contain_file('/var/www/foo') } - it { is_expected.to contain_file('/tmp/logroot').with({ - 'ensure' => 'absent', - }) - } - it { is_expected.to contain_concat('25-rspec.example.com.conf').with({ - 'ensure' => 'absent', - }) - } - it { is_expected.to contain_concat__fragment('rspec.example.com-apache-header') } - it { is_expected.to contain_concat__fragment('rspec.example.com-docroot') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-aliases') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-itk') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-fallbackresource') } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories') } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Allow from 127\.0\.0\.1$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Allow from 127\.0\.0\.2$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Allow from 127\.0\.0\.5$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Deny from 127\.0\.0\.3$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Deny from 127\.0\.0\.4$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Deny from all$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Satisfy any$/ ) } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Order deny,allow$/ ) } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-additional_includes') } - it { is_expected.to contain_concat__fragment('rspec.example.com-logging') } - it { is_expected.to contain_concat__fragment('rspec.example.com-serversignature') } - it { is_expected.to contain_concat__fragment('rspec.example.com-access_log') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-action') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-block') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-error_document') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-proxy') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-rack') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-redirect') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-rewrite') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-scriptalias') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-serveralias') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-setenv') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-ssl') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-sslproxy') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-suphp') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-php_admin') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-header') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-requestheader') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-wsgi') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-custom_fragment') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-fastcgi') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-suexec') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-charsets') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-limits') } - it { is_expected.to contain_concat__fragment('rspec.example.com-file_footer') } - end - context 'when not setting nor managing the docroot' do - let :params do - { - 'docroot' => false, - 'manage_docroot' => false, - } - end - it { is_expected.to compile } - it { is_expected.not_to contain_concat__fragment('rspec.example.com-docroot') } - end - context 'ssl_proxyengine without ssl' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'ssl' => false, - 'ssl_proxyengine' => true, - } - end - it { is_expected.to compile } - it { is_expected.not_to contain_concat__fragment('rspec.example.com-ssl') } - it { is_expected.to contain_concat__fragment('rspec.example.com-sslproxy') } - end - context 'ssl_proxy_protocol without ssl_proxyengine' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'ssl' => true, - 'ssl_proxyengine' => false, - 'ssl_proxy_protocol' => 'TLSv1.2', - } - end - it { is_expected.to compile } - it { is_expected.to contain_concat__fragment('rspec.example.com-ssl') } - it { is_expected.not_to contain_concat__fragment('rspec.example.com-sslproxy') } - end - end - describe 'access logs' do - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context 'single log file' do - let(:params) do - { - 'docroot' => '/rspec/docroot', - 'access_log_file' => 'my_log_file', - } - end - it { is_expected.to contain_concat__fragment('rspec.example.com-access_log').with( - :content => /^\s+CustomLog.*my_log_file" combined\s*$/ - )} - end - context 'single log file with environment' do - let(:params) do - { - 'docroot' => '/rspec/docroot', - 'access_log_file' => 'my_log_file', - 'access_log_env_var' => 'prod' - } - end - it { is_expected.to contain_concat__fragment('rspec.example.com-access_log').with( - :content => /^\s+CustomLog.*my_log_file" combined\s+env=prod$/ - )} - end - context 'multiple log files' do - let(:params) do - { - 'docroot' => '/rspec/docroot', - 'access_logs' => [ - { 'file' => '/tmp/log1', 'env' => 'dev' }, - { 'file' => 'log2' }, - { 'syslog' => 'syslog', 'format' => '%h %l' } - ], - } - end - it { is_expected.to contain_concat__fragment('rspec.example.com-access_log').with( - :content => /^\s+CustomLog "\/tmp\/log1"\s+combined\s+env=dev$/ - )} - it { is_expected.to contain_concat__fragment('rspec.example.com-access_log').with( - :content => /^\s+CustomLog "\/var\/log\/httpd\/log2"\s+combined\s*$/ - )} - it { is_expected.to contain_concat__fragment('rspec.example.com-access_log').with( - :content => /^\s+CustomLog "syslog" "%h %l"\s*$/ - )} - end - end # access logs - describe 'validation' do - let :default_facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '6', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :is_pe => false, - } - end - context 'bad ensure' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'ensure' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad suphp_engine' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'suphp_engine' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad ip_based' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'ip_based' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad access_log' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'access_log' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad error_log' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'error_log' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad_ssl' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'ssl' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad default_vhost' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'default_vhost' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad ssl_proxyengine' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'ssl_proxyengine' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad rewrites' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'rewrites' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad rewrites 2' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'rewrites' => ['bogus'], - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'empty rewrites' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'rewrites' => [], - } - end - let :facts do default_facts end - it { is_expected.to compile } - end - context 'bad suexec_user_group' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'suexec_user_group' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad wsgi_script_alias' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'wsgi_script_alias' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad wsgi_daemon_process_options' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'wsgi_daemon_process_options' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad wsgi_import_script_alias' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'wsgi_import_script_alias' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad itk' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'itk' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad logroot_ensure' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'log_level' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad log_level' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'log_level' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'access_log_file and access_log_pipe' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'access_log_file' => 'bogus', - 'access_log_pipe' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'error_log_file and error_log_pipe' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'error_log_file' => 'bogus', - 'error_log_pipe' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad fallbackresource' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'fallbackresource' => 'bogus', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad custom_fragment' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'custom_fragment' => true, - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'bad access_logs' do - let :params do - { - 'docroot' => '/rspec/docroot', - 'access_logs' => '/var/log/somewhere', - } - end - let :facts do default_facts end - it { expect { is_expected.to compile }.to raise_error } - end - context 'default of require all granted' do - let :params do - { - 'docroot' => '/var/www/foo', - 'directories' => [ - { - 'path' => '/var/www/foo/files', - 'provider' => 'files', - }, - ], - - } - end - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '7', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :kernelversion => '3.19.2', - :is_pe => false, - } - end - - it { is_expected.to compile } - it { is_expected.to contain_concat('25-rspec.example.com.conf') } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories') } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Require all granted$/ ) } - end - context 'require unmanaged' do - let :params do - { - 'docroot' => '/var/www/foo', - 'directories' => [ - { - 'path' => '/var/www/foo', - 'require' => 'unmanaged', - }, - ], - - } - end - let :facts do - { - :osfamily => 'RedHat', - :operatingsystemrelease => '7', - :concat_basedir => '/dne', - :operatingsystem => 'RedHat', - :id => 'root', - :kernel => 'Linux', - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :kernelversion => '3.19.2', - :is_pe => false, - } - end - - it { is_expected.to compile } - it { is_expected.to contain_concat('25-rspec.example.com.conf') } - it { is_expected.to contain_concat__fragment('rspec.example.com-directories') } - it { is_expected.to_not contain_concat__fragment('rspec.example.com-directories').with( - :content => /^\s+Require all granted$/ ) - } - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/fixtures/files/negotiation.conf b/modules/services/unix/http/apache_stretch_compatible/apache/spec/fixtures/files/negotiation.conf deleted file mode 100644 index c0bb8b9fd..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/fixtures/files/negotiation.conf +++ /dev/null @@ -1,4 +0,0 @@ -# This is a file only for spec testing - -LanguagePriority en ca cs da de el eo es et fr he hr it ja ko ltz nl nn no pl pt pt-BR ru sv zh-CN zh-TW -ForceLanguagePriority Prefer Fallback diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/fixtures/files/spec b/modules/services/unix/http/apache_stretch_compatible/apache/spec/fixtures/files/spec deleted file mode 100644 index 76e9a1446..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/fixtures/files/spec +++ /dev/null @@ -1 +0,0 @@ -# This is a file only for spec testing diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/fixtures/site_apache/templates/fake.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/fixtures/site_apache/templates/fake.conf.erb deleted file mode 100644 index 019debfe4..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/fixtures/site_apache/templates/fake.conf.erb +++ /dev/null @@ -1 +0,0 @@ -Fake template for rspec. diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/fixtures/templates/negotiation.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/fixtures/templates/negotiation.conf.erb deleted file mode 100644 index 557502246..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/fixtures/templates/negotiation.conf.erb +++ /dev/null @@ -1,4 +0,0 @@ -# This is a template only for spec testing - -LanguagePriority en ca cs da de el eo es et fr he hr it ja ko ltz nl nn no pl pt pt-BR ru sv zh-CN zh-TW -ForceLanguagePriority Prefer Fallback diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/spec_helper.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/spec_helper.rb deleted file mode 100644 index 22d5d689f..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/spec_helper.rb +++ /dev/null @@ -1,8 +0,0 @@ -#This file is generated by ModuleSync, do not edit. -require 'puppetlabs_spec_helper/module_spec_helper' - -# put local configuration and setup into spec_helper_local -begin - require 'spec_helper_local' -rescue LoadError -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/spec_helper_acceptance.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/spec_helper_acceptance.rb deleted file mode 100644 index c652104c2..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/spec_helper_acceptance.rb +++ /dev/null @@ -1,77 +0,0 @@ -require 'beaker-rspec/spec_helper' -require 'beaker-rspec/helpers/serverspec' -require 'beaker/puppet_install_helper' -require 'beaker/module_install_helper' - -run_puppet_install_helper -install_module_on(hosts) -install_module_dependencies_on(hosts) - -RSpec.configure do |c| - c.filter_run :focus => true - c.run_all_when_everything_filtered = true - # apache on Ubuntu 10.04 and 12.04 doesn't like IPv6 VirtualHosts, so we skip ipv6 tests on those systems - if fact('operatingsystem') == 'Ubuntu' and (fact('operatingsystemrelease') == '10.04' or fact('operatingsystemrelease') == '12.04') - c.filter_run_excluding :ipv6 => true - end - - # Readable test descriptions - c.formatter = :documentation - - # detect the situation where PUP-5016 is triggered and skip the idempotency tests in that case - # also note how fact('puppetversion') is not available because of PUP-4359 - if fact('osfamily') == 'Debian' && fact('operatingsystemmajrelease') == '8' && shell('puppet --version').stdout =~ /^4\.2/ - c.filter_run_excluding :skip_pup_5016 => true - end - - # Configure all nodes in nodeset - c.before :suite do - # net-tools required for netstat utility being used by be_listening - if fact('osfamily') == 'RedHat' && fact('operatingsystemmajrelease') == '7' - pp = <<-EOS - package { 'net-tools': ensure => installed } - EOS - - apply_manifest_on(agents, pp, :catch_failures => false) - end - - if fact('osfamily') == 'Debian' - # Make sure snake-oil certs are installed. - shell 'apt-get install -y ssl-cert' - end - - # Install module and dependencies - hosts.each do |host| - # Required for mod_passenger tests. - if fact('osfamily') == 'RedHat' - on host, puppet('module','install','stahnma/epel') - on host, puppet('module','install','puppetlabs/inifile') - #we need epel installed, so we can get plugins, wsgi, mime ... - pp = <<-EOS - class { 'epel': } - EOS - - apply_manifest_on(host, pp, :catch_failures => true) - end - - # Required for manifest to make mod_pagespeed repository available - if fact('osfamily') == 'Debian' - on host, puppet('module','install','puppetlabs-apt') - end - - # Make sure selinux is disabled so the tests work. - on host, puppet('apply', '-e', - %{"exec { 'setenforce 0': path => '/bin:/sbin:/usr/bin:/usr/sbin', onlyif => 'which setenforce && getenforce | grep Enforcing', }"}) - end - end -end - -shared_examples "a idempotent resource" do - it 'should apply with no errors' do - apply_manifest(pp, :catch_failures => true) - end - - it 'should apply a second time without changes', :skip_pup_5016 do - apply_manifest(pp, :catch_changes => true) - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/spec_helper_local.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/spec_helper_local.rb deleted file mode 100644 index d861a1c49..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/spec_helper_local.rb +++ /dev/null @@ -1,39 +0,0 @@ -RSpec.configure do |c| - c.before :each do - # Ensure that we don't accidentally cache facts and environment - # between test cases. - Facter::Util::Loader.any_instance.stubs(:load_all) - Facter.clear - Facter.clear_messages - end -end - -RSpec.configure do |config| - config.filter_run focus: true - config.run_all_when_everything_filtered = true - #as soon as psh is updated, the following line can be removed - config.mock_with :rspec -end - -shared_examples :compile, :compile => true do - it { should compile.with_all_deps } -end - -shared_examples 'a mod class, without including apache' do - let :facts do - { - :id => 'root', - :lsbdistcodename => 'squeeze', - :kernel => 'Linux', - :osfamily => 'Debian', - :operatingsystem => 'Debian', - :operatingsystemrelease => '6', - :operatingsystemmajrelease => nil, - :path => '/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin', - :concat_basedir => '/dne', - :is_pe => false, - :hardwaremodel => 'x86_64', - } - end - it { should compile.with_all_deps } -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/unit/apache_version_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/unit/apache_version_spec.rb deleted file mode 100644 index 2036449fd..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/unit/apache_version_spec.rb +++ /dev/null @@ -1,33 +0,0 @@ -require 'spec_helper' - -describe Facter::Util::Fact do - before do - Facter.clear - end - - describe 'apache_version' do - context 'with value' do - before :each do - expect(Facter::Util::Resolution).to receive(:which).with('apachectl') { true } - expect(Facter::Util::Resolution).to receive(:exec).with('apachectl -v 2>&1') {'Server version: Apache/2.4.16 (Unix) - Server built: Jul 31 2015 15:53:26'} - end - it do - expect(Facter.fact(:apache_version).value).to eq('2.4.16') - end - end - end - - describe 'apache_version with empty OS' do - context 'with value' do - before :each do - expect(Facter::Util::Resolution).to receive(:which).with('apachectl') { true } - expect(Facter::Util::Resolution).to receive(:exec).with('apachectl -v 2>&1') {'Server version: Apache/2.4.6 () - Server built: Nov 21 2015 05:34:59' } - end - it do - expect(Facter.fact(:apache_version).value).to eq('2.4.6') - end - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/unit/provider/a2mod/gentoo_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/unit/provider/a2mod/gentoo_spec.rb deleted file mode 100644 index 1bccc94d1..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/unit/provider/a2mod/gentoo_spec.rb +++ /dev/null @@ -1,182 +0,0 @@ -require 'spec_helper' - -provider_class = Puppet::Type.type(:a2mod).provider(:gentoo) - -describe provider_class do - before :each do - provider_class.clear - end - - [:conf_file, :instances, :modules, :initvars, :conf_file, :clear].each do |method| - it "should respond to the class method #{method}" do - expect(provider_class).to respond_to(method) - end - end - - describe "when fetching modules" do - before do - @filetype = double() - end - - it "should return a sorted array of the defined parameters" do - expect(@filetype).to receive(:read) { %Q{APACHE2_OPTS="-D FOO -D BAR -D BAZ"\n} } - expect(provider_class).to receive(:filetype) { @filetype } - - expect(provider_class.modules).to eq(%w{bar baz foo}) - end - - it "should cache the module list" do - expect(@filetype).to receive(:read).once { %Q{APACHE2_OPTS="-D FOO -D BAR -D BAZ"\n} } - expect(provider_class).to receive(:filetype).once { @filetype } - - 2.times { expect(provider_class.modules).to eq(%w{bar baz foo}) } - end - - it "should normalize parameters" do - @filetype.expects(:read).returns(%Q{APACHE2_OPTS="-D FOO -D BAR -D BAR"\n}) - provider_class.expects(:filetype).returns(@filetype) - - expect(provider_class.modules).to eq(%w{bar foo}) - end - end - - describe "when prefetching" do - it "should match providers to resources" do - provider = double("ssl_provider", :name => "ssl") - resource = double("ssl_resource") - resource.expects(:provider=).with(provider) - - expect(provider_class).to receive(:instances) { [provider] } - provider_class.prefetch("ssl" => resource) - end - end - - describe "when flushing" do - before :each do - @filetype = double() - allow(@filetype).to receive(:backup) - allow(provider_class).to receive(:filetype).at_least(:once) { @filetype } - - @info = double() - allow(@info).to receive(:[]).with(:name) { "info" } - allow(@info).to receive(:provider=) - - @mpm = double() - allow(@mpm).to receive(:[]).with(:name) { "mpm" } - allow(@mpm).to receive(:provider=) - - @ssl = double() - allow(@ssl).to receive(:[]).with(:name) { "ssl" } - allow(@ssl).to receive(:provider=) - end - - it "should add modules whose ensure is present" do - expect(@filetype).to receive(:read).at_least(:once) { %Q{APACHE2_OPTS=""} } - expect(@filetype).to receive(:write).with(%Q{APACHE2_OPTS="-D INFO"}) - - allow(@info).to receive(:should).with(:ensure) { :present } - provider_class.prefetch("info" => @info) - - provider_class.flush - end - - it "should remove modules whose ensure is present" do - expect(@filetype).to receive(:read).at_least(:once) { %Q{APACHE2_OPTS="-D INFO"} } - expect(@filetype).to receive(:write).with(%Q{APACHE2_OPTS=""}) - - allow(@info).to receive(:should).with(:ensure) { :absent } - allow(@info).to receive(:provider=) - provider_class.prefetch("info" => @info) - - provider_class.flush - end - - it "should not modify providers without resources" do - expect(@filetype).to receive(:read).at_least(:once) { %Q{APACHE2_OPTS="-D INFO -D MPM"} } - expect(@filetype).to receive(:write).with(%Q{APACHE2_OPTS="-D MPM -D SSL"}) - - allow(@info).to receive(:should).with(:ensure) { :absent } - provider_class.prefetch("info" => @info) - - allow(@ssl).to receive(:should).with(:ensure) { :present } - provider_class.prefetch("ssl" => @ssl) - - provider_class.flush - end - - it "should write the modules in sorted order" do - expect(@filetype).to receive(:read).at_least(:once) { %Q{APACHE2_OPTS=""} } - expect(@filetype).to receive(:write).with(%Q{APACHE2_OPTS="-D INFO -D MPM -D SSL"}) - - allow(@mpm).to receive(:should).with(:ensure) { :present } - provider_class.prefetch("mpm" => @mpm) - allow(@info).to receive(:should).with(:ensure) { :present } - provider_class.prefetch("info" => @info) - allow(@ssl).to receive(:should).with(:ensure) { :present } - provider_class.prefetch("ssl" => @ssl) - - provider_class.flush - end - - it "should write the records back once" do - expect(@filetype).to receive(:read).at_least(:once) { %Q{APACHE2_OPTS=""} } - expect(@filetype).to receive(:write).once.with(%Q{APACHE2_OPTS="-D INFO -D SSL"}) - - allow(@info).to receive(:should).with(:ensure) { :present } - provider_class.prefetch("info" => @info) - - allow(@ssl).to receive(:should).with(:ensure) { :present } - provider_class.prefetch("ssl" => @ssl) - - provider_class.flush - end - - it "should only modify the line containing APACHE2_OPTS" do - expect(@filetype).to receive(:read).at_least(:once) { %Q{# Comment\nAPACHE2_OPTS=""\n# Another comment} } - expect(@filetype).to receive(:write).once.with(%Q{# Comment\nAPACHE2_OPTS="-D INFO"\n# Another comment}) - - allow(@info).to receive(:should).with(:ensure) { :present } - provider_class.prefetch("info" => @info) - provider_class.flush - end - - it "should restore any arbitrary arguments" do - expect(@filetype).to receive(:read).at_least(:once) { %Q{APACHE2_OPTS="-Y -D MPM -X"} } - expect(@filetype).to receive(:write).once.with(%Q{APACHE2_OPTS="-Y -X -D INFO -D MPM"}) - - allow(@info).to receive(:should).with(:ensure) { :present } - provider_class.prefetch("info" => @info) - provider_class.flush - end - - it "should backup the file once if changes were made" do - expect(@filetype).to receive(:read).at_least(:once) { %Q{APACHE2_OPTS=""} } - expect(@filetype).to receive(:write).once.with(%Q{APACHE2_OPTS="-D INFO -D SSL"}) - - allow(@info).to receive(:should).with(:ensure) { :present } - provider_class.prefetch("info" => @info) - - allow(@ssl).to receive(:should).with(:ensure) { :present } - provider_class.prefetch("ssl" => @ssl) - - @filetype.unstub(:backup) - @filetype.expects(:backup) - provider_class.flush - end - - it "should not write the file or run backups if no changes were made" do - expect(@filetype).to receive(:read).at_least(:once) { %Q{APACHE2_OPTS="-X -D INFO -D SSL -Y"} } - expect(@filetype).to receive(:write).never - - allow(@info).to receive(:should).with(:ensure) { :present } - provider_class.prefetch("info" => @info) - - allow(@ssl).to receive(:should).with(:ensure) { :present } - provider_class.prefetch("ssl" => @ssl) - - @filetype.unstub(:backup) - @filetype.expects(:backup).never - provider_class.flush - end - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/unit/puppet/parser/functions/bool2httpd_spec.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/unit/puppet/parser/functions/bool2httpd_spec.rb deleted file mode 100644 index 19d35e592..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/unit/puppet/parser/functions/bool2httpd_spec.rb +++ /dev/null @@ -1,53 +0,0 @@ -require 'spec_helper' - -describe "the bool2httpd function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("bool2httpd")).to eq("function_bool2httpd") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_bool2httpd([]) }.to( raise_error(Puppet::ParseError)) - end - - it "should convert true to 'On'" do - result = scope.function_bool2httpd([true]) - expect(result).to(eq('On')) - end - - it "should convert true to a string" do - result = scope.function_bool2httpd([true]) - expect(result.class).to(eq(String)) - end - - it "should convert false to 'Off'" do - result = scope.function_bool2httpd([false]) - expect(result).to(eq('Off')) - end - - it "should convert false to a string" do - result = scope.function_bool2httpd([false]) - expect(result.class).to(eq(String)) - end - - it "should accept (and return) any string" do - result = scope.function_bool2httpd(["mail"]) - expect(result).to(eq('mail')) - end - - it "should accept a nil value (and return Off)" do - result = scope.function_bool2httpd([nil]) - expect(result).to(eq('Off')) - end - - it "should accept an undef value (and return 'Off')" do - result = scope.function_bool2httpd([:undef]) - expect(result).to(eq('Off')) - end - - it "should return a default value on non-matches" do - result = scope.function_bool2httpd(['foo']) - expect(result).to(eq('foo')) - end -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/spec/unit/puppet/parser/functions/validate_apache_log_level.rb b/modules/services/unix/http/apache_stretch_compatible/apache/spec/unit/puppet/parser/functions/validate_apache_log_level.rb deleted file mode 100644 index dfef66eea..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/spec/unit/puppet/parser/functions/validate_apache_log_level.rb +++ /dev/null @@ -1,39 +0,0 @@ -#! /usr/bin/env ruby -S rspec -require 'spec_helper' - -describe "the validate_apache_log_level function" do - let(:scope) { PuppetlabsSpec::PuppetInternals.scope } - - it "should exist" do - expect(Puppet::Parser::Functions.function("validate_apache_log_level")).to eq("function_validate_apache_log_level") - end - - it "should raise a ParseError if there is less than 1 arguments" do - expect { scope.function_validate_apache_log_level([]) }.to( raise_error(Puppet::ParseError) ) - end - - it "should raise a ParseError when given garbage" do - expect { scope.function_validate_apache_log_level(['garbage']) }.to( raise_error(Puppet::ParseError) ) - end - - it "should not raise a ParseError when given a plain log level" do - expect { scope.function_validate_apache_log_level(['info']) }.to_not raise_error - end - - it "should not raise a ParseError when given a log level and module log level" do - expect { scope.function_validate_apache_log_level(['warn ssl:info']) }.to_not raise_error - end - - it "should not raise a ParseError when given a log level and module log level" do - expect { scope.function_validate_apache_log_level(['warn mod_ssl.c:info']) }.to_not raise_error - end - - it "should not raise a ParseError when given a log level and module log level" do - expect { scope.function_validate_apache_log_level(['warn ssl_module:info']) }.to_not raise_error - end - - it "should not raise a ParseError when given a trace level" do - expect { scope.function_validate_apache_log_level(['trace4']) }.to_not raise_error - end - -end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/tasks/init.json b/modules/services/unix/http/apache_stretch_compatible/apache/tasks/init.json new file mode 100644 index 000000000..3822ed643 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/tasks/init.json @@ -0,0 +1,14 @@ +{ + "description": "Allows you to perform apache service functions", + "input_method": "stdin", + "parameters": { + "action": { + "description": "Action to perform ", + "type": "Enum[reload]" + }, + "service_name": { + "description": "The name of the apache service ", + "type": "Optional[String[1]]" + } + } +} diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/tasks/init.rb b/modules/services/unix/http/apache_stretch_compatible/apache/tasks/init.rb new file mode 100755 index 000000000..bb82d9aa7 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/tasks/init.rb @@ -0,0 +1,36 @@ +#!/opt/puppetlabs/puppet/bin/ruby +# frozen_string_literal: true + +require 'json' +require 'open3' +require 'puppet' + +def service(action, service_name) + if service_name.nil? + stdout, _stderr, _status = Open3.capture3('facter', '-p', 'osfamily') + osfamily = stdout.strip + service_name = if osfamily == 'RedHat' + 'httpd' + elsif osfamily == 'FreeBSD' + 'apache24' + else + 'apache2' + end + end + _stdout, stderr, status = Open3.capture3('service', service_name, action) + raise Puppet::Error, stderr if status != 0 + { status: "#{action} successful" } +end + +params = JSON.parse(STDIN.read) +action = params['action'] +service_name = params['service_name'] + +begin + result = service(action, service_name) + puts result.to_json + exit 0 +rescue Puppet::Error => e + puts({ status: 'failure', error: e.message }.to_json) + exit 1 +end diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/httpd.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/httpd.conf.erb index d5b31c738..b19d8da81 100755 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/httpd.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/httpd.conf.erb @@ -1,7 +1,7 @@ # Security ServerTokens <%= @server_tokens %> -ServerSignature <%= scope.function_bool2httpd([@server_signature]) %> -TraceEnable <%= scope.function_bool2httpd([@trace_enable]) %> +ServerSignature <%= scope.call_function('apache::bool2httpd', [@server_signature]) %> +TraceEnable <%= scope.call_function('apache::bool2httpd', [@trace_enable]) %> ServerName "<%= @servername %>" ServerRoot "<%= @server_root %>" @@ -11,11 +11,22 @@ KeepAlive <%= @keepalive %> MaxKeepAliveRequests <%= @max_keepalive_requests %> KeepAliveTimeout <%= @keepalive_timeout %> LimitRequestFieldSize <%= @limitreqfieldsize %> -# Actually >= 2.4.24, but the minor version is not provided +LimitRequestFields <%= @limitreqfields %> +<%# Actually >= 2.4.24, but the minor version is not provided -%> <%- if @http_protocol_options and scope.function_versioncmp([@apache_version, '2.4']) >= 0 -%> HttpProtocolOptions <%= @http_protocol_options %> <%- end -%> +<%# Actually >= 2.4.17, but the minor version is not provided -%> +<%- if scope.function_versioncmp([@apache_version, '2.4']) >= 0 -%> + <%- unless @protocols.empty? -%> +Protocols <%= @protocols.join(' ') %> + <%- end -%> + <%- unless @protocols_honor_order.nil? -%> +ProtocolsHonorOrder <%= scope.call_function('apache::bool2httpd', [@protocols_honor_order]) %> + <%- end -%> +<%- end -%> + <%- if @rewrite_lock and scope.function_versioncmp([@apache_version, '2.2']) <= 0 -%> RewriteLock <%= @rewrite_lock %> <%- end -%> @@ -24,7 +35,7 @@ User <%= @user %> Group <%= @group %> AccessFileName .htaccess -> + <%- if scope.function_versioncmp([@apache_version, '2.4']) >= 0 -%> Require all denied <%- else -%> @@ -54,7 +65,7 @@ AddDefaultCharset <%= @default_charset %> <%- if scope.function_versioncmp([@apache_version, '2.4']) < 0 -%> DefaultType <%= @default_type %> <%- end -%> -HostnameLookups Off +HostnameLookups <%= @hostname_lookups %> <%- if /^[|\/]/.match(@error_log) || /^syslog:/.match(@error_log) -%> ErrorLog "<%= @error_log %>" <%- else -%> @@ -68,6 +79,9 @@ AllowEncodedSlashes <%= @allow_encoded_slashes %> <%- if @file_e_tag -%> FileETag <%= @file_e_tag %> <%- end -%> +<%- if @use_canonical_name -%> +UseCanonicalName <%= @use_canonical_name %> +<%- end -%> #Listen 80 @@ -85,10 +99,10 @@ Include "<%= @mod_load_dir %>/*.conf" Include "<%= @ports_file %>" <% unless @log_formats.has_key?('combined') -%> -LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined +LogFormat "%a %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined <% end -%> <% unless @log_formats.has_key?('common') -%> -LogFormat "%h %l %u %t \"%r\" %>s %b" common +LogFormat "%a %l %u %t \"%r\" %>s %b" common <% end -%> <% unless @log_formats.has_key?('referer') -%> LogFormat "%{Referer}i -> %U" referer @@ -105,6 +119,9 @@ LogFormat "<%= format -%>" <%= nickname %> <%- end -%> <% end -%> +<%- if @conf_enabled and scope.function_versioncmp([@apache_version, '2.4']) >= 0 -%> +IncludeOptional "<%= @conf_enabled %>/*.conf" +<%- end -%> <%- if scope.function_versioncmp([@apache_version, '2.4']) >= 0 -%> IncludeOptional "<%= @confd_dir %>/*.conf" <%- else -%> @@ -117,12 +134,18 @@ IncludeOptional "<%= @vhost_load_dir %>/<%= @vhost_include_pattern %>" Include "<%= @vhost_load_dir %>/<%= @vhost_include_pattern %>" <%- end -%> <% end -%> +<% if @ldap_verify_server_cert -%> +LDAPVerifyServerCert <%= @ldap_verify_server_cert %> +<% end -%> +<% if @ldap_trusted_mode -%> +LDAPTrustedMode <%= @ldap_trusted_mode %> +<% end -%> <% if @error_documents -%> # /usr/share/apache2/error on debian Alias /error/ "<%= @error_documents_path %>/" -> +"> AllowOverride None Options IncludesNoExec AddOutputFilter Includes html diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/_allow.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/_allow.erb new file mode 100644 index 000000000..0542e49a6 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/_allow.erb @@ -0,0 +1,7 @@ + Order deny,allow + Deny from all +<% if @allow_from != nil and ! @allow_from.empty? -%> + Allow from <%= Array(@allow_from).join(" ") %> +<% else -%> + Allow from <%= Array(@allow_defaults).join(" ") %> +<% end -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/_require.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/_require.erb new file mode 100644 index 000000000..d55e312e9 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/_require.erb @@ -0,0 +1,41 @@ +<% if @requires != nil -%> + <%- _requires = @requires -%> +<% elsif @allow_from != nil and ! @allow_from.empty? -%> + <%- scope.function_warning(["Class #{@title}: Using Allow is deprecated in Apache #{@_apache_version}"]) -%> + <%- _requires = 'ip ' + Array(@allow_from).join(" ") -%> +<% else -%> + <%- _requires = @requires_defaults -%> +<% end -%> +<%-# -%> +<% if _requires.is_a?(String) -%> + <%- if ! ['', 'unmanaged'].include?_requires.downcase -%> + Require <%= _requires %> + <%- end -%> +<% elsif _requires.is_a?(Array) -%> + <%- _requires.each do |req| -%> + Require <%= req %> + <%- end -%> +<% elsif _requires.is_a?(Hash) -%> + <%- if _requires.has_key?('enforce') and ['all', 'none', 'any'].include?_requires['enforce'].downcase -%> + <%- enforce_str = "Require#{_requires['enforce'].capitalize}>\n" -%> + <%- enforce_open = " <#{enforce_str}" -%> + <%- enforce_close = " + <%- indentation = ' ' -%> + <%- else -%> + <%- if _requires.has_key?('enforce') -%> + <%- scope.function_warning(["Class #{@title}: Require can only be overwritten with all, none or any."]) -%> + <%- end -%> + <%- enforce_open = '' -%> + <%- enforce_close = '' -%> + <%- indentation = '' -%> + <%- end -%> + <%- if _requires.has_key?('requires') and _requires['requires'].is_a?(Array) -%> +<%# %><%= enforce_open -%> + <%- _requires['requires'].each do |req| -%> +<%# %> <%= indentation -%>Require <%= req %> + <%- end -%> +<%# %><%= enforce_close -%> + <%- else -%> + <%- scope.function_warning(["Class #{@title}: Require hash must have a key named \"requires\" with array value"]) -%> + <%- end -%> +<% end -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/alias.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/alias.conf.erb index 8580f707c..313fdf9d1 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/alias.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/alias.conf.erb @@ -1,5 +1,5 @@ -Alias /icons/ "<%= @icons_path %>/" +Alias /<%= @icons_prefix %>/ "<%= @icons_path %>/" "> Options <%= @icons_options %> AllowOverride None diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/autoindex.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/autoindex.conf.erb index ef6bbebea..e097f9c9b 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/autoindex.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/autoindex.conf.erb @@ -1,56 +1,56 @@ IndexOptions FancyIndexing VersionSort HTMLTable NameWidth=* DescriptionWidth=* Charset=UTF-8 -AddIconByEncoding (CMP,/icons/compressed.gif) x-compress x-gzip x-bzip2 +AddIconByEncoding (CMP,/<%= @icons_prefix %>/compressed.gif) x-compress x-gzip x-bzip2 -AddIconByType (TXT,/icons/text.gif) text/* -AddIconByType (IMG,/icons/image2.gif) image/* -AddIconByType (SND,/icons/sound2.gif) audio/* -AddIconByType (VID,/icons/movie.gif) video/* +AddIconByType (TXT,/<%= @icons_prefix %>/text.gif) text/* +AddIconByType (IMG,/<%= @icons_prefix %>/image2.gif) image/* +AddIconByType (SND,/<%= @icons_prefix %>/sound2.gif) audio/* +AddIconByType (VID,/<%= @icons_prefix %>/movie.gif) video/* -AddIcon /icons/binary.gif .bin .exe -AddIcon /icons/binhex.gif .hqx -AddIcon /icons/tar.gif .tar -AddIcon /icons/world2.gif .wrl .wrl.gz .vrml .vrm .iv -AddIcon /icons/compressed.gif .Z .z .tgz .gz .zip -AddIcon /icons/a.gif .ps .ai .eps -AddIcon /icons/layout.gif .html .shtml .htm .pdf -AddIcon /icons/text.gif .txt -AddIcon /icons/c.gif .c -AddIcon /icons/p.gif .pl .py -AddIcon /icons/f.gif .for -AddIcon /icons/dvi.gif .dvi -AddIcon /icons/uuencoded.gif .uu -AddIcon /icons/script.gif .conf .sh .shar .csh .ksh .tcl -AddIcon /icons/tex.gif .tex -AddIcon /icons/bomb.gif /core -AddIcon (SND,/icons/sound2.gif) .ogg -AddIcon (VID,/icons/movie.gif) .ogm +AddIcon /<%= @icons_prefix %>/binary.gif .bin .exe +AddIcon /<%= @icons_prefix %>/binhex.gif .hqx +AddIcon /<%= @icons_prefix %>/tar.gif .tar +AddIcon /<%= @icons_prefix %>/world2.gif .wrl .wrl.gz .vrml .vrm .iv +AddIcon /<%= @icons_prefix %>/compressed.gif .Z .z .tgz .gz .zip +AddIcon /<%= @icons_prefix %>/a.gif .ps .ai .eps +AddIcon /<%= @icons_prefix %>/layout.gif .html .shtml .htm .pdf +AddIcon /<%= @icons_prefix %>/text.gif .txt +AddIcon /<%= @icons_prefix %>/c.gif .c +AddIcon /<%= @icons_prefix %>/p.gif .pl .py +AddIcon /<%= @icons_prefix %>/f.gif .for +AddIcon /<%= @icons_prefix %>/dvi.gif .dvi +AddIcon /<%= @icons_prefix %>/uuencoded.gif .uu +AddIcon /<%= @icons_prefix %>/script.gif .conf .sh .shar .csh .ksh .tcl +AddIcon /<%= @icons_prefix %>/tex.gif .tex +AddIcon /<%= @icons_prefix %>/bomb.gif /core +AddIcon (SND,/<%= @icons_prefix %>/sound2.gif) .ogg +AddIcon (VID,/<%= @icons_prefix %>/movie.gif) .ogm -AddIcon /icons/back.gif .. -AddIcon /icons/hand.right.gif README -AddIcon /icons/folder.gif ^^DIRECTORY^^ -AddIcon /icons/blank.gif ^^BLANKICON^^ +AddIcon /<%= @icons_prefix %>/back.gif .. +AddIcon /<%= @icons_prefix %>/hand.right.gif README +AddIcon /<%= @icons_prefix %>/folder.gif ^^DIRECTORY^^ +AddIcon /<%= @icons_prefix %>/blank.gif ^^BLANKICON^^ -AddIcon /icons/odf6odt-20x22.png .odt -AddIcon /icons/odf6ods-20x22.png .ods -AddIcon /icons/odf6odp-20x22.png .odp -AddIcon /icons/odf6odg-20x22.png .odg -AddIcon /icons/odf6odc-20x22.png .odc -AddIcon /icons/odf6odf-20x22.png .odf -AddIcon /icons/odf6odb-20x22.png .odb -AddIcon /icons/odf6odi-20x22.png .odi -AddIcon /icons/odf6odm-20x22.png .odm +AddIcon /<%= @icons_prefix %>/odf6odt<%= @icon_suffix %>.png .odt +AddIcon /<%= @icons_prefix %>/odf6ods<%= @icon_suffix %>.png .ods +AddIcon /<%= @icons_prefix %>/odf6odp<%= @icon_suffix %>.png .odp +AddIcon /<%= @icons_prefix %>/odf6odg<%= @icon_suffix %>.png .odg +AddIcon /<%= @icons_prefix %>/odf6odc<%= @icon_suffix %>.png .odc +AddIcon /<%= @icons_prefix %>/odf6odf<%= @icon_suffix %>.png .odf +AddIcon /<%= @icons_prefix %>/odf6odb<%= @icon_suffix %>.png .odb +AddIcon /<%= @icons_prefix %>/odf6odi<%= @icon_suffix %>.png .odi +AddIcon /<%= @icons_prefix %>/odf6odm<%= @icon_suffix %>.png .odm -AddIcon /icons/odf6ott-20x22.png .ott -AddIcon /icons/odf6ots-20x22.png .ots -AddIcon /icons/odf6otp-20x22.png .otp -AddIcon /icons/odf6otg-20x22.png .otg -AddIcon /icons/odf6otc-20x22.png .otc -AddIcon /icons/odf6otf-20x22.png .otf -AddIcon /icons/odf6oti-20x22.png .oti -AddIcon /icons/odf6oth-20x22.png .oth +AddIcon /<%= @icons_prefix %>/odf6ott<%= @icon_suffix %>.png .ott +AddIcon /<%= @icons_prefix %>/odf6ots<%= @icon_suffix %>.png .ots +AddIcon /<%= @icons_prefix %>/odf6otp<%= @icon_suffix %>.png .otp +AddIcon /<%= @icons_prefix %>/odf6otg<%= @icon_suffix %>.png .otg +AddIcon /<%= @icons_prefix %>/odf6otc<%= @icon_suffix %>.png .otc +AddIcon /<%= @icons_prefix %>/odf6otf<%= @icon_suffix %>.png .otf +AddIcon /<%= @icons_prefix %>/odf6oti<%= @icon_suffix %>.png .oti +AddIcon /<%= @icons_prefix %>/odf6oth<%= @icon_suffix %>.png .oth -DefaultIcon /icons/unknown.gif +DefaultIcon /<%= @icons_prefix %>/unknown.gif ReadmeName README.html HeaderName HEADER.html -IndexIgnore .??* *~ *# HEADER* README* RCS CVS *,v *,t +IndexIgnore .??* *~ *# HEADER.html README.html RCS CVS *,v *,t diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/cluster.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/cluster.conf.erb index 58229a88a..d2f9d52e4 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/cluster.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/cluster.conf.erb @@ -8,10 +8,10 @@ Listen <%= @ip %>:<%= @port %> KeepAliveTimeout <%= @keep_alive_timeout %> MaxKeepAliveRequests <%= @max_keep_alive_requests %> - EnableMCPMReceive <%= scope.function_bool2httpd([@enable_mcpm_receive]) %> + EnableMCPMReceive <%= scope.call_function('apache::bool2httpd', [@enable_mcpm_receive]) %> ManagerBalancerName <%= @balancer_name %> - ServerAdvertise <%= scope.function_bool2httpd([@server_advertise]) %> + ServerAdvertise <%= scope.call_function('apache::bool2httpd', [@server_advertise]) %> <%- if @server_advertise == true and @advertise_frequency != nil -%> AdvertiseFrequency <%= @advertise_frequency %> <%- end -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/disk_cache.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/disk_cache.conf.erb index b1b460e52..c97ee7662 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/disk_cache.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/disk_cache.conf.erb @@ -1,4 +1,9 @@ +<% if @default_cache_enable -%> CacheEnable disk / +<% end -%> CacheRoot "<%= @_cache_root %>" CacheDirLevels 2 CacheDirLength 1 +<% if @cache_ignore_headers -%> +CacheIgnoreHeaders <%= @cache_ignore_headers -%> +<% end -%> \ No newline at end of file diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/expires.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/expires.conf.erb index 7660cfcd0..a864c6ca1 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/expires.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/expires.conf.erb @@ -1,4 +1,4 @@ -ExpiresActive <%= scope.function_bool2httpd([@expires_active]) %> +ExpiresActive <%= scope.call_function('apache::bool2httpd', [@expires_active]) %> <%- if ! @expires_default.nil? and ! @expires_default.empty? -%> ExpiresDefault "<%= @expires_default %>" <%- end -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/geoip.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/geoip.conf.erb index 00e61d98b..a99bee048 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/geoip.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/geoip.conf.erb @@ -1,4 +1,4 @@ -GeoIPEnable <%= scope.function_bool2httpd([@enable]) %> +GeoIPEnable <%= scope.call_function('apache::bool2httpd', [@enable]) %> <%- if @db_file and ! [ false, 'false', '' ].include?(@db_file) -%> <%- if @db_file.kind_of?(Array) -%> @@ -11,15 +11,15 @@ GeoIPDBFile <%= @db_file %> <%= @flag %> <%- end -%> GeoIPOutput <%= @output %> <% if ! @enable_utf8.nil? -%> -GeoIPEnableUTF8 <%= scope.function_bool2httpd([@enable_utf8]) %> +GeoIPEnableUTF8 <%= scope.call_function('apache::bool2httpd', [@enable_utf8]) %> <% end -%> <% if ! @scan_proxy_headers.nil? -%> -GeoIPScanProxyHeaders <%= scope.function_bool2httpd([@scan_proxy_headers]) %> +GeoIPScanProxyHeaders <%= scope.call_function('apache::bool2httpd', [@scan_proxy_headers]) %> <% end -%> <% if ! @scan_proxy_header_field.nil? -%> GeoIPScanProxyHeaderField <%= @scan_proxy_header_field %> <% end -%> <% if ! @use_last_xforwarededfor_ip.nil? -%> -GeoIPUseLastXForwardedForIP <%= scope.function_bool2httpd([@use_last_xforwarededfor_ip]) %> +GeoIPUseLastXForwardedForIP <%= scope.call_function('apache::bool2httpd', [@use_last_xforwarededfor_ip]) %> <% end -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/http2.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/http2.conf.erb new file mode 100644 index 000000000..483901368 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/http2.conf.erb @@ -0,0 +1,65 @@ +# The http2 Apache module configuration file is being +# managed by Puppet and changes will be overwritten. + +<%# Actually >= 2.4.24, but the minor version is not provided -%> +<% if !@h2_copy_files.nil? && scope.function_versioncmp([@_apache_version, '2.4']) >= 0 -%> +H2CopyFiles <%= scope.call_function('apache::bool2httpd', [@h2_copy_files]) %> +<% end -%> +<% unless @h2_direct.nil? -%> +H2Direct <%= scope.call_function('apache::bool2httpd', [@h2_direct]) %> +<% end -%> +<%# Actually >= 2.4.24, but the minor version is not provided -%> +<% if !@h2_early_hints.nil? && scope.function_versioncmp([@_apache_version, '2.4']) >= 0 -%> +H2EarlyHints <%= scope.call_function('apache::bool2httpd', [@h2_early_hints]) %> +<% end -%> +<% unless @h2_max_session_streams.nil? -%> +H2MaxSessionStreams <%= @h2_max_session_streams %> +<% end -%> +<% unless @h2_max_worker_idle_seconds.nil? -%> +H2MaxWorkerIdleSeconds <%= @h2_max_worker_idle_seconds %> +<% end -%> +<% unless @h2_max_workers.nil? -%> +H2MaxWorkers <%= @h2_max_workers %> +<% end -%> +<% unless @h2_min_workers.nil? -%> +H2MinWorkers <%= @h2_min_workers %> +<% end -%> +<%# Actually >= 2.4.24, but the minor version is not provided -%> +<% if scope.function_versioncmp([@_apache_version, '2.4']) >= 0 -%> + <%- unless @h2_modern_tls_only.nil? -%> +H2ModernTLSOnly <%= scope.call_function('apache::bool2httpd', [@h2_modern_tls_only]) %> + <%- end -%> + <%- unless @h2_push.nil? -%> +H2Push <%= scope.call_function('apache::bool2httpd', [@h2_push]) %> + <%- end -%> + <%- unless @h2_push_diary_size.nil? -%> +H2PushDiarySize <%= @h2_push_diary_size %> + <%- end -%> + <%- @h2_push_priority.each do |expr| -%> +H2PushPriority <%= expr %> + <%- end -%> + <%- @h2_push_resource.each do |expr| -%> +H2PushResource <%= expr %> + <%- end -%> +<% end -%> +<% unless @h2_serialize_headers.nil? -%> +H2SerializeHeaders <%= scope.call_function('apache::bool2httpd', [@h2_serialize_headers]) %> +<% end -%> +<% unless @h2_stream_max_mem_size.nil? -%> +H2StreamMaxMemSize <%= @h2_stream_max_mem_size %> +<% end -%> +<%# Actually >= 2.4.24, but the minor version is not provided -%> +<% if scope.function_versioncmp([@_apache_version, '2.4']) >= 0 -%> + <%- unless @h2_tls_cool_down_secs.nil? -%> +H2TLSCoolDownSecs <%= @h2_tls_cool_down_secs %> + <%- end -%> + <%- unless @h2_tls_warm_up_size.nil? -%> +H2TLSWarmUpSize <%= @h2_tls_warm_up_size %> + <%- end -%> +<% end -%> +<% unless @h2_upgrade.nil? -%> +H2Upgrade <%= scope.call_function('apache::bool2httpd', [@h2_upgrade]) %> +<% end -%> +<% unless @h2_window_size.nil? -%> +H2WindowSize <%= @h2_window_size %> +<% end -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/itk.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/itk.conf.erb index f45f2b35d..4abade8fb 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/itk.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/itk.conf.erb @@ -5,4 +5,7 @@ ServerLimit <%= @serverlimit %> MaxClients <%= @maxclients %> MaxRequestsPerChild <%= @maxrequestsperchild %> + <%- if (not @enablecapabilities.nil?) && (scope.function_versioncmp([@_apache_version, '2.4']) >= 0) -%> + EnableCapabilities <%= scope.call_function('apache::bool2httpd', [@enablecapabilities]) %> + <%- end -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/jk.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/jk.conf.erb new file mode 100644 index 000000000..c0d5bc2ff --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/jk.conf.erb @@ -0,0 +1,167 @@ +# This file is generated automatically by Puppet - DO NOT EDIT +# Any manual changes will be overwritten + + + <%- if @workers_file -%> + JkWorkersFile <%= @workers_file %> + <%- end -%> + <%- if @worker_property -%> + <%- @worker_property.sort.each do |property,value| -%> + JkWorkerProperty <%= property %>=<%= value %> + <%- end -%> + <%- end -%> + <%- if @shm_path -%> + JkShmFile <%= @shm_path %> + <%- end -%> + <%- if @shm_size -%> + JkShmSize <%= @shm_size %> + <%- end -%> + <%- if @mount_file -%> + JkMountFile <%= @mount_file %> + <%- end -%> + <%- if @mount_file_reload -%> + JkMountFileReload <%= @mount_file_reload %> + <%- end -%> + <%- if @mount -%> + <%- @mount.sort.each do |url_prefix,worker_name| -%> + JkMount <%= url_prefix %> <%= worker_name %> + <%- end -%> + <%- end -%> + <%- if @un_mount -%> + <%- @un_mount.sort.each do |url_prefix,worker_name| -%> + JkUnMount <%= url_prefix %> <%= worker_name %> + <%- end -%> + <%- end -%> + <%- if @auto_alias -%> + JkAutoAlias <%= @auto_alias %> + <%- end -%> + <%- if @mount_copy -%> + JkMountCopy <%= @mount_copy %> + <%- end -%> + <%- if @worker_indicator -%> + JkWorkerIndicator <%= @worker_indicator %> + <%- end -%> + <%- if @watchdog_interval -%> + JkWatchdogInterval <%= @watchdog_interval %> + <%- end -%> + <%- if @log_path -%> + JkLogFile <%= @log_path %> + <%- end -%> + <%- if @log_level -%> + JkLogLevel <%= @log_level %> + <%- end -%> + <%- if @log_stamp_format -%> + JkLogStampFormat <%= @log_stamp_format %> + <%- end -%> + <%- if @request_log_format -%> + JkRequestLogFormat <%= @request_log_format %> + <%- end -%> + <%- if @extract_ssl -%> + JkExtractSSL <%= @extract_ssl %> + <%- end -%> + <%- if @https_indicator -%> + JkHTTPSIndicator <%= @https_indicator %> + <%- end -%> + <%- if @sslprotocol_indicator -%> + JkSSLPROTOCOLIndicator <%= @sslprotocol_indicator %> + <%- end -%> + <%- if @certs_indicator -%> + JkCERTSIndicator <%= @certs_indicator %> + <%- end -%> + <%- if @cipher_indicator -%> + JkCIPHERIndicator <%= @cipher_indicator %> + <%- end -%> + <%- if @certchain_prefix -%> + JkCERTCHAINPrefix <%= @certchain_prefix %> + <%- end -%> + <%- if @session_indicator -%> + JkSESSIONIndicator <%= @session_indicator %> + <%- end -%> + <%- if @keysize_indicator -%> + JkKEYSIZEIndicator <%= @keysize_indicator %> + <%- end -%> + <%- if @local_name_indicator -%> + JkLocalNameIndicator <%= @local_name_indicator %> + <%- end -%> + <%- if @ignore_cl_indicator -%> + JkIgnoreCLIndicator <%= @ignore_cl_indicator %> + <%- end -%> + <%- if @local_addr_indicator -%> + JkLocalAddrIndicator <%= @local_addr_indicator %> + <%- end -%> + <%- if @local_port_indicator -%> + JkLocalPortIndicator <%= @local_port_indicator %> + <%- end -%> + <%- if @remote_host_indicator -%> + JkRemoteHostIndicator <%= @remote_host_indicator %> + <%- end -%> + <%- if @remote_addr_indicator -%> + JkRemoteAddrIndicator <%= @remote_addr_indicator %> + <%- end -%> + <%- if @remote_port_indicator -%> + JkRemotePortIndicator <%= @remote_port_indicator %> + <%- end -%> + <%- if @remote_user_indicator -%> + JkRemoteUserIndicator <%= @remote_user_indicator %> + <%- end -%> + <%- if @auth_type_indicator -%> + JkAuthTypeIndicator <%= @auth_type_indicator %> + <%- end -%> + <%- if @options -%> + <%- @options.sort.each do |fwd_option| -%> + JkOptions <%= fwd_option %> + <%- end -%> + <%- end -%> + <%- if @env_var -%> + <%- @env_var.sort.each do |variable,value| -%> + JkEnvVar <%= variable %><% if not value.empty? -%> value<% end -%> + <%- end -%> + <%- end -%> + <%- if @strip_session -%> + JkStripSession <%= @strip_session %> + <%- end -%> + <%-# -%> + <%-# Global locations for mod_jk are defined in array location_list -%> + <%-# Each array item is a hash with quoted* property name as key -%> + <%-# and value as value itself -%> + <%-# You can define a comment in a special 'comment' key -%> + <%-# -%> + <%-# Example: -%> + <%-# -%> + <%-# # Configures jkstatus -%> + <%-# JkMount status -%> + <%-# Order deny,allow -%> + <%-# Deny from all -%> + <%-# Allow from 127.0.0.1 -%> + <%-# -%> + <%-# -%> + <%-# Is defined as: -%> + <%-# location_list = [ -%> + <%-# { -%> + <%-# 'Location' => '/jkstatus/', -%> + <%-# 'Comment' => 'Configures jkstatus', -%> + <%-# 'JkMount' => 'status', -%> + <%-# 'Order' => 'deny,allow', -%> + <%-# 'Deny from' => 'all', -%> + <%-# 'Allow from' => '127.0.0.1', -%> + <%-# }, -%> + <%-# ] -%> + <%-# * Keys must be quoted to allow arbitrary case and/or multi-word keys -%> + <%-# (BTW, note the case of 'Location' and 'Comment' keys) -%> + <%-# -%> + <%- if @location_list -%> + <%- @location_list.each do |location_tag| -%> + + > + <%- if location_tag.has_key?('Comment') -%> + # <%= location_tag['Comment'] %> + <%- end -%> + <%- location_tag.each do |property,value| -%> + <%- if property != 'Comment' and property != 'Location' -%> + <%= property %> <%= value %> + <%- end -%> + <%- end -%> + + <%- end -%> + <%- end -%> + diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/jk/uriworkermap.properties.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/jk/uriworkermap.properties.erb new file mode 100644 index 000000000..4d9eac03f --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/jk/uriworkermap.properties.erb @@ -0,0 +1,40 @@ +# This file is generated automatically by Puppet - DO NOT EDIT +# Any manual changes will be overwritten +<%# -%> +<%# mount_file_content should be a hash which keys are workers names -%> +<%# and values are new hashes with two items: -%> +<%# uri_list - Array with URIs to be mapped to worker -%> +<%# comment - Optional comment line -%> +<%# -%> +<%# Example: -%> +<%# # Worker 1 -%> +<%# /context_1/ = worker_1 -%> +<%# /context_1/* = worker_1 -%> +<%# -%> +<%# # Worker 2 -%> +<%# / = worker_2 -%> +<%# /context_2/ = worker_2 -%> +<%# /context_2/* = worker_2 -%> +<%# -%> +<%# should be parameterized as: -%> +<%# $mount_file_content = { -%> +<%# worker_1 => { -%> +<%# uri_list => ['/context_1/', '/context_1/*'], -%> +<%# comment => 'Worker 1', -%> +<%# }, -%> +<%# worker_2 => { -%> +<%# uri_list => ['/context_2/', '/context_2/*'], -%> +<%# comment => 'Worker 2', -%> +<%# }, -%> +<%# }, -%> +<%# -%> +<% @mount_file_content.sort.each do |worker,directives| -%> + +<%# Places comment before worker mappings -%> +<% if directives.has_key?('comment') -%> +# <%= directives['comment'] %> +<% end -%> +<% directives['uri_list'].sort.each do |uri| -%> +<%= uri %> = <%= worker %> +<% end -%> +<% end -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/jk/workers.properties.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/jk/workers.properties.erb new file mode 100644 index 000000000..8292f3d37 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/jk/workers.properties.erb @@ -0,0 +1,62 @@ +# This file is generated automatically by Puppet - DO NOT EDIT +# Any manual changes will be overwritten +<%# -%> +<%# workers_file_content should be a hash which keys are workers names -%> +<%# and values are new hashes with properties and values -%> +<%# Two keys are special (and reserved!): -%> +<%# worker_lists - Array of comma-separated worker names lists -%> +<%# Each list is an item of the array and will be placed in one line -%> +<%# worker_maintain - Numeric string -%> +<%# -%> +<%# Example: -%> +<%# worker.list = status -%> +<%# worker.list = some_name,other_name -%> +<%# worker.maintain = 60 -%> +<%# # Optional comment -%> +<%# worker.some_name.type=ajp13 -%> +<%# worker.some_name.socket_keepalive=true -%> +<%# # I just like comments -%> +<%# worker.other_name.type=ajp12 (why would you?) -%> +<%# worker.other_name.socket_keepalive=false -%> +<%# -%> +<%# should be parameterized as: -%> +<%# $workers_file_content = { -%> +<%# worker_lists => ['status', 'some_name,other_name'], -%> +<%# worker_maintain => '60', -%> +<%# some_name => { -%> +<%# type => 'ajp13', -%> +<%# socket_keepalive => 'true', -%> +<%# comment => 'Optional comment', -%> +<%# }, -%> +<%# other_name => { -%> +<%# type => 'ajp12', -%> +<%# socket_keepalive => 'false', -%> +<%# comment => 'I just like comments', -%> +<%# }, -%> +<%# }, -%> +<%# -%> +<% if @workers_file_content.has_key?('worker_lists') -%> + +<% @workers_file_content['worker_lists'].sort.each do |list| -%> +worker.list = <%= list %> +<% end -%> +<% end -%> +<% if @workers_file_content.has_key?('worker_maintain') -%> + +worker.maintain = <%= @workers_file_content['worker_maintain'] %> +<% end -%> +<% @workers_file_content.sort.each do |name,directives| -%> +<%# Skip hash items with the reserved keys -%> +<% if not ['worker_lists', 'worker_maintain'].include?(name) -%> + +<%# Places comment before worker directives -%> +<% if directives.has_key?('comment') -%> +# <%= directives['comment'] %> +<% end -%> +<% directives.sort.each do |property,value| -%> +<% if property != 'comment' -%> +worker.<%= name %>.<%= property %>=<%= value %> +<% end -%> +<% end -%> +<% end -%> +<% end -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/ldap.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/ldap.conf.erb index 5ac0c1c54..7c2dac5e9 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/ldap.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/ldap.conf.erb @@ -1,4 +1,4 @@ - +> SetHandler ldap-status <%- if scope.function_versioncmp([@_apache_version, '2.4']) >= 0 -%> Require ip 127.0.0.1 ::1 @@ -12,6 +12,9 @@ <% if @ldap_trusted_global_cert_file -%> LDAPTrustedGlobalCert <%= @ldap_trusted_global_cert_type %> <%= @ldap_trusted_global_cert_file %> <% end -%> +<% if @ldap_trusted_mode -%> +LDAPTrustedMode <%= @ldap_trusted_mode %> +<% end -%> <%- if @ldap_shared_cache_size -%> LDAPSharedCacheSize <%= @ldap_shared_cache_size %> <%- end -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/md.conf.epp b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/md.conf.epp new file mode 100644 index 000000000..0ae45fc7c --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/md.conf.epp @@ -0,0 +1,84 @@ +<% if $apache::mod::md::md_activation_delay { -%> +MDActivationDelay <%= $apache::mod::md::md_activation_delay %> +<% } -%> +<% if $apache::mod::md::md_base_server { -%> +MDBaseServer <%= $apache::mod::md::md_base_server %> +<% } -%> +<% if $apache::mod::md::md_ca_challenges { -%> +MDCAChallenges <%= $apache::mod::md::md_ca_challenges.join(' ') %> +<% } -%> +<% if $apache::mod::md::md_certificate_agreement { -%> +MDCertificateAgreement <%= $apache::mod::md::md_certificate_agreement %> +<% } -%> +<% if $apache::mod::md::md_certificate_authority { -%> +MDCertificateAuthority <%= $apache::mod::md::md_certificate_authority %> +<% } -%> +<% if $apache::mod::md::md_certificate_check { -%> +MDCertificateCheck <%= $apache::mod::md::md_certificate_check %> +<% } -%> +<% if $apache::mod::md::md_certificate_monitor { -%> +MDCertificateMonitor <%= $apache::mod::md::md_certificate_monitor %> +<% } -%> +<% if $apache::mod::md::md_certificate_protocol { -%> +MDCertificateProtocol <%= $apache::mod::md::md_certificate_protocol %> +<% } -%> +<% if $apache::mod::md::md_certificate_status { -%> +MDCertificateStatus <%= $apache::mod::md::md_certificate_status %> +<% } -%> +<% if $apache::mod::md::md_challenge_dns01 { -%> +MDChallengeDns01 "<%= $apache::mod::md::md_challenge_dns01 %>" +<% } -%> +<% if $apache::mod::md::md_contact_email { -%> +MDContactEmail <%= $apache::mod::md::md_contact_email %> +<% } -%> +<% if $apache::mod::md::md_http_proxy { -%> +MDHttpProxy <%= $apache::mod::md::md_http_proxy %> +<% } -%> +<% if $apache::mod::md::md_members { -%> +MDMembers <%= $apache::mod::md::md_members %> +<% } -%> +<% if $apache::mod::md::md_message_cmd { -%> +MDMessageCmd "<%= $apache::mod::md::md_message_cmd %>" +<% } -%> +<% if $apache::mod::md::md_must_staple { -%> +MDMustStaple <%= $apache::mod::md::md_must_staple %> +<% } -%> +<% if $apache::mod::md::md_notify_cmd { -%> +MDNotifyCmd "<%= $apache::mod::md::md_notify_cmd %>" +<% } -%> +<% if $apache::mod::md::md_port_map { -%> +MDPortMap <%= $apache::mod::md::md_port_map %> +<% } -%> +<% if $apache::mod::md::md_private_keys { -%> +MDPrivateKeys <%= $apache::mod::md::md_private_keys %> +<% } -%> +<% if $apache::mod::md::md_renew_mode { -%> +MDRenewMode <%= $apache::mod::md::md_renew_mode %> +<% } -%> +<% if $apache::mod::md::md_renew_window { -%> +MDRenewWindow <%= $apache::mod::md::md_renew_window %> +<% } -%> +<% if $apache::mod::md::md_require_https { -%> +MDRequireHttps <%= $apache::mod::md::md_require_https %> +<% } -%> +<% if $apache::mod::md::md_server_status { -%> +MDServerStatus <%= $apache::mod::md::md_server_status %> +<% } -%> +<% if $apache::mod::md::md_staple_others { -%> +MDStapleOthers <%= $apache::mod::md::md_staple_others %> +<% } -%> +<% if $apache::mod::md::md_stapling { -%> +MDStapling <%= $apache::mod::md::md_stapling %> +<% } -%> +<% if $apache::mod::md::md_stapling_keep_response { -%> +MDStaplingKeepResponse <%= $apache::mod::md::md_stapling_keep_response %> +<% } -%> +<% if $apache::mod::md::md_stapling_renew_window { -%> +MDStaplingRenewWindow <%= $apache::mod::md::md_stapling_renew_window %> +<% } -%> +<% if $apache::mod::md::md_store_dir { -%> +MDStoreDir "<%= $apache::mod::md::md_store_dir %>" +<% } -%> +<% if $apache::mod::md::md_warn_window { -%> +MDWarnWindow <%= $apache::mod::md::md_warn_window %> +<% } -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/passenger.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/passenger.conf.erb index 03ff534d2..f7078db92 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/passenger.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/passenger.conf.erb @@ -1,61 +1,259 @@ # The Passenger Apache module configuration file is being # managed by Puppet and changes will be overwritten. + <%- if @passenger_allow_encoded_slashes -%> + PassengerAllowEncodedSlashes <%= @passenger_allow_encoded_slashes %> + <%- end -%> + <%- if @passenger_anonymous_telemetry_proxy -%> + PassengerAnonymousTelemetryProxy <%= @passenger_anonymous_telemetry_proxy %> + <%- end -%> + <%- if @passenger_app_env -%> + PassengerAppEnv <%= @passenger_app_env %> + <%- end -%> + <%- if @passenger_app_group_name -%> + PassengerAppGroupName <%= @passenger_app_group_name %> + <%- end -%> + <%- if @passenger_app_root -%> + PassengerAppRoot "<%= @passenger_app_root %>" + <%- end -%> + <%- if @passenger_app_type -%> + PassengerAppType <%= @passenger_app_type %> + <%- end -%> + <%- if @passenger_base_uri -%> + PassengerBaseURI <%= @passenger_base_uri %> + <%- end -%> + <%- if @passenger_buffer_response -%> + PassengerBufferResponse <%= @passenger_buffer_response %> + <%- end -%> + <%- if @passenger_buffer_upload -%> + PassengerBufferUpload <%= @passenger_buffer_upload %> + <%- end -%> + <%- if @passenger_concurrency_model -%> + PassengerConcurrencyModel <%= @passenger_concurrency_model %> + <%- end -%> + <%- if @passenger_data_buffer_dir -%> + PassengerDataBufferDir "<%= @passenger_data_buffer_dir %>" + <%- end -%> + <%- if @passenger_debug_log_file -%> + PassengerDebugLogFile <%= @passenger_debug_log_file %> + <%- end -%> + <%- if @passenger_debugger -%> + PassengerDebugger <%= @passenger_debugger %> + <%- end -%> + <%- if @passenger_default_group -%> + PassengerDefaultGroup <%= @passenger_default_group %> + <%- end -%> + <%- if @passenger_default_ruby -%> + PassengerDefaultRuby "<%= @passenger_default_ruby %>" + <%- end -%> + <%- if @passenger_default_user -%> + PassengerDefaultUser <%= @passenger_default_user %> + <%- end -%> + <%- unless @passenger_disable_anonymous_telemetry.nil? -%> + PassengerDisableAnonymousTelemetry <%= scope.call_function('apache::bool2httpd', [@passenger_disable_anonymous_telemetry]) %> + <%- end -%> + <%- unless @passenger_disable_log_prefix.nil? -%> + PassengerDisableLogPrefix <%= scope.call_function('apache::bool2httpd', [@passenger_disable_log_prefix]) %> + <%- end -%> + <%- if @passenger_disable_security_update_check -%> + PassengerDisableSecurityUpdateCheck <%= @passenger_disable_security_update_check %> + <%- end -%> + <%- if @passenger_enabled -%> + PassengerEnabled <%= @passenger_enabled %> + <%- end -%> + <%- if @passenger_error_override -%> + PassengerErrorOverride <%= @passenger_error_override %> + <%- end -%> + <%- if @passenger_file_descriptor_log_file -%> + PassengerFileDescriptorLogFile "<%= @passenger_file_descriptor_log_file %>" + <%- end -%> + <%- if @passenger_fly_with -%> + PassengerFlyWith "<%= @passenger_fly_with %>" + <%- end -%> + <%- if @passenger_force_max_concurrent_requests_per_process -%> + PassengerForceMaxConcurrentRequestsPerProcess <%= @passenger_force_max_concurrent_requests_per_process %> + <%- end -%> + <%- if @passenger_friendly_error_pages -%> + PassengerFriendlyErrorPages <%= @passenger_friendly_error_pages %> + <%- end -%> + <%- if @passenger_group -%> + PassengerGroup <%= @passenger_group %> + <%- end -%> + <%- if @passenger_high_performance -%> + PassengerHighPerformance <%= @passenger_high_performance %> + <%- end -%> + <%- if @passenger_instance_registry_dir -%> + PassengerInstanceRegistryDir "<%= @passenger_instance_registry_dir %>" + <%- end -%> + <%- if @passenger_load_shell_envvars -%> + PassengerLoadShellEnvvars <%= @passenger_load_shell_envvars %> + <%- end -%> + <%- if @passenger_log_file -%> + PassengerLogFile "<%= @passenger_log_file %>" + <%- end -%> + <%- if @passenger_log_level -%> + PassengerLogLevel <%= @passenger_log_level %> + <%- end -%> + <%- if @passenger_lve_min_uid -%> + PassengerLveMinUid <%= @passenger_lve_min_uid %> + <%- end -%> + <%- if @passenger_max_instances -%> + PassengerMaxInstances <%= @passenger_max_instances %> + <%- end -%> + <%- if @passenger_max_instances_per_app -%> + PassengerMaxInstancesPerApp <%= @passenger_max_instances_per_app %> + <%- end -%> + <%- if @passenger_max_pool_size -%> + PassengerMaxPoolSize <%= @passenger_max_pool_size %> + <%- end -%> + <%- if @passenger_max_preloader_idle_time -%> + PassengerMaxPreloaderIdleTime <%= @passenger_max_preloader_idle_time %> + <%- end -%> + <%- if @passenger_max_request_queue_size -%> + PassengerMaxRequestQueueSize <%= @passenger_max_request_queue_size %> + <%- end -%> + <%- if @passenger_max_request_time -%> + PassengerMaxRequestTime <%= @passenger_max_request_time %> + <%- end -%> + <%- if @passenger_max_requests -%> + PassengerMaxRequests <%= @passenger_max_requests %> + <%- end -%> + <%- if @passenger_memory_limit -%> + PassengerMemoryLimit <%= @passenger_memory_limit %> + <%- end -%> + <%- if @passenger_meteor_app_settings -%> + PassengerMeteorAppSettings "<%= @passenger_meteor_app_settings %>" + <%- end -%> + <%- if @passenger_min_instances -%> + PassengerMinInstances <%= @passenger_min_instances %> + <%- end -%> + <%- if @passenger_nodejs -%> + PassengerNodejs "<%= @passenger_nodejs %>" + <%- end -%> + <%- if @passenger_pool_idle_time -%> + PassengerPoolIdleTime <%= @passenger_pool_idle_time %> + <%- end -%> + <%- if @passenger_pre_start -%> + <%- [@passenger_pre_start].flatten.compact.each do |passenger_pre_start| -%> + PassengerPreStart <%= passenger_pre_start %> + <%- end -%> + <%- end -%> + <%- if @passenger_python -%> + PassengerPython "<%= @passenger_python %>" + <%- end -%> + <%- if @passenger_resist_deployment_errors -%> + PassengerResistDeploymentErrors <%= @passenger_resist_deployment_errors %> + <%- end -%> + <%- if @passenger_resolve_symlinks_in_document_root -%> + PassengerResolveSymlinksInDocumentRoot <%= @passenger_resolve_symlinks_in_document_root %> + <%- end -%> + <%- if @passenger_response_buffer_high_watermark -%> + PassengerResponseBufferHighWatermark <%= @passenger_response_buffer_high_watermark %> + <%- end -%> + <%- if @passenger_restart_dir -%> + PassengerRestartDir "<%= @passenger_restart_dir %>" + <%- end -%> + <%- if @passenger_rolling_restarts -%> + PassengerRollingRestarts <%= @passenger_rolling_restarts %> + <%- end -%> <%- if @passenger_root -%> PassengerRoot "<%= @passenger_root %>" <%- end -%> <%- if @passenger_ruby -%> PassengerRuby "<%= @passenger_ruby %>" <%- end -%> - <%- if @passenger_default_ruby -%> - PassengerDefaultRuby "<%= @passenger_default_ruby %>" + <%- if @passenger_security_update_check_proxy -%> + PassengerSecurityUpdateCheckProxy <%= @passenger_security_update_check_proxy %> <%- end -%> - <%- if @passenger_high_performance -%> - PassengerHighPerformance <%= @passenger_high_performance %> + <%- if @passenger_show_version_in_header -%> + PassengerShowVersionInHeader <%= @passenger_show_version_in_header %> <%- end -%> - <%- if @passenger_max_pool_size -%> - PassengerMaxPoolSize <%= @passenger_max_pool_size %> + <%- if @passenger_socket_backlog -%> + PassengerSocketBacklog <%= @passenger_socket_backlog %> <%- end -%> - <%- if @passenger_min_instances -%> - PassengerMinInstances <%= @passenger_min_instances %> - <%- end -%> - <%- if @passenger_max_instances_per_app -%> - PassengerMaxInstancesPerApp <%= @passenger_max_instances_per_app %> - <%- end -%> - <%- if @passenger_pool_idle_time -%> - PassengerPoolIdleTime <%= @passenger_pool_idle_time %> - <%- end -%> - <%- if @passenger_max_request_queue_size -%> - PassengerMaxRequestQueueSize <%= @passenger_max_request_queue_size %> - <%- end -%> - <%- if @passenger_max_requests -%> - PassengerMaxRequests <%= @passenger_max_requests %> + <%- if @passenger_spawn_dir -%> + PassengerSpawnDir "<%= @passenger_spawn_dir %>" <%- end -%> <%- if @passenger_spawn_method -%> PassengerSpawnMethod <%= @passenger_spawn_method %> <%- end -%> + <%- if @passenger_start_timeout -%> + PassengerStartTimeout <%= @passenger_start_timeout %> + <%- end -%> + <%- if @passenger_startup_file -%> + PassengerStartupFile "<%= @passenger_startup_file %>" + <%- end -%> <%- if @passenger_stat_throttle_rate -%> PassengerStatThrottleRate <%= @passenger_stat_throttle_rate %> <%- end -%> - <%- if @rack_autodetect -%> - RackAutoDetect <%= @rack_autodetect %> + <%- if @passenger_sticky_sessions -%> + PassengerStickySessions <%= @passenger_sticky_sessions %> <%- end -%> - <%- if @rails_autodetect -%> - RailsAutoDetect <%= @rails_autodetect %> + <%- if @passenger_sticky_sessions_cookie_name -%> + PassengerStickySessionsCookieName <%= @passenger_sticky_sessions_cookie_name %> + <%- end -%> + <%- if @passenger_sticky_sessions_cookie_attributes -%> + PassengerStickySessionsCookieAttributes "<%= @passenger_sticky_sessions_cookie_attributes %>" + <%- end -%> + <%- if @passenger_thread_count -%> + PassengerThreadCount <%= @passenger_thread_count %> <%- end -%> <%- if @passenger_use_global_queue -%> PassengerUseGlobalQueue <%= @passenger_use_global_queue %> <%- end -%> - <%- if @passenger_app_env -%> - PassengerAppEnv <%= @passenger_app_env %> + <%- if @passenger_user -%> + PassengerUser <%= @passenger_user %> <%- end -%> - <%- if @passenger_log_file -%> - PassengerLogFile <%= @passenger_log_file %> + <%- if @passenger_user_switching -%> + PassengerUserSwitching <%= @passenger_user_switching %> <%- end -%> - <%- if @passenger_log_level -%> - PassengerLogLevel <%= @passenger_log_level %> + <%- if @rack_auto_detect -%> + RackAutoDetect <%= @rack_auto_detect %> <%- end -%> - <%- if @passenger_data_buffer_dir -%> - PassengerDataBufferDir <%= @passenger_data_buffer_dir %> + <%- if @rack_base_uri -%> + RackBaseURI <%= @rack_base_uri %> <%- end -%> + <%- if @rack_env -%> + RackEnv <%= @rack_env %> + <%- end -%> + <%- if @rails_allow_mod_rewrite -%> + RailsAllowModRewrite <%= @rails_allow_mod_rewrite %> + <%- end -%> + <%- if @rails_app_spawner_idle_time -%> + RailsAppSpawnerIdleTime <%= @rails_app_spawner_idle_time %> + <%- end -%> + <%- if @rails_auto_detect -%> + RailsAutoDetect <%= @rails_auto_detect %> + <%- end -%> + <%- if @rails_base_uri -%> + RailsBaseURI <%= @rails_base_uri %> + <%- end -%> + <%- if @rails_default_user -%> + RailsDefaultUser <%= @rails_default_user %> + <%- end -%> + <%- if @rails_env -%> + RailsEnv <%= @rails_env %> + <%- end -%> + <%- if @rails_framework_spawner_idle_time -%> + RailsFrameworkSpawnerIdleTime <%= @rails_framework_spawner_idle_time %> + <%- end -%> + <%- if @rails_ruby -%> + RailsRuby <%= @rails_ruby %> + <%- end -%> + <%- if @rails_spawn_method -%> + RailsSpawnMethod <%= @rails_spawn_method %> + <%- end -%> + <%- if @rails_user_switching -%> + RailsUserSwitching <%= @rails_user_switching %> + <%- end -%> + <%- if @wsgi_auto_detect -%> + WsgiAutoDetect <%= @wsgi_auto_detect %> + <%- end -%> + <%- if @rails_autodetect -%> + RailsAutoDetect <%= @rails_autodetect %> + <%- end -%> + <%- if @rack_autodetect -%> + RackAutoDetect <%= @rack_autodetect %> + <%- end -%> + diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/prefork.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/prefork.conf.erb index aabfdf7b2..01f0b84f8 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/prefork.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/prefork.conf.erb @@ -3,6 +3,15 @@ MinSpareServers <%= @minspareservers %> MaxSpareServers <%= @maxspareservers %> ServerLimit <%= @serverlimit %> - MaxClients <%= @maxclients %> - MaxRequestsPerChild <%= @maxrequestsperchild %> + <%- if @maxrequestworkers -%> + MaxRequestWorkers <%= @maxrequestworkers %> + <%- elsif @maxclients -%> + MaxClients <%= @maxclients %> + <%- end -%> + <%- if @maxconnectionsperchild -%> + MaxConnectionsPerChild <%= @maxconnectionsperchild %> + <%- elsif @maxrequestsperchild -%> + MaxRequestsPerChild <%= @maxrequestsperchild %> + <%- end -%> + ListenBacklog <%= @listenbacklog %> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/proxy.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/proxy.conf.erb index d023c14e5..76968cb6f 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/proxy.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/proxy.conf.erb @@ -24,4 +24,11 @@ # ("Full" adds the server version; "Block" removes all outgoing Via: headers) # Set to one of: Off | On | Full | Block ProxyVia <%= @proxy_via %> + + <%- if @proxy_timeout -%> + ProxyTimeout <%= @proxy_timeout %> + <%- end -%> + <%- if @proxy_iobuffersize -%> + ProxyIOBufferSize <%= @proxy_iobuffersize %> + <%- end -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/proxy_html.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/proxy_html.conf.erb index f2f0bc0ce..3cb8eca62 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/proxy_html.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/proxy_html.conf.erb @@ -9,9 +9,10 @@ ProxyHTMLLinks ins cite ProxyHTMLLinks del cite ProxyHTMLLinks form action ProxyHTMLLinks input src usemap -ProxyHTMLLinks head profileProxyHTMLLinks base href -ProxyHTMLLinks script src for +ProxyHTMLLinks head profile ProxyHTMLLinks base href +ProxyHTMLLinks script src for +ProxyHTMLLinks meta content ProxyHTMLEvents onclick ondblclick onmousedown onmouseup \ onmouseover onmousemove onmouseout onkeypress \ diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/remoteip.conf.epp b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/remoteip.conf.epp new file mode 100644 index 000000000..6f4793979 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/remoteip.conf.epp @@ -0,0 +1,51 @@ +<%- | + String $header, + Optional[Array[Variant[Stdlib::Host,Stdlib::IP::Address]]] $internal_proxy = undef, + Optional[Stdlib::Absolutepath] $internal_proxy_list = undef, + Optional[String] $proxies_header = undef, + Boolean $proxy_protocol = undef, + Optional[Array[Variant[Stdlib::Host,Stdlib::IP::Address]]] $proxy_protocol_exceptions = undef, + Optional[Array[Stdlib::IP::Address]] $trusted_proxy = undef, + Optional[Stdlib::Absolutepath] $trusted_proxy_list = undef, +| -%> +# Declare the header field which should be parsed for useragent IP addresses +RemoteIPHeader <%= $header %> + +<%- if $internal_proxy { -%> +# Declare client intranet IP addresses trusted to present +# the RemoteIPHeader value +<%- [$internal_proxy].flatten.each |$proxy| { -%> +RemoteIPInternalProxy <%= $proxy %> +<%- } -%> +<%- } -%> + +<%- if $internal_proxy_list { -%> +RemoteIPInternalProxyList <%= $internal_proxy_list %> +<%- } -%> + +<%- if $proxies_header { -%> +# Declare the header field which will record all intermediate IP addresses +RemoteIPProxiesHeader <%= $proxies_header %> +<%- } -%> + +<%- if $proxy_protocol { -%> +RemoteIPProxyProtocol On +<%- } -%> + +<%- if $proxy_protocol_exceptions { -%> +<%- [$proxy_protocol_exceptions].flatten.each |$exception| { -%> +RemoteIPProxyProtocolExceptions <%= $exception %> +<%- } -%> +<%- } -%> + +<%- if $trusted_proxy { -%> +# Declare client intranet IP addresses trusted to present +# the RemoteIPHeader value + <%- [$trusted_proxy].flatten.each |$proxy| { -%> +RemoteIPTrustedProxy <%= $proxy %> + <%- } -%> +<%- } -%> + +<%- if $trusted_proxy_list { -%> +RemoteIPTrustedProxyList <%= $trusted_proxy_list %> +<%- } -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/remoteip.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/remoteip.conf.erb deleted file mode 100644 index e10ebb51c..000000000 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/remoteip.conf.erb +++ /dev/null @@ -1,23 +0,0 @@ -# Declare the header field which should be parsed for useragent IP addresses -RemoteIPHeader <%= @header %> - -<%- if @proxy_ips -%> -# Declare client intranet IP addresses trusted to present -# the RemoteIPHeader value -<%- [@proxy_ips].flatten.each do |proxy| -%> -RemoteIPInternalProxy <%= proxy %> -<%- end -%> -<%- end -%> - -<%- if @proxies_header -%> -# Declare the header field which will record all intermediate IP addresses -RemoteIPProxiesHeader <%= @proxies_header %> -<%- end -%> - -<%- if @trusted_proxy_ips -%> -# Declare client intranet IP addresses trusted to present -# the RemoteIPHeader value - <%- [@trusted_proxy_ips].flatten.each do |proxy| -%> -RemoteIPTrustedProxy <%= proxy %> - <%- end -%> -<%- end -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/security.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/security.conf.erb index 638332e52..0302cebf3 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/security.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/security.conf.erb @@ -2,6 +2,9 @@ # Default recommended configuration SecRuleEngine <%= @modsec_secruleengine %> SecRequestBodyAccess On + <%- if @custom_rules -%> + Include <%= @modsec_dir %>/custom_rules/*.conf + <%- end -%> SecRule REQUEST_HEADERS:Content-Type "text/xml" \ "id:'200000',phase:1,t:none,t:lowercase,pass,nolog,ctl:requestBodyProcessor=XML" SecRequestBodyLimit <%= @secrequestbodylimit %> @@ -45,7 +48,10 @@ SecAuditEngine RelevantOnly SecAuditLogRelevantStatus "<%= @audit_log_relevant_status %>" SecAuditLogParts <%= @audit_log_parts %> - SecAuditLogType Serial + SecAuditLogType <%= @audit_log_type %> + <%- if @audit_log_storage_dir -%> + SecAuditLogStorageDir <%= @audit_log_storage_dir %> + <%- end -%> SecArgumentSeparator & SecCookieFormat 0 <%- if scope.lookupvar('::osfamily') == 'Debian' -%> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/security_custom.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/security_custom.conf.erb new file mode 100644 index 000000000..97ed20dc4 --- /dev/null +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/security_custom.conf.erb @@ -0,0 +1,6 @@ +# This file is managed by puppet, any direct modification will be overwritten. +<% if defined?(@custom_rules_set) && ! @custom_rules_set.empty? -%> +<% @custom_rules_set.each do |secrule| -%> +SecRule <%= secrule %> +<% end -%> +<% end -%> \ No newline at end of file diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/ssl.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/ssl.conf.erb index 5fa7bb9ba..94dc7bb82 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/ssl.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/ssl.conf.erb @@ -13,22 +13,31 @@ <%- if scope.function_versioncmp([@_apache_version, '2.4']) >= 0 -%> Mutex <%= @_ssl_mutex %> <%- if @ssl_compression -%> - SSLCompression <%= scope.function_bool2httpd([@ssl_compression]) %> + SSLCompression <%= scope.call_function('apache::bool2httpd', [@ssl_compression]) %> + <%- end -%> + <%- unless @ssl_sessiontickets.nil? -%> + SSLSessionTickets <%= scope.call_function('apache::bool2httpd', [@ssl_sessiontickets]) %> <%- end -%> <%- else -%> SSLMutex <%= @_ssl_mutex %> <%- end -%> SSLCryptoDevice <%= @ssl_cryptodevice %> - SSLHonorCipherOrder <%= scope.function_bool2httpd([@_ssl_honorcipherorder]) %> + SSLHonorCipherOrder <%= scope.call_function('apache::bool2httpd', [@_ssl_honorcipherorder]) %> + <%- if @ssl_cert -%> + SSLCertificateFile "<%= @ssl_cert %>" + <%- end -%> + <%- if @ssl_key -%> + SSLCertificateKeyFile "<%= @ssl_key %>" + <%- end -%> <%- if @ssl_ca -%> SSLCACertificateFile "<%= @ssl_ca %>" <%- end -%> <% if scope.function_versioncmp([@_apache_version, '2.4']) >= 0 -%> - SSLUseStapling <%= scope.function_bool2httpd([@ssl_stapling]) %> + SSLUseStapling <%= scope.call_function('apache::bool2httpd', [@ssl_stapling]) %> <%- if not @ssl_stapling_return_errors.nil? -%> - SSLStaplingReturnResponderErrors <%= scope.function_bool2httpd([@ssl_stapling_return_errors]) %> + SSLStaplingReturnResponderErrors <%= scope.call_function('apache::bool2httpd', [@ssl_stapling_return_errors]) %> <%- end -%> - SSLStaplingCache "shmcb:<%= @stapling_cache %>" + SSLStaplingCache "shmcb:<%= @_stapling_cache %>" <% end -%> SSLCipherSuite <%= @ssl_cipher %> SSLProtocol <%= @ssl_protocol.compact.join(' ') %> diff --git a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/status.conf.erb b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/status.conf.erb index 6a6b3daa2..28cc55b4f 100644 --- a/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/status.conf.erb +++ b/modules/services/unix/http/apache_stretch_compatible/apache/templates/mod/status.conf.erb @@ -1,11 +1,13 @@ > SetHandler server-status + <%-# From Puppet 4.2 up, replace: -%> + <%-# "scope.function_template(["apache/mod/