Metadata-Version: 2.1
Name: certbot-dns-constellix
Version: 0.1.2
Summary: Constellix DNS Authenticator plugin for Certbot
Home-page: https://github.com/Constellix/certbot-constellix
Author: Jessica Smith
Author-email: jsmith@constellix.com
License: Apache License 2.0
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Plugins
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Security
Classifier: Topic :: System :: Installation/Setup
Classifier: Topic :: System :: Networking
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
Description-Content-Type: text/markdown
Requires-Dist: acme (>=0.29.0)
Requires-Dist: certbot (>=0.31.0)
Requires-Dist: setuptools
Requires-Dist: requests
Requires-Dist: mock
Requires-Dist: requests-mock

# certbot-dns-constellix Documentation

The `certbot-dns-constellix` plugin is used to automate the process of
a `dns-01` challenge in Certbot to allow the requesting and renewal of SSL
certificates through the Constellix DNS API.

This is done through the process of adding and removing TXT records to the
appropriate domain in your Constellix DNS account.

## Installation

1. Install certbot for your operating system
2. Install the plugin by using `pip install certbot-dns-constellix`

## Configuration

The plugin requires an API key and secret key for the Constellix DNS API. The
key will need to have permissions to add and remove records on the domain you
want to issue certificates for.

These will need to be added to a file, eg. `constellix.ini` in the following
format:

```
certbot_dns_constellix:constellix_dns_apikey=5fb4e76f-ac91-43e5-f982458bc595
certbot_dns_constellix:constellix_dns_secretkey=47d99fd0-32e7-4e07-85b46d08e70b
certbot_dns_constellix:constellix_dns_endpoint=https://api.dns.constellix.com
```

### Caution

You should secure this file from any unauthorised access. Anyone with access
to these credentials and this file will be able to add and remove records from
your domain. You should configure the file to not be readable by any other
users on the system

## Usage

Once the plugin is installed and configured it can be used by specifying the
plugin in the certbot command and the location of the credentials file.

```
certbot certonly \
    --certbot-dns-constellix:dns-constellix \
    --certbot-dns-constellix:dns-constellix-credentials=~./constellix.ini \
    -d example.com
```

For more options please check the certbot documentation.







