在Websauna项目中使用Let's Encrypt配置HTTPS证书

前言

在现代Web开发中，HTTPS已经成为标配而非可选功能。Websauna作为一个全栈Python Web框架，提供了与Let's Encrypt集成的简便方法，让开发者能够快速为应用部署免费的HTTPS证书。本文将详细介绍如何在Websauna项目中配置Let's Encrypt证书，实现安全的HTTPS连接。

Let's Encrypt简介

Let's Encrypt是一个非盈利的证书颁发机构(CA)，提供免费的TLS/SSL证书。它的主要特点包括：

• 完全自动化证书颁发和续订流程
• 证书有效期为90天（3个月）
• 支持通配符证书（Wildcard Certificates）
• 完全免费使用

准备工作

在开始配置之前，请确保：

1. 已经有一个运行中的Websauna项目
2. 服务器上已安装Ansible
3. 拥有一个有效的域名并已正确解析到服务器IP

安装Ansible角色

Websauna项目推荐使用特定的ansible-letsencrypt角色来管理Let's Encrypt证书。以下是安装步骤：

1. 在包含playbook.yml文件的目录中，创建或编辑requirements.yml文件
2. 添加以下内容：

- src: git+https://github.com/websauna/ansible-letsencrypt.git
  name: ansible-letsencrypt

3. 运行以下命令安装依赖：

ansible-galaxy install -r requirements.yml

配置Playbook

配置Let's Encrypt需要修改Ansible playbook。以下是关键配置项：

- letsencrypt: on  # 启用Let's Encrypt
- ssl: on  # 启用SSL

# Let's Encrypt参数配置
- server_name: yourdomain.com  # 你的完整域名
- letsencrypt_webroot_path: /var/www/html  # Webroot验证路径
- letsencrypt_email: [e-mail]  # 用于证书通知的邮箱
- letsencrypt_cert_domains:
  - "{{ server_name }}"  # 证书适用的域名
- letsencrypt_renewal_command_args: '--renew-hook "service nginx restart"'  # 证书续订后重启Nginx
- nginx_ssl_certificate_path: "/etc/letsencrypt/live/{{ server_name }}/cert.pem"  # 证书路径
- nginx_ssl_certificate_path_key: "/etc/letsencrypt/live/{{ server_name }}/privkey.pem"  # 私钥路径

角色配置

在playbook的roles部分添加以下内容：

roles:
  - { role: Stouts.python, become: yes, become_user: root }
  - {role: ansible-letsencrypt, tags: 'letsencrypt'}
  - { role: websauna.site, tags: ['site'] }

运行Playbook

完成配置后，运行完整的playbook使更改生效：

ansible-playbook playbook.yml

自动续订机制

Let's Encrypt证书的有效期为90天，配置完成后系统会自动设置cron任务，在证书到期前自动续订。续订过程完全自动化，无需人工干预。

验证配置

配置完成后，可以通过以下方式验证：

1. 访问你的网站，确认浏览器地址栏显示安全锁标志
2. 使用在线SSL检查工具验证证书配置是否正确
3. 检查Nginx错误日志，确认没有SSL相关错误

常见问题解决

1. 证书申请失败：检查域名解析是否正确，确保服务器可以通过80端口访问
2. Nginx配置错误：验证证书路径是否正确，确保Nginx有读取证书文件的权限
3. 自动续订失败：检查cron任务是否正常运行，查看Let's Encrypt日志获取详细信息

最佳实践

1. 建议在非生产环境测试配置后再部署到生产环境
2. 定期检查证书续订日志，确保自动续订正常工作
3. 考虑设置证书过期监控，作为自动续订的备份方案

通过以上步骤，你的Websauna项目将获得由Let's Encrypt提供的免费HTTPS证书，大大提升了应用的安全性和可信度。