Metadata-Version: 2.4
Name: uacme-desec
Version: 1.2.1
Summary: uacme-desec - An UACME hook for deSEC
Author-email: Hugo Rodrigues <hugo.rodrigues@openbit.tech>
Project-URL: Homepage, https://codeberg.org/openbit/uacme-desec
Project-URL: Issues, https://codeberg.org/openbit/uacme-desec/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown

<!--
SPDX-FileCopyrightText: 2024 OpenBit
SPDX-FileContributor: Hugo Rodrigues

SPDX-License-Identifier: MIT
-->

# UACME deSEC

This is a hook for [UACME](https://github.com/ndilieto/uacme) that creates and deletes DNS records on deSEC for the dns-01 challenge

## Usage

    DESEC_TOKEN=mydesecaccounttoken DESEC_DOMAN=example.com uacme --hook /usr/bin/uacme-desec

## Configurations

uacme-desec is configured using the following environment variables

| Environment variable | Usage | Required | Default |
|-|-|-|-|
|DESEC_TOKEN|API Token for deSEC | Yes | - |
|DESEC_HOST|deSEC hostname | No | desec.io |
|DESEC_DOMAIN|Domain where the record will be created | No | If not set, will use SLD and TLD provided by UACME|
|DESEC_SYSLOG|If set, will enable logging to syslog. The value should be the address/path to syslog| -
|DESEC_ALIAS|If set, will use the value as subname. Use this for [DNS alias mode](https://github.com/acmesh-official/acme.sh/wiki/DNS-alias-mode)| -

## External services

This tool uses the following 3rd party services

|Service|Usage|
|-|-|
|Google DNS|Since Let's Encrypt uses Google DNS for dns-01 challenge, we use it as well to ensure that the dns-01 record is propagated|

## License

uacme-desec is licensed under MIT
