Unverified Commit edfefb67 authored by Armando Lüscher's avatar Armando Lüscher
Browse files

Add usage instructions and repo link to post issues.

parent 98b3dcbf
...@@ -272,6 +272,7 @@ You don't have to do anything manually! ...@@ -272,6 +272,7 @@ You don't have to do anything manually!
1. Alwaysdata.com API 1. Alwaysdata.com API
1. Linode.com API 1. Linode.com API
1. FreeDNS (https://freedns.afraid.org/) 1. FreeDNS (https://freedns.afraid.org/)
1. cyon.ch
**More APIs coming soon...** **More APIs coming soon...**
......
...@@ -305,6 +305,24 @@ Note that you cannot use acme.sh automatic DNS validation for FreeDNS public dom ...@@ -305,6 +305,24 @@ Note that you cannot use acme.sh automatic DNS validation for FreeDNS public dom
you create under a FreeDNS public domain. You must own the top level domain in order to automaitcally you create under a FreeDNS public domain. You must own the top level domain in order to automaitcally
validate with acme.sh at FreeDNS. validate with acme.sh at FreeDNS.
## 16. Use cyon.ch
You only need to set your cyon.ch login credentials.
If you also have 2 Factor Authentication (OTP) enabled, you need to set your secret token too and have `oathtool` installed.
```
export cyon_username="your_cyon_username"
export cyon_password="your_cyon_password"
export cyon_otp_secret="your_otp_secret" # Only required if using 2FA
```
To issue a cert:
```
acme.sh --issue --dns dns_cyon -d example.com -d www.example.com
```
The `cyon_username`, `cyon_password` and `cyon_otp_secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
# Use custom API # Use custom API
If your API is not supported yet, you can write your own DNS API. If your API is not supported yet, you can write your own DNS API.
......
...@@ -9,27 +9,12 @@ ...@@ -9,27 +9,12 @@
# ------------- # -------------
# - oathtool (When using 2 Factor Authentication) # - oathtool (When using 2 Factor Authentication)
# #
# Author: Armando Lüscher <armando@noplanman.ch> # Issues:
######## # -------
# Any issues / questions / suggestions can be posted here:
######## # https://github.com/noplanman/cyon-api/issues
# Define cyon.ch login credentials:
#
# Either set them here: (uncomment these lines)
# #
# cyon_username='your_cyon_username' # Author: Armando Lüscher <armando@noplanman.ch>
# cyon_password='your_cyon_password'
# cyon_otp_secret='your_otp_secret' # Only required if using 2FA
#
# ...or export them as environment variables in your shell:
#
# $ export cyon_username='your_cyon_username'
# $ export cyon_password='your_cyon_password'
# $ export cyon_otp_secret='your_otp_secret' # Only required if using 2FA
#
# *Note:*
# After the first run, the credentials are saved in the "account.conf"
# file, so any hard-coded or environment variables can then be removed.
######## ########
dns_cyon_add() { dns_cyon_add() {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment