Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bodsch/ansible-php

install and configure PHP. primary used for php-fpm.
https://github.com/bodsch/ansible-php

ansible automation php php-fpm web-application

Last synced: 9 days ago
JSON representation

install and configure PHP. primary used for php-fpm.

Awesome Lists containing this project

README

        

# Ansible Role: `php`

Ansible role to install fpm-php on various systems.

Only inspired by [geerlingguy](https://github.com/geerlingguy/ansible-role-php)

Detect available PHP Version based on `php_version` Variable.

Supports PHP version 7 and 8, **as long as the corresponding versions are available.**

ArchLinux has removed the PHP 7 packages from their repository!

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/bodsch/ansible-php/main.yml?branch=main)][ci]
[![GitHub issues](https://img.shields.io/github/issues/bodsch/ansible-php)][issues]
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/bodsch/ansible-php)][releases]
[![Ansible Downloads](https://img.shields.io/ansible/role/d/bodsch/php?logo=ansible)][galaxy]

[ci]: https://github.com/bodsch/ansible-php/actions
[issues]: https://github.com/bodsch/ansible-php/issues?q=is%3Aopen+is%3Aissue
[releases]: https://github.com/bodsch/ansible-php/releases
[galaxy]: https://galaxy.ansible.com/ui/standalone/roles/bodsch/php

## Requirements & Dependencies

Ansible Collections

- [bodsch.core](https://github.com/bodsch/ansible-collection-core)

```bash
ansible-galaxy collection install bodsch.core
```
or
```bash
ansible-galaxy collection install --requirements-file collections.yml
```

### Operating systems

Tested on

* ArchLinux (**only PHP 8!**)
* Debian based
- Debian 12
- Ubuntu 22.04

> **RedHat-based systems are no longer officially supported! May work, but does not have to.**

## usage

```yaml
# choose your version!
php_version: "8"

php_packages_state: present

php_fpm_log_directory: /var/log/php-fpm
php_fpm_tmp_upload_directory: /tmp/php-fpm
php_fpm_socket_directory: /run/php

php_fpm_log_level: notice

php_enable_php_fpm: true

php_fpm_listen: "127.0.0.1:9000"
php_fpm_listen_allowed_clients: "127.0.0.1"
php_fpm_pm:
max_children: 50
start_servers: 5
spare_servers:
min: 5
max: 5

php_use_managed_ini: true

php_expose_php: "On"
php_memory_limit: "256M"
php_max_execution_time: "60"
php_max_input_time: "60"
php_max_input_vars: "1000"
php_realpath_cache_size: "32K"

php_file_uploads: "On"
php_upload_max_filesize: "64M"
php_max_file_uploads: "20"

php_post_max_size: "32M"
php_date_timezone: "Europe/Berlin"
php_allow_url_fopen: "On"

php_sendmail_path: "/usr/sbin/sendmail -t -i"
php_output_buffering: "4096"
php_short_open_tag: "Off"
php_disable_functions: []

php_session_cookie_lifetime: 0
php_session_gc_probability: 1
php_session_gc_divisor: 1000
php_session_gc_maxlifetime: 1440
php_session_save_handler: files
php_session_save_path: ''
php_session_cache_expire: 180

php_error_reporting: "E_ALL & ~E_DEPRECATED & ~E_STRICT"
php_display_errors: "Off"
php_display_startup_errors: "Off"

php_packages: []

php_fpm_default_pool:
delete: false
name: www.conf

php_fpm_pools: []

# php modules
php_modules: []
```

### custom packages

To install more PHP packages, you can find a list at `php_packages` specify.

E.G.:

```yaml
php_packages:
- php-ldap
```

The packages do not require version information, as it would be necessary for RedHat and Remis packages,
for example. The role takes care that the package name is valid.

As an example, `php-ldap` would be `php73-php-ldap`.

### php pools

```yaml
php_fpm_pools:
- name: worker-01
user: "{{ php_fpm_pool_user }}"
group: "{{ php_fpm_pool_group }}"
listen.owner: "{{ php_fpm_pool_user }}"
listen.group: "{{ php_fpm_pool_group }}"
listen: "{{ php_fpm_socket_directory }}/$pool.sock"
# static, dynamic or ondemand
pm: ondemand
pm.max_children: 10
pm.start_servers: 4
pm.min_spare_servers: 2
pm.max_spare_servers: 6
pm.status_path: /status

- name: worker-02
user: "{{ php_fpm_pool_user }}"
group: "{{ php_fpm_pool_group }}"
listen.owner: "{{ php_fpm_pool_user }}"
listen.group: "{{ php_fpm_pool_group }}"
listen: "{{ php_fpm_socket_directory }}/$pool.sock"
pm: dynamic
pm.max_children: 10
pm.start_servers: 4
pm.min_spare_servers: 2
pm.max_spare_servers: 6
pm.status_path: /status
ping.path: /ping
ping.response: pong
access.log: "{{ php_fpm_log_directory }}/$pool_access.log"
access.format: "%R - %n - %{HTTP_HOST}e - %u %t \"%m %r [%Q%q]\" %s %f %{mili}d %{kilo}M %C%%"
chdir: /
env:
PATH: "/usr/local/bin:/usr/bin:/bin"
TMPDIR: "{{ php_fpm_tmp_upload_diectory }}"
php_admin_value:
date.timezone: "Europe/Berlin"
log_errors: 'on'
max_execution_time: 300
memory_limit: 512M
upload_max_filesize: 32M
```

### php modules

```yaml
php_modules:
# gd
- name: gd
enabled: true
priority: 20
content: |
extension=gd
# OpCache settings
- name: opcache
enabled: true
priority: 10
content: |
zend_extension=opcache
opcache.enable=1
opcache.enable_cli=1
opcache.memory_consumption=128
opcache.interned_strings_buffer=16
opcache.max_accelerated_files=10000
opcache.max_wasted_percentage=5
opcache.validate_timestamps=1
opcache.revalidate_path=0
opcache.revalidate_freq=1
opcache.max_file_size=0
# PDO mysql
- name: pdo_mysql
enabled: true
priority: 20
content: |
extension=pdo_mysql
```

Under [documentation](documentation) you can find some module configurations that have been copied from php.ini.

---

## Contribution

Please read [Contribution](CONTRIBUTING.md)

## Development, Branches (Git Tags)

The `master` Branch is my *Working Horse* includes the "latest, hot shit" and can be complete broken!

If you want to use something stable, please use a [Tagged Version](https://github.com/bodsch/ansible-php/tags)!

---

## Author

- Bodo Schulz

## License

[Apache](LICENSE)

**FREE SOFTWARE, HELL YEAH!**