cert/letsencrypt-bundle

Free SSL/HTTPS for your Symfony application with automatic renewal and certificates monitoring

dev-master / 1.0.x-dev 2016-11-11 11:16 UTC

Requires

• php: >=5.4
• symfony/console: ~2.3|~3.0
• symfony/framework-bundle: ~2.3|~3.0

Requires (Dev)

• phpunit/phpunit: ^4.8.21
• swiftmailer/swiftmailer: ~4.3|~5
• symfony/yaml: ~2.3|~3.0

MIT

• Daria

• symfony
• monitoring
• https
• free
• automatic
• ssl
• certificates
• letsencrypt
• renewal

README

This bundle is currently in development.

CertLetsEncryptBundle provides a simple yet fully configurable Symfony command to renew automatically the HTTPS certificates of your website. It has never been so easy to use HTTPS in your Symfony application!

CertLetsEncryptBundle is also able to warn you (by mail for instance) when the renewal of a certificate failed.

Installation

Using Composer:

composer require cert/letsencrypt-bundle:1.0.x-dev

Enable the bundle in your AppKernel:

<?php

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            // ...
            
            new Cert\LetsEncryptBundle\CertLetsEncryptBundle(),

            // ...
        ];
        
        // ...
    }
    
    // ...
}

Usage

Simply configure the bundle to your needs:

# app/config/config.yml

cert_lets_encrypt:

    # Path to the Let's Encrypt executable (usually your letsencrypt-auto binary)
    letsencrypt:          ~ # Required

    # Recovery email used by Let's Encrypt for registration and recovery contact
    recovery_email:       ~ # Required

    # Logs directory (if not specified, the application logs directory will be used)
    logs_directory:       null

    # Domains to get certificates for (this application should response to these domains)
    domains:              [] # Required

    # Monitorings to be warned if an error occured during the renewal of one of your certificates
    monitoring:

        # Email monitoring
        email:
            enabled:              false

            # If an error occured, emails where a warning should be sent
            to:                   []

For a classical setup, you can clone the Let's Encrypt repository in your bin directory (cd /path/to/your/project/bin && git clone https://github.com/letsencrypt/letsencrypt) and use it as script. You probably also want to be warned by email if an error occurs.

# app/config/config.yml

cert_lets_encrypt:
    letsencrypt: "%kernel.root_dir%/../bin/letsencrypt/letsencrypt-auto"
    recovery_email: "[e-mail]"
    domains:
        - example1.org
        - www.example1.org
        - example2.org
        - www.example2.org
    monitoring:
        email:
            enabled: true
            to: [ "[e-mail]" ]

You can test your parameters work properly by running:

$ sudo -H php app/console cert:letsencrypt
# Or for Symfony 3
$ sudo -H php bin/console cert:letsencrypt

You need to run this script as root as Let's Encrypt need root privileges.

And you can check you are properly warned if an error occurs by running:

$ sudo -H php app/console cert:letsencrypt --emulate-failure
# Or for Symfony 3
$ sudo -H php bin/console cert:letsencrypt --emulate-failure

If everything work as expected, you can configure a CRON task to run this command every 2 days for instance:

$ sudo su
$ crontab -e

0 0 */2 * * sudo -H php /path/to/your/project/app/console cert:letsencrypt
# Or for Symfony 3
0 0 */2 * * sudo -H php /path/to/your/project/bin/console cert:letsencrypt