Skip to content

Commit f1278dd

Browse files
author
Patrick Koss
committed
rework readme
1 parent 67a9d4f commit f1278dd

1 file changed

Lines changed: 19 additions & 17 deletions

File tree

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,34 +7,35 @@
77
[![Code Size](https://img.shields.io/github/languages/code-size/stackitcloud/certbot-dns-stackit.svg)](https://github.com/stackitcloud/certbot-dns-stackit)
88
[![Contributors](https://img.shields.io/github/contributors/stackitcloud/certbot-dns-stackit.svg)](https://github.com/stackitcloud/certbot-dns-stackit/graphs/contributors)
99

10-
The Certbot DNS-Stackit Authenticator Plugin allows you to obtain SSL/TLS certificates from Let's Encrypt using the
11-
DNS-01 challenge method with STACKIT as your DNS provider. This README provides detailed instructions on how to install
12-
and use the plugin.
10+
The Certbot DNS-STACKIT Authenticator Plugin facilitates the procurement of SSL/TLS certificates from Let's Encrypt
11+
utilizing the DNS-01 challenge methodology in conjunction with STACKIT as the designated DNS service provider. This
12+
document elucidates the procedural steps for the installation and operational utilization of this plugin.
1313

1414
## Installation
1515

16-
You can install the Certbot DNS-STACKIT Authenticator Plugin using pip:
16+
To initialize the Certbot DNS-STACKIT Authenticator Plugin, deploy the following pip command:
1717

1818
```bash
1919
pip install certbot-dns-stackit
2020
```
2121

2222
## Usage
2323

24-
Once the plugin is installed, you can use it with Certbot to obtain SSL/TLS certificates. Below are the available
25-
arguments and examples of how to use them:
24+
Upon successful integration of the plugin, it becomes viable to employ it with Certbot for the retrieval of SSL/TLS
25+
certificates. The subsequent section delineates the pertinent arguments and their respective examples:
2626

2727
### Arguments
2828

29-
| Argument | Example Value | Description |
30-
|-------------------------------------|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
31-
| `--authenticator` | dns-stackit | Selects the STACKIT authenticator. It must be set to dns-stackit. (Required) |
32-
| `--dns-stackit-credentials` | ./credentials.ini | Specifies the path to the file where the credentials for STACKIT DNS are stored. This file should contain the dns_stackit_auth_token and dns_stackit_project_id. (Required) |
33-
| `--dns-stackit-propagation-seconds` | 900 | Sets the time to wait until the DNS record is queried. It is recommended to set this to 900 seconds (15 minutes) for safety. (Default: 900) |
29+
| Argument | Example Value | Description |
30+
|-------------------------------------|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
31+
| `--authenticator` | dns-stackit | Engages the STACKIT authenticator mechanism. This must be configured as dns-stackit. (Mandatory) |
32+
| `--dns-stackit-credentials` | ./credentials.ini | Denotes the directory path to the credentials file for STACKIT DNS. This document must encapsulate the dns_stackit_auth_token and dns_stackit_project_id variables. (Mandatory) |
33+
| `--dns-stackit-propagation-seconds` | 900 | Configures the delay prior to initiating the DNS record query. A 900-second interval (equivalent to 15 minutes) is recommended. (Default: 900) |
3434

3535
### Example
3636

37-
Here's an example of how to use Certbot with the Certbot DNS-STACKIT Authenticator Plugin to obtain a certificate:
37+
Below is a structured example detailing the application of Certbot in conjunction with the DNS-STACKIT
38+
Authenticator Plugin to retrieve a certificate:
3839

3940
```bash
4041
certbot certonly \
@@ -48,20 +49,21 @@ certbot certonly \
4849
-d '*.example.runs.onstackit.cloud'
4950
```
5051

51-
where example.runs.onstackit.cloud is the domain (zone) for which you want to obtain a certificate.
52+
For this example, example.runs.onstackit.cloud represents the designated domain (zone) for certificate procurement.
5253

5354
### Example of credentials.ini
5455

55-
To use the plugin, you need to create a credentials.ini file that contains your STACKIT DNS credentials:
56+
To operationalize the plugin, it's imperative to curate a credentials.ini file encompassing your STACKIT DNS
57+
credentials:
5658

5759
```ini
5860
dns_stackit_auth_token = "your_token_here"
5961
dns_stackit_project_id = "your_project_id_here"
6062
```
6163

62-
Make sure to replace "your_token_here" and "your_project_id_here" with your actual STACKIT authentication token and
63-
project ID. The service account that owns the token must have the project membership role in order to create record
64-
sets.
64+
It's crucial to replace "your_token_here" and "your_project_id_here" placeholders with the genuine STACKIT
65+
authentication token and project ID. The token's associated service account necessitates project membership privileges
66+
for record set creation.
6567

6668
## Test Procedures
6769

0 commit comments

Comments
 (0)