Skip to content

Commit de57d91

Browse files
m8rmclarenm8rmclaren
committed
chore(docs): Overview and Requirements
1 parent 13a56eb commit de57d91

4 files changed

Lines changed: 133 additions & 13 deletions

File tree

‎README.md‎

Lines changed: 72 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,90 @@
1+
<h1 align="center" style="border-bottom: none">
2+
GoDaddy
3+
</h1>
14

2-
# godaddy-anycaplugin
5+
<p align="center">
6+
<!-- Badges -->
7+
<img src="https://img.shields.io/badge/integration_status-prototype-3D1973?style=flat-square" alt="Integration Status: prototype" />
8+
<a href="https://github.com/Keyfactor/godaddy-anycagateway/releases"><img src="https://img.shields.io/github/v/release/Keyfactor/godaddy-anycagateway?style=flat-square" alt="Release" /></a>
9+
<img src="https://img.shields.io/github/issues/Keyfactor/godaddy-anycagateway?style=flat-square" alt="Issues" />
10+
<img src="https://img.shields.io/github/downloads/Keyfactor/godaddy-anycagateway/total?style=flat-square&label=downloads&color=28B905" alt="GitHub Downloads (all assets, all releases)" />
11+
</p>
312

4-
GoDaddy plugin for the AnyCA Gateway framework
13+
<p align="center">
14+
<!-- TOC -->
15+
<a href="#support">
16+
<b>Support</b>
17+
</a>
18+
·
19+
<a href="#license">
20+
<b>License</b>
21+
</a>
22+
·
23+
<a href="https://github.com/orgs/Keyfactor/repositories?q=anycagateway">
24+
<b>Related Integrations</b>
25+
</a>
26+
</p>
527

6-
#### Integration status: Prototype - Demonstration quality. Not for use in customer environments.
728

8-
## About the Keyfactor
29+
The GoDaddy AnyCA REST plugin extends the capabilities of the [GoDaddy Certificate Authority (CA)](https://www.godaddy.com/web-security/ssl-certificate) to Keyfactor Command via the Keyfactor AnyCA REST Gateway. The plugin represents a fully featured AnyCA REST Plugin with the following capabilies:
30+
* CA Sync:
31+
* Download all certificates issued to the customer by the GoDaddy CA.
32+
* Certificate enrollment for all published GoDaddy Certificate SKUs:
33+
* Support certificate enrollment (new keys/certificate).
34+
* Support certificate renewal (extend the life of a previously issued certificate with the same or different domain names).
35+
* Support certificate re-issuance (new public/private keys with the same or different domain names).
36+
* Certificate revocation:
37+
* Request revocation of a previously issued certificate.
938

1039

1140

12-
## Support for godaddy-anycaplugin
41+
## Compatibility
1342

14-
godaddy-anycaplugin is open source and community supported, meaning that there is no support guaranteed from Keyfactor Support for these tools.
43+
The GoDaddy AnyCA REST plugin is compatible with the Keyfactor AnyCA REST Gateway 24.2 and later.
1544

16-
###### To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab.
45+
## Support
46+
The GoDaddy AnyCA REST plugin is open source and community supported, meaning that there is **no SLA** applicable.
1747

18-
---
48+
> To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab.
1949
50+
## Requirements
51+
1. **GoDaddy Account**
52+
53+
To use the GoDaddy AnyCA REST plugin, a production GoDaddy account must be created and fully configured. To create a new account, follow [GoDaddy's official documentation](https://www.godaddy.com/help/create-a-godaddy-account-16618). Make sure that your [account Profile is fully configured](https://www.godaddy.com/help/update-my-godaddy-account-profile-27250) with at least the following fields:
54+
* Full Name
55+
* Address
56+
* Organization
57+
* Email
58+
* Primary Phone
2059

21-
---
60+
Your GoDaddy account must also have at least one payment method. Follow [GoDaddy's official documentation](https://www.godaddy.com/help/add-a-payment-method-to-my-godaddy-account-20037) to add a payment method.
2261

62+
2. **GoDaddy Certificate**
2363

64+
The GoDaddy AnyCA REST plugin does not purchase certificates from GoDaddy on its own. To enroll a certificate using the plugin, you must first [purchase a certificate from GoDaddy](https://www.godaddy.com/web-security/ssl-certificate). Once purchased, the AnyCA REST plugin enables enrollment, [renewal](https://www.godaddy.com/help/renewing-my-ssl-certificate-864), and [rekeying (re-issuing)](https://www.godaddy.com/help/ssl-certificates-1000006) your purchased certificate.
2465

66+
3. **GoDaddy API Key**
2567

68+
The GoDaddy AnyCA REST plugin uses the [GoDaddy API](https://developer.godaddy.com/doc/endpoint/certificates) to perform all certificate operations. GoDaddy offers an environment for testing (OTE) and an environment for production use (Production). To configure the plugin, follow the [official GoDaddy documentation](https://developer.godaddy.com/getstarted) to create a [production API key](https://developer.godaddy.com/keys). To configure the AnyCA REST Gateway, you'll need the following parameters handy:
2669

70+
* API URL (https://api.godaddy.com or https://api.ote-godaddy.com)
71+
* API Key
72+
* API Secret
2773

74+
4. **GoDaddy Shopper ID**
75+
76+
To synchronize certificates issued by the GoDaddy CA, the GoDaddy AnyCA REST plugin needs to know your Shopper ID (shown as Customer # on the GoDaddy website). The Shopper ID is a number with a max length of 10 (e.g., 1234567890). To find your Shopper ID, sign into [GoDaddy](https://www.godaddy.com/) and click on your name dropdown on the top right. The Shopper ID is shown as **Customer #** in this dropdown.
77+
78+
79+
80+
## Installation
81+
82+
83+
84+
## License
85+
86+
Apache License 2.0, see [LICENSE](LICENSE).
87+
88+
## Related Integrations
89+
90+
See all [Keyfactor Any CA Gateways (REST)](https://github.com/orgs/Keyfactor/repositories?q=anycagateway).

‎docsource/configuration.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## Overview
2+
3+
The GoDaddy AnyCA REST plugin extends the capabilities of the [GoDaddy Certificate Authority (CA)](https://www.godaddy.com/web-security/ssl-certificate) to Keyfactor Command via the Keyfactor AnyCA REST Gateway. The plugin represents a fully featured AnyCA REST Plugin with the following capabilies:
4+
* CA Sync:
5+
* Download all certificates issued to the customer by the GoDaddy CA.
6+
* Certificate enrollment for all published GoDaddy Certificate SKUs:
7+
* Support certificate enrollment (new keys/certificate).
8+
* Support certificate renewal (extend the life of a previously issued certificate with the same or different domain names).
9+
* Support certificate re-issuance (new public/private keys with the same or different domain names).
10+
* Certificate revocation:
11+
* Request revocation of a previously issued certificate.
12+
13+
## Requirements
14+
15+
1. **GoDaddy Account**
16+
17+
To use the GoDaddy AnyCA REST plugin, a production GoDaddy account must be created and fully configured. To create a new account, follow [GoDaddy's official documentation](https://www.godaddy.com/help/create-a-godaddy-account-16618). Make sure that your [account Profile is fully configured](https://www.godaddy.com/help/update-my-godaddy-account-profile-27250) with at least the following fields:
18+
* Full Name
19+
* Address
20+
* Organization
21+
* Email
22+
* Primary Phone
23+
24+
Your GoDaddy account must also have at least one payment method. Follow [GoDaddy's official documentation](https://www.godaddy.com/help/add-a-payment-method-to-my-godaddy-account-20037) to add a payment method.
25+
26+
2. **GoDaddy Certificate**
27+
28+
The GoDaddy AnyCA REST plugin does not purchase certificates from GoDaddy on its own. To enroll a certificate using the plugin, you must first [purchase a certificate from GoDaddy](https://www.godaddy.com/web-security/ssl-certificate). Once purchased, the AnyCA REST plugin enables enrollment, [renewal](https://www.godaddy.com/help/renewing-my-ssl-certificate-864), and [rekeying (re-issuing)](https://www.godaddy.com/help/ssl-certificates-1000006) your purchased certificate.
29+
30+
3. **GoDaddy API Key**
31+
32+
The GoDaddy AnyCA REST plugin uses the [GoDaddy API](https://developer.godaddy.com/doc/endpoint/certificates) to perform all certificate operations. GoDaddy offers an environment for testing (OTE) and an environment for production use (Production). To configure the plugin, follow the [official GoDaddy documentation](https://developer.godaddy.com/getstarted) to create a [production API key](https://developer.godaddy.com/keys). To configure the AnyCA REST Gateway, you'll need the following parameters handy:
33+
34+
* API URL (https://api.godaddy.com or https://api.ote-godaddy.com)
35+
* API Key
36+
* API Secret
37+
38+
4. **GoDaddy Shopper ID**
39+
40+
To synchronize certificates issued by the GoDaddy CA, the GoDaddy AnyCA REST plugin needs to know your Shopper ID (shown as Customer # on the GoDaddy website). The Shopper ID is a number with a max length of 10 (e.g., 1234567890). To find your Shopper ID, sign into [GoDaddy](https://www.godaddy.com/) and click on your name dropdown on the top right. The Shopper ID is shown as **Customer #** in this dropdown.

‎integration-manifest-schema.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/Users/hroszell/Documents/dev/staff-tools/keyfactor.github.io/v2/integration-manifest-schema.json

‎integration-manifest.json‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,28 @@
11
{
2-
"$schema": "https://keyfactor.github.io/integration-manifest-schema.json",
3-
"name": "godaddy-anycaplugin",
2+
"$schema": "integration-manifest-schema.json",
3+
"name": "GoDaddy AnyCA REST plugin",
44
"status": "prototype",
55
"integration_type": "anyca-plugin",
66
"support_level": "community",
77
"link_github": false,
88
"update_catalog": false,
99
"description": "GoDaddy plugin for the AnyCA Gateway framework",
10-
"gateway_framework": "1.0.0",
11-
"release_dir": "godaddy-anycaplugin/bin/Release/net6.0"
10+
"gateway_framework": "24.2",
11+
"release_dir": "godaddy-anycaplugin/bin/Release/net6.0",
12+
"about": {
13+
"carest": {
14+
"product_ids": [
15+
"DV_SSL",
16+
"DV_WILDCARD_SSL",
17+
"EV_SSL",
18+
"OV_CS",
19+
"OV_DS",
20+
"OV_SSL",
21+
"OV_WILDCARD_SSL",
22+
"UCC_DV_SSL",
23+
"UCC_EV_SSL",
24+
"UCC_OV_SSL"
25+
]
26+
}
27+
}
1228
}

0 commit comments

Comments
 (0)