GitHub - aws-samples/ec2-lamp-server: Provision Apache or Nginx web server EC2 instance with PHP and MySQL, MariaDB or PostgreSQL. Includes option to install WordPress or Moodle (original) (raw)

EC2-LAMP-Server

AWS CloudFormation template to provision Amazon EC2 web server with Apache/Nginx, PHP and MySQL/MariaDB/PostgreSQL.

Description

LAMP is an acronym for the operating system, Linux; the web server, Apache; the database server, MySQL (or MariaDB); and the programming language, PHP. It is a common open source web platform for many of the web's popular applications. Variations include LEMP which replaces web server with Nginx, LAPP which replaces database server with PostgreSQL, and LEPP which uses Nginx and PostgreSQL. According to W3Techs more than 70% of websites use PHP.

This repo provides CloudFormation templates to provision EC2 instances with option to specify PHP version, web server engine and database engine. The instances can be used for software development or deployment of PHP based web applications, and include options to install WordPress or Moodle.

Architecture Diagram

Overview of features

The template provides the following features:

• Amazon Linux 2023, Ubuntu/Ubuntu Pro 22.04/24.04, or Amazon Linux 2
• Applications
  • Apache or Nginx web server
  • MySQL, MariaDB or PostgreSQL database server
  • PHP
    * Amazon Linux: PHP 8 with additional PECL extensions (imagick, apcu, memcached, redis, igbinary, msgpack, lzf, lz4, zstd, etc) compiled*
    * Ubuntu Linux: PHP 5.6, 7.x or 8.x from Ondřej Surý's ppa:ondrej/php repository
  • Web application: WordPress or Moodle (optional)
  • Composer
  • Valkey/Redis and Memcached in memory database
  • Certbot for free HTTPS certificate
    * Amazon Route 53 hosted zone access for use with certbot-dns-route53 DNS plugin
  • Docker Engine (optional)
  • MountPoint for Amazon S3 for mounting S3 bucket as local file system
    * Amazon S3 bucket access for use with Mountpoint with S3
  • AWS CLI v2 with auto-prompt
  • Amazon CloudWatch agent
  • AWS CodeDeploy agent
• Remote Administration
  • Amazon DCV remote display protocol server for graphical desktop access (optional)
  • SSM Session Manager secure shell access
  • EC2 Instance Connect in-browser SSH access
  • Webmin web-based system administration (optional)
• AWS Services
  • AWS Backup to protect EC2 instance data (optional)
  • Application Load Balancer with SSL/TLS certificate from AWS Certificate Manager (optional)
  • Amazon CloudFront CDN with support for VPC Origin (optional)

Notice

Although this repository is released under the MIT-0 license, its CloudFormation template uses features fromMySQL Community Edition and Webmin which are licensed under GPL and BSD-3-Clause license respectively. Usage of Amazon DCV indicates acceptance of DCV EULA.

By using the template, you accept license agreement of all software that is installed in the EC2 instance.

Requirements

• EC2 instance must be provisioned in a subnet with IPv4 internet connectivity.
• To use Application Load Balancer (ALB) with HTTPS, either request a public certificate or import a certificate into AWS Certificate Manager.

Deploying using CloudFormation console

Download .yaml file for the desired operating system (Amazon Linux 2, Amazon Linux 2023 or Ubuntu/Ubuntu Pro)

Login to AWS CloudFormation console. Choose Create Stack, Upload a template file, Choose File, select your .YAML file and choose Next. Enter a Stack name and specify parameters values.

EC2 Instance

• ec2Name: EC2 instance name
• ec2KeyPair: EC2 key pair name. Create key pair if necessary
• processorArchitecture / osVersion : Intel/AMD x86_64 or Graviton arm64. Default is Graviton (arm64).
• instanceType: EC2 instance types. Do ensure type matches processor architecture. Default is t4g.xlarge burstable instance type. For best performance, consider newer M7g and M8g Graviton instance
• ec2TerminationProtection: enable EC2 termination protection to prevent accidental deletion. Default is Yes

EC2 Network

• vpcID: VPC with internet connectivity. Select default VPC if unsure
• subnetID: subnet with internet connectivity. Select subnet in default VPC if unsure
• displayPublicIP: set this to No if your EC2 instance will not receive public IP address. EC2 private IP will be displayed in CloudFormation Outputs section instead. Default is Yes
• assignStaticIP: associates a static public IPv4 address using Elastic IP address. Default is Yes

EC2 Remote Administration

• ingressIPv4: allowed IPv4 source prefix to remote administration services, e.g. 1.2.3.4/32. You can get your source IP from https://checkip.amazonaws.com. Default is 0.0.0.0/0.
• ingressIPv6: allowed IPv6 source prefix to remote administration services. Use ::1/128 to block all incoming IPv6 access. Default is ::/0
• allowSSHport: allow inbound SSH. Option does not affect EC2 Instance Connect access. Default is Yes
• installDCV: install graphical desktop environment and DCV server. Default is Yes
• installWebmin: install Webmin web-based system administration tool. Default is No

SSH, DCV and Webmin inbound access are restricted to ingressIPv4 and ingressIPv6 IP prefixes.

LAMP

• webOption: Apache or Nginx web server.
• phpVersion: PHP version to install or none.
• databaseOption: MySQL, MariaDB, PostgreSQL database server or none. MySQL option for Amazon Linux will attempt to use MySQL Community Edition repository, where MySQL root password can be retrieved using the command sudo grep password /var/log/mysqld.log. Select none if using external database such as Amazon RDS.
• installApp#: option to install WordPress or Moodle. If selected, template will create MySQL/MariaDB database and user, and download installation files. Default is None.

#When stack has been provisioned, open a browser to continue WordPress or Moodle web based installation. The database name, user and password to use can be located in /home/ec2-user/database-credentials (AL2023) or /home/ubuntu/database-credentials (Ubuntu)

Others

• installDocker (optional): install Docker Engine (also known as Docker CE) from Docker repository or Linux OS package repository. Default is No
• r53ZoneID (optional): Amazon Route 53 hosted zone ID to grant access for use with Certbot certbot-dns-route53 DNS plugin. Default is * for access to all Route 53 zones in your AWS account. Permission is restricted to _acme-challenge.* TXT DNS records using resource record set permissions
• s3BucketName (optional): name of Amazon S3 bucket to grant EC2 instance access using IAM policy. Default is empty not to grant access. A * value will grant the EC2 instance access to all S3 buckets in your AWS account

EBS

• volumeSize: Amazon EBS volume size
• volumeType: EBS General Purpose Volume type

Application Load Balancer (ALB)

• enableALB: deploy Application Load Balancer with EC2 instance as target. Associated charges are listed on Elastic Load Balancing pricing page. Default is No
• albScheme: either internet-facing or internal. An internet-facing load balancer routes requests from clients to targets over the internet. An internal load balancer routes requests to targets using private IP addresses. Default is internet-facing
• albIpAddressType: IP address type, either IPv4, IPv4-and-IPv6 or IPv6. Default is IPv4
• albSubnets: subnets for ALB. Select at least 2 AZ subnets in EC2 VPC

Select a subnet even if enableALB is No

ALB HTTPS listener

• albCertificateArn: AWS Certificate Manager (ACM) certificate ARN for ALB HTTPS listener. Leave blank not to create HTTPS listener
• albSecurityPolicy: Security policy for HTTPS listener. Default is ELBSecurityPolicy-TLS13-1-2-2021-06
• albRedirectHTTPtoHTTPS: option to redirect HTTP requests to HTTPS. Default is Yes
• albHstsHeaderValue: HSTS (HTTP Strict Transport Security) response header value to send. Set empty string not to send HSTS header. Default is max-age=31536000; includeSubDomains

The above options only apply if enableALB is Yes

Amazon CloudFront

• enableCloudFront: create a Amazon CloudFront distribution to your EC2 instance or ALB. Associated charges are listed on Amazon CloudFront pricing page. Default is No
• originType: either Custom Origin or VPC Origin. Most AWS Regions support VPC Origins, which allow CloudFront to deliver content even if your EC2 instance is in a VPC private subnet. Default is Custom Origin

AWS Backup

• enableBackup : EC2 data protection with AWS Backup. Associated charges are listed on AWS Backup pricing page. Default is Yes
• scheduleExpression: start time of backup using CRON expression. Default is 1 am
• scheduleExpressionTimezone: timezone in which the schedule expression is set. Default is Etc/UTC
• deleteAfterDays: number of days after backup creation that a recovery point is deleted. Default is 35

CloudFormation Outputs

The following are available on Outputs section

• EC2console: EC2 console URL to manage your EC2 instance
• EC2instanceConnect: EC2 Instance Connect URL. Functionality is only available under certain conditions
• EC2serialConsole: EC2 Serial Console URL. Functionality is available under certain conditions.
• EC2iamRole: IAM role URL link to manage permissions
• SSMsessionManager or SSMsessionManagerDCV: SSM Session Manager URL
• WebUrl: EC2 web server URL

If installDCV is Yes

• DCVwebConsole : DCV web browser client URL. Native DCV clients can be downloaded from https://www.amazondcv.com/. Login as the user specified in Description field.

If installWebmin is Yes

• WebminUrl : Webmin URL link. Set the root password by running sudo passwd root using EC2instanceConnect, SSMsessionManager or SSH session first

If enableALB is Yes

• AlbConsole: ALB console URL
• AlbDnsName: ALB domain name. Create a DNS CNAME or Route 53 alias to ALB domain name especially if you are using HTTPS listener

If enableCloudFront is Yes

• CloudFrontConsole : CloudFront console URL link
• CloudFrontURL : CloudFront distribution URL, e.g. https://d111111abcdef8.cloudfront.net

Troubleshooting

To troubleshoot any installation issue, you can view contents of the following log files (if available)

• /var/log/cloud-init-output.log
• /var/log/install-cfn-helper.log
• /var/log/install-sw.log
• /var/log/install-php.log
• /var/log/install-lamp.log
• /var/log/install-dcv.log

PHP performance configuration

Based on public articles about PHP performance (many thanks to the authors), the following enhancements were made:

• Default processor architecture is Graviton as per Improving performance of PHP for Arm64 and impact on AWS Graviton2 based EC2 instances and arm64 vs x86_64 for php
• PHP OPcache and JIT enabled: from Make your PHP 8 apps twice as fast (OPCache & JIT)
• FastCGI Process Manager (FPM): from PHP-FPM Cuts Web App Loading Times by 300%
• Apache MPM Event: from Apache Performance Tuning: MPM Modules
• Valkey or Redis session store: from Highly Performant PHP Sessions with Redis
• Serialisation (igbinary,msgpack) and compression (lzf,zstd,lz4) extensions to reduce Valkey/Redis/Memcached network traffic: from Strategies for Reducing Big Redis Traffic in Laravel
• PHP OPcache file cache configured as per PHP Opcache file cache but not enabled. To enable, edit /etc/php.d/10-opcache.ini (Amazon Linux) or /etc/php/ phpVersion/fpm/php.ini (Ubuntu) file to uncomment the line beginning with opcache.file_cache=/var/www/.opcache and restart php-fpm.

Obtaining certificate for HTTPS

Amazon CloudFront (enableCloudFront) supports HTTPS. You can use AWS Certificate Manager to request a public certificate for your own domain and associate it with your CloudFront distribution.

The EC2 instance uses a self-signed certificate for HTTPS. You can use Certbot to obtain and install Let's Encrypt certificate on your web server.

Certbot prerequisites

Ensure you have a domain name whose DNS entry resolves to your EC2 instance IP address. If you do not have a domain, you can register a new domain using Amazon Route 53 and create a DNS A record.

Using apache plugin

• From terminal, run the below command and follow instructions.

Using nginx plugin

• From terminal, run the below command and follow instructions.
  Apache and Nginx plugin uses HTTP-01 challenge, and require HTTP port 80 to be accessible from public internet

Using Route 53 plugin

The certbot-dns-route53 option requires your DNS to be hosted by Route 53. It supports wildcard certificates and domain names that resolve to private IP addresses. Ensure that Route 53 zone access is granted by specifying r53ZoneID value. From terminal, run the below command based on installed web server type and follow instructions.

• Apache

sudo certbot --dns-route53 --installer apache  

• Nginx

sudo certbot --dns-route53 --installer nginx  

Refer to Certbot site for help with this tool.

Using Cloudwatch agent

Amazon CloudWatch agent is installed, and enables collection of EC2 system-level metrics and AWS X-Ray traces.

The template configures agent to collect memory and disk utilization metrics. You can configure Cloudwatch agent to collect other data as follows.

Create agent configuration file

Create agent configuration file. You can use agent configuration file wizard:

sudo /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-config-wizard

Start Cloudwatch agent

After config.json file is created, start CloudWatch agent:

sudo systemctl enable amazon-cloudwatch-agent
sudo /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-ctl -a fetch-config -m ec2 -s -c file:/opt/aws/amazon-cloudwatch-agent/bin/config.json

Refer to How do I install and configure the unified CloudWatch agent to push metrics and logs from my EC2 instance to CloudWatch? for more details.

Compiling PHP extensions on Amazon Linux 2023 (AL2023)

If you are looking to compile PHP extensions on AL2023, refer to community article How do I compile PHP extensions on Amazon Linux 2023?

About EC2 instance

Well-architected

To improve performance, reliability, scalability, high availability and functionality, EC2 instance can be extended to use other services such as Amazon RDS, Amazon S3, Amazon ElastiCache and Amazon EFS, and with AWS SDK for PHP. Some useful resources that can help with the integration include:

• AWS Well-Architected
• AWS Architecture Center including Scaling PHP Applications on AWS
• PHP on AWS
• Moodle Reference Architecture
• Best Practices for WordPress on AWS

Restoring from backup

If you enable AWS Backup, you can restore your EC2 instance from recovery points (backups) in your backup vault. The CloudFormation template creates an IAM role that grants AWS Backup permission to restore your backups. Role name can be located in your CoudFormation stack Resources section as the Physical ID value whose Logical ID value is backupRestoreRole

Securing

To futher secure your EC2 instance, you may want to

• Restrict remote administration access to your IP address only (ingressIPv4 and ingressIPv6)
• For DCV (installDCV)
  • Use native clients for remote access, and disable web browser client by removing nice-dcv-web-viewer package
• Disable SSH access from public internet (allowSSHport)
  • Use EC2 Instance Connect or SSM Session Manager for in-browser terminal access, or
  • Start a session using AWS CLI or SSH with Session Manager plugin for the AWS CLI
• Use AWS Backup (enableBackup)
  • Enable AWS Backup Vault Lock to prevent your backups from accidental or malicious deletion, and for protection from ransomware
• Deploy EC2 instance in a private subnet
  • Use Application Load Balancer (enableALB) or Amazon CloudFront (enableCloudFront) with VPC Origin for public internet access
  • Use AWS Certificate Manager to request a public HTTPS certificate and associate it with your Application Load Balancer or CloudFront distribution
  • Use AWS WAF to protect your CloudFront distribution or Application Load Balancer
• With Amazon CloudFront
  • Additional inbound HTTP and HTTPS security groups with AWS-managed prefix list for Amazon CloudFront as source are created. Restrict EC2/ALB origin HTTP/HTTPS inbound access to CloudFront only by removing public internet inbound (0.0.0.0/0) from security group
  • Install public HTTPS certificate on your ALB/EC2 origin. Enable HTTPS communication between CloudFront and origin. For custom origin, configure origin domain name to match certificate name.
• Enable Amazon Inspector to scan EC2 instance for software vulnerabilities and unintended network exposure.
• Enable Amazon GuardDuty security monitoring service with Runtime Monitoring and Malware Protection for EC2

Clean Up

To remove created resources, you will need to

• Delete any recovery points in created backup vault
• Disable EC2 instance termination protection (if enabled)
• Delete CloudFormation stack

Security

See CONTRIBUTING for more information.

License

This library is licensed under the MIT-0 License. See the LICENSE file.