https://github.com/decryptus/certbot-httpreq

Customize and send authenticator and installer certbot requests through HTTP protocol
https://github.com/decryptus/certbot-httpreq

certbot certbot-plugin customization http-requests json-api

Last synced: 4 days ago
JSON representation

Customize and send authenticator and installer certbot requests through HTTP protocol

• Host: GitHub
• URL: https://github.com/decryptus/certbot-httpreq
• Owner: decryptus
• License: gpl-3.0
• Created: 2019-11-10T19:13:38.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-10-09T22:06:36.000Z (about 2 years ago)
• Last Synced: 2024-12-07T20:28:18.392Z (27 days ago)
• Topics: certbot, certbot-plugin, customization, http-requests, json-api
• Language: Python
• Size: 39.1 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
## certbot-httpreq project

[![PyPI pyversions](https://img.shields.io/pypi/pyversions/certbot-httpreq.svg)](https://pypi.org/project/certbot-httpreq/)

[![PyPI version shields.io](https://img.shields.io/pypi/v/certbot-httpreq.svg)](https://pypi.org/project/certbot-httpreq/)

[![Documentation Status](https://readthedocs.org/projects/certbot-httpreq/badge/?version=latest)](https://certbot-httpreq.readthedocs.io/)

certbot-httpreq is a free and open-source, we develop it to customize and send authenticator and installer certbot requests through HTTP protocol.

## Table of contents

1. [Installation](#installation)

2. [Usage](#usage)

3. [Configuration](#configuration)

## Installation

`pip install certbot-httpreq`

## Usage

```

certbot \

  --agree-tos \

  --text \

  -a certbot-httpreq:auth \

  -i certbot-httpreq:installer \

  --certbot-httpreq:auth-config /etc/letsencrypt/certbot-httpreq.yml \ # not required

  --certbot-httpreq:installer-config /etc/letsencrypt/certbot-httpreq.yml \ # not required

  run

```

Configuration file must be placed in /etc/letsencrypt/certbot-httpreq.yml or be specified with arguments --certbot-httpreq:auth-config and --certbot-httpreq:installer-config.

## Configuration

You can customize authenticator HTTP requests for perform and cleanup phases and also installer HTTP requests for deploy phase.

```

# authenticator

perform:

  ### perform HTTP URI ###

  uri: http://localhost

  ### perform HTTP path ###

  path: /

  ### perform HTTP method: PUT or POST ###

  method: PUT

  ### perform HTTP format: json or form-urlencoded ###

  format: json

  ### parameter name in HTTP query string for challenge string ###

  ### default: HTTP path e.g.: http://localhost/HGr8U1IeTW4kY_Z6UIyaakzOkyQgPr_7ArlLgtZE8SX ###

  param_challenge: ~

  ### parameter name in HTTP body for validation string

  ### default: HTTP json payload e.g.: "gfj9Xq...Rg85nM" ###

  param_validation: ~

  ### perform HTTP custom headers ###

  headers: {}

  ### perform HTTP connection timeout ###

  timeout: ~

  ### perform HTTP SSL verify ###

  verify: ~

cleanup:

  ### cleanup HTTP uri ###

  uri: http://localhost

  ### cleanup HTTP path ###

  path: /

  ### cleanup HTTP method: DELETE, PUT or POST ###

  method: DELETE

  ### cleanup HTTP format: json or form-urlencoded ###

  format: json

  ### parameter name in HTTP query string for challenge string ###

  ### default: HTTP path e.g.: http://localhost/HGr8U1IeTW4kY_Z6UIyaakzOkyQgPr_7ArlLgtZE8SX ###

  param_challenge: ~

  ### cleanup HTTP custom headers ###

  headers: {}

  ### cleanup HTTP connection timeout ###

  timeout: ~

  ### cleanup HTTP SSL verify ###

  verify: ~

# installer

deploy:

  ### deploy HTTP URI ###

  uri: http://localhost

  ### deploy HTTP path ###

  path: /

  ### deploy HTTP method: POST or PUT or PATCH ###

  method: POST

  ### deploy HTTP format: json or form-urlencoded ###

  ### e.g.: HTTP json payload: {"domain":"...","cert":"...","key":"...","chain":"..."} ###

  format: json

  ### parameter names in HTTP body

  body_params:

    domain: domain

    cert: cert

    key: key

    chain: chain

  ### deploy HTTP custom headers ###

  headers: {}

  ### deploy HTTP connection timeout ###

  timeout: ~

  ### deploy HTTP SSL verify ###

  verify: ~

```