Skip to main content

A simple Django app to handle Let's Encrypt ACME challenges.

Project description

Let's Encrypt App for Django

django-letsencrypt will allow you to add, remove, and update any ACME challenge objects you may need through your Django admin interface. Simply add the ACME challenge and response for your app to serve up the necessary information for Let's Encrypt validation.

This project strives to make installation, configuration, and usage a snap! From high levels of code coverage, multiple compatible python versions, multiple versions of Django supported, even multiple databases too!

And of course all wrapped up and published to PyPI for standard installation!

Supported Configurations

django-letsencrypt is tested across a number of configurations, here's what's supported so far:

  • Python Versions Supported:
    • 3.13 (with Django 5.1)
    • 3.12 (with Django 5.1, 5.0, 4.2)
    • 3.11 (with Django 5.1, 5.0, 4.2)
    • 3.10 (with Django 5.1, 5.0, 4.2)
    • 3.9 (with Django 4.2)
    • 3.8 (with Django 4.2)
  • Django Versions Supported:
    • 5.1 minimum version 5.1.7
    • 5.0 minimum version 5.0.13
    • 4.2 LTS minimum version 4.2.20
  • Databases Supported:
    • mysql
    • postgres
    • sqlite

Recent Build Status Badges

  • Linting - Master
  • Testing Django 4.0 - Master
  • Testing Django 5.0 - Master
  • Testing Django 5.1 - Master
  • Codecov - Master

Installation & Configuration

  1. pip install django-letsencrypt

  2. Add letsencrypt to your INSTALLED_APPS

INSTALLED_APPS = [
   ... ,
   'letsencrypt',
   ... ,
]
  1. Include the letsencrypt in your project's urls.py, or where applicable (usually your root urls.py).
re_path(r'^\.well-known/', include('letsencrypt.urls'))
  1. Run manage.py migrate to create the required table for the letsencrypt model

  2. Create your ACME Challenge objects in your Django admin interface

  3. Test your ACME Challenge objects and their responses by visiting them:

{Django Site}/.well-known/acme-challenge/challenge_text
  1. Enjoy your easy to manage ACME Challenges inside your Django project!

Example Project

If you would like a demo of how to use this application simply clone this project's git repository from GitHub, take a moment to read the README.md file within the example_project directory, and follow the directions. That will spin up a small sample django application already configured for you to try out.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_letsencrypt-5.1.0.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

django_letsencrypt-5.1.0-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file django_letsencrypt-5.1.0.tar.gz.

File metadata

  • Download URL: django_letsencrypt-5.1.0.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for django_letsencrypt-5.1.0.tar.gz
Algorithm Hash digest
SHA256 ef4714053105b71aaed42b2e6c13006e154d6bdb419a098cdd172b22da9992d2
MD5 8d3e4cfdb3dd78cf8a7f3cc9d36a5f9a
BLAKE2b-256 333427f08170935a9eea2e36567eb4e6b61b3f77ca89ff0aaf7aa6b4e3312dca

See more details on using hashes here.

File details

Details for the file django_letsencrypt-5.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_letsencrypt-5.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9cad93c2b6517d1062111cdc7eaa6fef835e0fb623ed9b1d5d8f9077dd1a232b
MD5 346d178ce4829b24f0273518b32f780c
BLAKE2b-256 b583a83b648a89a157dba1b8e5feda3de799d05b5a33f6b8f5c45a8502bb1819

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page