Metadata-Version: 2.1
Name: aerix-certbot
Version: 0.6.4
Summary: Certbot authenticator plugin for Aerix HTTP-01 challenge responder
Author: Aerix
License: MIT License
        
        Copyright (c) 2024 Aerix
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/aerix-certbot/aerix-certbot
Keywords: certbot,acme,aerix,letsencrypt,plugin
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Plugins
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Security
Classifier: Topic :: System :: Systems Administration
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: certbot >=2.7
Requires-Dist: zope.interface >=6.0

# Aerix Certbot Plugin

This repository provides a Certbot authenticator plugin that writes HTTP-01
challenge responses into Aerix's built-in ACME responder directory structure
(`/var/lib/aerix/<domain>/<token>`). Once the files are written, Aerix serves
them at `http://<domain>/.well-known/acme-challenge/<token>` automatically
before any other routing or redirects, allowing Certbot to complete domain
validation without manual web server configuration.

## Installation

Install the plugin into the same Python environment that runs Certbot. When
published to PyPI you can install it directly:

```bash
pip install aerix-certbot
```

If you are working from a checkout of this repository, run `pip install .`
instead to install from the local sources.

You can confirm Certbot sees the plugin with:

```bash
certbot plugins
```

## Usage

Run Certbot with the Aerix authenticator selected. The plugin writes challenge
files to `/var/lib/aerix/<domain>/<token>`, which Aerix serves automatically at
`/.well-known/acme-challenge/<token>` before routing or redirects.

Use `--aerix-debug` to log where the plugin writes and removes challenge files:

```bash
certbot certonly \
  --authenticator aerix \
  --aerix-debug \
  --agree-tos \
  -m admin@example.com \
  -d example.com
```

When running `certbot renew`, the plugin restarts the Aerix service after it
cleans up challenge files so Aerix can pick up any state changes.

Certbot writes the validation file to
`/var/lib/aerix/example.com/<token>`, which Aerix serves automatically at
`http://example.com/.well-known/acme-challenge/<token>`.

## Uninstallation

To remove the plugin from the Certbot environment:

```bash
pip uninstall aerix-certbot
```

## Notes

- The plugin only supports HTTP-01 challenges.
- Certbot must have permission to create files under `/var/lib/aerix`.
