Skip to main content

A re-usable Django app to quickly deploy a page for the ACME challenge

Project description

https://badge.fury.io/py/django-acme.svg https://travis-ci.org/browniebroke/django-acme.svg?branch=master https://codecov.io/gh/browniebroke/django-acme/branch/master/graph/badge.svg

A re-usable Django app to quickly deploy a page for the ACME challenge

Documentation

The full documentation is at https://django-acme.readthedocs.io.

Quickstart

Install Django ACME:

pip install django-acme

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'acme_challenge',
    ...
)

Add the Django ACME’s URL patterns:

from acme_challenge import urls as acme_challenge_urls


urlpatterns = [
    ...
    url(r'^', include(acme_challenge_urls)),
    ...
]

The URL of the ACME challenge to serve as well as the content are controlled via 2 settings which default to:

ACME_CHALLENGE_URL_SLUG = os.getenv('ACME_CHALLENGE_URL_SLUG')
ACME_CHALLENGE_TEMPLATE_CONTENT = os.getenv('ACME_CHALLENGE_TEMPLATE_CONTENT')

The slug being the suffix of the URL path: /.well-known/acme-challenge/[ACME_CHALLENGE_URL_SLUG]/

Features

  • TODO

Running Tests

Does the code actually work? This projects uses tox:

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox [-e py27-django18]

Credits

Tools used in rendering this package:

History

0.2.1 (2016-11-25)

  • Settings are taken from the environment variables by default

0.2.0 (2016-11-17)

  • The root URL includes the .well-known/acme-challenge/ prefix.

  • Accept an optional / at the end of the URL

  • Updated documentation

0.1.3 (2016-11-17)

  • Bump version, various minor docs updates

0.1.0 (2016-11-16)

  • First release on PyPI.

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-acme-0.2.1.tar.gz (5.7 kB view details)

Uploaded Source

File details

Details for the file django-acme-0.2.1.tar.gz.

File metadata

  • Download URL: django-acme-0.2.1.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for django-acme-0.2.1.tar.gz
Algorithm Hash digest
SHA256 762bcb939e79076840ee6a529e3a12418abd6976c1d454c241c8dbb647e55319
MD5 2b38ace3738d0161dc3b97f5463b5a64
BLAKE2b-256 ab8b48733963f90fc37c0820e5772df8706f2038ad6abe2236352daef316a674

See more details on using hashes here.

Supported by

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