https://github.com/ansibleguy/infra_apache
Ansible Role to provision Apache2 sites
https://github.com/ansibleguy/infra_apache
ansible ansible-role apache2 automation certbot certificates iac infrastructure-as-code webserver
Last synced: 3 months ago
JSON representation
Ansible Role to provision Apache2 sites
- Host: GitHub
- URL: https://github.com/ansibleguy/infra_apache
- Owner: ansibleguy
- License: other
- Created: 2021-11-02T21:03:38.000Z (about 4 years ago)
- Default Branch: latest
- Last Pushed: 2024-09-06T16:32:54.000Z (about 1 year ago)
- Last Synced: 2024-09-06T19:46:13.698Z (about 1 year ago)
- Topics: ansible, ansible-role, apache2, automation, certbot, certificates, iac, infrastructure-as-code, webserver
- Language: Jinja
- Homepage:
- Size: 125 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://httpd.apache.org/)
# Ansible Role - Apache2 Webserver
Ansible Role to deploy one or multiple Apache2 sites on a linux server.
[](https://github.com/ansibleguy/infra_apache/actions/workflows/lint.yml)
[](https://galaxy.ansible.com/ui/standalone/roles/ansibleguy/infra_apache)
**Molecule Integration-Tests**:
* Status: [](https://github.com/ansibleguy/_meta_cicd/blob/latest/templates/usr/local/bin/cicd/molecule.sh.j2) |
[](https://github.com/ansibleguy/infra_apache/actions/workflows/integration_test_result.yml)
* Logs: [API](https://ci.ansibleguy.net/api/job/ansible-test-molecule-infra_apache/logs?token=2b7bba30-9a37-4b57-be8a-99e23016ce70&lines=1000) | [Short](https://badges.ansibleguy.net/log/molecule_infra_apache_test_short.log) | [Full](https://badges.ansibleguy.net/log/molecule_infra_apache_test.log)
Internal CI: [Tester Role](https://github.com/ansibleguy/_meta_cicd) | [Jobs API](https://github.com/O-X-L/github-self-hosted-jobs-systemd)
**Tested:**
* Debian 11
* Debian 12
----
## Install
```bash
# latest
ansible-galaxy role install git+https://github.com/ansibleguy/infra_apache
# from galaxy
ansible-galaxy install ansibleguy.infra_apache
# or to custom role-path
ansible-galaxy install ansibleguy.infra_apache --roles-path ./roles
# install dependencies
ansible-galaxy install -r requirements.yml
```
----
## Advertisement
* Need **professional support** using Ansible or managing Web-Applications? Contact us:
E-Mail: [contact@oxl.at](mailto:contact@oxl.at)
Tel: [+43 3115 40 900 0](tel:+433115409000)
Web: [EN](https://www.o-x-l.com) | [DE](https://www.oxl.at)
Language: German or English
* You want a simple **Ansible GUI**?
Check-out this [Ansible WebUI](https://github.com/ansibleguy/webui)
----
## Usage
### Config
Define the apache dictionary as needed!
```yaml
apache:
headers:
mySuperCustom: 'headerContent'
modules:
present: ['evasive', 'ssl', 'headers', 'rewrite']
guys_statics:
mode: 'serve'
domain: 'static.guy.net'
serve:
path: '/var/www/site_guys_statics'
ssl:
mode: 'snakeoil'
config: # add settings as key-value pairs
KeepAliveTimeout: 10
config_additions: # add a list of custom lines of config
- 'location = / { return 301 /kitty.jpg; }'
git_stuff:
mode: 'redirect'
domain: 'ansibleguy.net'
aliases: ['www.ansibleguy.net']
redirect:
target: 'https://github.com/ansibleguy'
ssl:
mode: 'letsencrypt'
letsencrypt:
email: 'apache@template.ansibleguy.net'
security:
restrict_methods: false
```
### Execution
Run the playbook:
```bash
ansible-playbook -K -D -i inventory/hosts.yml playbook.yml
```
There are also some useful **tags** available:
* base => only configure basics; sites will not be touched
* sites
* config => configuration (base and instances)
* certs
To debug errors - you can set the 'debug' variable at runtime:
```bash
ansible-playbook -K -D -i inventory/hosts.yml playbook.yml -e debug=yes
```
----
## Functionality
* **Package installation**
* Ansible dependencies (_minimal_)
* Apache2
* **Configuration**
* Support for multiple sites/servers
* Two **config-modes**:
* serve (_default_)
* redirect
* Support for specific configurations using the 'config' and 'config_additions' parameters
* **Default config**:
* Disabled: Generate self-signed ones
* **ca** => Generate a minimal Certificate Authority and certificate signed by it
* **letsencrypt** => Uses the LetsEncrypt certbot
* **existing** => Copy certificate files or use existing ones
* **Default opt-ins**:
* restricting methods to POST/GET/HEAD
* status-page listener on localhost
* Logging to syslog
* http2
* **Default opt-outs**:
* Include the config file 'sites-available/site_{{ site_name }}_app.conf' for advanced usage
Options to provide module config will be added in the future!
Also some basic mods will get a pre-config added. (_prefork, evasive_)
----
## Info
* **Note:** Most of the role's functionality can be opted in or out.
For all available options - see the default-config located in the main/site defaults-file!
* **Note:** this role currently only supports debian-based systems
* **Note:** This role expects that the site's unencrypted 'server' will only redirect to its encrypted connection.
* **Note:** If you want any requested domain to get handled by a site/server you need to add a **wildcard** '*' as alias!
BUT: You still have to provide a main domain!
* **Warning:** Not every setting/variable you provide will be checked for validity. Bad config might break the role!
* **Info:** To disable default settings and headers => just set their value to: ''
* **Info:** For LetsEncrypt renewal to work, you must allow outgoing connections to:
80/tcp, 443/tcp+udp to acme-v02.api.letsencrypt.org, staging-v02.api.letsencrypt.org (_debug mode_) and r3.o.lencr.org