Skip to content
This repository was archived by the owner on Jul 16, 2020. It is now read-only.

Commit 39848a7

Browse files
authored
Update README.md
1 parent f7fa184 commit 39848a7

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# OVH DNS API Client for Certbot
2-
Certbot plugin to respond to DNS-01 challenges by updating the DNS zone in an OVH account.
1+
# Certbot plugin for OVH DNS
2+
Certbot hook scripts that allow to respond to DNS-01 challenges from _Let's Encrypt_ by updating the DNS zone in an OVH account.
33

4-
# Why
5-
There are several use cases for DNS challenge with **Certbot**, for example when the server or machine that need a
6-
certificate is not directly accessible from the internet. This way, you can secure machines and services in your
7-
internal network, behind a firewall or VPN. Other use cases could be automating multi-server deploys.
4+
# Why and when you might need this
5+
There are several use cases for DNS challenge with **Certbot**. For example, when the server or machine that needs a
6+
certificate is not directly accessible from the internet; this way, you can secure machines and services in your
7+
internal network or company domain, even behind a firewall or VPN. Another example for this is to automatically deploy certificates to servers that for any reason cannot perform their challenges, like CDNs or other servers that for any reason cannot run **Certbot**. In this case you would need more automation to deliver the certificates securely to those hosts, but it's not the scope of this project.
88

99
## Prerequisites
1010
- [Node JS](https://nodejs.org/) ≥ 6.
1111
- [Certbot](https://certbot.eff.org).
1212

13-
## How to Use
13+
## Instructions
1414
0. Download or clone this repo, and then from a terminal enter the directory: `cd ovh-certbot-dns` and run `npm install`.
1515

1616
1. Get an _App Key_ and _App Secret_ from OVH by registering a new app at this URL:

0 commit comments

Comments
 (0)