Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/urda/django-letsencrypt
A simple Django app to handle Let's Encrypt ACME challenges
https://github.com/urda/django-letsencrypt
django letsencrypt python
Last synced: 20 days ago
JSON representation
A simple Django app to handle Let's Encrypt ACME challenges
- Host: GitHub
- URL: https://github.com/urda/django-letsencrypt
- Owner: urda
- License: apache-2.0
- Created: 2016-11-16T09:22:23.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-12-30T07:53:53.000Z (about 3 years ago)
- Last Synced: 2024-12-08T11:36:58.981Z (about 1 month ago)
- Topics: django, letsencrypt, python
- Language: Python
- Homepage: https://pypi.org/project/django-letsencrypt/
- Size: 326 KB
- Stars: 72
- Watchers: 4
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Let's Encrypt App for Django
`django-letsencrypt` will allow you to add, remove, and update any
[ACME challenge](https://github.com/ietf-wg-acme/acme/) 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](https://letsencrypt.org/how-it-works/) 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](https://pypi.org/project/django-letsencrypt/) 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.10` (Django `4.0` and `3.2` only)
- `3.9` (Django `4.0` and `3.2` only)
- `3.8`
- `3.7` (Django `3.2` and `2.2` only)
- Django Versions Supported:
- `4.0` minimum version `4.0`
- `3.2` minimum version `3.2.10`
- `2.2` minimum version `2.2.25`
- Databases Supported:
- `mysql`
- `postgres`
- `sqlite`
# Recent Build Status Badges
- [](https://github.com/urda/django-letsencrypt/actions/workflows/linting.yaml)
- [](https://github.com/urda/django-letsencrypt/actions/workflows/testing-22.yaml)
- [](https://github.com/urda/django-letsencrypt/actions/workflows/testing-32.yaml)
- [](https://github.com/urda/django-letsencrypt/actions/workflows/testing-40.yaml)
- [](https://codecov.io/gh/urda/django-letsencrypt)
# Installation & Configuration
1. `pip install django-letsencrypt`
2. Add `letsencrypt` to your `INSTALLED_APPS`
```python
INSTALLED_APPS = [
... ,
'letsencrypt',
... ,
]
```
3. Include the `letsencrypt` in your project's `urls.py`,
or where applicable (usually your root `urls.py`).
```python
re_path(r'^\.well-known/', include('letsencrypt.urls'))
```
4. Run `manage.py migrate` to create the required table for the
`letsencrypt` model
5. Create your `ACME Challenge` objects in your Django admin interface
6. Test your `ACME Challenge` objects and their responses by visiting
them:
```
{Django Site}/.well-known/acme-challenge/challenge_text
```
7. 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](https://github.com/urda/django-letsencrypt),
take a moment to read the `README.md` file within the
[`example_project`](https://github.com/urda/django-letsencrypt/tree/master/example_project)
directory, and follow the directions. That will spin up a small sample django
application already configured for you to try out.