Automate the installation of Let's Encrypt SSL on the free plan of ServerPilot
Python
Switch branches/tags
Nothing to show
Clone or download
Latest commit b33f4c4 Jun 9, 2018
Permalink
Failed to load latest commit information.
rwssl Raising exceptions May 29, 2018
.gitignore Updating version to 1.0.5 May 30, 2018
README.md Updating readme Jun 9, 2018
setup.py Updating readme May 30, 2018

README.md

Let's Encrypt on Your ServerPilot Servers

Automate the installation of Let's Encrypt SSL on servers managed by ServerPilot. Both free and paid plans of ServerPilot are supported now. SSLs can be installed on all apps owned by serverpilot or any other user.

Update: Now rwssl can install SSLs for all apps at once with a single command rwssl -a

Attention: All Prevoious Versions Need an Upgrade

In order to get SSL renewals work flawlessly, all versions prior to v1.0.3 need an upgrade. If you are using the old script and haven't installed it using Python PIP, then please scroll to the bottom of this page to learn how to upgrade. If you have installed the package using PIP, then check rwssl version like this:

pip show rwssl

If the version is older than 1.0.5, then you need to upgrade it:

pip uninstall rwssl
pip install --no-cache-dir rwssl

Getting started

Install

pip install rwssl

PIP not installed? Install it by running:

apt install python-pip

If all goes fine, a new command rwssl will become available.

Below commands can be used with rwssl:

Available Commands

  -h, --help            show this help message and exit
  -a, --all             Install SSL for all available apps.
  -f, --fresh           Obtain and install SSL certificates for new (non-ssl)
                        apps only.
  -i IGNOREAPPS, --ignore IGNOREAPPS
                        Comma-seperated app names to ignore some apps and
                        install SSL for all others.
  -n APPNAME, --name APPNAME
                        Name of the app where SSL should be installed.
  -r, --renew           Renew all installed SSL certificates which are about
                        to expire.
  -ic, --installcron    Install the cron job for SSL renewals.
  -dc, --deletecron     Uninstall the cron job responsible for SSL renewals.
  -ap, --autopilot      A CRON job that attempts to automatically obtain SSL
                        certificates for newly added apps.
  -na, --noautopilot    Disable Autopilot mode and disable automatic SSLs for
                        your apps.
  -re, --refresh        Cleans all previous SSL vhost files, reinstalls the
                        SSLs and reloads nginx. Only needed if you are having
                        issues on a server with old SSL installations.
  -redir REDIRECT, --redirect REDIRECT
                        Apply a 301 redirect from HTTP to HTTPs for a given
                        app or for all apps.
  -noredir NOREDIRECT, --noredirect NOREDIRECT
                        Disable HTTP to HTTPs redirect for a single app or for
                        all apps.

Get Help on All Available Commands

rwssl -h

or

rwssl --help

Install SSLs

  1. Install SSL on all available apps
rwssl -a

or

rwssl --all
  1. Install SSL on all apps ignoring some (Provide comma-separated app names)
rwssl -i 'app1,app2,app3'

or

rwssl --ignore 'app1,app2,app3'
  1. Install SSL on a specific app
rwssl -n app_name
  1. Install SSL on all new apps (that doesn't have an SSL yet)
rwssl -f

or

rwssl --fresh

Renew SSLs

rwssl -r

or

rwssl --renew

CRON Job for SSL Renewals

Install the CRON job:

rwssl -ic

or

rwssl --installcron

Uninstall the CRON job (Renewals will not be carried out by rwssl):

rwssl -dc

or

rwssl --deletecron

Autopilot Mode

Enable autopilot mode so you will not need to obtain SSL certificates for your new apps manually. This will add a CRON job set to run every 10 minutes. rwssl will check for new non-ssl apps and if any new apps are added, an SSL certificate will be obtained and installed automatically.

Enable Autopilot Mode:

rwssl -ap

or

rwssl --autopilot

Disable Autopilot Mode:

rwssl -na

or

rwssl --noautopilot

Refresh SSL Apps:

If you have added SSL vhosts in the past yourself or if you have used the old rwssl script, then this command is helpful in order to do a cleanup and reinstall SSL certificates/SSL vhosts. You should not run it unless it is too important.

rwssl -re

or

rwssl --refresh

Force HTTPS (301 Redirect):

You don't need to modify your .htaccess file or nginx configuration manually to enable HTTP to HTTPS redirect as rwssl does it automatically for you.

To force HTTPS on all apps:

rwssl -redir all

or

rwssl --redirect all

To force HTTPS on a selected app:

rwssl -redir appname

or

rwssl --redirect appname

To disable HTTPS redirect for all apps:

rwssl -noredir all

or

rwssl -noredirect all

To disable HTTPS redirect on a selected app:

rwssl -noredir appname

or

rwssl -noredirect appname

If you notice redirect loops after enabling HTTP to HTTPS redirect, then it means that either your SSL vhosts need a refresh (rwssl -re) or your website's .htaccess rules need to be fixed. In such a scenario, please fix your .htaccess file or disable the SSL for the app by running rwssl -noredir appname until you sort out the issue.

Upgrade (Only for old script's users)

If you have used rwssl previously on a server, then follow these instructions:

  1. Remove old script
rm /usr/local/bin/rwssl
  1. Install the latest package
pip install rwssl

To get help on commands, type rwssl -h or rwssl --help

Any questions? Ask me in my blog post here.

How to Uninstall

To unintall rwssl, simply run:

sudo pip uninstall rwssl