acmesmith-ns1
A plugin for Acmesmith and implements an automated dns-01
challenge responder using NS1 API.
With this plugin and Acmesmith, you can automate and authorize your domain hosted on NS1 Portal and request TLS certificates for the domains against Let's Encrypt and other CAs supporting the ACME protocol.
For more infromation on NS1 API - API Documentation
NS1 calls are managed by ns-1
gem see ns-1
Usage
Prerequisites
- You need to issue an API token from your NS1 Portal.
- And attached the relevant permissions to the API token
Installation
Install acmesith-ns1
gem along with acmesmith
. You can just do gem install acmesith-ns1
or use Bundler if you want.
Configuration
Use ns1
challenge responder in your acmesmith.yml
. General instructions about acmesmith.yml
is available in the manual of Acmesmith.
The mandatory options for the acmesmith.yml
(Or other file specified from command line) are:
- token:
NS1 API Token
Optional option is:
- ttl:
Integer
-> Where default TTL is 3600 if this option is omitted.
---
directory: https://acme-v02.api.letsencrypt.org/directory
storage:
type: filesystem
path: /path/to/key/storage
challenge_responders:
- ns1:
token: "API_TOKEN" # (required)
ttl: 60 # (optional)
License
The gem is available as open source under the terms of the MIT License.