Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.06 KB

quickstart.rst

File metadata and controls

44 lines (29 loc) · 1.06 KB
Raw

Quickstart

Requirements

  • Python 3.10 or newer
  • Django 3.2 or newer

Installation

  1. Install from PyPI using pip:

    pip install django-simple-certmanager

  2. Add simple_certmanager to the INSTALLED_APPS setting.

  3. Run python src/manage.py migrate to create the necessary database tables

  4. Configure django-privates correctly - the TLS certificates and keys are stored outside of settings.MEDIA_ROOT for security reasons.

Usage

Django admin

In the Django admin, you can create Certificate instances to (re-)use (mutual) TLS configuration.

Whenever an instance is deleted (through the admin or code), the associated files are purged as well.

Programmatically

The Certificate model is the public API of the library.

.. autoclass:: simple_certmanager.models.Certificate
    :members:
    :undoc-members:
    :exclude-members: DoesNotExist, MultipleObjectsReturned, clean, save, id, objects