Skip to content

Latest commit

 

History

History
143 lines (90 loc) · 5.05 KB

README.md

File metadata and controls

143 lines (90 loc) · 5.05 KB
Raw

Let's Encrypt Backup

During installation of Let's Encrypt/Certbot you are advised that you should take a backup of your configuration regularly. This configuration also includes your account credentials.

Your account credentials have been saved in your Certbot
configuration directory at /etc/letsencrypt. You should make a
secure backup of this folder now. This configuration directory will
also contain certificates and private keys obtained by Certbot so
making regular backups of this folder is ideal.

This simple BASH script is designed to easily backup these files in a compressed/archived format to a location outside of production.

Contributors

Prerequisites

To be able to use this you must have the following installed:

  • GNU tar

If you do not have tar installed then you can do so with the following:

Debian

The following installs tar on Debian.

apt-get install tar

Ubuntu

This command will install tar on Ubuntu. The sudo command ensures that the apt command is run with root privileges.

sudo apt-get install tar

CentOS

Execute the following command as root user on the shell to install tar on CentOS.

yum install tar

Versions

This BASH script has been tested to work on the following:

  • Debian 9 Stretch
  • Debian 10 Buster
  • Debian 11 Bullseye
  • Certbot 0.28.0

To find your version of Certbot.

root@0:~# apt-cache policy certbot | grep -i Installed
  Installed: 0.28.0-1~bpo9+1

Or, for those not running a distribution with apt.

root@0:~# /usr/bin/certbot --version
certbot 0.28.0

Whilst these versions have been tested your mileage may vary, there is very little reason if you are using an older/newer version of Debian or another flavour of Linux you may need to alter the directory locations, but the script itself should still work as it relies primarily on simple BASH file system commands and tar.

Getting Started

The simplest way to get started is to clone the repository:

git clone https://github.com/AlexWinder/letsencrypt-backup.git

This script assumes that you are using the default directory of /etc/letsencrypt. If your Let's Encrypt configuration files are in a different location then you will need to amend this as appropriate, as detailed in the section below.

Once cloned you will need to set up a crontab to run periodically to execute the letsencrypt-backup.sh script. The example below will run the backup script every day at 00:00, however you are free to run the script as often or as little as your requirements or resources permit.

0 0 * * * /location/to/letsencrypt-backup/letsencrypt-backup.sh

You will need to drop in the correct location to the directory as per your system when you cloned the repository.

Test Script

To test that the permissions issue is now resolved you can attempt to execute the script manually, using the --help flag to check if the script actually executes.

To test that the script runs as expected you can use the --help flag.

/location/to/letsencrypt-backup/letsencrypt-backup.sh --help

If you don't get any errors then all is working as expected and you can use the script to backup your Let's Encrypt configuration.

If the script doesn't execute then the most common cause of this is due to file permissions or a missing dependency. Make notes of the output errors to give an indication as to the reason of why the file couldn't be executed.

Custom Arguments

There are a number of supported flags which allow you to override parts of the script to meet your requirements:

  • --help - Show a help guide on the script. If used then no other parameters will be considered.
  • --from - The location where your Let's Encrypt configuration files are. Default: /etc/letsencrypt.
  • --to - Where you would like to back the files up to. Default: /var/backups/letsencrypt.
  • --days - The number of days to keep backup files before deleting them. Default: 120 (days).
./letsencrypt-backup.sh --from <configuration location> --to <backup location> --days <number of days to store backups>

For example:

./letsencrypt-backup.sh --from /etc/certbot --to /home/certbot/backups --days 365

In the above example we are taking the configuration files in /etc/certbot, compressing and then sending them to /home/certbot/backups, and deleting any files which are older than 365 days old in the backup to directory.

You are free to use any combination of the above flags (--from, --to, and --days). Any which you do not specify will take the default value as listed above.

Extracting Backups

If you wish to extract a particular backup you can do so with the following command:

tar -xvf /var/backups/letsencrypt/letsencrypt_backup-DATE-TIME.tar.gz

You should swap in the path and filename as per your own setup. This will extract the backup to its own directory as per your current working directory.

License

This project is licensed under the MIT License.